-
Notifications
You must be signed in to change notification settings - Fork 96
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
Add procedure for managing image mode hosts #3612
base: master
Are you sure you want to change the base?
Add procedure for managing image mode hosts #3612
Conversation
@ianballou This procedure might need some clarification on where we tell the user to navigate to in order to perform some of these steps. Take a look and make any comments or suggestions. |
The PR preview for 2cc9442 is available at theforeman-foreman-documentation-preview-pr-3612.surge.sh The following output files are affected by this PR: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just some small comments, but this generally looks great 👍
guides/common/modules/proc_managing-image-mode-hosts-and-booted-container-images.adoc
Outdated
Show resolved
Hide resolved
guides/common/modules/proc_managing-image-mode-hosts-and-booted-container-images.adoc
Outdated
Show resolved
Hide resolved
f9adcd8
to
8fd8346
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is the goal of this procedure?
"Managing" isn't a goal. "Managing" is a whole set of goals.
Please, try to write down User Stories for the various goals and come up with a structure that follows those User Stories.
8fd8346
to
2cc9442
Compare
When this gets merged, it needs to be added to the assembly created in #3611. |
endif::[] | ||
|
||
include::modules/proc_viewing-image-mode-hosts-and-booted-container-images.adoc[leveloffset=+1] | ||
endif::[] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If image mode hosts are only available with Katello, remove the endif
above. If they are available without Katello, remove the endif
below.
Then you don't have to remove it in master.adoc, which should stay without changes.
* *Bootc Action* - Script Default: Select any Bootc action from the dropdown menu, enter arguments, and specify a target. | ||
* *Bootc Rollback* - Script Default: Run Bootc rollback to revert to a previous image. | ||
* *Bootc Status* - Script Default: Run Bootc status with optional extra parameters to check the status. | ||
* *Bootc Switch* - Script Default: Run Bootc switch with a mandatory image input and optional extra parameters to switch to a different image. | ||
* *Bootc Upgrade* - Script Default: Run Bootc upgrade with optional extra parameters to update the image. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should there be a procedure for each of those actions? They aren't for viewing image mode hosts as specified by the title.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually, I think that we might need to split this info into:
- Procedure for Viewing booted container images.
- Reference for the REX jobs, eg. Managing image mode hosts.
These actions streamline the management of image mode hosts, providing flexibility and control over host operations through {Project}. | ||
|
||
.Prerequisites | ||
* *Pull-Mode Remote Execution*: For pull-mode remote execution users, related packages must be included in the image mode host's container image. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* *Pull-Mode Remote Execution*: For pull-mode remote execution users, related packages must be included in the image mode host's container image. | |
* *Pull-Mode Remote Execution*: If you use pull-mode remote execution, the `x`, `y`, and `z` packages must be included in the image mode host's container image. |
Can we tell them what packages specifically they need?
[NOTE] | ||
==== | ||
CLI users can alternatively run the `hammer host bootc images` command. | ||
==== |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[NOTE] | |
==== | |
CLI users can alternatively run the `hammer host bootc images` command. | |
==== | |
.CLI procedure | |
* Run the `hammer host bootc images` command. |
What changes are you introducing?
Adding a procedure for managing image mode
hosts and booted container images.
Why are you introducing these changes? (Explanation, links to references, issues, etc.)
This is in reference to https://issues.redhat.com/browse/SAT-28185.
Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)
Checklists
Please cherry-pick my commits into: