Skip to content
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
wants to merge 28 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
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 Nov 25, 2024
7647ba7
fixup! Create a new guide for installer-based provisioning
Lennonka Nov 25, 2024
0240a65
fixup! Create a new guide for installer-based provisioning
Lennonka Nov 25, 2024
2aca670
fixup! Create a new guide for installer-based provisioning
Lennonka Nov 26, 2024
f0a683c
Rename the guide
Lennonka Dec 3, 2024
9d2bece
Update IDs, xrefs, and links
Lennonka Dec 3, 2024
2766f7c
Update context and guide attributes
Lennonka Dec 3, 2024
8044280
Incorporate Secure Boot from #2145
Lennonka Dec 3, 2024
76f6011
fixup! Rename the guide
Lennonka Dec 3, 2024
cb5a811
Incorporate smaller suggestions from review
Lennonka Dec 3, 2024
cc638fe
Move network boot info
Lennonka Dec 3, 2024
73a99ce
Add concept for Secure Boot config
Lennonka Dec 3, 2024
5bd81c7
Move iPXE
Lennonka Dec 3, 2024
53a6f18
Hide prereqs for image-based provisioning
Lennonka Dec 3, 2024
6709b54
Add Abstract
Lennonka Dec 4, 2024
169943b
Move settings to a special chapter
Lennonka Dec 5, 2024
8f75bd2
Remove 'Building cloud images' from this guide
Lennonka Dec 5, 2024
2f54109
Move provisioning contexts to a special chapter
Lennonka Dec 5, 2024
049dbc4
Fix title attribute in docinfo.xml
Lennonka Dec 5, 2024
15ba29d
Incorporate suggestions from Max
Lennonka Dec 10, 2024
d6d8df0
Incorporate suggestions from Avital
Lennonka Dec 10, 2024
3cf5402
fixup after rebase
Lennonka Dec 18, 2024
0596f6b
Reword 'Configuring' to 'Preparing'
Lennonka Dec 19, 2024
9566c0b
Change the title of the guide
Lennonka Dec 19, 2024
7bb21f2
Rename two headings
Lennonka Dec 19, 2024
80299e4
Fix link labels
Lennonka Dec 20, 2024
3a0fd76
Refactor TFTP boot
Lennonka Dec 20, 2024
5cb540b
fixup! Refactor TFTP boot
Lennonka Dec 20, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ include::modules/proc_creating-architectures.adoc[leveloffset=+1]

include::modules/proc_creating-hardware-models.adoc[leveloffset=+1]

include::modules/proc_using-a-synced-kickstart-repository.adoc[leveloffset=+1]
include::modules/proc_preparing-a-synchronized-kickstart-repository.adoc[leveloffset=+1]

include::modules/proc_adding-installation-media.adoc[leveloffset=+1]

Expand Down
6 changes: 6 additions & 0 deletions guides/common/assembly_introduction-to-provisioning.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,16 @@ include::modules/con_provisioning-methods-in-project.adoc[leveloffset=+1]

include::modules/ref_supported-host-platforms-in-provisioning.adoc[leveloffset=+1]

ifdef::provisioning,provisioning-cloud[]
include::modules/ref_supported-cloud-providers.adoc[leveloffset=+1]
endif::[]

ifdef::provisioning,provisioning-virtual[]
include::modules/ref_supported-virtualization-infrastructures.adoc[leveloffset=+1]
endif::[]

ifdef::provisioning[]
include::modules/con_network-boot-provisioning-workflow.adoc[leveloffset=+1]

include::modules/ref_required-boot-order-for-network-boot.adoc[leveloffset=+1]
endif::[]
49 changes: 49 additions & 0 deletions guides/common/assembly_preparing-client-platforms.adoc
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::[]
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
include::modules/con_configuring-networking.adoc[]
include::modules/con_preparing-networking.adoc[]

include::modules/con_facts-and-nic-filtering.adoc[leveloffset=+1]

Expand All @@ -10,7 +10,9 @@ include::modules/con_dhcp-options.adoc[leveloffset=+1]

include::modules/proc_troubleshooting-dhcp-problems.adoc[leveloffset=+1]

ifdef::provisioning,provisioning-cloud,provisioning-virtual[]
include::modules/con_prerequisites-for-image-based-provisioning.adoc[leveloffset=+1]
endif::[]

include::modules/proc_configuring-network-services.adoc[leveloffset=+1]

Expand Down
15 changes: 15 additions & 0 deletions guides/common/assembly_preparing-provisioning-content.adoc
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 guides/common/assembly_preparing-templates-for-provisioning.adoc
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]
11 changes: 11 additions & 0 deletions guides/common/assembly_security-settings.adoc
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 guides/common/assembly_using-boot-disks-to-provision-hosts.adoc
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 guides/common/assembly_using-network-boot-to-provision-hosts.adoc
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:
1 change: 1 addition & 0 deletions guides/common/attributes-base.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
:ManagingSecurityDocURL: {BaseURL}Managing_Security_Compliance/{BaseFilenameURL}#
:MonitoringDocURL: {BaseURL}Monitoring_Project/{BaseFilenameURL}#
:PlanningDocURL: {BaseURL}Planning_for_Project/{BaseFilenameURL}#
:ProvisioningInstallerDocURL: {BaseURL}Provisioning_Installer/{BaseFilenameURL}#
:ProvisioningDocURL: {BaseURL}Provisioning_Hosts/{BaseFilenameURL}#
:ReleaseNotesDocURL: {BaseURL}Release_Notes/{BaseFilenameURL}#
:TuningDocURL: {BaseURL}Tuning_Performance/{BaseFilenameURL}#
Expand Down
1 change: 1 addition & 0 deletions guides/common/attributes-satellite.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
:MonitoringDocURL: {BaseURL}monitoring_satellite_performance/index#
:PlanningDocURL: {BaseURL}overview_concepts_and_deployment_considerations/index#
:ProvisioningDocURL: {BaseURL}provisioning_hosts/index#
:ProvisioningInstallerDocURL: {BaseURL}provisioning_hosts_by_using_anaconda/index#
:TuningDocURL: {BaseURL}tuning_performance_of_red_hat_satellite/index#
:UpdatingDocURL: {BaseURL}updating_red_hat_satellite/index#
:UpgradingDocURL: {BaseURL}upgrading_connected_red_hat_satellite_to_{ProjectVersion}/index#
Expand Down
2 changes: 2 additions & 0 deletions guides/common/attributes-titles.adoc
Copy link
Contributor Author

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.

Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
:MonitoringDocTitle: Monitoring {Project} performance
:PlanningDocTitle: Planning for {ProjectName}
:ProvisioningDocTitle: Provisioning hosts
:ProvisioningInstallerDocTitle: Provisioning hosts by using an installer
:QuickStartDocTitle: Quick start guide for {Project} on {install-on-os}
:ReleaseNotesDocTitle: Release notes
:TuningDocTitle: Tuning performance of {ProjectName}
Expand All @@ -50,6 +51,7 @@ ifdef::satellite[]
:ManagingConfigurationsAnsibleDocTitle: Managing configurations by using Ansible integration
:ManagingConfigurationsPuppetDocTitle: Managing configurations by using Puppet integration
:PlanningDocTitle: Overview, concepts, and deployment considerations
:ProvisioningInstallerDocTitle: Provisioning hosts by using Anaconda
:QuickstartDocTitle: Quickstart
:UpgradingDocTitle: Upgrading connected {ProjectName} to {ProjectVersion}
endif::[]
Expand Down
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.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[id="discovering-hosts-on-a-network_{context}"]
[id="discovering-hosts-on-a-network"]
= Discovering hosts on a network
[[Configuring_the_Discovery_Service_{context}]]

Expand Down
2 changes: 1 addition & 1 deletion guides/common/modules/con_discovery-in-pxe-mode.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[id="discovery-in-pxe-mode_{context}"]
[id="discovery-in-pxe-mode"]
= Discovery in PXE mode

{Project} provides a PXE-based Discovery service that uses DHCP and TFTP services.
Expand Down
2 changes: 1 addition & 1 deletion guides/common/modules/con_discovery-in-pxeless-mode.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[id="discovery-in-pxeless-mode_{context}"]
[id="discovery-in-pxeless-mode"]
= Discovery in PXE-less mode

{Project} provides a PXE-less Discovery service for environments without DHCP and TFTP services.
Expand Down
2 changes: 1 addition & 1 deletion guides/common/modules/con_infoblox-limitations.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ If you want to configure clustering and High Availability, make the configuratio

Hosting PXE-related files by using the TFTP functionality of Infoblox is not supported.
You must use {ProductName} as a TFTP server for PXE provisioning.
For more information, see {ProvisioningDocURL}Configuring_Networking_provisioning[Configuring networking] in _{ProvisioningDocTitle}_.
For more information, see {ProvisioningDocURL}preparing-networking[Preparing networking] in _{ProvisioningDocTitle}_.

{Project} IPAM feature cannot be integrated with Infoblox.
10 changes: 10 additions & 0 deletions guides/common/modules/con_preparing-client-platforms.adoc
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.
====
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Configuring_Networking_{context}"]
= Configuring networking
[id="preparing-networking"]
= Preparing networking

Each provisioning type requires some network configuration.
Use this chapter to configure network services in your integrated {SmartProxy} on {ProjectServer}.
Expand Down
8 changes: 8 additions & 0 deletions guides/common/modules/con_preparing-provisioning-content.adoc
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}_]
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}.
Loading
Loading