-
Notifications
You must be signed in to change notification settings - Fork 106
Add section "Boot loader management and file structure" #4422
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.
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
base: master
Are you sure you want to change the base?
Add section "Boot loader management and file structure" #4422
Conversation
|
The PR preview for 162b582 is available at theforeman-foreman-documentation-preview-pr-4422.surge.sh The following output files are affected by this PR: |
21f4436 to
d7f1022
Compare
|
@jloeser I've seen you recently investigate and write down some great research into how things work (like https://community.theforeman.org/t/grub2-network-boot-tftp-http-https-for-legacy-bios-uefi/44755). I'd appreciate if you could take a look at the content. To the writers: would this be better suited for an appendix, or is it too long for that? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you, Yusuke, for your contribution!
This will take a decent amount of fine tuning, so brace yourself.
Let's start with moving the new assembly into an appendix and I'll get back to you with a more detailed review later.
@ekohl Should this replace the PXE loader reference?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I think it will be better as an appendix in doc-Provisioning_Hosts/master.adoc. It's no big deal that it's long.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @Lennonka,
I’ve updated the PR as discussed — the new assembly has been moved to the appendix section under
doc-Provisioning_Hosts/master.adoc.
Thanks again for your helpful feedback!
Please take another look when you have a moment.
|
cc @jafiala |
d7f1022 to
7c7a74f
Compare
When users install Foreman and Smart Proxy using foreman-installer, PXE bootloader binaries are automatically deployed under /var/lib/tftpboot/. However, users who handle non-x86 architectures (for example, Arm or PowerPC), or who install these components manually, often find the following points unclear: - Which bootloader binaries should be placed under which directories - How the bootloader-universe/ structure should be organized - How these files correspond to architectures and operating systems defined in the Foreman Web UI This commit adds a new appendix section titled "Boot loader management and file structure" to the Provisioning Hosts guide. The appendix explains: 1. The structure and purpose of /var/lib/tftpboot/ and bootloader-universe/ 2. Where to place PXE bootloader binaries for GRUB2, PXELinux, and iPXE 3. How symbolic links are automatically created for each host at build time This documentation helps users correctly prepare and manage PXE bootloader files for both x86 and non-x86 environments. Co-Authored-By: Vanou Ishii <[email protected]>
7c7a74f to
162b582
Compare
What changes are you introducing?
This PR adds a new section “8.3. Bootloader Binary Location” to the Provisioning Hosts guide:
https://docs.theforeman.org/3.16/Provisioning_Hosts/index-foreman-el.html#using-network-boot-to-provision-hosts
This section explains how PXE bootloader binaries are managed and where they should be placed when setting up network-based provisioning environments.
The section includes:
/var/lib/tftpboot/andbootloader-universe/directory structures/var/lib/tftpboot/boot/or/var/lib/tftpboot/host-config/Why are you introducing these changes? (Explanation, links to references, issues, etc.)
When users install Foreman and Smart Proxy using
foreman-installer, PXE bootloader binaries are automatically deployed under/var/lib/tftpboot/.However, users who handle non-x86 architectures (for example, Arm or PowerPC), or who install these components manually, often find the following points unclear:
bootloader-universe/structure should be organizedThis update clarifies these points and provides concrete examples of directory layout and file placement.
It helps users correctly prepare and manage PXE bootloader binaries across different architectures and provisioning setups.
Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)
It improves clarity and usability for users who manually configure PXE, iPXE, or HTTPBoot provisioning environments, including non-x86 systems.
Contributor checklists
Please cherry-pick my commits into:
Any feedback or suggestions for improvement are very welcome.
Thank you.