-
Notifications
You must be signed in to change notification settings - Fork 95
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
Create a new guide for installer-based provisioning (1 guide of 3) #3472
Open
Lennonka
wants to merge
28
commits into
theforeman:master
Choose a base branch
from
Lennonka:create-provisioning-netboot-guide-1of3
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 25 commits
Commits
Show all changes
28 commits
Select commit
Hold shift + click to select a range
c3b5984
Create a new guide for installer-based provisioning
Lennonka 7647ba7
fixup! Create a new guide for installer-based provisioning
Lennonka 0240a65
fixup! Create a new guide for installer-based provisioning
Lennonka 2aca670
fixup! Create a new guide for installer-based provisioning
Lennonka f0a683c
Rename the guide
Lennonka 9d2bece
Update IDs, xrefs, and links
Lennonka 2766f7c
Update context and guide attributes
Lennonka 8044280
Incorporate Secure Boot from #2145
Lennonka 76f6011
fixup! Rename the guide
Lennonka cb5a811
Incorporate smaller suggestions from review
Lennonka cc638fe
Move network boot info
Lennonka 73a99ce
Add concept for Secure Boot config
Lennonka 5bd81c7
Move iPXE
Lennonka 53a6f18
Hide prereqs for image-based provisioning
Lennonka 6709b54
Add Abstract
Lennonka 169943b
Move settings to a special chapter
Lennonka 8f75bd2
Remove 'Building cloud images' from this guide
Lennonka 2f54109
Move provisioning contexts to a special chapter
Lennonka 049dbc4
Fix title attribute in docinfo.xml
Lennonka 15ba29d
Incorporate suggestions from Max
Lennonka d6d8df0
Incorporate suggestions from Avital
Lennonka 3cf5402
fixup after rebase
Lennonka 0596f6b
Reword 'Configuring' to 'Preparing'
Lennonka 9566c0b
Change the title of the guide
Lennonka 7bb21f2
Rename two headings
Lennonka 80299e4
Fix link labels
Lennonka 3a0fd76
Refactor TFTP boot
Lennonka 5cb540b
fixup! Refactor TFTP boot
Lennonka File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
include::modules/con_preparing-client-platforms.adoc[] | ||
|
||
include::modules/proc_creating-operating-systems.adoc[leveloffset=+1] | ||
|
||
ifndef::satellite[] | ||
:parent-DL: {DL} | ||
|
||
:DL: Debian | ||
:DL-codename: bookworm | ||
:DL-major: 12 | ||
:DL-major-context: {DL-major} | ||
include::modules/proc_creating-an-operating-system-for-debian.adoc[leveloffset=+1] | ||
|
||
:DL: Debian | ||
:DL-codename: bullseye | ||
:DL-major: 11 | ||
:DL-major-context: {DL-major} | ||
include::modules/proc_creating-an-operating-system-for-debian.adoc[leveloffset=+1] | ||
|
||
:DL: Ubuntu | ||
:DL-codename: noble | ||
:DL-major: 24.04 | ||
:DL-major-context: 24-04 | ||
include::modules/proc_creating-an-operating-system-for-debian.adoc[leveloffset=+1] | ||
|
||
:DL: Ubuntu | ||
:DL-codename: jammy | ||
:DL-major: 22.04 | ||
:DL-major-context: 22-04 | ||
include::modules/proc_creating-an-operating-system-for-debian.adoc[leveloffset=+1] | ||
|
||
:!DL-codename: | ||
:!DL-major: | ||
:!DL-major-context: | ||
:DL: {parent-DL} | ||
:!parent-DL: | ||
endif::[] | ||
|
||
include::modules/proc_updating-the-details-of-multiple-operating-systems.adoc[leveloffset=+1] | ||
|
||
include::modules/proc_creating-architectures.adoc[leveloffset=+1] | ||
|
||
include::modules/proc_creating-hardware-models.adoc[leveloffset=+1] | ||
|
||
ifdef::provisioning-cloud,provisioning-virtual[] | ||
include::modules/proc_creating-compute-profiles.adoc[leveloffset=+1] | ||
|
||
include::modules/proc_using-novnc-to-access-virtual-machines.adoc[leveloffset=+1] | ||
endif::[] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
15 changes: 15 additions & 0 deletions
15
guides/common/assembly_preparing-provisioning-content.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
include::modules/con_preparing-provisioning-content.adoc[] | ||
|
||
include::modules/proc_preparing-a-synchronized-kickstart-repository.adoc[leveloffset=+1] | ||
|
||
include::modules/proc_configuring-project-to-provision-from-a-builder-image.adoc[leveloffset=+1] | ||
|
||
include::modules/proc_adding-installation-media.adoc[leveloffset=+1] | ||
|
||
ifndef::satellite[] | ||
include::modules/proc_creating-an-installation-medium-for-debian.adoc[leveloffset=+1] | ||
|
||
include::modules/proc_creating-an-installation-medium-for-ubuntu-22-04.adoc[leveloffset=+1] | ||
|
||
include::modules/proc_provisioning-ubuntu-autoinstall-through-smart-proxies.adoc[leveloffset=+1] | ||
endif::[] |
25 changes: 25 additions & 0 deletions
25
guides/common/assembly_preparing-templates-for-provisioning.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
include::modules/con_preparing-templates-for-provisioning.adoc[] | ||
|
||
include::modules/con_provisioning-templates.adoc[leveloffset=+1] | ||
|
||
include::modules/ref_kinds-of-provisioning-templates.adoc[leveloffset=+1] | ||
|
||
include::modules/proc_creating-provisioning-templates.adoc[leveloffset=+1] | ||
|
||
include::modules/proc_cloning-provisioning-templates.adoc[leveloffset=+1] | ||
|
||
include::modules/proc_creating-custom-provisioning-snippets.adoc[leveloffset=+1] | ||
|
||
ifndef::satellite[] | ||
include::modules/ref_custom-provisioning-snippet-example-for-debian.adoc[leveloffset=+1] | ||
endif::[] | ||
|
||
include::modules/ref_custom-provisioning-snippet-example-for-enterprise-linux.adoc[leveloffset=+1] | ||
|
||
include::modules/proc_associating-templates-with-operating-systems.adoc[leveloffset=+1] | ||
|
||
include::modules/proc_creating-partition-tables.adoc[leveloffset=+1] | ||
|
||
include::modules/proc_associating-partition-tables-with-disk-encryption.adoc[leveloffset=+1] | ||
|
||
include::modules/ref_dynamic_partition_example.adoc[leveloffset=+1] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
include::modules/con_security-settings.adoc[] | ||
|
||
include::modules/proc_configuring-the-security-token-validity-duration.adoc[leveloffset=+1] | ||
|
||
include::modules/proc_setting-a-default-encrypted-root-password.adoc[leveloffset=+1] | ||
|
||
ifdef::provisioning-cloud,provisioning-virtual[] | ||
include::modules/proc_removing-a-virtual-machine-upon-host-deletion.adoc[leveloffset=+1] | ||
endif::[] | ||
|
||
include::assembly_provisioning-fips-compliant-hosts.adoc[leveloffset=+1] |
13 changes: 13 additions & 0 deletions
13
guides/common/assembly_using-boot-disks-to-provision-hosts.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
:using-bootdisks-to-provision-hosts: | ||
:parent-context: {context} | ||
:context: using-bootdisks | ||
|
||
include::modules/con_using-boot-disks-to-provision-hosts.adoc[] | ||
|
||
include::modules/proc_creating-hosts-with-pxeless-provisioning.adoc[leveloffset=+1] | ||
|
||
include::modules/proc_deploying-ssh-keys-during-provisioning.adoc[leveloffset=+1] | ||
|
||
:context: {parent-context} | ||
:!parent-context: | ||
:!using-bootdisks-to-provision-hosts: |
119 changes: 119 additions & 0 deletions
119
guides/common/assembly_using-network-boot-to-provision-hosts.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,119 @@ | ||
:using-network-boot-to-provision-hosts: | ||
:parent-context: {context} | ||
:context: using-netboot | ||
|
||
include::modules/con_using-network-boot-to-provision-hosts.adoc[] | ||
|
||
include::modules/con_network-boot-provisioning-workflow.adoc[leveloffset=+1] | ||
|
||
include::modules/con_prerequisites-for-network-boot-provisioning.adoc[leveloffset=+1] | ||
|
||
include::modules/ref_required-boot-order-for-network-boot.adoc[leveloffset=+1] | ||
|
||
include::modules/con_configuring-smartproxy-for-secure-boot.adoc[leveloffset=+1] | ||
|
||
ifndef::satellite[] | ||
:extract_deb_prefix: cd /tmp && ar x /tmp | ||
:extract_deb_xz_suffix: && tar -xf data.tar.xz && cd - | ||
:extract_deb_zst_suffix: && tar --use-compress-program=unzstd -xf data.tar.zst && cd - | ||
:extract_rpm_prefix: rpm2cpio /tmp | ||
:extract_rpm_suffix: | cpio -idv --directory /tmp | ||
:parent-client-os: {client-os} | ||
:parent-client-pkg-ext: {client-pkg-ext} | ||
:secureboot-os-name: My_Operating_System_In_Lowercase | ||
|
||
:client-os-context: almalinux | ||
:client-os: AlmaLinux | ||
:client-pkg-ext: rpm | ||
:grub_efi_download_url: https://repo.almalinux.org/almalinux/9/BaseOS/x86_64/os/Packages/ | ||
:grub_efi_downloaded_package_name: grub2-efi-x64.rpm | ||
:grub_efi_package_name: grub2-efi-x64 | ||
:grub_efi_tmp_binary_path: /tmp/boot/efi/EFI/{client-os-context}/grubx64.efi | ||
:shim_efi_download_url: https://repo.almalinux.org/almalinux/9/BaseOS/x86_64/os/Packages/ | ||
:shim_efi_downloaded_package_name: shim-x64.rpm | ||
:shim_efi_package_name: shim-x64 | ||
:shim_efi_tmp_binary_path: /tmp/boot/efi/EFI/{client-os-context}/shimx64.efi | ||
:extract_grub: {extract_rpm_prefix}/{grub_efi_downloaded_package_name} {extract_rpm_suffix} | ||
:extract_shim: {extract_rpm_prefix}/{shim_efi_downloaded_package_name} {extract_rpm_suffix} | ||
include::modules/proc_configuring-smart-proxy-to-provision-secure-boot-enabled-hosts.adoc[leveloffset=+2] | ||
|
||
:client-os-context: debian | ||
:client-os: Debian | ||
:client-pkg-ext: deb | ||
:grub_efi_download_url: http://security.debian.org/debian-security/pool/updates/main/g/grub-efi-amd64-signed/ | ||
:grub_efi_downloaded_package_name: grub-efi-amd64-signed.deb | ||
:grub_efi_package_name: grub-efi-amd64-signed | ||
:grub_efi_tmp_binary_path: /tmp/usr/lib/grub/x86_64-efi-signed/grubnetx64.efi.signed | ||
:shim_efi_download_url: http://ftp.de.debian.org/debian/pool/main/s/shim-signed/ | ||
:shim_efi_downloaded_package_name: shim-signed.deb | ||
:shim_efi_package_name: shim-signed | ||
:shim_efi_tmp_binary_path: /tmp/usr/lib/shim/shimx64.efi.signed | ||
:extract_grub: {extract_deb_prefix}/{grub_efi_downloaded_package_name} {extract_deb_xz_suffix} | ||
:extract_shim: {extract_deb_prefix}/{shim_efi_downloaded_package_name} {extract_deb_xz_suffix} | ||
include::modules/proc_configuring-smart-proxy-to-provision-secure-boot-enabled-hosts.adoc[leveloffset=+2] | ||
|
||
:client-os-context: rocky | ||
:client-os: Rocky Linux | ||
:client-pkg-ext: rpm | ||
:grub_efi_download_url: http://dl.rockylinux.org/pub/rocky/9/BaseOS/x86_64/os/Packages/g/ | ||
:grub_efi_downloaded_package_name: grub2-efi-x64.rpm | ||
:grub_efi_package_name: grub2-efi-x64 | ||
:grub_efi_tmp_binary_path: /tmp/boot/efi/EFI/{client-os-context}/grubx64.efi | ||
:shim_efi_download_url: http://dl.rockylinux.org/pub/rocky/9/BaseOS/x86_64/os/Packages/s/ | ||
:shim_efi_downloaded_package_name: shim-x64.rpm | ||
:shim_efi_package_name: shim-x64 | ||
:shim_efi_tmp_binary_path: /tmp/boot/efi/EFI/{client-os-context}/shimx64.efi | ||
:extract_grub: {extract_rpm_prefix}/{grub_efi_downloaded_package_name} {extract_rpm_suffix} | ||
:extract_shim: {extract_rpm_prefix}/{shim_efi_downloaded_package_name} {extract_rpm_suffix} | ||
include::modules/proc_configuring-smart-proxy-to-provision-secure-boot-enabled-hosts.adoc[leveloffset=+2] | ||
|
||
:client-os-context: ubuntu | ||
:client-os: Ubuntu | ||
:client-pkg-ext: deb | ||
:grub_efi_download_url: http://security.ubuntu.com/ubuntu/pool/main/g/grub2-signed/ | ||
:grub_efi_downloaded_package_name: grub-efi-amd64-signed.deb | ||
:grub_efi_package_name: grub-efi-amd64-signed | ||
:grub_efi_tmp_binary_path: /tmp/usr/lib/grub/x86_64-efi-signed/grubnetx64.efi.signed | ||
:shim_efi_download_url: http://de.archive.ubuntu.com/ubuntu/pool/main/s/shim-signed/ | ||
:shim_efi_downloaded_package_name: shim-signed.deb | ||
:shim_efi_package_name: shim-signed | ||
:shim_efi_tmp_binary_path: /tmp/usr/lib/shim/shimx64.efi.signed.latest | ||
:extract_grub: {extract_deb_prefix}/{grub_efi_downloaded_package_name} {extract_deb_zst_suffix} | ||
:extract_shim: {extract_deb_prefix}/{shim_efi_downloaded_package_name} {extract_deb_xz_suffix} | ||
include::modules/proc_configuring-smart-proxy-to-provision-secure-boot-enabled-hosts.adoc[leveloffset=+2] | ||
|
||
// reset global attributes | ||
:client-os: {parent-client-os} | ||
:client-pkg-ext: {parent-client-pkg-ext} | ||
:!client-os-context: | ||
:!extract_deb_prefix: | ||
:!extract_deb_xz_suffix: | ||
:!extract_deb_zst_suffix: | ||
:!extract_grub: | ||
:!extract_rpm_prefix: | ||
:!extract_rpm_suffix: | ||
:!extract_shim: | ||
:!grub_efi_download_url: | ||
:!grub_efi_downloaded_package_name: | ||
:!grub_efi_package_name: | ||
:!grub_efi_tmp_binary_path: | ||
:!parent-client-os: | ||
:!parent-client-pkg-ext: | ||
:!secureboot-os-name: | ||
:!shim_efi_download_url: | ||
:!shim_efi_downloaded_package_name: | ||
:!shim_efi_package_name: | ||
:!shim_efi_tmp_binary_path: | ||
endif::[] | ||
|
||
include::modules/proc_creating-hosts-with-pxe-provisioning.adoc[leveloffset=+1] | ||
|
||
include::modules/proc_creating-hosts-with-uefi-http-boot-provisioning.adoc[leveloffset=+1] | ||
|
||
include::modules/proc_deploying-ssh-keys-during-provisioning.adoc[leveloffset=+1] | ||
|
||
include::assembly_using-ipxe-to-reduce-provisioning-times.adoc[leveloffset=+1] | ||
|
||
:context: {parent-context} | ||
:!parent-context: | ||
:!using-network-boot-to-provision-hosts: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 4 additions & 0 deletions
4
guides/common/modules/con_configuring-smartproxy-for-secure-boot.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
[id="configuring-{smart-proxy-context}-for-secure-boot"] | ||
= Configuring {SmartProxy} for Secure Boot | ||
|
||
If you want to provision Secure Boot enabled hosts, configure your {SmartProxy} for the provisionable operating system. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
[id="preparing-client-platforms"] | ||
= Preparing client platforms | ||
|
||
You have to configure the platforms that you will provision. | ||
That entails creating a hardware model, CPU architecture, and operating system. | ||
|
||
[NOTE] | ||
==== | ||
The records for Red{nbsp}Hat supported platforms are created automatically when you enable a Red{nbsp}Hat repository. | ||
==== |
4 changes: 2 additions & 2 deletions
4
...n/modules/con_configuring-networking.adoc → ...mon/modules/con_preparing-networking.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
8 changes: 8 additions & 0 deletions
8
guides/common/modules/con_preparing-provisioning-content.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
[id="preparing-provisioning-content"] | ||
= Preparing provisioning content | ||
|
||
You have to configure provisioning content that will be used for installation of the operating system on the provisioned host. | ||
|
||
[role="_additional-resources"] | ||
.Additional resources | ||
* {ContentManagementDocURL}[_{ContentManagementDocTitle}_] |
16 changes: 16 additions & 0 deletions
16
guides/common/modules/con_preparing-templates-for-provisioning.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
[id="preparing-templates-for-provisioning"] | ||
= Preparing templates for provisioning | ||
|
||
{Project} provides the following default template types: | ||
|
||
* Provisioning templates | ||
* Partition tables | ||
|
||
You can use the default templates or create custom templates. | ||
|
||
Provisioning templates are implemented with parameters that you can configure as host parameters to affect the provisioning process. | ||
You can also add custom steps to certain templates by creating custom `pre` or `post` snippets and thus customize the provisioning process further without editing the default templates. | ||
|
||
Thanks to partition tables implemented as templates, you can create custom, even dynamic, partition tables. | ||
|
||
When you do not edit the default templates, maintenance is easier and you get the benefit of updates to the templates from {Team}. |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
@apinnick FYI, we have separate titles for upstream and downstream.