Skip to content

Conversation

@aneta-petrova
Copy link
Member

What changes are you introducing?

Changing references to foremanctl from "installer" to "deployment tool/utility".

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

In foremanctl, the existing foreman-installer and foreman-maintain tools will merge into one "deployment tool". Changing the wording we use to refer to the tool seems appropriate.

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 3.16/Katello 4.18 (Satellite 6.18)
  • Foreman 3.15/Katello 4.17
  • Foreman 3.14/Katello 4.16 (Satellite 6.17; orcharhino 7.4)
  • 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)
  • Foreman 3.11/Katello 4.13 (orcharhino 6.11 on EL8 only; orcharhino 7.0 on EL8+EL9; orcharhino 7.1 with Leapp)
  • Foreman 3.10/Katello 4.12
  • Foreman 3.9/Katello 4.11 (Satellite 6.15; orcharhino 6.8/6.9/6.10)
  • We do not accept PRs for Foreman older than 3.9.

@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 Oct 27, 2025
@aneta-petrova aneta-petrova removed the Needs testing Requires functional testing label Oct 27, 2025
@aneta-petrova aneta-petrova force-pushed the foremanctl-deployment-tool branch from 348673a to ddb4f08 Compare October 27, 2025 15:09
@github-actions
Copy link

github-actions bot commented Oct 27, 2025

Copy link
Member

@ekohl ekohl left a comment

Choose a reason for hiding this comment

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

Thanks for picking up on this.

Copy link
Member

@ekohl ekohl left a comment

Choose a reason for hiding this comment

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

@evgeni and or @ehelms can probably tell you that I'm wrong in my suggestion ;)

@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 Oct 27, 2025
The full installation guide is currently provided only for the Puppet-based installation.

:FeatureName: The `foremanctl` installer
:FeatureName: The `foremanctl` deployment tool
Copy link
Member

Choose a reason for hiding this comment

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

In the other file you call it "utility", not "tool", while both refer to the same thing, I guess it's easier if the same word is used?

ACK either way.

Copy link
Member

Choose a reason for hiding this comment

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

We should add a description in the About section of https://github.com/theforeman/foremanctl that we can reuse here. For now it can only deploy, but we've also been talking about merging foreman-maintain functionality into it so we may need to revisit this if/when we do.

Copy link
Member Author

Choose a reason for hiding this comment

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

I took a look at the About section but I don't think I can help with that because I don't have permissions in that repo. So for now, I'm going to go ahead with merging this PR and if the description there turns out to be significantly different from what we have in the Quickstart guide, we can sync them later.

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.

Please, can we pick one of those words (tool/utility) and use it consistently?

@pr-processor pr-processor bot added the Waiting on contributor Requires an action from the author label Oct 29, 2025
@pr-processor pr-processor bot added Needs re-review and removed Waiting on contributor Requires an action from the author labels Oct 29, 2025
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.

Thank you!

@Lennonka 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 Oct 29, 2025
@aneta-petrova aneta-petrova merged commit da5bb6f into theforeman:master Oct 29, 2025
10 checks passed
aneta-petrova added a commit that referenced this pull request Oct 29, 2025
@aneta-petrova
Copy link
Member Author

Merged to "master" and cherry-picked:

516f95d..5be804a 3.16 -> 3.16

@aneta-petrova aneta-petrova deleted the foremanctl-deployment-tool branch October 29, 2025 08: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.

5 participants