Add concept for Package and Image Mode Hosts #3611

bangelic · 2025-01-23T20:20:55Z

What changes are you introducing?

Adding a concept for understanding package
mode and image mode hosts.

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

This is in reference to https://issues.redhat.com/browse/SAT-28164.

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 · 2025-01-23T20:22:25Z

@ianballou This is the concept for Package and Image Mode hosts. The procedure for https://issues.redhat.com/browse/SAT-28185 will be in another PR.

github-actions · 2025-01-23T20:24:34Z

The PR preview for b1901a6 is available at theforeman-foreman-documentation-preview-pr-3611.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

ianballou

Small comments only here!

guides/common/modules/con_understanding-package-mode-and-image-mode-hosts.adoc

guides/common/assembly_administering-hosts.adoc

guides/doc-Managing_Hosts/master.adoc

guides/common/modules/con_understanding-package-mode-and-image-mode-hosts.adoc

guides/doc-Managing_Hosts/master.adoc

guides/common/modules/con_understanding-package-mode-and-image-mode-hosts.adoc

Lennonka

The purpose of this concept module us unclear to me. It currently describes the user interface, which we don't do.

Try to think harder about what the user needs to learn before they get to manage image mode hosts:

What is the "image mode"?
Why is it relevant?
What are the advantages of the image mode vs. the package mode?
The keyword "bootc" should probably appear here.

Also, I'm not sure if this assembly is the right place. Should it go to a standalone chapter maybe? Have you considered that? Why yes? Why not?

Please, try again.

guides/common/modules/con_understanding-package-mode-and-image-mode-hosts.adoc

Lennonka · 2025-01-30T11:39:08Z

guides/common/modules/con_understanding-package-mode-and-image-mode-hosts.adoc

+A new card appears on the Details tab for registered hosts, displaying the additional fields from `Bootc`.
+
+.Important Notes
+* *Pull-Mode Remote Execution*: For pull-mode remote execution users, related packages must be included in the image mode host's container image.


Perhaps this should be a prerequisite in the procedure? (I'm not sure because it isn't clear to me why that's needed.)

Lennonka

Thanks, Brian, that's better!

Lennonka · 2025-02-03T12:44:51Z

guides/common/modules/con_package-mode-and-image-mode-hosts.adoc

+
+The distinction between package mode and image mode provides greater flexibility in managing hosts and streamlines operations for image-based deployments.
+
+{Project} enables registration, monitoring, and update support for image mode hosts. 


Suggested change

{Project} enables registration, monitoring, and update support for image mode hosts.

In {Project}, you can register, monitor, and update image mode hosts.

Lennonka · 2025-02-03T12:45:23Z

guides/common/modules/con_package-mode-and-image-mode-hosts.adoc

+{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 OS.


Suggested change

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

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.

I'm surprised that Vale hasn't reported this. 🤔

Lennonka · 2025-02-03T16:32:33Z

guides/common/modules/con_package-mode-and-image-mode-hosts.adoc

@@ -0,0 +1,25 @@
+[id="package-mode-and-image-mode-hosts_{context}"]
+= Package mode and image mode hosts


Suggested change

= Package mode and image mode hosts

= Image mode hosts

I'd simplify it.

I'm not sure about this...

Lennonka · 2025-02-03T16:33:16Z

guides/common/modules/con_package-mode-and-image-mode-hosts.adoc

+[id="package-mode-and-image-mode-hosts_{context}"]
+= Package mode and image mode hosts
+
+You can operate hosts in two modes: package mode and image mode.


Suggested change

You can operate hosts in two modes: package mode and image mode.

You can operate hosts in two modes: package mode and image mode.

I'd drop this sentence because this can be inferred from the overall context.

I'm not sure about this.

Lennonka · 2025-02-03T16:33:55Z

guides/common/modules/con_package-mode-and-image-mode-hosts.adoc

+{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.


I would lead with this - move it to the top.

Lennonka · 2025-02-03T16:34:30Z

guides/common/modules/con_package-mode-and-image-mode-hosts.adoc

+
+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 OS.
+
+The distinction between package mode and image mode provides greater flexibility in managing hosts and streamlines operations for image-based deployments.


Line 11 doesn't seem useful to me. Looks like fluff.

Lennonka · 2025-02-03T16:35:09Z

guides/common/modules/con_package-mode-and-image-mode-hosts.adoc

+
+{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].


Move to "Additional resources" at the bottom.

Lennonka · 2025-02-03T16:35:43Z

guides/common/modules/con_package-mode-and-image-mode-hosts.adoc

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


Aren't these things described in the web UI?

Lennonka · 2025-02-03T16:37:07Z

guides/doc-Managing_Hosts/master.adoc

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


I think it's quite important and I'd include it in common/assembly_overview-of-hosts.adoc

Lennonka · 2025-02-03T16:38:50Z

guides/common/modules/con_package-mode-and-image-mode-hosts.adoc

+
+You can operate hosts in two modes: package mode and image mode.
+
+{Project} identifies an image mode host as any system that reports a container image from its bootc status through `subscription-manager`. 


Suggested change

{Project} identifies an image mode host as any system that reports a container image from its bootc status through `subscription-manager`.

{Project} identifies an image mode host as any system that reports a container image from its bootc status through Subscription Manager.

SM is an established term.

Lennonka · 2025-02-03T17:12:39Z

I'm still missing one more bit of information: What can the user do on hosts in Package mode that they cannot do on hosts in Image mode?

My guess: manage packages (as described in the chapter Managing packages)

Lennonka · 2025-02-03T17:15:12Z

Did you know you could display a column in the New UI of All Hosts page with a mode indicator?
It looks like something the user might be interested in and the column is disabled by default. Perhaps we should give them a hint that they can do that?

pr-processor bot added the Not yet reviewed label Jan 23, 2025

ianballou changed the title ~~Add concept for Package and Imahe Mode Hosts~~ Add concept for Package and Image Mode Hosts Jan 24, 2025

ianballou reviewed Jan 24, 2025

View reviewed changes

guides/common/modules/con_understanding-package-mode-and-image-mode-hosts.adoc Outdated Show resolved Hide resolved

guides/common/modules/con_understanding-package-mode-and-image-mode-hosts.adoc Outdated Show resolved Hide resolved

pr-processor bot removed the Not yet reviewed label Jan 24, 2025

ianballou reviewed Jan 24, 2025

View reviewed changes

guides/common/modules/con_understanding-package-mode-and-image-mode-hosts.adoc Outdated Show resolved Hide resolved

maximiliankolb reviewed Jan 27, 2025

View reviewed changes

bangelic force-pushed the bangelic-SAT-28164-Add-section-to-managing-hosts-guide-about-image-mode-hosts branch from f9ca843 to ded44c2 Compare January 29, 2025 21:46

maximiliankolb reviewed Jan 30, 2025

View reviewed changes

guides/doc-Managing_Hosts/master.adoc Show resolved Hide resolved

guides/common/modules/con_understanding-package-mode-and-image-mode-hosts.adoc Outdated Show resolved Hide resolved

guides/common/modules/con_understanding-package-mode-and-image-mode-hosts.adoc Outdated Show resolved Hide resolved

Lennonka requested changes Jan 30, 2025

View reviewed changes

pr-processor bot added the Waiting on contributor Requires an action from the author label Jan 30, 2025

Lennonka marked this pull request as draft January 31, 2025 06:13

bangelic added 3 commits January 31, 2025 14:39

Add concept for Package and Imahe Mode Hosts

d2fb990

Remove endif and minor edits

1c50102

Create assembly, add what image mode does, other suggested changes

b1901a6

bangelic force-pushed the bangelic-SAT-28164-Add-section-to-managing-hosts-guide-about-image-mode-hosts branch from ded44c2 to b1901a6 Compare January 31, 2025 19:39

pr-processor bot added Needs re-review and removed Waiting on contributor Requires an action from the author labels Jan 31, 2025

bangelic mentioned this pull request Jan 31, 2025

Add procedure for managing image mode hosts #3612

Open

9 tasks

Lennonka reviewed Feb 3, 2025

View reviewed changes

pr-processor bot removed the Needs re-review label Feb 3, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add concept for Package and Image Mode Hosts #3611

Add concept for Package and Image Mode Hosts #3611

bangelic commented Jan 23, 2025

bangelic commented Jan 23, 2025

github-actions bot commented Jan 23, 2025 •

edited

Loading

ianballou left a comment

Lennonka left a comment

Lennonka Jan 30, 2025

Lennonka left a comment

Lennonka Feb 3, 2025

Lennonka Feb 3, 2025

Lennonka Feb 3, 2025

Lennonka Feb 3, 2025

Lennonka Feb 3, 2025

Lennonka Feb 3, 2025

Lennonka Feb 3, 2025

Lennonka Feb 3, 2025 •

edited

Loading

Lennonka Feb 3, 2025

Lennonka Feb 3, 2025

Lennonka Feb 3, 2025

Lennonka Feb 3, 2025

Lennonka commented Feb 3, 2025 •

edited

Loading

Lennonka commented Feb 3, 2025 •

edited

Loading


		The distinction between package mode and image mode provides greater flexibility in managing hosts and streamlines operations for image-based deployments.

		{Project} enables registration, monitoring, and update support for image mode hosts.

	{Project} enables registration, monitoring, and update support for image mode hosts.
	In {Project}, you can register, monitor, and update image 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 OS.
	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.

		@@ -0,0 +1,25 @@
		[id="package-mode-and-image-mode-hosts_{context}"]
		= Package mode and image mode hosts

	You can operate hosts in two modes: package mode and image mode.
	You can operate hosts in two modes: package mode and image mode.

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

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

Add concept for Package and Image Mode Hosts #3611

Are you sure you want to change the base?

Add concept for Package and Image Mode Hosts #3611

Conversation

bangelic commented Jan 23, 2025

What changes are you introducing?

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

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

Checklists

bangelic commented Jan 23, 2025

github-actions bot commented Jan 23, 2025 • edited Loading

ianballou left a comment

Choose a reason for hiding this comment

Lennonka left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Lennonka left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Lennonka Feb 3, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Lennonka commented Feb 3, 2025 • edited Loading

Lennonka commented Feb 3, 2025 • edited Loading

github-actions bot commented Jan 23, 2025 •

edited

Loading

Lennonka Feb 3, 2025 •

edited

Loading

Lennonka commented Feb 3, 2025 •

edited

Loading

Lennonka commented Feb 3, 2025 •

edited

Loading