Skip to content

Initial content for the foremanctl installer guide #4087

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

Jump to bottom
Draft
wants to merge 7 commits into
base: master
Choose a base branch
from
Draft

Initial content for the foremanctl installer guide #4087

wants to merge 7 commits into from

Conversation

aneta-petrova
Copy link
Member

What changes are you introducing?

Populating the foremanctl installation guide with initial content.

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

https://github.com/theforeman/foremanctl

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

I'm opening this as a draft because I want to use this PR as a continuous preview for now while I work on some related changes in separate PRs.

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.15/Katello 4.17
  • Foreman 3.14/Katello 4.16 (Satellite 6.17)
  • 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.

Review checklists

Tech review (performed by an Engineer who did not author the PR; can be skipped if tech review is unnecessary):

  • The PR documents a recommended, user-friendly path.
  • The PR removes steps that have been made unnecessary or obsolete.
  • Any steps introduced or updated in the PR have been tested to confirm that they lead to the documented end result.

Style review (by a Technical Writer who did not author the PR):

  • The PR conforms with the team's style guidelines.
  • The PR introduces documentation that describes a user story rather than a product feature.

@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 Jul 30, 2025
@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 Jul 30, 2025
@github-actions GitHub Actions
Copy link

github-actions bot commented Jul 30, 2025 •
edited
Loading

The PR preview for 138f770 is available at theforeman-foreman-documentation-preview-pr-4087.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

@aneta-petrova aneta-petrova changed the title Initial commit for the foremanctl installer guide Initial content for the foremanctl installer guide Jul 30, 2025
@aneta-petrova aneta-petrova force-pushed the installing-foremanctl branch from c6b7e27 to 498a011 Compare July 31, 2025 10:45
@aneta-petrova
Copy link
Member Author

aneta-petrova commented Aug 27, 2025 •
edited
Loading

https://github.com/theforeman/foreman-documentation/pull/4070/files#r2303927111 notes that when it comes to system prereqs, only the apache user is relevant for a containerized installation.

EDIT: Implemented.

@aneta-petrova aneta-petrova mentioned this pull request Aug 27, 2025
Merged
14 tasks
@aneta-petrova aneta-petrova force-pushed the installing-foremanctl branch 2 times, most recently from 5e5dba8 to c91278f Compare August 29, 2025 07:49
This was referenced Sep 4, 2025
Merged
Merged
ekohl
ekohl reviewed Sep 25, 2025
View reviewed changes
guides/common/modules/ref_system-requirements.adoc
* If you use an external identity provider in your deployment, ensure the provider did not create the following user accounts on the system.
These user accounts can cause conflicts with the local users that {ProductName} creates:
** {apache-user}
** `{apache-user}`
Copy link
Member

Choose a reason for hiding this comment

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

Apache is not containerized so I'd expect the same problem here. Right now that would be the only exception.

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 think that should be covered by lines 81-84.

@aneta-petrova
Copy link
Member Author

Based on https://github.com/theforeman/foreman-documentation/pull/4305/files#r2378985208, the containerized installation works on EPEL-enabled systems.

@maximiliankolb
Copy link
Contributor

Based on https://github.com/theforeman/foreman-documentation/pull/4305/files#r2378985208, the containerized installation works on EPEL-enabled systems.

Just to clarify: because the VM can use EPEL because it does not affect running containers; not because your containers consume content from EPEL?

@evgeni
Copy link
Member

evgeni commented Sep 29, 2025

Based on https://github.com/theforeman/foreman-documentation/pull/4305/files#r2378985208, the containerized installation works on EPEL-enabled systems.

Just to clarify: because the VM can use EPEL because it does not affect running containers; not because your containers consume content from EPEL?

Correct.

We forbid EPEL for normal Foreman deployments, as RPMs from there clash with what we ship in our repos (version wise).
As we move to containers, EPEL on the host won't affect the container content and is thus "allowed".

@aneta-petrova aneta-petrova force-pushed the installing-foremanctl branch from 50a8276 to 138f770 Compare October 7, 2025 18:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ekohl ekohl ekohl left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@aneta-petrova @maximiliankolb @evgeni @ekohl