Skip to content

Conversation

@jafiala
Copy link
Contributor

@jafiala jafiala commented Nov 28, 2025

What changes are you introducing?

Further adjust newly added files for downstream docs

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

Conclusion of #4422

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

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

Summary by Sourcery

Update bootloader reference documentation for HTTP and shared TFTP/HTTP usage and remove obsolete iPXE-specific module.

Documentation:

  • Add new reference modules documenting HTTP bootloaders and shared TFTP/HTTP root configuration.
  • Adjust bootloader binary location assembly to use the new reference modules and drop the deprecated iPXE bootloaders reference.

@sourcery-ai
Copy link

sourcery-ai bot commented Nov 28, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Reorganizes and consolidates boot loader reference documentation by replacing the ipxe-specific reference module with more generic HTTP and shared TFTP/HTTP root reference modules and wiring them into the main bootloader binary location assembly.

File-Level Changes

Change Details Files
Update bootloader binary location assembly to reference new shared modules instead of the removed iPXE-specific one.
  • Adjust includes or cross-references in the bootloader binary location assembly to use the new HTTP bootloader and shared TFTP/HTTP root reference modules
  • Remove references to the deprecated ipxe bootloader reference module within the assembly
guides/common/assembly_bootloader-binary-location.adoc
Introduce reusable reference content for HTTP bootloaders.
  • Create a new reference module describing HTTP bootloader locations and usage
  • Structure the content so it can be included from multiple downstream docs
guides/common/modules/ref_http-bootloaders.adoc
Introduce reusable reference content for the shared TFTP/HTTP root.
  • Create a new reference module explaining the shared TFTP/HTTP root structure and paths
  • Ensure headings/ids align with existing docs conventions for downstream reuse
guides/common/modules/ref_shared-tftp-http-root.adoc
Remove the old iPXE-specific bootloader reference module in favor of the new, more generic modules.
  • Delete the ipxe bootloaders reference module file
  • Migrate its relevant information into the new HTTP and shared TFTP/HTTP root modules where applicable
guides/common/modules/ref_ipxe-bootloaders.adoc

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@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 Nov 28, 2025
@github-actions
Copy link

github-actions bot commented Nov 28, 2025

@jafiala jafiala removed the Needs testing Requires functional testing label Jan 12, 2026
@jafiala jafiala marked this pull request as ready for review January 12, 2026 15:46
@pr-processor pr-processor bot added the Waiting on contributor Requires an action from the author label Jan 12, 2026
@jafiala
Copy link
Contributor Author

jafiala commented Jan 12, 2026

Ready for review. I see the conflict, but it doesn't show in the web editor, and I don't see it on my command line either. Not sure why it's a conflict either, I renamed the ref_ipxe-bootloaders.adoc file to ref_http-bootloaders.adoc.

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.

Left you a couple of suggestions.

@pr-processor pr-processor bot added Needs re-review and removed Waiting on contributor Requires an action from the author labels Jan 13, 2026
maximiliankolb and others added 28 commits January 21, 2026 10:16
This patch also drops "Optional:" to avoid telling users that security
is optional.
Users should never clone and edit templates. Instead, if they really
need to run custom code before or after registration or provisioning
workflows, they should use "custom pre" and "custom post" snippets as
documented. This way they do not lose support by the community/vendor.

Also, there's configuration management.

Fixes theforeman#4256
This patch drops the procedure to add KernelCare clients for EL and
instead moves all necessary information for EL and Deb to tables.

Add KernelCare Clients for EL10

Refs 29eda6f
This patch introduces attributes for the major and minor version of
SLES. It also bumps the version to SLES 16.0.

SLES 16 does not use Service Packs anymore to indicate minor releases:

$ podman run --rm -it registry.suse.com/bci/bci-base:16.0 cat /etc/os-release | rg "^VERSION=|^VERSION_ID=|^PRETTY_NAME=" | sort -u
PRETTY_NAME="SUSE Linux Enterprise Server 16.0"
VERSION="16.0"
VERSION_ID="16.0"
$ podman run --rm -it registry.suse.com/bci/bci-base:15.7 cat /etc/os-release | rg "^VERSION=|^VERSION_ID=|^PRETTY_NAME=" | sort -u
PRETTY_NAME="SUSE Linux Enterprise Server 15 SP7"
VERSION="15-SP7"
VERSION_ID="15.7"
* Show enabling REX Pull Provider for Katello-like builds

Foreman+Katello and Katello-like builds have REX on Foreman Server
enabled by default.

* Show REX on Smart Proxy Servers for orcharhino builds

* Require REX to enable REX Pull Provider

On Satellite, REX is always enabled on Foreman Server and Smart Proxy
Servers by default.

* fixup! Require REX to enable REX Pull Provider
* Fix broken xrefs
* Fix titles
* Hide links for orcharhino builds
* Hide xrefs for orcharhino builds
* Remove broken xrefs
Reproducer to verify that there are no new broken links:

$ rg -i "Creating_a_Custom_File_Type_Repository_"
$ rg -i "Creating_a_Local_Source_for_a_Custom_File_Type_Repository_"
$ rg -i "Creating_a_Remote_Source_for_a_Custom_File_Type_Repository_"
$ rg -i "Downloading_Files_to_a_Host_from_a_Custom_File_Type_Repository_"
$ rg -i "Managing_Custom_File_Type_Content_"
$ rg -i "Uploading_Files_To_a_Custom_File_Type_Repository_"
$ rg -i "cli-creating-a-custom-file-type-repository_"
* Split helper app modules

* Add abstracts

* Minor fixes

* Ensure continuous procedure steps to avoid error

Snippets with steps sometimes cause asciidoctor-dita-vale to think the
procedure is not a continuous series of steps.

* Fix capitalization to address Vale error

---------

Co-authored-by: Maximilian Kolb <[email protected]>
Reproducer to verify that there are no new broken links:

$ rg -i "Downloading_Files_to_a_Host_from_a_Python_Type_Repository_"
$ rg -i "Installing_Python_Packages_from_"
$ rg -i "Managing_Python_Type_Content_"
$ rg -i "Synchronizing_Python_Repositories_"
$ rg -i "Uploading_Files_To_a_Python_Type_Repository_"
* Show RHUI ACS for orcharhino builds
* Hide bootstrap.py for orcharhino builds
* Move appendix to introduction for orcharhino builds
* Fix attributes for discovery for orcharhino builds
* Show discovery via Smart Proxy Servers for orcharhino builds
  If you have multiple Smart Proxy Servers and want to perform boot
  disk-based host provisioning, you need to apply this workaround.
* Show latest two Deb major versions
  In upstream docs, show the last two Debian and Ubuntu releases.
* Only show module once for orcharhino builds
  In downstream orcharhino builds, the module is included only once but
  adjusted by Client OS-specific attributes.
Update IPA Kerberos auth source for foremanctl

Update AD external auth source for foremanctl

Update procedure on resetting external auth

Move reset to its own module

Update ext auth reset with additional details

Drop equal signs

Define project-package-install for foremanctl

Clarify auth sources affected by auth config reset

Update PAM service option

Add ext auth overview to foremanctl Configuring User Auth

Clarify that auth source are mutually exclusive

Add verification step for resetting Kerberos SSO

Apply suggestions from style review

Co-authored-by: Maximilian Kolb <[email protected]>

Call out a f-ctl prereq explicitly

Ensure standalone Hammer scenario is covered

Drop an internal comment about why a prereq is here

Reference --add-feature hammer

Apply easy fixes from style review

Co-authored-by: Lena Ansorgová <[email protected]>
Co-authored-by: Maximilian Kolb <[email protected]>

Move stdout outside of a command block
@jafiala
Copy link
Contributor Author

jafiala commented Jan 21, 2026

Closing due to conflicts that persist even after rebase. Opened #4604 with the same changes on a clean slate. Apologies for the inconvenience.

@jafiala jafiala closed this Jan 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Needs style review Requires a review 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.