Include RH subscription management in containerized by aneta-petrova · Pull Request #5314 · theforeman/foreman-documentation

aneta-petrova · 2026-09-14T07:08:07Z

What changes are you introducing?

Adding assembly on RH subscription management to containerized guides

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

To extend the containerized docs set

https://redhat.atlassian.net/browse/SAT-47721

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

N/A

Contributor 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 5.0/Katello 5.0
Foreman 3.19/Katello 4.21
Foreman 3.18/Katello 4.20 (Satellite 6.19; orcharhino 7.9 and 7.10)
Foreman 3.17/Katello 4.19
Foreman 3.16/Katello 4.18 (Satellite 6.18; orcharhino 7.6, 7.7, and 7.8)
Foreman 3.15/Katello 4.17
Foreman 3.14/Katello 4.16 (Satellite 6.17; orcharhino 7.4; orcharhino 7.5)
We do not accept PRs for Foreman older than 3.14.

github-actions · 2026-09-14T07:11:11Z

The PR preview for a734251 is available at theforeman-foreman-documentation-preview-pr-5314.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

Lennonka

LGTM style wise

aneta-petrova · 2026-09-22T14:38:29Z

-.Prerequisites
-* The `foreman_rh_cloud` plugin is enabled on {ProjectServer}.
-You can enable the plugin by running `{foreman-installer}`:
+.Procedure


Making sure the steps in the procedure render correctly for all builds was tricky. The result that I'm proposing is:

For Satellite builds, there is a single step procedure where the step is a number (1.) rather than a bullet point (*). This is because eventually, the second step in the procedure will also get containerized and the number (1.) will be correct. So this divergence from style guidelines is only temporary and the alternative would be to use a lot of conditionals to turn that 1. into * (IMO not worth it)

For containerized and non-containerized Katello builds, the procedure includes only the step for connected servers (because disconnected is not available in Katello builds).

The disconnected step is actually not shown in either build right now; but I'd like to keep it in the source because we expect for it to be added eventually/soon (after the containerized solution becomes available).

aneta-petrova · 2026-09-22T14:39:06Z

Hi @jeremylenz, can you please review this update?

jeremylenz

Checked 3 previews (index-satellite, index-katello, index-containerized-katello) and they all look correct. Tech ACK 👍

aneta-petrova · 2026-09-22T16:24:08Z

Thanks @jeremylenz! We'll also need a testing ack for this PR. Could you perhaps check whether the functionality described in the chapter is covered by automated tests for containerized deployments? Or feel free to use any other way to ensure this is tested based on your team's preference.

jeremylenz · 2026-09-22T17:26:39Z

 +
 [options="nowrap" subs="+quotes,verbatim,attributes"]
 ----
 # foreman-rake rh_cloud_inventory:report:generate


We will no longer recommend or allow generating inventory reports via foreman-rake. See theforeman/foremanctl#825

I think this will need to be replaced with API instructions, or ideally, a command added to Hammer that makes it easier.

This can be done via web UI, no?

actually, yes, web UI would be the most user-friendly!

This is the part that is currently excluded for containerized because the functionality is not available in containerized deployments. When I last inquired about this particular foreman-rake task, I found out that not even the web UI counterpart would work in containerized. Has that changed? If not, I believe we can leave this excluded for containerized guides.

@nofaralfasi After your PR merge, web UI download of the reports should work correctly, right?

I think it's past feature freeze, is that right? Will theforeman/foremanctl#825 make it into 5.0?

We can go past feature freeze for bugs. Depends how you look at it 😄

This is blocking basic functionality, so I view it more as a bug

Record keeping: theforeman/foremanctl#825 was closed in favor of theforeman/foreman_rh_cloud#1262. That has been merged so I'll try to make progress with this docs PR now.

aneta-petrova · 2026-10-05T12:52:32Z

Hi @jeremylenz, now that theforeman/foreman_rh_cloud#1262 has been merged, is it a good time for a final re-review of this documentation update?

I'd like to know if the contents of 2. Managing Red Hat subscriptions are ready to be included in containerized deployments. Specifically the section 2.1. Tracking subscription usage by using the Subscriptions service deserves the most attention -- that's the one affected by theforeman/foreman_rh_cloud#1262. Does it capture the current state correctly?

Also, the documentation team is requesting explicit testing acks for including existing documentation in containerized deployments, see also #5314 (comment). Are the procedures included in 2. Managing Red Hat subscriptions covered by testing?

jeremylenz · 2026-10-05T20:54:15Z

I'd like to know if the contents of 2. Managing Red Hat subscriptions are ready to be included in containerized deployments. Specifically the section 2.1. Tracking subscription usage by using the Subscriptions service deserves the most attention -- that's the one affected by theforeman/foreman_rh_cloud#1262. Does it capture the current state correctly?

Two things to think about here -- (1) the current state of behavior; and (2) what we want to support and document.

(1) Currently, theforeman/foreman_rh_cloud#1262 is merged, but we have just this morning discovered another bug that breaks reporting. That bug will be fixed ASAP, but until then these instructions will not be in a testable state.

(2) Ideally in the containerized world, we will shift from recommending foreman-rake tasks to recommending report generation via web UI. Once the issues above are worked out, the "disconnected" way to generate the report should be as simple as clicking Generate in the UI. (Also note that in a disconnected setup, you will have to perform some additional steps after generating your report to make sure that the data gets to Red Hat.)

aneta-petrova · 2026-10-13T14:18:55Z

Two things to think about here -- (1) the current state of behavior; and (2) what we want to support and document.

Thanks a lot for the comments @jeremylenz. This is the last chapter to be included in the Managing Content guide, it will be a relief when we're done here! 🙃

(1) Currently, theforeman/foreman_rh_cloud#1262 is merged, but we have just this morning discovered another bug that breaks reporting. That bug will be fixed ASAP, but until then these instructions will not be in a testable state.

Do you have a link to the PR that fixes the bug?

(2) Ideally in the containerized world, we will shift from recommending foreman-rake tasks to recommending report generation via web UI. Once the issues above are worked out, the "disconnected" way to generate the report should be as simple as clicking Generate in the UI. (Also note that in a disconnected setup, you will have to perform some additional steps after generating your report to make sure that the data gets to Red Hat.)

Agreed, but when it comes to the 5.0 release (that's where we're cherry-picking this change), waiting for the bug fix in (1) should be enough, right?

jeremylenz · 2026-10-13T14:34:06Z

(Also note that in a disconnected setup, you will have to perform some additional steps after generating your report to make sure that the data gets to Red Hat.)

Agreed, but when it comes to the 5.0 release (that's where we're cherry-picking this change), waiting for the bug fix in (1) should be enough, right?

The additional steps I am referring to are basically Step 2-3 in this Red Hat doc: https://access.redhat.com/solutions/7133704

I think we meant to file an RFE to move that knowledge to the official docs, but it hasn't happened yet.

jeremylenz · 2026-10-13T14:36:09Z

Do you have a link to the PR that fixes the bug?

The bug is https://redhat.atlassian.net/browse/SAT-52095 and there is no fix yet. cc @vkrizan

aneta-petrova · 2026-10-13T14:39:15Z

Should I just go back to excluding section "2.1. Tracking subscription usage by using the Subscriptions service" from containerized completely, then? I'd really love to include whatever I can in the containerized docs. We can track "2.1. Tracking subscription usage by using the Subscriptions service" as a to-do item for the future. @jeremylenz

jeremylenz · 2026-10-13T14:43:29Z

@aneta-petrova That seems fine to me for now. 👍

Update tracking subscription usage to meet requirements on procedures Add a disclaimer about disconnected servers

This reverts commit f921087c069f5876cb2f8c542aab05c061f6deb1.

maximiliankolb

style-wise LGTM

aneta-petrova · 2026-10-14T12:03:19Z

Hi @jeremylenz, can you please re-review? With the latest set of changes, this PR adds chapter Managing Red Hat subscriptions but also excludes section Tracking subscription usage by using the Subscriptions service from that chapter in containerized builds.

Does the current set of changes make the Managing Red Hat subscriptions suitable to be published in the containerized docs?

EDIT: I also raised https://redhat.atlassian.net/browse/SAT-52316 to track the (future) addition of Tracking subscription usage by using the Subscriptions service.

jeremylenz

LGTM, thanks @aneta-petrova!

(cherry picked from commit 2ab27a1)

aneta-petrova · 2026-10-14T18:28:50Z

Merged to "master" and cherry-picked:

0e17e27..4fa1075 5.0 -> 5.0

Include RH subscriptions in containerized builds

0a798ce

pr-processor Bot added the Not yet reviewed label Sep 14, 2026

github-actions Bot added Needs tech review Requires a review from the technical perspective Needs style review Requires a review from docs style/grammar perspective Needs testing Requires functional testing labels Sep 14, 2026

Lennonka reviewed Sep 14, 2026

View reviewed changes

Comment thread guides/common/modules/con_managing-red-hat-subscriptions.adoc

pr-processor Bot removed the Not yet reviewed label Sep 14, 2026

Lennonka added Waiting on contributor Requires an action from the author and removed Waiting on contributor Requires an action from the author labels Sep 14, 2026

Lennonka approved these changes Sep 21, 2026

View reviewed changes

Lennonka added style review done No issues from docs style/grammar perspective and removed Needs style review Requires a review from docs style/grammar perspective labels Sep 21, 2026

aneta-petrova commented Sep 22, 2026

View reviewed changes

Exclude features not ready for containerization

00c8755

aneta-petrova force-pushed the foremanctl-subscriptions branch from 4983dd4 to 70e31d5 Compare September 22, 2026 14:40

jeremylenz approved these changes Sep 22, 2026

View reviewed changes

aneta-petrova added tech review done No issues from the technical perspective and removed Needs tech review Requires a review from the technical perspective labels Sep 22, 2026

jeremylenz suggested changes Sep 22, 2026

View reviewed changes

pr-processor Bot added the Waiting on contributor Requires an action from the author label Sep 22, 2026

jeremylenz mentioned this pull request Sep 22, 2026

Share RH Cloud inventory reports between Foreman and Dynflow with a named volume theforeman/foremanctl#825

Closed

aneta-petrova removed the Waiting on contributor Requires an action from the author label Oct 5, 2026

aneta-petrova added 2 commits October 14, 2026 13:50

Update Tracking subscription usage for containerization

64667af

Update tracking subscription usage to meet requirements on procedures Add a disclaimer about disconnected servers

Revert "Update Tracking subscription usage for containerization"

e38b88c

This reverts commit f921087c069f5876cb2f8c542aab05c061f6deb1.

aneta-petrova force-pushed the foremanctl-subscriptions branch from bc29ae1 to e38b88c Compare October 14, 2026 11:52

maximiliankolb approved these changes Oct 14, 2026

View reviewed changes

Drop a previous containerized edit

a734251

jeremylenz approved these changes Oct 14, 2026

View reviewed changes

aneta-petrova merged commit 2ab27a1 into theforeman:master Oct 14, 2026
11 of 12 checks passed

aneta-petrova deleted the foremanctl-subscriptions branch October 14, 2026 18:27

aneta-petrova added a commit that referenced this pull request Oct 14, 2026

Include RH subscription management in containerized (#5314)

4fa1075

(cherry picked from commit 2ab27a1)

Conversation

aneta-petrova commented Sep 14, 2026

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

Contributor checklists

Uh oh!

github-actions Bot commented Sep 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Lennonka left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aneta-petrova commented Sep 22, 2026

Uh oh!

jeremylenz left a comment

Choose a reason for hiding this comment

Uh oh!

aneta-petrova commented Sep 22, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aneta-petrova commented Oct 5, 2026

Uh oh!

jeremylenz commented Oct 5, 2026

Uh oh!

aneta-petrova commented Oct 13, 2026

Uh oh!

jeremylenz commented Oct 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jeremylenz commented Oct 13, 2026

Uh oh!

aneta-petrova commented Oct 13, 2026

Uh oh!

jeremylenz commented Oct 13, 2026

Uh oh!

maximiliankolb left a comment

Choose a reason for hiding this comment

Uh oh!

aneta-petrova commented Oct 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jeremylenz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

aneta-petrova commented Oct 14, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

github-actions Bot commented Sep 14, 2026 •

edited

Loading

jeremylenz commented Oct 13, 2026 •

edited

Loading

aneta-petrova commented Oct 14, 2026 •

edited

Loading