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

Add procedure for managing image mode hosts #3612

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

bangelic
Copy link
Contributor

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

  • 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:

  • Foreman 3.13/Katello 4.15 (EL9 only)
  • Foreman 3.12/Katello 4.14 (Satellite 6.16)
  • Foreman 3.11/Katello 4.13 (orcharhino 6.11 on EL8 only; orcharhino 7.0 on EL8+EL9)
  • Foreman 3.10/Katello 4.12
  • Foreman 3.9/Katello 4.11 (Satellite 6.15; orcharhino 6.8/6.9/6.10)
  • Foreman 3.8/Katello 4.10
  • Foreman 3.7/Katello 4.9 (Satellite 6.14)
  • We do not accept PRs for Foreman older than 3.7.

@bangelic
Copy link
Contributor Author

@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.

Copy link

github-actions bot commented Jan 23, 2025

Copy link
Contributor

@ianballou ianballou left a 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 👍

@bangelic bangelic force-pushed the bangelic-SAT-28185-Add-procedure-for-updating-image-mode-RHEL-hosts branch from f9adcd8 to 8fd8346 Compare January 29, 2025 21:05
Copy link
Contributor

@Lennonka Lennonka left a 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.

@Lennonka Lennonka added the Waiting on contributor Requires an action from the author label Jan 31, 2025
@bangelic bangelic force-pushed the bangelic-SAT-28185-Add-procedure-for-updating-image-mode-RHEL-hosts branch from 8fd8346 to 2cc9442 Compare January 31, 2025 19:50
@pr-processor pr-processor bot added Needs re-review and removed Waiting on contributor Requires an action from the author labels Jan 31, 2025
@bangelic
Copy link
Contributor Author

When this gets merged, it needs to be added to the assembly created in #3611.

Comment on lines 57 to +60
endif::[]

include::modules/proc_viewing-image-mode-hosts-and-booted-container-images.adoc[leveloffset=+1]
endif::[]
Copy link
Contributor

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.

Comment on lines +17 to +21
* *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.
Copy link
Contributor

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.

Copy link
Contributor

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:

  1. Procedure for Viewing booted container images.
  2. 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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* *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?

Comment on lines +23 to +26
[NOTE]
====
CLI users can alternatively run the `hammer host bootc images` command.
====
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
[NOTE]
====
CLI users can alternatively run the `hammer host bootc images` command.
====
.CLI procedure
* Run the `hammer host bootc images` command.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants