Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a new guide for provisioning virtual machines (2 of 3) #3608

Draft
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

Lennonka
Copy link
Contributor

@Lennonka Lennonka commented Jan 23, 2025

What changes are you introducing?

Splitting Provisioning hosts into 3 new guides:

  1. Provisioning machines by using an installer - includes network boot and boot disks, which are both installer-based provisioning, plus Discovery, which also uses network boot
  2. Provisioning virtual machines - includes virtualization providers, image-based provisioning, and directives for installer-based provisioning if available <--- We are here.
  3. Provisioning cloud instances - includes cloud infrastructure providers and image-based provisioning only

Why are you introducing these changes? (Explanation, links to references, issues, etc.)

To mitigate pain points identified in SAT-26089 comments (public).

Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)

  • Provisioning hosts will be destroyed after all 3 guides from above will have been created.
  • Currently, I am only modifying the structure. Further, detailed improvements will be done in subsequent PRs. Therefore, the new guide is terminologically inconsistent.
    Reviewers, please, focus on the title and heading structure in this PR. Using preview first is highly recommended.
  • May require updates of documentation links in the web UI.

Checklists

  • I am okay with my commits getting squashed when you merge this PR.
  • I am familiar with the contributing guidelines.

Please cherry-pick my commits into: N/A

@Lennonka Lennonka added Needs tech review Requires a review from the technical perspective Needs style review Requires a review from docs style/grammar perspective labels Jan 23, 2025
Copy link

github-actions bot commented Jan 23, 2025

The PR preview for f570995 is available at theforeman-foreman-documentation-preview-pr-3608.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

<productnumber>{ProjectVersion}</productnumber>
<abstract>
<para>
TODO
Copy link
Contributor Author

@Lennonka Lennonka Jan 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note to self: TODO

"Overture is composed last."

Copy link
Contributor

@maximiliankolb maximiliankolb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your effort Lena! Diff looks very reasonable to me but tech ACK is appreciated.

Comment on lines +5 to +8

= {ProvisioningVirtualDocTitle}

// This guide is not ready for stable releases
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

question: Do you have reasons to believe that the guide would not work for unstable and/or foreman-el/foreman-deb?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It probably should work for all builds, since images are not part of Katello. However, right now I'm not sure it works at all and I would prefer to revisit this question later :))

@Lennonka Lennonka marked this pull request as draft January 24, 2025 01:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs style review Requires a review from docs style/grammar perspective Needs tech review Requires a review from the technical perspective
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants