Skip to content

Conversation

@maximiliankolb
Copy link
Contributor

What changes are you introducing?

  • Show "Enabling REX" for foreman-el and foreman-deb builds (for Katello-like builds, it's enabled by default on Foreman Server)
  • Show "Enabling REX Pull provider" for all Katello-like builds
  • Add prerequisite that you need to enabled REX on your Smart Proxy Server if you want to configure REX Pull Provider on it.

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

The third item is the result of a bug report.

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

Needs TECH ACK on the following assumptions which I could non conclusively verify in code:

  • Satellite Server and Capsule Servers always have REX enabled
  • orcharhino Server has REX enabled by default
  • orcharhino Proxy Server does not have REX enabled by default
  • Foreman+Katello Server has REX enabled by default
  • Foreman+Katello Smart Proxy Servers do not have REX enabled by default (due to line 7)
  • REX Pull Provider is for Katello-like builds only (due to line 11)

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.17/Katello 4.19
  • Foreman 3.16/Katello 4.18 (Satellite 6.18; orcharhino 7.6)
  • 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 Jan 2, 2026
@maximiliankolb maximiliankolb changed the title Show REX Pull Provider notes and prerequisite Add prerequisite to REX Pull Provider Jan 2, 2026
@github-actions
Copy link

github-actions bot commented Jan 2, 2026

The PR preview for 2dd5ac0 is available at theforeman-foreman-documentation-preview-pr-4559.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

For more information, see {InstallingServerDocURL}enabling-remote-execution[Enabling remote execution in _{InstallingServerDocTitle}_].
endif::[]
ifeval::["{ProductName}" == "{SmartProxyServer}"]
For more information, see {InstallingSmartProxyDocURL}enabling-remote-execution[Enabling remote execution in _{InstallingSmartProxyDocTitle}_].
Copy link
Member

Choose a reason for hiding this comment

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

This looks like it could also be an xref to the module rather than a link.

.Prerequisites
* Ensure that you have enabled remote execution on your {ProductName}.
ifeval::["{ProductName}" == "{ProjectServer}"]
For more information, see {InstallingServerDocURL}enabling-remote-execution[Enabling remote execution in _{InstallingServerDocTitle}_].
Copy link
Member

Choose a reason for hiding this comment

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

You're adding the module to the server installation guide's master.adoc only for foreman-el and foreman-deb, but you're adding this prerequisite for everything except satellite. This results in a broken link in the katello and orcharhino builds.

Copy link
Member

Choose a reason for hiding this comment

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

Similar to the one below, this should perhaps be an xref.

@lhellebr
Copy link
Contributor

lhellebr commented Jan 5, 2026

Satellite Server and Capsule Servers always have REX enabled

They do by default. It's possible to disable it.

@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 Jan 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Needs tech review Requires a review from the technical perspective Needs testing Requires functional testing style review done No issues from docs style/grammar perspective

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants