Skip to content

Update foreman-maintain health for foremanctl#4843

Merged
aneta-petrova merged 14 commits into
theforeman:masterfrom
aneta-petrova:foremanctl-health
Jun 12, 2026
Merged

Update foreman-maintain health for foremanctl#4843
aneta-petrova merged 14 commits into
theforeman:masterfrom
aneta-petrova:foremanctl-health

Conversation

@aneta-petrova

@aneta-petrova aneta-petrova commented May 13, 2026

Copy link
Copy Markdown
Member

What changes are you introducing?

Changing references to foreman-maintain health to foremanctl health.

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

To support the transition to containerized Foreman.

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

This PR only updates the commands. It does not publish the changes to docs.theforeman.org because I'm only verifying the new commands work, not the procedures as a whole.

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 3.19/Katello 4.21
  • Foreman 3.18/Katello 4.20 (Satellite 6.19)
  • 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)
  • Foreman 3.13/Katello 4.15 (EL9 only)
  • Foreman 3.12/Katello 4.14 (Satellite 6.16; orcharhino 7.2 on EL9 only; orcharhino 7.3)
  • We do not accept PRs for Foreman older than 3.12.

@github-actions 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 May 13, 2026
@aneta-petrova aneta-petrova removed 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 May 13, 2026
@github-actions

github-actions Bot commented May 13, 2026

Copy link
Copy Markdown

The PR preview for 24dd254 is available at theforeman-foreman-documentation-preview-pr-4843.surge.sh

No diff compared to the current base

show diff

@aneta-petrova aneta-petrova marked this pull request as ready for review May 14, 2026 06:36
@aneta-petrova

Copy link
Copy Markdown
Member Author

@jafiala Can you please take a look here? This is my first foremanctl PR that updates a foreman-maintain command to its foremanctl equivalent.

This involves introducing a foremanctl-maintain attribute (which has the same value as foremanctl-installer, I think those can be merged after we change the foremanctl build target attribute) and updating the individual occurrences of the commands.

It does not involve exposing the affected guides' foremanctl variants in the list of containerized guides in https://docs.theforeman.org/release/nightly/ because this particular command is spread over multiple procedures and verifying those procedures (and assemblies) as a whole is out of scope (that should come later, as we actually review the whole guides and expose them).

Does this make sense to you?

@aneta-petrova aneta-petrova added Needs tech review Requires a review from the technical perspective Needs style review Requires a review from docs style/grammar perspective labels May 14, 2026

@maximiliankolb maximiliankolb left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

diff LGTM

@aneta-petrova aneta-petrova 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 May 18, 2026
Comment thread guides/common/modules/con_considerations-for-performance-tuning.adoc Outdated
Comment thread guides/common/modules/proc_retrieving-status-of-services-by-using-cli.adoc Outdated
Comment thread guides/common/attributes-base.adoc Outdated
Comment thread guides/common/modules/proc_troubleshooting-permission-issues.adoc Outdated
Comment thread guides/common/modules/proc_troubleshooting-permission-issues.adoc Outdated
Comment thread guides/common/modules/proc_troubleshooting-permission-issues.adoc
@pr-processor pr-processor Bot added the Waiting on contributor Requires an action from the author label May 29, 2026
@pr-processor pr-processor Bot added Needs re-review and removed Waiting on contributor Requires an action from the author Needs re-review labels Jun 1, 2026
@aneta-petrova

Copy link
Copy Markdown
Member Author

With the latest commit, I also exposed proc_troubleshooting-permission-issues.adoc in the Upgrading guide. Because all steps in that procedure are being updated for foremanctl, I think that's safe enough to do already. Doing so will ensure the procedure will show up in https://docs.theforeman.org/nightly/Upgrading_Project/index-containerized-katello.html, which is accessible from https://docs.theforeman.org/release/nightly/

@aneta-petrova

Copy link
Copy Markdown
Member Author

Hi @qcjames53, I think I applied all your feedback. Can you please re-review?

@aneta-petrova aneta-petrova requested a review from qcjames53 June 1, 2026 17:50

@qcjames53 qcjames53 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I'm sorry about the big delay for re-reviewing this. I'm confident we're finally at a place where there won't be any more param changes on theforeman/foremanctl#521. Sorry to keep changing things; it has been a very involved review process. This will need one more round of fixes and I think we'll be good.

Comment thread guides/common/modules/proc_troubleshooting-permission-issues.adoc
Comment thread guides/common/modules/proc_troubleshooting-permission-issues.adoc Outdated
@aneta-petrova

Copy link
Copy Markdown
Member Author

I moved some feedback to #4928, and applied the feedback for the changes that remained here. @qcjames53 can you please re-review?

@aneta-petrova aneta-petrova requested a review from qcjames53 June 11, 2026 17:10
@qcjames53

Copy link
Copy Markdown
Contributor

Absolutely! We surprise merged theforeman/foremanctl#521 today so there will be no more changes 🥳🥳🥳

@qcjames53 qcjames53 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hi Aneta. All the changed files look good to me! Thank you for raising #4928 and for changing shells to use $. Super happy with these changes :)

@aneta-petrova aneta-petrova force-pushed the foremanctl-health branch 2 times, most recently from 558be24 to 5267ac9 Compare June 12, 2026 08:28
@aneta-petrova 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 Jun 12, 2026
@aneta-petrova

Copy link
Copy Markdown
Member Author

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

This PR only updates the commands. It does not publish the changes to docs.theforeman.org because I'm only verifying the new commands work, not the procedures as a whole.

The requirement has changed and this PR should now also expose and publish the affected pieces of docs. I'll add some conditionals to make that happen and that will need a new style review.

@aneta-petrova

Copy link
Copy Markdown
Member Author

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

This PR only updates the commands. It does not publish the changes to docs.theforeman.org because I'm only verifying the new commands work, not the procedures as a whole.

The requirement has changed and this PR should now also expose and publish the affected pieces of docs. I'll add some conditionals to make that happen and that will need a new style review.

After seeing the preview and the conditionals needed to make this happen, there has been a decision to change the scope again and we'll stick to just updating the commands. Exposing the documentation will come later.

@aneta-petrova

Copy link
Copy Markdown
Member Author

The PR is now back to the state where it has received the acks. #4928 will finish the foremanctl health --fix cleanup by removing the module, this PR only hides it from containerized builds.

@aneta-petrova aneta-petrova merged commit 4cc66d2 into theforeman:master Jun 12, 2026
12 checks passed
@aneta-petrova aneta-petrova deleted the foremanctl-health branch June 12, 2026 09:38
aneta-petrova added a commit that referenced this pull request Jun 12, 2026
@aneta-petrova

Copy link
Copy Markdown
Member Author

Merged to "master" and cherry-picked:

4f238cc..c46809c 3.19 -> 3.19

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

style review done No issues from docs style/grammar perspective tech review done No issues from the technical perspective

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants