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.

Sign up for GitHub

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 concept for Package and Image Mode Hosts #3611

Closed
wants to merge 14 commits into from
Closed

Add concept for Package and Image Mode Hosts #3611

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
d3dadb5
Add concept for Package and Imahe Mode Hosts
bangelic Jan 23, 2025
ee5004d
Remove endif and minor edits
bangelic Jan 29, 2025
6b407ae
Create assembly, add what image mode does, other suggested changes
bangelic Jan 31, 2025
8621f2e
Move to new assembly, change ID, fix some content
bangelic Feb 4, 2025
d08e96f
Add procedure for managing image mode hosts
bangelic Jan 23, 2025
e146c67
Fix bootc and add line about new Hosts Overview page
bangelic Jan 29, 2025
be98085
Change title and add prerequisites
bangelic Jan 31, 2025
1f0ef93
Create separate reference module and procedure and update master.adoc
bangelic Feb 4, 2025
390f184
Fix some content into a step and address other suggestions
bangelic Feb 5, 2025
47e6925
Merge branch into bangelic-SAT-28164 and fix merge conflict
bangelic Feb 6, 2025
d7f1a40
Restore file
bangelic Feb 6, 2025
d2a7614
Fix merge conflict in assembly
bangelic Feb 6, 2025
33ee4bf
Fix mnerge conflict in proc
bangelic Feb 6, 2025
1c14ca1
Fix another merhe conflict in proc
bangelic Feb 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions guides/common/assembly_administering-hosts.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,13 @@

include::modules/con_host-search-by-rhel-lifecycle-status.adoc[leveloffset=+2]
endif::[]

include::modules/ref_managing-image-modes-hosts.adoc[leveloffset=+1]

include::modules/proc_viewing-booted-container-images.adoc[leveloffset=+1]

<<<<<<< HEAD

Check failure on line 63 in guides/common/assembly_administering-hosts.adoc

View workflow job for this annotation

GitHub Actions / linter 

[vale] reported by reviewdog 🐶
[RedHat.MergeConflictMarkers] Do not commit Git merge conflict markers in source code.

Raw Output:
{"message": "[RedHat.MergeConflictMarkers] Do not commit Git merge conflict markers in source code.", "location": {"path": "guides/common/assembly_administering-hosts.adoc", "range": {"start": {"line": 63, "column": 1}}}, "severity": "ERROR"}
include::modules/proc_viewing-image-mode-hosts-and-booted-container-images.adoc[leveloffset=+1]

=======

Check failure on line 66 in guides/common/assembly_administering-hosts.adoc

View workflow job for this annotation

GitHub Actions / linter 

[vale] reported by reviewdog 🐶
[RedHat.MergeConflictMarkers] Do not commit Git merge conflict markers in source code.

Raw Output:
{"message": "[RedHat.MergeConflictMarkers] Do not commit Git merge conflict markers in source code.", "location": {"path": "guides/common/assembly_administering-hosts.adoc", "range": {"start": {"line": 66, "column": 1}}}, "severity": "ERROR"}
>>>>>>> 1f0ef93f20 (Create separate reference module and procedure and update master.adoc)

Check failure on line 67 in guides/common/assembly_administering-hosts.adoc

View workflow job for this annotation

GitHub Actions / linter 

[vale] reported by reviewdog 🐶
[RedHat.MergeConflictMarkers] Do not commit Git merge conflict markers in source code.

Raw Output:
{"message": "[RedHat.MergeConflictMarkers] Do not commit Git merge conflict markers in source code.", "location": {"path": "guides/common/assembly_administering-hosts.adoc", "range": {"start": {"line": 67, "column": 1}}}, "severity": "ERROR"}
2 changes: 2 additions & 0 deletions guides/common/assembly_overview-of-hosts.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
include::modules/con_overview-of-hosts-in-project.adoc[]

include::modules/con_browsing-hosts-in-foreman-webui.adoc[leveloffset=+1]

include::modules/con_overview-of-image-mode-hosts.adoc
1 change: 1 addition & 0 deletions guides/common/assembly_package-mode-and-image-mode-hosts.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
include::modules/con_overview-of-image-mode-hosts.adoc[]
24 changes: 24 additions & 0 deletions guides/common/modules/con_overview-of-image-mode-hosts.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
[id="overview-of-image-mode-hosts_{context}"]
= Overview of image mode hosts

{Project} identifies an image mode host as any system that reports a container image from its bootc status through Subscription Manager.
It classifies all other hosts as package mode hosts.

Image mode simplifies enterprise operations by enabling development, operations, and solution providers to use the same container-native tools and techniques to manage both applications and the underlying operating system.

.Image mode hosts
Image mode hosts include additional fields that reflect their boot status.
These fields track the container images used in various scenarios:

* *Booted Image & Digest*: Indicates the container image the host is currently using.
* *Staged Image & Digest*: Indicates the container image the host uses after the next reboot.
* *Available Image & Digest*: Represents the container image cached by running `bootc upgrade --check`.
* *Rollback Image & Digest*: Represents the container image the host reverts to after the next reboot if `Bootc rollback` is applied.

.Additional resources
{Project} enables registration, monitoring, and update support for image mode hosts.
Register image mode hosts like any other host, view their `bootc` statuses in a centralized location, and trigger updates remotely using remote execution.
For more information on image mode concepts, refer to the https://www.redhat.com/en/blog/image-mode-red-hat-enterprise-linux-quick-start-guide[RHEL Image Mode quick start guide].
You can display a column in the New UI of the *All Hosts* page that includes a mode indicator.
This column is disabled by default, so enabling it views mode information.

29 changes: 29 additions & 0 deletions guides/common/modules/proc_viewing-booted-container-images.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
[id="Viewing_booted_container_images_{context}"]
= Viewing booted container images

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, the `foreman_ygg_worker` package must be included in the image mode host's container image.

.Procedure
. Navigate to *Content* > *Booted Container Images* to view all images used by image mode hosts.
This page displays the spread of digests under specific image paths.
More digests under an image path indicate greater drift in the host ecosystem, ideally minimized by ensuring all hosts run the most up-to-date image version.
. Click the host count to navigate to the *All Hosts* page, which identifies the hosts associated with each specific image and displays the number of hosts using each digest.
. Select a host and on the *Details* tab, use the image mode *Details* card to see the current `bootc` status.
. Click the link to the *Bootc Action - Script Default* remote execution job in this card to perform a Bootc action on the host.

* *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.
For more information, see xref:transport-modes-for-remote-execution_{context}[].

.Procedure
. Navigate to *Content* > *Booted Container Images* to view all images used by image mode hosts.
This page displays the spread of digests under specific image paths.
More digests under an image path indicate greater drift in the host ecosystem, ideally minimized by ensuring all hosts run the most up-to-date image version.
. Click the host count to navigate to the *All Hosts* page, which identifies the hosts associated with each specific image and displays the number of hosts using each digest.
. Select a host and on the *Details* tab, use the image mode *Details* card to see the current `bootc` status.
. Click the link to the *Bootc Action - Script Default* remote execution job in this card to perform a Bootc action on the host.

.CLI procedure
* Run the `hammer host bootc images` command.
9 changes: 9 additions & 0 deletions guides/common/modules/ref_managing-image-modes-hosts.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[id="Managing_image_mode_hosts{context}"]
= Managing image mode hosts

* Use the new remote execution jobs under the Bootc job category to manage image mode hosts:
** *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.
3 changes: 2 additions & 1 deletion guides/doc-Managing_Hosts/master.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ include::common/assembly_host-status.adoc[leveloffset=+1]

include::common/assembly_managing-packages.adoc[leveloffset=+1]

include::common/assembly_package-mode-and-image-mode-hosts.adoc[leveloffset=+1]
bangelic marked this conversation as resolved.
Show resolved Hide resolved

:numbered!:

[appendix]
Expand All @@ -68,5 +70,4 @@ include::common/assembly_job-template-examples-and-extensions.adoc[leveloffset=+

[appendix]
include::common/modules/ref_overview-of-the-host-columns.adoc[leveloffset=+1]

endif::[]
bangelic marked this conversation as resolved.
Show resolved Hide resolved
Loading