From c3b59844527cfad6d3ebc4d3786fb8fb49d214d8 Mon Sep 17 00:00:00 2001 From: Zuzana Lena Ansorgova Date: Mon, 25 Nov 2024 22:54:00 +0100 Subject: [PATCH 01/28] Create a new guide for installer-based provisioning --- ...y_configuring-provisionable-platforms.adoc | 57 +++++++++++++ ...mbly_configuring-provisioning-content.adoc | 15 ++++ ...onfiguring-templates-for-provisioning.adoc | 25 ++++++ ...assembly_introduction-to-provisioning.adoc | 9 +++ ...y_using-boot-disks-to-provision-hosts.adoc | 9 +++ ...using-network-boot-to-provision-hosts.adoc | 13 +++ guides/common/attributes-base.adoc | 1 + guides/common/attributes-satellite.adoc | 1 + guides/common/attributes-titles.adoc | 1 + .../modules/con_configuring-networking.adoc | 2 +- ...n_configuring-provisionable-platforms.adoc | 12 +++ .../con_configuring-provisioning-content.adoc | 8 ++ ...onfiguring-templates-for-provisioning.adoc | 16 ++++ ...uisites-for-network-boot-provisioning.adoc | 16 ++++ ...using-network-boot-to-provision-hosts.adoc | 80 +++++++++++++++++++ ...c_using-a-synced-kickstart-repository.adoc | 4 +- ...requisite-networking-for-provisioning.adoc | 2 +- ...ip_steps-create-a-host-tab-interfaces.adoc | 2 +- guides/doc-Provisioning_Netboot/Makefile | 1 + guides/doc-Provisioning_Netboot/common | 1 + guides/doc-Provisioning_Netboot/docinfo.html | 1 + guides/doc-Provisioning_Netboot/docinfo.xml | 19 +++++ guides/doc-Provisioning_Netboot/images/common | 1 + guides/doc-Provisioning_Netboot/master.adoc | 49 ++++++++++++ 24 files changed, 340 insertions(+), 5 deletions(-) create mode 100644 guides/common/assembly_configuring-provisionable-platforms.adoc create mode 100644 guides/common/assembly_configuring-provisioning-content.adoc create mode 100644 guides/common/assembly_configuring-templates-for-provisioning.adoc create mode 100644 guides/common/assembly_using-boot-disks-to-provision-hosts.adoc create mode 100644 guides/common/assembly_using-network-boot-to-provision-hosts.adoc create mode 100644 guides/common/modules/con_configuring-provisionable-platforms.adoc create mode 100644 guides/common/modules/con_configuring-provisioning-content.adoc create mode 100644 guides/common/modules/con_configuring-templates-for-provisioning.adoc create mode 100644 guides/common/modules/con_prerequisites-for-network-boot-provisioning.adoc create mode 100644 guides/common/modules/con_using-network-boot-to-provision-hosts.adoc create mode 100644 guides/doc-Provisioning_Netboot/Makefile create mode 120000 guides/doc-Provisioning_Netboot/common create mode 120000 guides/doc-Provisioning_Netboot/docinfo.html create mode 100644 guides/doc-Provisioning_Netboot/docinfo.xml create mode 120000 guides/doc-Provisioning_Netboot/images/common create mode 100644 guides/doc-Provisioning_Netboot/master.adoc diff --git a/guides/common/assembly_configuring-provisionable-platforms.adoc b/guides/common/assembly_configuring-provisionable-platforms.adoc new file mode 100644 index 00000000000..82ec42084c9 --- /dev/null +++ b/guides/common/assembly_configuring-provisionable-platforms.adoc @@ -0,0 +1,57 @@ +include::modules/con_configuring-provisionable-platforms.adoc[] + +include::modules/con_provisioning-contexts.adoc[leveloffset=+1] + +include::modules/proc_setting-the-provisioning-context.adoc[leveloffset=+1] + +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] + +include::modules/proc_setting-a-default-encrypted-root-password.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] + +include::modules/proc_removing-a-virtual-machine-upon-host-deletion.adoc[leveloffset=+1] +endif::[] diff --git a/guides/common/assembly_configuring-provisioning-content.adoc b/guides/common/assembly_configuring-provisioning-content.adoc new file mode 100644 index 00000000000..492caece7da --- /dev/null +++ b/guides/common/assembly_configuring-provisioning-content.adoc @@ -0,0 +1,15 @@ +include::modules/con_configuring-provisioning-content.adoc[] + +include::modules/proc_using-a-synced-kickstart-repository.adoc[leveloffset=+1] + +include::modules/proc_using-an-imagebuilder-image-for-provisioning.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::[] diff --git a/guides/common/assembly_configuring-templates-for-provisioning.adoc b/guides/common/assembly_configuring-templates-for-provisioning.adoc new file mode 100644 index 00000000000..18f10ccd400 --- /dev/null +++ b/guides/common/assembly_configuring-templates-for-provisioning.adoc @@ -0,0 +1,25 @@ +include::modules/con_configuring-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] diff --git a/guides/common/assembly_introduction-to-provisioning.adoc b/guides/common/assembly_introduction-to-provisioning.adoc index 25df2cd2971..8c0a534773d 100644 --- a/guides/common/assembly_introduction-to-provisioning.adoc +++ b/guides/common/assembly_introduction-to-provisioning.adoc @@ -4,10 +4,19 @@ include::modules/con_provisioning-methods-in-project.adoc[leveloffset=+1] include::modules/ref_supported-host-platforms-in-provisioning.adoc[leveloffset=+1] +ifdef::provisioning-cloud[] include::modules/ref_supported-cloud-providers.adoc[leveloffset=+1] +endif::[] +ifdef::provisioning-virtual[] include::modules/ref_supported-virtualization-infrastructures.adoc[leveloffset=+1] +endif::[] +ifdef::provisioning-netboot[] include::modules/con_network-boot-provisioning-workflow.adoc[leveloffset=+1] include::modules/ref_required-boot-order-for-network-boot.adoc[leveloffset=+1] +endif::[] + +// Network boot provisioning overview? +// Provisioning paths? diff --git a/guides/common/assembly_using-boot-disks-to-provision-hosts.adoc b/guides/common/assembly_using-boot-disks-to-provision-hosts.adoc new file mode 100644 index 00000000000..062c7e50a23 --- /dev/null +++ b/guides/common/assembly_using-boot-disks-to-provision-hosts.adoc @@ -0,0 +1,9 @@ +:using-bootdisks-to-provision-hosts: +include::modules/con_using-network-boot-to-provision-hosts.adoc[] + +include::modules/proc_configuring-the-security-token-validity-duration.adoc[leveloffset=+1] + +include::modules/proc_creating-hosts-with-pxeless-provisioning.adoc[leveloffset=+1] + +include::modules/proc_deploying-ssh-keys-during-provisioning.adoc[leveloffset=+1] +:!using-bootdisks-to-provision-hosts: diff --git a/guides/common/assembly_using-network-boot-to-provision-hosts.adoc b/guides/common/assembly_using-network-boot-to-provision-hosts.adoc new file mode 100644 index 00000000000..89a1eb657a5 --- /dev/null +++ b/guides/common/assembly_using-network-boot-to-provision-hosts.adoc @@ -0,0 +1,13 @@ +:using-network-boot-to-provision-hosts: +include::modules/con_using-network-boot-to-provision-hosts.adoc[] + +include::modules/con_prerequisites-for-network-boot-provisioning.adoc[leveloffset=+1] + +include::modules/proc_configuring-the-security-token-validity-duration.adoc[leveloffset=+1] + +include::modules/proc_creating-hosts-with-unattended-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] +:!using-network-boot-to-provision-hosts: diff --git a/guides/common/attributes-base.adoc b/guides/common/attributes-base.adoc index 78e6debf2dc..83b54df3344 100644 --- a/guides/common/attributes-base.adoc +++ b/guides/common/attributes-base.adoc @@ -17,6 +17,7 @@ :ManagingSecurityDocURL: {BaseURL}Managing_Security_Compliance/{BaseFilenameURL}# :MonitoringDocURL: {BaseURL}Monitoring_Project/{BaseFilenameURL}# :PlanningDocURL: {BaseURL}Planning_for_Project/{BaseFilenameURL}# +:ProvisioningNetbootDocURL: {BaseURL}Provisioning_Netboot/{BaseFilenameURL}# :ProvisioningDocURL: {BaseURL}Provisioning_Hosts/{BaseFilenameURL}# :ReleaseNotesDocURL: {BaseURL}Release_Notes/{BaseFilenameURL}# :TuningDocURL: {BaseURL}Tuning_Performance/{BaseFilenameURL}# diff --git a/guides/common/attributes-satellite.adoc b/guides/common/attributes-satellite.adoc index 58e2fcc1ada..ba6aef1d1c3 100644 --- a/guides/common/attributes-satellite.adoc +++ b/guides/common/attributes-satellite.adoc @@ -28,6 +28,7 @@ :MonitoringDocURL: {BaseURL}monitoring_satellite_performance/index# :PlanningDocURL: {BaseURL}overview_concepts_and_deployment_considerations/index# :ProvisioningDocURL: {BaseURL}provisioning_hosts/index# +:ProvisioningNetbootDocURL: {BaseURL}provisioning_machines_by_using_network_boot/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# diff --git a/guides/common/attributes-titles.adoc b/guides/common/attributes-titles.adoc index 2d5f1c4dd12..859f88a62ba 100644 --- a/guides/common/attributes-titles.adoc +++ b/guides/common/attributes-titles.adoc @@ -24,6 +24,7 @@ :MonitoringDocTitle: Monitoring {Project} performance :PlanningDocTitle: Planning for {ProjectName} :ProvisioningDocTitle: Provisioning hosts +:ProvisioningNetbootDocTitle: Provisioning machines by using network boot :QuickStartDocTitle: Quick start guide for {Project} on {install-on-os} :ReleaseNotesDocTitle: Release notes :TuningDocTitle: Tuning performance of {ProjectName} diff --git a/guides/common/modules/con_configuring-networking.adoc b/guides/common/modules/con_configuring-networking.adoc index 466c598e03a..ca35a6c5d99 100644 --- a/guides/common/modules/con_configuring-networking.adoc +++ b/guides/common/modules/con_configuring-networking.adoc @@ -1,4 +1,4 @@ -[id="Configuring_Networking_{context}"] +[id="Configuring_Networking"] = Configuring networking Each provisioning type requires some network configuration. diff --git a/guides/common/modules/con_configuring-provisionable-platforms.adoc b/guides/common/modules/con_configuring-provisionable-platforms.adoc new file mode 100644 index 00000000000..74fab69aff2 --- /dev/null +++ b/guides/common/modules/con_configuring-provisionable-platforms.adoc @@ -0,0 +1,12 @@ +[id="configuring-provisionable-platforms"] += Configuring provisionable platforms + +You have to configure the platforms that you will provision. +That entails creating a hardware model, CPU architecture, and operating system. + +ifndef::orcharhino[] +[NOTE] +==== +The records for Red{nbsp}Hat supported platforms are created automatically when you enable a Red{nbsp}Hat repository. +==== +endif::[] diff --git a/guides/common/modules/con_configuring-provisioning-content.adoc b/guides/common/modules/con_configuring-provisioning-content.adoc new file mode 100644 index 00000000000..6466945a242 --- /dev/null +++ b/guides/common/modules/con_configuring-provisioning-content.adoc @@ -0,0 +1,8 @@ +[id="configuring-provisioning-content"] += Configuring 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}_] \ No newline at end of file diff --git a/guides/common/modules/con_configuring-templates-for-provisioning.adoc b/guides/common/modules/con_configuring-templates-for-provisioning.adoc new file mode 100644 index 00000000000..e831d5b5c64 --- /dev/null +++ b/guides/common/modules/con_configuring-templates-for-provisioning.adoc @@ -0,0 +1,16 @@ +[id="configuring-templates-for-provisioning"] += Configuring templates for provisioning + +{Project} provides the following default template types: + +* Provisioning templates +* Templates of 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}. diff --git a/guides/common/modules/con_prerequisites-for-network-boot-provisioning.adoc b/guides/common/modules/con_prerequisites-for-network-boot-provisioning.adoc new file mode 100644 index 00000000000..fb8a15f46f7 --- /dev/null +++ b/guides/common/modules/con_prerequisites-for-network-boot-provisioning.adoc @@ -0,0 +1,16 @@ +[id="prerequisites-for-network-boot-provisioning"] += Prerequisites for network-boot provisioning + +The requirements for network-boot provisioning include: + +* A {SmartProxyServer} managing the network for the network-booted machines. +For unattended provisioning and discovery-based provisioning, {ProjectServer} requires PXE server settings. ++ +For more information about networking requirements, see xref:Configuring_Networking_{context}[]. ++ +For more information about the Discovery service, xref:discovering-hosts-on-a-network_{context}[]. ++ +* A bare-metal host or a blank VM. +include::snip_prerequisites-common-compute-resource.adoc[] + +For information about the security token for unattended and PXE-less provisioning, see xref:Configuring_the_Security_Token_Validity_Duration_{context}[]. diff --git a/guides/common/modules/con_using-network-boot-to-provision-hosts.adoc b/guides/common/modules/con_using-network-boot-to-provision-hosts.adoc new file mode 100644 index 00000000000..02130f4c341 --- /dev/null +++ b/guides/common/modules/con_using-network-boot-to-provision-hosts.adoc @@ -0,0 +1,80 @@ +[id="using-network-boot-to-provision-hosts"] += Using network boot to provision hosts + +You can provision bare-metal instances with {Project} by using one of the following methods: + +Unattended Provisioning:: +New hosts are identified by a MAC address. +{ProjectServer} provisions the host by using a PXE boot process. + +Unattended Provisioning with Discovery:: +New hosts use PXE boot to load the {Project} Discovery service. +This service identifies hardware information about the host and lists it as an available host to provision. +For more information, see xref:discovering-hosts-on-a-network_{context}[]. + +PXE-less Provisioning:: +ifndef::satellite[] +New hosts are provisioned with a boot disk or PXE-less discovery image that {ProjectServer} generates. + +PXE-less Provisioning with Discovery:: +New hosts use an ISO boot disk that loads the {Project} Discovery service. +This service identifies hardware information about the host and lists it as an available host to provision. +For more information, see xref:discovery-in-pxeless-mode_{context}[]. +endif::[] +ifdef::satellite[] +New hosts are provisioned with a boot disk image that {ProjectServer} generates. +endif::[] + +ifndef::satellite[] +[NOTE] +==== +Discovery workflows are only available when the Discovery plugin is installed. +For more information, see xref:discovering-hosts-on-a-network_{context}[]. +==== +endif::[] + +.BIOS and UEFI support +With {ProjectName}, you can perform both BIOS and UEFI based PXE provisioning. +Both BIOS and UEFI interfaces work as interpreters between the operating system and firmware of a computer, initializing hardware components and starting the operating system at boot time. + +.PXE loaders +In {Project} provisioning, the PXE loader option defines the DHCP `filename` option to use during provisioning. + +* For BIOS systems, use the *PXELinux BIOS* option to enable a provisioned host to download the `pxelinux.0` file over TFTP. +* For UEFI systems, use the *PXEGrub2 UEFI* option to enable a TFTP client to download `grub2/grubx64.efi` file, or use the *PXEGrub2 UEFI HTTP* option to enable an UEFI HTTP client to download `grubx64.efi` from {SmartProxy} with the HTTP Boot feature. + +ifndef::satellite[] +{ProjectName} supports UEFI Secure Boot. +SecureBoot PXE loaders enable a client to download the `shim.efi` bootstrap boot loader that then loads the signed `grubx64.efi`. +Use the *Grub2 UEFI SecureBoot* PXE loader for PXE-boot provisioning or *Grub2 UEFI HTTPS SecureBoot* for HTTP-boot provisioning. + +[IMPORTANT] +==== +You can only use Secure Boot to provision hosts with the same operating system version, major and minor, that runs on your TFTP {SmartProxy}. +==== +endif::[] + +ifdef::satellite[] +For more information about supported workflows, see https://access.redhat.com/solutions/2674001[Supported architectures and provisioning scenarios]. +endif::[] +ifndef::satellite[] +Other PXE loaders, such as PXELinux UEFI, Grub2 ELF, or iPXE Chain, require additional configuration. +These workflows are not documented. + +.Template association with operating systems +For BIOS provisioning, you must associate a PXELinux template with the operating system. +For UEFI provisioning, you must associate a PXEGrub2 template with the operating system. +If you associate both PXELinux and PXEGrub2 templates, {Project} can deploy configuration files for both on a TFTP server, so that you can switch between PXE loaders easily. +endif::[] + +.Bonded network interfaces +You can configure a bonded interface that {Project} will use during the installation process, for example, to download installation content. +After provisioning completes, the provisioned system can also use the bonded interface. + +[IMPORTANT] +==== +{Project} cannot PXE boot a bonded interface that requires configuration on a network switch as well as on your host. + +After your host loads the kernel of an installer or the kernel of an operating system, bonding works as expected. +Therefore, you can use a boot disk to work around PXE boot limitations when your bonded interface requires configuration on both a switch and your host. +==== diff --git a/guides/common/modules/proc_using-a-synced-kickstart-repository.adoc b/guides/common/modules/proc_using-a-synced-kickstart-repository.adoc index ae6fda4d020..59bc8668a1d 100644 --- a/guides/common/modules/proc_using-a-synced-kickstart-repository.adoc +++ b/guides/common/modules/proc_using-a-synced-kickstart-repository.adoc @@ -1,5 +1,5 @@ -[id="using-a-synchronized-kickstart-repository-for-a-hosts-operating-system_{context}"] -= Using a synchronized Kickstart repository for a host's operating system +[id="using-a-synchronized-kickstart-repository-as-an-installation-medium"] += Using a synchronized Kickstart repository as an installation medium ifdef::foreman-el,katello[] The following feature is provided by the Katello plugin. diff --git a/guides/common/modules/snip_prerequisite-networking-for-provisioning.adoc b/guides/common/modules/snip_prerequisite-networking-for-provisioning.adoc index cbfbf07d9d1..688dc72969f 100644 --- a/guides/common/modules/snip_prerequisite-networking-for-provisioning.adoc +++ b/guides/common/modules/snip_prerequisite-networking-for-provisioning.adoc @@ -1,2 +1,2 @@ * Configure a domain and subnet on {Project}. -For more information about networking requirements, see xref:Configuring_Networking_provisioning[]. +For more information about networking requirements, see xref:Configuring_Networking[]. diff --git a/guides/common/modules/snip_steps-create-a-host-tab-interfaces.adoc b/guides/common/modules/snip_steps-create-a-host-tab-interfaces.adoc index 67206ccd416..59a095c1065 100644 --- a/guides/common/modules/snip_steps-create-a-host-tab-interfaces.adoc +++ b/guides/common/modules/snip_steps-create-a-host-tab-interfaces.adoc @@ -4,7 +4,7 @@ Note in particular: + * {Project} automatically assigns an IP address for the new host. + -ifdef::using-pxe-to-provision-hosts[] +ifdef::using-pxe-to-provision-hosts,using-network-boot-to-provision-hosts[] * In the *MAC address* field, enter a MAC address of the provisioning interface of the host. This ensures the identification of the host during the PXE boot process. endif::[] diff --git a/guides/doc-Provisioning_Netboot/Makefile b/guides/doc-Provisioning_Netboot/Makefile new file mode 100644 index 00000000000..dd1e5be8557 --- /dev/null +++ b/guides/doc-Provisioning_Netboot/Makefile @@ -0,0 +1 @@ +include ../common/Makefile diff --git a/guides/doc-Provisioning_Netboot/common b/guides/doc-Provisioning_Netboot/common new file mode 120000 index 00000000000..60d3b0a6a8f --- /dev/null +++ b/guides/doc-Provisioning_Netboot/common @@ -0,0 +1 @@ +../common \ No newline at end of file diff --git a/guides/doc-Provisioning_Netboot/docinfo.html b/guides/doc-Provisioning_Netboot/docinfo.html new file mode 120000 index 00000000000..e037c37244a --- /dev/null +++ b/guides/doc-Provisioning_Netboot/docinfo.html @@ -0,0 +1 @@ +../common/docinfo.html \ No newline at end of file diff --git a/guides/doc-Provisioning_Netboot/docinfo.xml b/guides/doc-Provisioning_Netboot/docinfo.xml new file mode 100644 index 00000000000..7b63ec58b79 --- /dev/null +++ b/guides/doc-Provisioning_Netboot/docinfo.xml @@ -0,0 +1,19 @@ +{ProvisioningNetbootDocTitle} + + Provision bare-metal or virtual machines by using installer-based methods, such as network booting and boot disk, and discover unknown hosts on your provisioning network + +Red Hat Satellite +{ProjectVersion} + + + TODO + + + + + Red Hat Satellite + Documentation Team + satellite-doc-list@redhat.com + + + diff --git a/guides/doc-Provisioning_Netboot/images/common b/guides/doc-Provisioning_Netboot/images/common new file mode 120000 index 00000000000..53d0c7f575d --- /dev/null +++ b/guides/doc-Provisioning_Netboot/images/common @@ -0,0 +1 @@ +../common/images \ No newline at end of file diff --git a/guides/doc-Provisioning_Netboot/master.adoc b/guides/doc-Provisioning_Netboot/master.adoc new file mode 100644 index 00000000000..2719e9587bd --- /dev/null +++ b/guides/doc-Provisioning_Netboot/master.adoc @@ -0,0 +1,49 @@ +include::common/attributes.adoc[] +include::common/header.adoc[] +:context: provisioning-netboot +:provisioning-netboot: + += {ProvisioningNetbootDocTitle} + +// This guide is not ready for stable releases +ifdef::HideDocumentOnStable[] +include::common/modules/snip_guide-not-ready.adoc[] +endif::[] +ifndef::HideDocumentOnStable[] + +ifdef::satellite[] +include::common/modules/proc_providing-feedback-on-red-hat-documentation.adoc[leveloffset=+1] +endif::[] + +include::common/assembly_introduction-to-provisioning.adoc[leveloffset=+1] + +include::common/assembly_configuring-provisioning-content.adoc[leveloffset=+1] + +include::common/assembly_configuring-provisionable-platforms.adoc[leveloffset=+1] + +include::common/assembly_configuring-templates-for-provisioning.adoc[leveloffset=+1] + +include::common/assembly_configuring-networking.adoc[leveloffset=+1] + +include::common/assembly_using-network-boot-to-provision-hosts.adoc[leveloffset=+1] + +include::common/assembly_using-ipxe-to-reduce-provisioning-times.adoc[leveloffset=+1] + +include::common/assembly_using-boot-disks-to-provision-hosts.adoc[leveloffset=+1] + +include::common/assembly_discovering-hosts-on-a-network.adoc[leveloffset=+1] + +[appendix] +include::common/assembly_provisioning-fips-compliant-hosts.adoc[leveloffset=+1] + +ifdef::satellite[] +[appendix] +include::common/assembly_building_cloud-images.adoc[leveloffset=+1] +endif::[] + +[appendix] +include::common/modules/ref_host-parameter-hierarchy.adoc[leveloffset=+1] + +[appendix] +include::common/modules/ref_permissions-required-to-provision-hosts.adoc[leveloffset=+1] +endif::[] From 7647ba73004acd68e1aa53307b01fd9bc82fe736 Mon Sep 17 00:00:00 2001 From: Zuzana Lena Ansorgova Date: Mon, 25 Nov 2024 23:35:51 +0100 Subject: [PATCH 02/28] fixup! Create a new guide for installer-based provisioning --- .../assembly_using-boot-disks-to-provision-hosts.adoc | 6 +++++- guides/common/modules/con_infoblox-limitations.adoc | 2 +- .../modules/con_prerequisites-for-vmware-provisioning.adoc | 2 +- .../con_provisioning-cloud-instances-on-openstack.adoc | 2 +- .../con_provisioning-virtual-machines-on-kubevirt.adoc | 2 +- .../modules/con_provisioning-virtual-machines-on-kvm.adoc | 2 +- .../modules/con_provisioning-virtual-machines-on-ovirt.adoc | 2 +- .../modules/con_using-boot-disks-to-provision-hosts.adoc | 4 ++++ 8 files changed, 15 insertions(+), 7 deletions(-) create mode 100644 guides/common/modules/con_using-boot-disks-to-provision-hosts.adoc diff --git a/guides/common/assembly_using-boot-disks-to-provision-hosts.adoc b/guides/common/assembly_using-boot-disks-to-provision-hosts.adoc index 062c7e50a23..ed6bceeb8ca 100644 --- a/guides/common/assembly_using-boot-disks-to-provision-hosts.adoc +++ b/guides/common/assembly_using-boot-disks-to-provision-hosts.adoc @@ -1,9 +1,13 @@ :using-bootdisks-to-provision-hosts: -include::modules/con_using-network-boot-to-provision-hosts.adoc[] +ifdef::context[:parent-context: {context}] + +include::modules/con_using-boot-disks-to-provision-hosts.adoc[] include::modules/proc_configuring-the-security-token-validity-duration.adoc[leveloffset=+1] include::modules/proc_creating-hosts-with-pxeless-provisioning.adoc[leveloffset=+1] include::modules/proc_deploying-ssh-keys-during-provisioning.adoc[leveloffset=+1] + +ifdef::parent-context[:context: {parent-context}] :!using-bootdisks-to-provision-hosts: diff --git a/guides/common/modules/con_infoblox-limitations.adoc b/guides/common/modules/con_infoblox-limitations.adoc index 6f7310d32e9..0a6c1cca137 100644 --- a/guides/common/modules/con_infoblox-limitations.adoc +++ b/guides/common/modules/con_infoblox-limitations.adoc @@ -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}Configuring_Networking[Configuring networking] in _{ProvisioningDocTitle}_. {Project} IPAM feature cannot be integrated with Infoblox. diff --git a/guides/common/modules/con_prerequisites-for-vmware-provisioning.adoc b/guides/common/modules/con_prerequisites-for-vmware-provisioning.adoc index 2c00f1bea20..5d955ab21e5 100644 --- a/guides/common/modules/con_prerequisites-for-vmware-provisioning.adoc +++ b/guides/common/modules/con_prerequisites-for-vmware-provisioning.adoc @@ -12,7 +12,7 @@ The following versions have been fully tested with {Project}: * A {SmartProxyServer} managing a network on the vSphere environment. Ensure no other DHCP services run on this network to avoid conflicts with {SmartProxyServer}. ifndef::orcharhino[] -For more information, see xref:Configuring_Networking_provisioning[]. +For more information, see xref:Configuring_Networking[]. endif::[] * An existing VMware template if you want to use image-based provisioning. include::snip_prerequisites-common-compute-resource.adoc[] diff --git a/guides/common/modules/con_provisioning-cloud-instances-on-openstack.adoc b/guides/common/modules/con_provisioning-cloud-instances-on-openstack.adoc index 29fcba49fec..4a6a923fa6b 100644 --- a/guides/common/modules/con_provisioning-cloud-instances-on-openstack.adoc +++ b/guides/common/modules/con_provisioning-cloud-instances-on-openstack.adoc @@ -8,7 +8,7 @@ In {Project}, you can interact with {OpenStack} REST API to create cloud instanc .Prerequisites include::snip_prerequisites-common-compute-resource.adoc[] * A {SmartProxyServer} managing a network in your OpenStack environment. -For more information, see {ProvisioningDocURL}Configuring_Networking_provisioning[Configuring Networking] in _{ProvisioningDocTitle}_. +For more information, see {ProvisioningDocURL}Configuring_Networking[Configuring Networking] in _{ProvisioningDocTitle}_. * An image added to OpenStack Image Storage (glance) service for image-based provisioning. ifndef::orcharhino[] For more information, see the {RHDocsBaseURL}red_hat_openstack_platform/16.0/html/instances_and_images_guide/index[{OpenStack} _Instances and Images Guide_]. diff --git a/guides/common/modules/con_provisioning-virtual-machines-on-kubevirt.adoc b/guides/common/modules/con_provisioning-virtual-machines-on-kubevirt.adoc index 4df4c31c236..b26044a621a 100644 --- a/guides/common/modules/con_provisioning-virtual-machines-on-kubevirt.adoc +++ b/guides/common/modules/con_provisioning-virtual-machines-on-kubevirt.adoc @@ -25,7 +25,7 @@ include::snip_prerequisites-common-compute-resource.adoc[] * You must have `cluster-admin` permissions for the {Kubernetes} cluster. * A {SmartProxyServer} managing a network on the {Kubernetes} cluster. Ensure that no other DHCP services run on this network to avoid conflicts with {SmartProxyServer}. -For more information about network service configuration for {SmartProxyServers}, see {ProvisioningDocURL}Configuring_Networking_provisioning[Configuring Networking] in _{ProvisioningDocTitle}_. +For more information about network service configuration for {SmartProxyServers}, see {ProvisioningDocURL}Configuring_Networking[Configuring Networking] in _{ProvisioningDocTitle}_. .Additional resources * For a list of permissions a non-admin user requires to provision hosts, see xref:permissions-required-to-provision-hosts_provisioning[]. diff --git a/guides/common/modules/con_provisioning-virtual-machines-on-kvm.adoc b/guides/common/modules/con_provisioning-virtual-machines-on-kvm.adoc index 6c24371fcbf..e2a0337e4d4 100644 --- a/guides/common/modules/con_provisioning-virtual-machines-on-kvm.adoc +++ b/guides/common/modules/con_provisioning-virtual-machines-on-kvm.adoc @@ -13,7 +13,7 @@ You can use KVM provisioning to create hosts over a network connection or from a include::snip_prerequisites-common-compute-resource.adoc[] * A {SmartProxyServer} managing a network on the KVM server. Ensure no other DHCP services run on this network to avoid conflicts with {SmartProxyServer}. -For more information about network service configuration for {SmartProxyServers}, see {ProvisioningDocURL}Configuring_Networking_provisioning[Configuring Networking] in _{ProvisioningDocTitle}_. +For more information about network service configuration for {SmartProxyServers}, see {ProvisioningDocURL}Configuring_Networking[Configuring Networking] in _{ProvisioningDocTitle}_. ifdef::satellite[] * A {RHEL} server running KVM virtualization tools (libvirt daemon). For more information, see the {RHELDocsBaseURL}8/html/configuring_and_managing_virtualization/index[_{RHEL}{nbsp}8 Configuring and managing virtualization_]. diff --git a/guides/common/modules/con_provisioning-virtual-machines-on-ovirt.adoc b/guides/common/modules/con_provisioning-virtual-machines-on-ovirt.adoc index f6867e56089..21b8c140921 100644 --- a/guides/common/modules/con_provisioning-virtual-machines-on-ovirt.adoc +++ b/guides/common/modules/con_provisioning-virtual-machines-on-ovirt.adoc @@ -15,7 +15,7 @@ This method does not require {Project} to connect to the provisioned virtual mac include::snip_prerequisites-common-compute-resource.adoc[] * A {SmartProxyServer} managing a logical network on the {oVirt} environment. Ensure no other DHCP services run on this network to avoid conflicts with {SmartProxyServer}. -For more information, see {ProvisioningDocURL}Configuring_Networking_provisioning[Configuring Networking] in _{ProvisioningDocTitle}_. +For more information, see {ProvisioningDocURL}Configuring_Networking[Configuring Networking] in _{ProvisioningDocTitle}_. * An existing template, other than the `blank` template, if you want to use image-based provisioning. For more information about creating templates for virtual machines, see ifdef::satellite[] diff --git a/guides/common/modules/con_using-boot-disks-to-provision-hosts.adoc b/guides/common/modules/con_using-boot-disks-to-provision-hosts.adoc new file mode 100644 index 00000000000..8dd9a852537 --- /dev/null +++ b/guides/common/modules/con_using-boot-disks-to-provision-hosts.adoc @@ -0,0 +1,4 @@ +[id="using-boot-disks-to-provision-hosts"] += Using boot disks to provision hosts + +You can use boot disks to boot hosts without PXE firmware. From 0240a6566025bdb6ce04b6f4bd7da0c4942dcf7a Mon Sep 17 00:00:00 2001 From: Zuzana Lena Ansorgova Date: Mon, 25 Nov 2024 23:43:24 +0100 Subject: [PATCH 03/28] fixup! Create a new guide for installer-based provisioning --- .../common/assembly_using-boot-disks-to-provision-hosts.adoc | 1 + .../assembly_using-network-boot-to-provision-hosts.adoc | 5 +++++ 2 files changed, 6 insertions(+) diff --git a/guides/common/assembly_using-boot-disks-to-provision-hosts.adoc b/guides/common/assembly_using-boot-disks-to-provision-hosts.adoc index ed6bceeb8ca..8062313392e 100644 --- a/guides/common/assembly_using-boot-disks-to-provision-hosts.adoc +++ b/guides/common/assembly_using-boot-disks-to-provision-hosts.adoc @@ -1,5 +1,6 @@ :using-bootdisks-to-provision-hosts: ifdef::context[:parent-context: {context}] +:context: using-bootdisks include::modules/con_using-boot-disks-to-provision-hosts.adoc[] diff --git a/guides/common/assembly_using-network-boot-to-provision-hosts.adoc b/guides/common/assembly_using-network-boot-to-provision-hosts.adoc index 89a1eb657a5..df3bb07e8ad 100644 --- a/guides/common/assembly_using-network-boot-to-provision-hosts.adoc +++ b/guides/common/assembly_using-network-boot-to-provision-hosts.adoc @@ -1,4 +1,7 @@ :using-network-boot-to-provision-hosts: +ifdef::context[:parent-context: {context}] +:context: using-netboot + include::modules/con_using-network-boot-to-provision-hosts.adoc[] include::modules/con_prerequisites-for-network-boot-provisioning.adoc[leveloffset=+1] @@ -10,4 +13,6 @@ include::modules/proc_creating-hosts-with-unattended-provisioning.adoc[leveloffs include::modules/proc_creating-hosts-with-uefi-http-boot-provisioning.adoc[leveloffset=+1] include::modules/proc_deploying-ssh-keys-during-provisioning.adoc[leveloffset=+1] + +ifdef::parent-context[:context: {parent-context}] :!using-network-boot-to-provision-hosts: From 2aca67095de845695975213ab1c87c98335de331 Mon Sep 17 00:00:00 2001 From: Zuzana Lena Ansorgova Date: Tue, 26 Nov 2024 06:46:45 +0100 Subject: [PATCH 04/28] fixup! Create a new guide for installer-based provisioning --- ...mbly_configuring-provisioning-content.adoc | 2 + ...assembly_introduction-to-provisioning.adoc | 9 +-- ...y_using-boot-disks-to-provision-hosts.adoc | 2 - ...using-network-boot-to-provision-hosts.adoc | 4 +- .../con_discovering-hosts-on-a-network.adoc | 2 +- .../modules/con_discovery-in-pxe-mode.adoc | 2 +- .../con_discovery-in-pxeless-mode.adoc | 2 +- ...equisites-for-bare-metal-provisioning.adoc | 6 +- ...uisites-for-network-boot-provisioning.adoc | 6 +- .../con_prerequisites-for-using-ipxe.adoc | 2 +- ...ud-instances-on-google-compute-engine.adoc | 2 +- ...s-on-microsoft-azure-resource-manager.adoc | 2 +- .../modules/con_provisioning-templates.adoc | 2 +- .../con_template-writing-reference.adoc | 2 +- ...using-network-boot-to-provision-hosts.adoc | 6 +- .../con_using-pxe-to-provision-hosts.adoc | 6 +- .../common/modules/proc_adding-a-subnet.adoc | 2 +- .../proc_cloning-provisioning-templates.adoc | 2 +- ...-the-security-token-validity-duration.adoc | 2 +- ...proc_creating-a-suse-operating-system.adoc | 2 +- ...eating-an-operating-system-for-debian.adoc | 2 +- .../proc_creating-compute-profiles.adoc | 4 +- .../proc_creating-discovery-rules.adoc | 2 +- ..._creating-hosts-from-discovered-hosts.adoc | 8 ++- ..._creating-hosts-with-pxe-provisioning.adoc | 60 +++++++++++++++++++ ...ating-hosts-with-pxeless-provisioning.adoc | 6 +- ...osts-with-uefi-http-boot-provisioning.adoc | 4 +- ...ng-hosts-with-unattended-provisioning.adoc | 2 +- .../proc_creating-provisioning-templates.adoc | 2 +- ...oc_customizing-the-discovery-pxe-boot.adoc | 4 +- ...eploying-ssh-keys-during-provisioning.adoc | 2 +- ...puppet-agent-during-host-provisioning.adoc | 2 +- ...n-imagebuilder-image-for-provisioning.adoc | 6 ++ .../ref_kinds-of-provisioning-templates.adoc | 2 +- .../ref_supported-cloud-providers.adoc | 2 +- ...ported-virtualization-infrastructures.adoc | 2 +- ...ip_configuring-templates-provisioning.adoc | 2 +- guides/doc-Provisioning_Hosts/master.adoc | 1 + 38 files changed, 123 insertions(+), 55 deletions(-) create mode 100644 guides/common/modules/proc_creating-hosts-with-pxe-provisioning.adoc diff --git a/guides/common/assembly_configuring-provisioning-content.adoc b/guides/common/assembly_configuring-provisioning-content.adoc index 492caece7da..9123ca67a7a 100644 --- a/guides/common/assembly_configuring-provisioning-content.adoc +++ b/guides/common/assembly_configuring-provisioning-content.adoc @@ -13,3 +13,5 @@ include::modules/proc_creating-an-installation-medium-for-ubuntu-22-04.adoc[leve include::modules/proc_provisioning-ubuntu-autoinstall-through-smart-proxies.adoc[leveloffset=+1] endif::[] + +include::modules/proc_configuring-the-security-token-validity-duration.adoc[leveloffset=+1] diff --git a/guides/common/assembly_introduction-to-provisioning.adoc b/guides/common/assembly_introduction-to-provisioning.adoc index 8c0a534773d..ff3b5365105 100644 --- a/guides/common/assembly_introduction-to-provisioning.adoc +++ b/guides/common/assembly_introduction-to-provisioning.adoc @@ -4,19 +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-cloud[] +ifdef::provisioning,provisioning-cloud[] include::modules/ref_supported-cloud-providers.adoc[leveloffset=+1] endif::[] -ifdef::provisioning-virtual[] +ifdef::provisioning,provisioning-virtual[] include::modules/ref_supported-virtualization-infrastructures.adoc[leveloffset=+1] endif::[] -ifdef::provisioning-netboot[] +ifdef::provisioning,provisioning-netboot[] include::modules/con_network-boot-provisioning-workflow.adoc[leveloffset=+1] include::modules/ref_required-boot-order-for-network-boot.adoc[leveloffset=+1] endif::[] - -// Network boot provisioning overview? -// Provisioning paths? diff --git a/guides/common/assembly_using-boot-disks-to-provision-hosts.adoc b/guides/common/assembly_using-boot-disks-to-provision-hosts.adoc index 8062313392e..7af55a6e27a 100644 --- a/guides/common/assembly_using-boot-disks-to-provision-hosts.adoc +++ b/guides/common/assembly_using-boot-disks-to-provision-hosts.adoc @@ -4,8 +4,6 @@ ifdef::context[:parent-context: {context}] include::modules/con_using-boot-disks-to-provision-hosts.adoc[] -include::modules/proc_configuring-the-security-token-validity-duration.adoc[leveloffset=+1] - include::modules/proc_creating-hosts-with-pxeless-provisioning.adoc[leveloffset=+1] include::modules/proc_deploying-ssh-keys-during-provisioning.adoc[leveloffset=+1] diff --git a/guides/common/assembly_using-network-boot-to-provision-hosts.adoc b/guides/common/assembly_using-network-boot-to-provision-hosts.adoc index df3bb07e8ad..298ebb08a4c 100644 --- a/guides/common/assembly_using-network-boot-to-provision-hosts.adoc +++ b/guides/common/assembly_using-network-boot-to-provision-hosts.adoc @@ -6,9 +6,7 @@ include::modules/con_using-network-boot-to-provision-hosts.adoc[] include::modules/con_prerequisites-for-network-boot-provisioning.adoc[leveloffset=+1] -include::modules/proc_configuring-the-security-token-validity-duration.adoc[leveloffset=+1] - -include::modules/proc_creating-hosts-with-unattended-provisioning.adoc[leveloffset=+1] +include::modules/proc_creating-hosts-with-pxe-provisioning.adoc[leveloffset=+1] include::modules/proc_creating-hosts-with-uefi-http-boot-provisioning.adoc[leveloffset=+1] diff --git a/guides/common/modules/con_discovering-hosts-on-a-network.adoc b/guides/common/modules/con_discovering-hosts-on-a-network.adoc index ca0fc3d7ee9..cdc30679a24 100644 --- a/guides/common/modules/con_discovering-hosts-on-a-network.adoc +++ b/guides/common/modules/con_discovering-hosts-on-a-network.adoc @@ -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}]] diff --git a/guides/common/modules/con_discovery-in-pxe-mode.adoc b/guides/common/modules/con_discovery-in-pxe-mode.adoc index 9593309ab12..08c55ed89ac 100644 --- a/guides/common/modules/con_discovery-in-pxe-mode.adoc +++ b/guides/common/modules/con_discovery-in-pxe-mode.adoc @@ -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. diff --git a/guides/common/modules/con_discovery-in-pxeless-mode.adoc b/guides/common/modules/con_discovery-in-pxeless-mode.adoc index 131a4796e3d..60b2472a61b 100644 --- a/guides/common/modules/con_discovery-in-pxeless-mode.adoc +++ b/guides/common/modules/con_discovery-in-pxeless-mode.adoc @@ -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. diff --git a/guides/common/modules/con_prerequisites-for-bare-metal-provisioning.adoc b/guides/common/modules/con_prerequisites-for-bare-metal-provisioning.adoc index 61b6fc26a44..ab66153743e 100644 --- a/guides/common/modules/con_prerequisites-for-bare-metal-provisioning.adoc +++ b/guides/common/modules/con_prerequisites-for-bare-metal-provisioning.adoc @@ -6,11 +6,11 @@ The requirements for bare-metal provisioning include: * A {SmartProxyServer} managing the network for bare-metal hosts. For unattended provisioning and discovery-based provisioning, {ProjectServer} requires PXE server settings. + -For more information about networking requirements, see xref:Configuring_Networking_{context}[]. +For more information about networking requirements, see xref:Configuring_Networking[]. + -For more information about the Discovery service, xref:discovering-hosts-on-a-network_{context}[]. +For more information about the Discovery service, xref:discovering-hosts-on-a-network[]. + * A bare-metal host or a blank VM. include::snip_prerequisites-common-compute-resource.adoc[] -For information about the security token for unattended and PXE-less provisioning, see xref:Configuring_the_Security_Token_Validity_Duration_{context}[]. +For information about the security token for unattended and PXE-less provisioning, see xref:Configuring_the_Security_Token_Validity_Duration[]. diff --git a/guides/common/modules/con_prerequisites-for-network-boot-provisioning.adoc b/guides/common/modules/con_prerequisites-for-network-boot-provisioning.adoc index fb8a15f46f7..9fcf73442ad 100644 --- a/guides/common/modules/con_prerequisites-for-network-boot-provisioning.adoc +++ b/guides/common/modules/con_prerequisites-for-network-boot-provisioning.adoc @@ -6,11 +6,11 @@ The requirements for network-boot provisioning include: * A {SmartProxyServer} managing the network for the network-booted machines. For unattended provisioning and discovery-based provisioning, {ProjectServer} requires PXE server settings. + -For more information about networking requirements, see xref:Configuring_Networking_{context}[]. +For more information about networking requirements, see xref:Configuring_Networking[]. + -For more information about the Discovery service, xref:discovering-hosts-on-a-network_{context}[]. +For more information about the Discovery service, xref:discovering-hosts-on-a-network[]. + * A bare-metal host or a blank VM. include::snip_prerequisites-common-compute-resource.adoc[] -For information about the security token for unattended and PXE-less provisioning, see xref:Configuring_the_Security_Token_Validity_Duration_{context}[]. +For information about the security token for unattended and PXE-less provisioning, see xref:Configuring_the_Security_Token_Validity_Duration[]. diff --git a/guides/common/modules/con_prerequisites-for-using-ipxe.adoc b/guides/common/modules/con_prerequisites-for-using-ipxe.adoc index 31324bd155f..e0405089bb8 100644 --- a/guides/common/modules/con_prerequisites-for-using-ipxe.adoc +++ b/guides/common/modules/con_prerequisites-for-using-ipxe.adoc @@ -7,7 +7,7 @@ You can use iPXE to boot virtual machines in the following cases: * Your virtual machines are in BIOS mode. In this case, you can configure PXELinux to chainboot iPXE and boot by using the HTTP protocol. -For booting virtual machines in UEFI mode by using HTTP, you can follow xref:Creating_Hosts_with_UEFI_HTTP_Boot_Provisioning_{context}[] instead. +For booting virtual machines in UEFI mode by using HTTP, you can follow xref:Creating_Hosts_with_UEFI_HTTP_Boot_Provisioning[] instead. ifndef::orcharhino,satellite[] .BIOS and UEFI support diff --git a/guides/common/modules/con_provisioning-cloud-instances-on-google-compute-engine.adoc b/guides/common/modules/con_provisioning-cloud-instances-on-google-compute-engine.adoc index f1b52d55bcf..47705ff0800 100644 --- a/guides/common/modules/con_provisioning-cloud-instances-on-google-compute-engine.adoc +++ b/guides/common/modules/con_provisioning-cloud-instances-on-google-compute-engine.adoc @@ -16,4 +16,4 @@ For more information, see https://cloud.google.com/compute/docs/access/iam[Compu For more information, see https://cloud.google.com/compute/docs/instances/managing-instance-access#enable_oslogin[Enabling or disabling OS Login] in the GCE documentation. * Optional: If you want to use Puppet with GCE hosts, navigate to *Administer* > *Settings* > *Puppet* and enable the `Use UUID for certificates` setting to configure Puppet to use consistent Puppet certificate IDs. * Based on your needs, associate a `finish` or `user_data` provisioning template with the operating system you want to use. -For more information, see {ProvisioningDocURL}provisioning-templates_provisioning[Provisioning Templates] in _{ProvisioningDocTitle}_. +For more information, see {ProvisioningDocURL}provisioning-templates[Provisioning Templates] in _{ProvisioningDocTitle}_. diff --git a/guides/common/modules/con_provisioning-cloud-instances-on-microsoft-azure-resource-manager.adoc b/guides/common/modules/con_provisioning-cloud-instances-on-microsoft-azure-resource-manager.adoc index eb9e7b31580..41d3f902db6 100644 --- a/guides/common/modules/con_provisioning-cloud-instances-on-microsoft-azure-resource-manager.adoc +++ b/guides/common/modules/con_provisioning-cloud-instances-on-microsoft-azure-resource-manager.adoc @@ -15,6 +15,6 @@ For more information, see https://docs.microsoft.com/en-us/azure/active-director For more information, see https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal[Use the portal to create an Azure AD application and service principal that can access resources] in the _Microsoft identity platform (Azure Active Directory for developers)_ documentation. * Optional: If you want to use Puppet with Azure hosts, navigate to *Administer* > *Settings* > *Puppet* and enable the `Use UUID for certificates` setting to configure Puppet to use consistent Puppet certificate IDs. * Based on your needs, associate a `finish` or `user_data` provisioning template with the operating system you want to use. -For more information about provisioning templates, see {ProvisioningDocURL}provisioning-templates_provisioning[Provisioning Templates]. +For more information about provisioning templates, see {ProvisioningDocURL}provisioning-templates[Provisioning Templates]. * Optional: If you want the virtual machine to use a static private IP address, create a subnet in {Project} with the *Network Address* field matching the Azure subnet address. * Before creating RHEL BYOS images, you must accept the image terms either in the Azure CLI or Portal so that the image can be used to create and manage virtual machines for your subscription. diff --git a/guides/common/modules/con_provisioning-templates.adoc b/guides/common/modules/con_provisioning-templates.adoc index d6734768381..0d493205e89 100644 --- a/guides/common/modules/con_provisioning-templates.adoc +++ b/guides/common/modules/con_provisioning-templates.adoc @@ -1,4 +1,4 @@ -[id="provisioning-templates_{context}"] +[id="provisioning-templates"] = Provisioning templates A provisioning template defines the way {ProjectServer} installs an operating system on a host. diff --git a/guides/common/modules/con_template-writing-reference.adoc b/guides/common/modules/con_template-writing-reference.adoc index 929f8419897..56af9bda133 100644 --- a/guides/common/modules/con_template-writing-reference.adoc +++ b/guides/common/modules/con_template-writing-reference.adoc @@ -5,7 +5,7 @@ Embedded Ruby (ERB) is a tool for generating text files based on templates that {ProjectName} uses ERB syntax in the following cases: Provisioning templates:: -For more information, see {ProvisioningDocURL}creating-provisioning-templates_provisioning[Creating Provisioning Templates] in _{ProvisioningDocTitle}_. +For more information, see {ProvisioningDocURL}creating-provisioning[Creating Provisioning Templates] in _{ProvisioningDocTitle}_. Remote execution job templates:: For more information, see xref:Configuring_and_Setting_Up_Remote_Jobs_{context}[]. diff --git a/guides/common/modules/con_using-network-boot-to-provision-hosts.adoc b/guides/common/modules/con_using-network-boot-to-provision-hosts.adoc index 02130f4c341..c751d2bc97c 100644 --- a/guides/common/modules/con_using-network-boot-to-provision-hosts.adoc +++ b/guides/common/modules/con_using-network-boot-to-provision-hosts.adoc @@ -10,7 +10,7 @@ New hosts are identified by a MAC address. Unattended Provisioning with Discovery:: New hosts use PXE boot to load the {Project} Discovery service. This service identifies hardware information about the host and lists it as an available host to provision. -For more information, see xref:discovering-hosts-on-a-network_{context}[]. +For more information, see xref:discovering-hosts-on-a-network[]. PXE-less Provisioning:: ifndef::satellite[] @@ -19,7 +19,7 @@ New hosts are provisioned with a boot disk or PXE-less discovery image that {Pro PXE-less Provisioning with Discovery:: New hosts use an ISO boot disk that loads the {Project} Discovery service. This service identifies hardware information about the host and lists it as an available host to provision. -For more information, see xref:discovery-in-pxeless-mode_{context}[]. +For more information, see xref:discovery-in-pxeless-mode[]. endif::[] ifdef::satellite[] New hosts are provisioned with a boot disk image that {ProjectServer} generates. @@ -29,7 +29,7 @@ ifndef::satellite[] [NOTE] ==== Discovery workflows are only available when the Discovery plugin is installed. -For more information, see xref:discovering-hosts-on-a-network_{context}[]. +For more information, see xref:discovering-hosts-on-a-network[]. ==== endif::[] diff --git a/guides/common/modules/con_using-pxe-to-provision-hosts.adoc b/guides/common/modules/con_using-pxe-to-provision-hosts.adoc index 31efe00c58e..fe434fd4581 100644 --- a/guides/common/modules/con_using-pxe-to-provision-hosts.adoc +++ b/guides/common/modules/con_using-pxe-to-provision-hosts.adoc @@ -10,7 +10,7 @@ New hosts are identified by a MAC address. Unattended Provisioning with Discovery:: New hosts use PXE boot to load the {Project} Discovery service. This service identifies hardware information about the host and lists it as an available host to provision. -For more information, see xref:discovering-hosts-on-a-network_{context}[]. +For more information, see xref:discovering-hosts-on-a-network[]. PXE-less Provisioning:: ifndef::satellite[] @@ -19,7 +19,7 @@ New hosts are provisioned with a boot disk or PXE-less discovery image that {Pro PXE-less Provisioning with Discovery:: New hosts use an ISO boot disk that loads the {Project} Discovery service. This service identifies hardware information about the host and lists it as an available host to provision. -For more information, see xref:discovery-in-pxeless-mode_{context}[]. +For more information, see xref:discovery-in-pxeless-mode[]. endif::[] ifdef::satellite[] New hosts are provisioned with a boot disk image that {ProjectServer} generates. @@ -29,7 +29,7 @@ ifndef::satellite[] [NOTE] ==== Discovery workflows are only available when the Discovery plugin is installed. -For more information, see xref:discovering-hosts-on-a-network_{context}[]. +For more information, see xref:discovering-hosts-on-a-network[]. ==== endif::[] diff --git a/guides/common/modules/proc_adding-a-subnet.adoc b/guides/common/modules/proc_adding-a-subnet.adoc index 0dc6c7dbb40..7d38084c8a5 100644 --- a/guides/common/modules/proc_adding-a-subnet.adoc +++ b/guides/common/modules/proc_adding-a-subnet.adoc @@ -17,7 +17,7 @@ To use the CLI instead of the {ProjectWebUI}, see the xref:cli-adding-a-subnet_{ . In the *Primary DNS server* field, enter a primary DNS for the subnet. . In the *Secondary DNS server*, enter a secondary DNS for the subnet. . From the *IPAM* list, select the method that you want to use for IP address management (IPAM). -For more information about IPAM, see xref:Configuring_Networking_{context}[]. +For more information about IPAM, see xref:Configuring_Networking[]. + . Enter the information for the IPAM method that you select. ifdef::satellite,orcharhino[] diff --git a/guides/common/modules/proc_cloning-provisioning-templates.adoc b/guides/common/modules/proc_cloning-provisioning-templates.adoc index a6ae4141283..75b0cf19ae3 100644 --- a/guides/common/modules/proc_cloning-provisioning-templates.adoc +++ b/guides/common/modules/proc_cloning-provisioning-templates.adoc @@ -1,4 +1,4 @@ -[id="cloning-provisioning-templates_{context}"] +[id="cloning-provisioning-templates"] = Cloning provisioning templates A provisioning template defines the way {ProjectServer} installs an operating system on a host. diff --git a/guides/common/modules/proc_configuring-the-security-token-validity-duration.adoc b/guides/common/modules/proc_configuring-the-security-token-validity-duration.adoc index d4676943ed5..abec2626633 100644 --- a/guides/common/modules/proc_configuring-the-security-token-validity-duration.adoc +++ b/guides/common/modules/proc_configuring-the-security-token-validity-duration.adoc @@ -1,4 +1,4 @@ -[id="Configuring_the_Security_Token_Validity_Duration_{context}"] +[id="Configuring_the_Security_Token_Validity_Duration"] = Configuring the security token validity duration When performing any kind of provisioning, as a security measure, {Project} automatically generates a unique token and adds this token to the {provision-script} URL in the PXE configuration file (PXELinux, Grub2). diff --git a/guides/common/modules/proc_creating-a-suse-operating-system.adoc b/guides/common/modules/proc_creating-a-suse-operating-system.adoc index d105f2b95c4..daa0396fab2 100644 --- a/guides/common/modules/proc_creating-a-suse-operating-system.adoc +++ b/guides/common/modules/proc_creating-a-suse-operating-system.adoc @@ -47,7 +47,7 @@ For more information, see {ProvisioningDocURL}creating-partition-tables_provisio . In the {ProjectWebUI}, navigate to *Hosts* > *Templates* > *Provisioning Templates* and click *Create Template*. The provisioning templates are stored in the `/usr/share/foreman/app/views/unattended/provisioning_templates/` directory on your {ProjectServer}. + -For more information, see {ProvisioningDocURL}provisioning-templates_provisioning[Provisioning Templates] in _{ProvisioningDocTitle}_. +For more information, see {ProvisioningDocURL}provisioning-templates[Provisioning Templates] in _{ProvisioningDocTitle}_. . In the {ProjectWebUI}, navigate to *Hosts* > *Provisioning Setup* > *Operating Systems*. . Select the previously created operating system. . On the *Partition Table* tab, select the previously created partition table. diff --git a/guides/common/modules/proc_creating-an-operating-system-for-debian.adoc b/guides/common/modules/proc_creating-an-operating-system-for-debian.adoc index 6a041c35a68..ed0b183a253 100644 --- a/guides/common/modules/proc_creating-an-operating-system-for-debian.adoc +++ b/guides/common/modules/proc_creating-an-operating-system-for-debian.adoc @@ -24,5 +24,5 @@ ifdef::orcharhino[] include::snip_host-parameters-for-orcharhino-clients.adoc[] endif::[] + -For more information, see xref:creating-provisioning-templates_{context}[]. +For more information, see xref:creating-provisioning-templates[]. . Click *Submit* to save the operating system entry for {DL}. diff --git a/guides/common/modules/proc_creating-compute-profiles.adoc b/guides/common/modules/proc_creating-compute-profiles.adoc index 0d95f764eaa..e1de9649b12 100644 --- a/guides/common/modules/proc_creating-compute-profiles.adoc +++ b/guides/common/modules/proc_creating-compute-profiles.adoc @@ -13,8 +13,8 @@ A default installation of {ProjectName} contains three predefined profiles: You can apply compute profiles to all supported compute resources: -* xref:supported-cloud-providers_{context}[] -* xref:supported-virtualization-infrastructures_{context}[] +* xref:supported-cloud-providers[] +* xref:supported-virtualization-infrastructures[] .Procedure . In the {ProjectWebUI}, navigate to *Infrastructure* > *Compute Profiles* and click *Create Compute Profile*. diff --git a/guides/common/modules/proc_creating-discovery-rules.adoc b/guides/common/modules/proc_creating-discovery-rules.adoc index b2a34711456..7d696e82d38 100644 --- a/guides/common/modules/proc_creating-discovery-rules.adoc +++ b/guides/common/modules/proc_creating-discovery-rules.adoc @@ -23,7 +23,7 @@ For example: `cpu_count > 8`. . In the *Hostname* field, enter the pattern to determine host names for multiple hosts. This uses the same ERB syntax that provisioning templates use. The host name can use the `@host` attribute for host-specific values and the `rand` macro for a random number or the `sequence_hostgroup_param_next` macro for incrementing the value. -For more information about provisioning templates, see xref:provisioning-templates_{context}[] and the API documentation. +For more information about provisioning templates, see xref:provisioning-templates[] and the API documentation. + * `myhost-<%= sequence_hostgroup_param_next("EL7/MyHostgroup", 10, "discovery_host") %>` * `myhost-<%= rand(99999) %>` diff --git a/guides/common/modules/proc_creating-hosts-from-discovered-hosts.adoc b/guides/common/modules/proc_creating-hosts-from-discovered-hosts.adoc index 4950b6ac272..de6bf372ada 100644 --- a/guides/common/modules/proc_creating-hosts-from-discovered-hosts.adoc +++ b/guides/common/modules/proc_creating-hosts-from-discovered-hosts.adoc @@ -13,7 +13,7 @@ include::snip_prerequisites-common-compute-resource.adoc[] * You have associated a `Discovery kexec`-kind template and `provisioning`-kind template with the operating system. For more information, see xref:Associating_Templates_with_Operating_Systems_{context}[]. -For information about the security tokens, see xref:Configuring_the_Security_Token_Validity_Duration_{context}[]. +For information about the security tokens, see xref:Configuring_the_Security_Token_Validity_Duration[]. .Procedure . In the {ProjectWebUI}, navigate to *Hosts* > *Discovered hosts*. @@ -69,4 +69,10 @@ $ hammer discovery provision \ This removes the host from the discovered host listing and creates a host entry with the provisioning settings. The Discovery image automatically reboots the host to PXE or initiates kernel execution. The host detects the DHCP service and starts installing the operating system. +ifdef::provisioning[] The rest of the process is identical to the normal PXE workflow described in xref:Creating_Hosts_with_Unattended_Provisioning_{context}[]. +endif::[] +ifdef::provisioning-netboot[] +The rest of the process is identical to the normal PXE workflow. +For more information, see xref:creating-hosts-with-pxe-provisioning[]. +endif::[] \ No newline at end of file diff --git a/guides/common/modules/proc_creating-hosts-with-pxe-provisioning.adoc b/guides/common/modules/proc_creating-hosts-with-pxe-provisioning.adoc new file mode 100644 index 00000000000..25b148e5170 --- /dev/null +++ b/guides/common/modules/proc_creating-hosts-with-pxe-provisioning.adoc @@ -0,0 +1,60 @@ +[id="creating-hosts-with-pxe-provisioning"] += Creating hosts with PXE provisioning + +Unattended provisioning is the simplest form of host provisioning. +You enter the host details on {ProjectServer} and boot your host. +{ProjectServer} automatically manages the PXE configuration, organizes networking services, and provides the operating system and configuration for the host. + +This method of provisioning hosts uses minimal interaction during the process. + +To use the CLI instead of the {ProjectWebUI}, see the xref:cli-creating-hosts-with-unattended-provisioning_{context}[]. + +.Procedure +include::snip_steps-create-a-host-tab-host.adoc[] +include::snip_steps-create-a-host-tab-interfaces.adoc[] +. Click the *Operating System* tab, and verify that all fields contain values. +Confirm each aspect of the operating system. +. Optional: Click *Resolve* in *Provisioning template* to check the new host can identify the right provisioning templates to use. ++ +For more information about associating provisioning templates, see xref:provisioning-templates[]. +ifdef::katello,satellite,orcharhino[] +. Click the *Parameters* tab, and ensure that a parameter exists that provides an activation key. +If not, add an activation key. +endif::[] +. Click *Submit* to save the host details. ++ +For more information about network interfaces, see {ManagingHostsDocURL}Adding_Network_Interfaces_managing-hosts[Adding network interfaces] in _{ManagingHostsDocTitle}_. + +This creates the host entry and the relevant provisioning settings. +This also includes creating the necessary directories and files for PXE booting the bare-metal host. +If you start the physical host and set its boot mode to PXE, the host detects the DHCP service of {ProjectServer}'s integrated {SmartProxy}, receives HTTP endpoint of the Kickstart tree and installs the operating system. + +ifdef::katello,satellite,orcharhino[] +When the installation completes, the host also registers to {ProjectServer} using the activation key and installs the necessary configuration and management tools from the {project-client-name} repository. +endif::[] + +[id="cli-creating-hosts-with-unattended-provisioning_{context}"] +.CLI procedure +. Create the host with the `hammer host create` command: ++ +[options="nowrap" subs="+quotes"] +---- +# hammer host create \ +--build true \ +--enabled true \ +--hostgroup "_My_Host_Group_" \ +--location "_My_Location_" \ +--mac "_My_MAC_Address_" \ +--managed true \ +--name "_My_Host_Name_" \ +--organization "_My_Organization_" +---- +. Ensure the network interface options are set using the `hammer host interface update` command: ++ +---- +# hammer host interface update \ +--host "_My_Host_Name_" \ +--managed true \ +--primary true \ +--provision true +---- diff --git a/guides/common/modules/proc_creating-hosts-with-pxeless-provisioning.adoc b/guides/common/modules/proc_creating-hosts-with-pxeless-provisioning.adoc index 5270ed833ba..7f315df906e 100644 --- a/guides/common/modules/proc_creating-hosts-with-pxeless-provisioning.adoc +++ b/guides/common/modules/proc_creating-hosts-with-pxeless-provisioning.adoc @@ -7,7 +7,7 @@ This is also known as PXE-less provisioning and involves generating a boot ISO t Using this ISO, the host can connect to {ProjectServer}, boot the installation media, and install the operating system. {Project} also provides a PXE-less discovery service that operates without PXE-based services, such as DHCP and TFTP. -For more information, see xref:discovery-in-pxeless-mode_{context}[]. +For more information, see xref:discovery-in-pxeless-mode[]. .Boot ISO types @@ -59,7 +59,7 @@ endif::[] ifndef::satellite[] *Host image* and *Full host image* contain provisioning tokens, therefore the generated image has limited lifespan. endif::[] -For more information about configuring security tokens, read xref:Configuring_the_Security_Token_Validity_Duration_{context}[]. +For more information about configuring security tokens, read xref:Configuring_the_Security_Token_Validity_Duration[]. To use the CLI instead of the {ProjectWebUI}, see the xref:cli-creating-hosts-with-pxe-less-provisioning_{context}[]. @@ -70,7 +70,7 @@ include::snip_steps-create-a-host-tab-interfaces.adoc[] Confirm each aspect of the operating system. . Click *Resolve* in *Provisioning Templates* to check the new host can identify the right provisioning templates to use. + -For more information about associating provisioning templates, see xref:provisioning-templates_{context}[]. +For more information about associating provisioning templates, see xref:provisioning-templates[]. ifdef::katello,satellite,orcharhino[] . Click the *Parameters* tab, and ensure that a parameter exists that provides an activation key. If not, add an activation key. diff --git a/guides/common/modules/proc_creating-hosts-with-uefi-http-boot-provisioning.adoc b/guides/common/modules/proc_creating-hosts-with-uefi-http-boot-provisioning.adoc index 2251724cd1a..a91f28e8207 100644 --- a/guides/common/modules/proc_creating-hosts-with-uefi-http-boot-provisioning.adoc +++ b/guides/common/modules/proc_creating-hosts-with-uefi-http-boot-provisioning.adoc @@ -1,4 +1,4 @@ -[id="Creating_Hosts_with_UEFI_HTTP_Boot_Provisioning_{context}"] +[id="Creating_Hosts_with_UEFI_HTTP_Boot_Provisioning"] = Creating hosts with UEFI HTTP boot provisioning You can provision hosts from {Project} using the UEFI HTTP Boot. @@ -43,7 +43,7 @@ Confirm each aspect of the operating system. . From the *PXE Loader* list, select *Grub2 UEFI HTTP*. . Optional: Click *Resolve* in *Provisioning template* to check the new host can identify the right provisioning templates to use. + -For more information about associating provisioning templates, see xref:creating-provisioning-templates_{context}[]. +For more information about associating provisioning templates, see xref:creating-provisioning-templates[]. ifdef::katello,satellite,orcharhino[] . Click the *Parameters* tab, and ensure that a parameter exists that provides an activation key. If not, add an activation key. diff --git a/guides/common/modules/proc_creating-hosts-with-unattended-provisioning.adoc b/guides/common/modules/proc_creating-hosts-with-unattended-provisioning.adoc index ceb3abbab6e..980aaefc407 100644 --- a/guides/common/modules/proc_creating-hosts-with-unattended-provisioning.adoc +++ b/guides/common/modules/proc_creating-hosts-with-unattended-provisioning.adoc @@ -16,7 +16,7 @@ include::snip_steps-create-a-host-tab-interfaces.adoc[] Confirm each aspect of the operating system. . Optional: Click *Resolve* in *Provisioning template* to check the new host can identify the right provisioning templates to use. + -For more information about associating provisioning templates, see xref:provisioning-templates_{context}[]. +For more information about associating provisioning templates, see xref:provisioning-templates[]. ifdef::katello,satellite,orcharhino[] . Click the *Parameters* tab, and ensure that a parameter exists that provides an activation key. If not, add an activation key. diff --git a/guides/common/modules/proc_creating-provisioning-templates.adoc b/guides/common/modules/proc_creating-provisioning-templates.adoc index 1ab4f83f391..3485138daab 100644 --- a/guides/common/modules/proc_creating-provisioning-templates.adoc +++ b/guides/common/modules/proc_creating-provisioning-templates.adoc @@ -1,4 +1,4 @@ -[id="creating-provisioning-templates_{context}"] +[id="creating-provisioning-templates"] = Creating provisioning templates A provisioning template defines the way {ProjectServer} installs an operating system on a host. diff --git a/guides/common/modules/proc_customizing-the-discovery-pxe-boot.adoc b/guides/common/modules/proc_customizing-the-discovery-pxe-boot.adoc index 75cf3908509..bd6c1a6ae8f 100644 --- a/guides/common/modules/proc_customizing-the-discovery-pxe-boot.adoc +++ b/guides/common/modules/proc_customizing-the-discovery-pxe-boot.adoc @@ -32,10 +32,10 @@ For information about the kernel parameters, see xref:kernel-parameters-for-disc .Procedure . In the {ProjectWebUI}, navigate to *Hosts* > *Templates* > *Provisioning Templates*. . Clone and edit the snippet you want to customize. -For more information, see xref:cloning-provisioning-templates_{context}[]. +For more information, see xref:cloning-provisioning-templates[]. . Clone and edit the template that contains the original snippet. Include your custom snippet instead of the original snippet. -For more information, see xref:cloning-provisioning-templates_{context}[]. +For more information, see xref:cloning-provisioning-templates[]. . Navigate to *Administer* > *Settings*. . Click the *Provisioning* tab. . In the appropriate *Global default PXE\* template* setting, select your custom template. diff --git a/guides/common/modules/proc_deploying-ssh-keys-during-provisioning.adoc b/guides/common/modules/proc_deploying-ssh-keys-during-provisioning.adoc index 6704dd05339..d8fd8baced3 100644 --- a/guides/common/modules/proc_deploying-ssh-keys-during-provisioning.adoc +++ b/guides/common/modules/proc_deploying-ssh-keys-during-provisioning.adoc @@ -7,7 +7,7 @@ For information on adding SSH keys to a user, see {AdministeringDocURL}Managing_ .Procedure . In the {ProjectWebUI}, navigate to *Hosts* > *Templates* > *Provisioning Templates*. . Create a provisioning template, or clone and edit an existing template. -For more information, see xref:creating-provisioning-templates_{context}[]. +For more information, see xref:creating-provisioning-templates[]. . In the template, click the *Template* tab. . In the *Template editor* field, add the `create_users` snippet to the `%post` section: + diff --git a/guides/common/modules/proc_installing-and-configuring-puppet-agent-during-host-provisioning.adoc b/guides/common/modules/proc_installing-and-configuring-puppet-agent-during-host-provisioning.adoc index edb94a7f21f..6d60407aa78 100644 --- a/guides/common/modules/proc_installing-and-configuring-puppet-agent-during-host-provisioning.adoc +++ b/guides/common/modules/proc_installing-and-configuring-puppet-agent-during-host-provisioning.adoc @@ -32,7 +32,7 @@ endif::[] .Procedure . Navigate to *Hosts* > *Templates* > *Provisioning Templates*. . Select a provisioning template depending on your host provisioning method. -For more information, see {ProvisioningDocURL}kinds-of-provisioning-templates_provisioning[Kinds of Provisioning Templates] in _{ProvisioningDocTitle}_. +For more information, see {ProvisioningDocURL}kinds-of-provisioning-templates[Kinds of Provisioning Templates] in _{ProvisioningDocTitle}_. ifndef::katello,orcharhino,satellite[] . Ensure the `puppetlabs_repo` snippet is included as follows: + diff --git a/guides/common/modules/proc_using-an-imagebuilder-image-for-provisioning.adoc b/guides/common/modules/proc_using-an-imagebuilder-image-for-provisioning.adoc index 9d452cbbd95..011b4667c21 100644 --- a/guides/common/modules/proc_using-an-imagebuilder-image-for-provisioning.adoc +++ b/guides/common/modules/proc_using-an-imagebuilder-image-for-provisioning.adoc @@ -30,6 +30,12 @@ endif::[] . In the *Value* field, enter the absolute path or a relative path in the following format `custom/_product_/_repository_/_image_name_` that points to the exact location where you store the image. . Click *Submit* to save your changes. +ifdef::provisioning[] You can use this image for bare-metal provisioning and provisioning using a compute resource. For more information about bare-metal provisioning, see xref:Using_PXE_to_Provision_Hosts_{context}[]. For more information about provisioning with different compute resources, see the relevant chapter for the compute resource that you want to use. +endif::[] +ifdef::provisioning-netboot[] +You can use this image for network-boot provisioning. +For more information, see xref:using-network-boot-to-provision-hosts[]. +endif::[] diff --git a/guides/common/modules/ref_kinds-of-provisioning-templates.adoc b/guides/common/modules/ref_kinds-of-provisioning-templates.adoc index 5b2a23f47eb..0c26595df69 100644 --- a/guides/common/modules/ref_kinds-of-provisioning-templates.adoc +++ b/guides/common/modules/ref_kinds-of-provisioning-templates.adoc @@ -1,4 +1,4 @@ -[id="kinds-of-provisioning-templates_{context}"] +[id="kinds-of-provisioning-templates"] = Kinds of provisioning templates There are various kinds of provisioning templates: diff --git a/guides/common/modules/ref_supported-cloud-providers.adoc b/guides/common/modules/ref_supported-cloud-providers.adoc index 16d16936880..7bd970ddb9e 100644 --- a/guides/common/modules/ref_supported-cloud-providers.adoc +++ b/guides/common/modules/ref_supported-cloud-providers.adoc @@ -1,4 +1,4 @@ -[id="supported-cloud-providers_{context}"] +[id="supported-cloud-providers"] = Supported cloud providers You can connect the following cloud providers as compute resources to {Project}: diff --git a/guides/common/modules/ref_supported-virtualization-infrastructures.adoc b/guides/common/modules/ref_supported-virtualization-infrastructures.adoc index 7a36054f1de..008ad357695 100644 --- a/guides/common/modules/ref_supported-virtualization-infrastructures.adoc +++ b/guides/common/modules/ref_supported-virtualization-infrastructures.adoc @@ -1,4 +1,4 @@ -[id="supported-virtualization-infrastructures_{context}"] +[id="supported-virtualization-infrastructures"] = Supported virtualization infrastructures You can connect the following virtualization infrastructures as compute resources to {Project}: diff --git a/guides/common/modules/snip_configuring-templates-provisioning.adoc b/guides/common/modules/snip_configuring-templates-provisioning.adoc index d43c942b31d..c2efbe4249f 100644 --- a/guides/common/modules/snip_configuring-templates-provisioning.adoc +++ b/guides/common/modules/snip_configuring-templates-provisioning.adoc @@ -2,5 +2,5 @@ ==== You can use the original templates shipped in {Project} as described below. If you require modification to an original template, clone the template, edit the clone, and associate the clone instead of the original template. -For more information, see xref:cloning-provisioning-templates_{context}[]. +For more information, see xref:cloning-provisioning-templates[]. ==== diff --git a/guides/doc-Provisioning_Hosts/master.adoc b/guides/doc-Provisioning_Hosts/master.adoc index 10a72201c8e..bf7ec405f4b 100644 --- a/guides/doc-Provisioning_Hosts/master.adoc +++ b/guides/doc-Provisioning_Hosts/master.adoc @@ -1,6 +1,7 @@ include::common/attributes.adoc[] include::common/header.adoc[] :context: provisioning +:provisioning: = {ProvisioningDocTitle} From f0a683c2c3a8ddc24b06cc5c28f4b4ff723881b4 Mon Sep 17 00:00:00 2001 From: Zuzana Lena Ansorgova Date: Tue, 3 Dec 2024 19:34:56 +0100 Subject: [PATCH 05/28] Rename the guide --- guides/common/attributes-base.adoc | 2 +- guides/common/attributes-satellite.adoc | 2 +- guides/common/attributes-titles.adoc | 2 +- .../Makefile | 0 .../common | 0 .../docinfo.html | 0 .../docinfo.xml | 0 .../images/common | 0 .../master.adoc | 0 9 files changed, 3 insertions(+), 3 deletions(-) rename guides/{doc-Provisioning_Netboot => doc-Provisioning_Installer}/Makefile (100%) rename guides/{doc-Provisioning_Netboot => doc-Provisioning_Installer}/common (100%) rename guides/{doc-Provisioning_Netboot => doc-Provisioning_Installer}/docinfo.html (100%) rename guides/{doc-Provisioning_Netboot => doc-Provisioning_Installer}/docinfo.xml (100%) rename guides/{doc-Provisioning_Netboot => doc-Provisioning_Installer}/images/common (100%) rename guides/{doc-Provisioning_Netboot => doc-Provisioning_Installer}/master.adoc (100%) diff --git a/guides/common/attributes-base.adoc b/guides/common/attributes-base.adoc index 83b54df3344..120c0b0cae5 100644 --- a/guides/common/attributes-base.adoc +++ b/guides/common/attributes-base.adoc @@ -17,7 +17,7 @@ :ManagingSecurityDocURL: {BaseURL}Managing_Security_Compliance/{BaseFilenameURL}# :MonitoringDocURL: {BaseURL}Monitoring_Project/{BaseFilenameURL}# :PlanningDocURL: {BaseURL}Planning_for_Project/{BaseFilenameURL}# -:ProvisioningNetbootDocURL: {BaseURL}Provisioning_Netboot/{BaseFilenameURL}# +:ProvisioningInstallerDocURL: {BaseURL}Provisioning_Installer/{BaseFilenameURL}# :ProvisioningDocURL: {BaseURL}Provisioning_Hosts/{BaseFilenameURL}# :ReleaseNotesDocURL: {BaseURL}Release_Notes/{BaseFilenameURL}# :TuningDocURL: {BaseURL}Tuning_Performance/{BaseFilenameURL}# diff --git a/guides/common/attributes-satellite.adoc b/guides/common/attributes-satellite.adoc index ba6aef1d1c3..44079666d40 100644 --- a/guides/common/attributes-satellite.adoc +++ b/guides/common/attributes-satellite.adoc @@ -28,7 +28,7 @@ :MonitoringDocURL: {BaseURL}monitoring_satellite_performance/index# :PlanningDocURL: {BaseURL}overview_concepts_and_deployment_considerations/index# :ProvisioningDocURL: {BaseURL}provisioning_hosts/index# -:ProvisioningNetbootDocURL: {BaseURL}provisioning_machines_by_using_network_boot/index# +:ProvisioningInstallerDocURL: {BaseURL}provisioning_hosts_by_using_installer_automation/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# diff --git a/guides/common/attributes-titles.adoc b/guides/common/attributes-titles.adoc index 859f88a62ba..a09ab114c93 100644 --- a/guides/common/attributes-titles.adoc +++ b/guides/common/attributes-titles.adoc @@ -24,7 +24,7 @@ :MonitoringDocTitle: Monitoring {Project} performance :PlanningDocTitle: Planning for {ProjectName} :ProvisioningDocTitle: Provisioning hosts -:ProvisioningNetbootDocTitle: Provisioning machines by using network boot +:ProvisioningInstallerDocTitle: Provisioning hosts by using installer automation :QuickStartDocTitle: Quick start guide for {Project} on {install-on-os} :ReleaseNotesDocTitle: Release notes :TuningDocTitle: Tuning performance of {ProjectName} diff --git a/guides/doc-Provisioning_Netboot/Makefile b/guides/doc-Provisioning_Installer/Makefile similarity index 100% rename from guides/doc-Provisioning_Netboot/Makefile rename to guides/doc-Provisioning_Installer/Makefile diff --git a/guides/doc-Provisioning_Netboot/common b/guides/doc-Provisioning_Installer/common similarity index 100% rename from guides/doc-Provisioning_Netboot/common rename to guides/doc-Provisioning_Installer/common diff --git a/guides/doc-Provisioning_Netboot/docinfo.html b/guides/doc-Provisioning_Installer/docinfo.html similarity index 100% rename from guides/doc-Provisioning_Netboot/docinfo.html rename to guides/doc-Provisioning_Installer/docinfo.html diff --git a/guides/doc-Provisioning_Netboot/docinfo.xml b/guides/doc-Provisioning_Installer/docinfo.xml similarity index 100% rename from guides/doc-Provisioning_Netboot/docinfo.xml rename to guides/doc-Provisioning_Installer/docinfo.xml diff --git a/guides/doc-Provisioning_Netboot/images/common b/guides/doc-Provisioning_Installer/images/common similarity index 100% rename from guides/doc-Provisioning_Netboot/images/common rename to guides/doc-Provisioning_Installer/images/common diff --git a/guides/doc-Provisioning_Netboot/master.adoc b/guides/doc-Provisioning_Installer/master.adoc similarity index 100% rename from guides/doc-Provisioning_Netboot/master.adoc rename to guides/doc-Provisioning_Installer/master.adoc From 9d2bece74e70e2311d8fd278f88441a18b40373d Mon Sep 17 00:00:00 2001 From: Zuzana Lena Ansorgova Date: Tue, 3 Dec 2024 19:35:21 +0100 Subject: [PATCH 06/28] Update IDs, xrefs, and links --- guides/common/modules/con_configuring-networking.adoc | 2 +- guides/common/modules/con_infoblox-limitations.adoc | 2 +- .../con_prerequisites-for-bare-metal-provisioning.adoc | 4 ++-- .../con_prerequisites-for-network-boot-provisioning.adoc | 4 ++-- .../con_provisioning-cloud-instances-on-openstack.adoc | 2 +- .../con_provisioning-virtual-machines-on-kubevirt.adoc | 2 +- .../modules/con_provisioning-virtual-machines-on-kvm.adoc | 2 +- .../modules/con_provisioning-virtual-machines-on-ovirt.adoc | 2 +- guides/common/modules/proc_adding-a-subnet.adoc | 2 +- ...proc_configuring-the-security-token-validity-duration.adoc | 2 +- .../modules/proc_creating-hosts-from-discovered-hosts.adoc | 2 +- .../proc_creating-hosts-with-pxeless-provisioning.adoc | 2 +- .../snip_prerequisite-networking-for-provisioning.adoc | 2 +- 13 files changed, 15 insertions(+), 15 deletions(-) diff --git a/guides/common/modules/con_configuring-networking.adoc b/guides/common/modules/con_configuring-networking.adoc index ca35a6c5d99..0dd83042026 100644 --- a/guides/common/modules/con_configuring-networking.adoc +++ b/guides/common/modules/con_configuring-networking.adoc @@ -1,4 +1,4 @@ -[id="Configuring_Networking"] +[id="configuring-networking"] = Configuring networking Each provisioning type requires some network configuration. diff --git a/guides/common/modules/con_infoblox-limitations.adoc b/guides/common/modules/con_infoblox-limitations.adoc index 0a6c1cca137..2cc35a15baa 100644 --- a/guides/common/modules/con_infoblox-limitations.adoc +++ b/guides/common/modules/con_infoblox-limitations.adoc @@ -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[Configuring networking] in _{ProvisioningDocTitle}_. +For more information, see {ProvisioningDocURL}configuring-networking[Configuring networking] in _{ProvisioningDocTitle}_. {Project} IPAM feature cannot be integrated with Infoblox. diff --git a/guides/common/modules/con_prerequisites-for-bare-metal-provisioning.adoc b/guides/common/modules/con_prerequisites-for-bare-metal-provisioning.adoc index ab66153743e..d836269f08d 100644 --- a/guides/common/modules/con_prerequisites-for-bare-metal-provisioning.adoc +++ b/guides/common/modules/con_prerequisites-for-bare-metal-provisioning.adoc @@ -6,11 +6,11 @@ The requirements for bare-metal provisioning include: * A {SmartProxyServer} managing the network for bare-metal hosts. For unattended provisioning and discovery-based provisioning, {ProjectServer} requires PXE server settings. + -For more information about networking requirements, see xref:Configuring_Networking[]. +For more information about networking requirements, see xref:configuring-networking[]. + For more information about the Discovery service, xref:discovering-hosts-on-a-network[]. + * A bare-metal host or a blank VM. include::snip_prerequisites-common-compute-resource.adoc[] -For information about the security token for unattended and PXE-less provisioning, see xref:Configuring_the_Security_Token_Validity_Duration[]. +For information about the security token for unattended and PXE-less provisioning, see xref:configuring-the-security-token-validity-duration[]. diff --git a/guides/common/modules/con_prerequisites-for-network-boot-provisioning.adoc b/guides/common/modules/con_prerequisites-for-network-boot-provisioning.adoc index 9fcf73442ad..f46321c6084 100644 --- a/guides/common/modules/con_prerequisites-for-network-boot-provisioning.adoc +++ b/guides/common/modules/con_prerequisites-for-network-boot-provisioning.adoc @@ -6,11 +6,11 @@ The requirements for network-boot provisioning include: * A {SmartProxyServer} managing the network for the network-booted machines. For unattended provisioning and discovery-based provisioning, {ProjectServer} requires PXE server settings. + -For more information about networking requirements, see xref:Configuring_Networking[]. +For more information about networking requirements, see xref:configuring-networking[]. + For more information about the Discovery service, xref:discovering-hosts-on-a-network[]. + * A bare-metal host or a blank VM. include::snip_prerequisites-common-compute-resource.adoc[] -For information about the security token for unattended and PXE-less provisioning, see xref:Configuring_the_Security_Token_Validity_Duration[]. +For information about the security token for unattended and PXE-less provisioning, see xref:configuring-the-security-token-validity-duration[]. diff --git a/guides/common/modules/con_provisioning-cloud-instances-on-openstack.adoc b/guides/common/modules/con_provisioning-cloud-instances-on-openstack.adoc index 4a6a923fa6b..ef3287270d5 100644 --- a/guides/common/modules/con_provisioning-cloud-instances-on-openstack.adoc +++ b/guides/common/modules/con_provisioning-cloud-instances-on-openstack.adoc @@ -8,7 +8,7 @@ In {Project}, you can interact with {OpenStack} REST API to create cloud instanc .Prerequisites include::snip_prerequisites-common-compute-resource.adoc[] * A {SmartProxyServer} managing a network in your OpenStack environment. -For more information, see {ProvisioningDocURL}Configuring_Networking[Configuring Networking] in _{ProvisioningDocTitle}_. +For more information, see {ProvisioningDocURL}configuring-networking[Configuring Networking] in _{ProvisioningDocTitle}_. * An image added to OpenStack Image Storage (glance) service for image-based provisioning. ifndef::orcharhino[] For more information, see the {RHDocsBaseURL}red_hat_openstack_platform/16.0/html/instances_and_images_guide/index[{OpenStack} _Instances and Images Guide_]. diff --git a/guides/common/modules/con_provisioning-virtual-machines-on-kubevirt.adoc b/guides/common/modules/con_provisioning-virtual-machines-on-kubevirt.adoc index b26044a621a..5f4fbd9abfe 100644 --- a/guides/common/modules/con_provisioning-virtual-machines-on-kubevirt.adoc +++ b/guides/common/modules/con_provisioning-virtual-machines-on-kubevirt.adoc @@ -25,7 +25,7 @@ include::snip_prerequisites-common-compute-resource.adoc[] * You must have `cluster-admin` permissions for the {Kubernetes} cluster. * A {SmartProxyServer} managing a network on the {Kubernetes} cluster. Ensure that no other DHCP services run on this network to avoid conflicts with {SmartProxyServer}. -For more information about network service configuration for {SmartProxyServers}, see {ProvisioningDocURL}Configuring_Networking[Configuring Networking] in _{ProvisioningDocTitle}_. +For more information about network service configuration for {SmartProxyServers}, see {ProvisioningDocURL}configuring-networking[Configuring Networking] in _{ProvisioningDocTitle}_. .Additional resources * For a list of permissions a non-admin user requires to provision hosts, see xref:permissions-required-to-provision-hosts_provisioning[]. diff --git a/guides/common/modules/con_provisioning-virtual-machines-on-kvm.adoc b/guides/common/modules/con_provisioning-virtual-machines-on-kvm.adoc index e2a0337e4d4..6c21d967852 100644 --- a/guides/common/modules/con_provisioning-virtual-machines-on-kvm.adoc +++ b/guides/common/modules/con_provisioning-virtual-machines-on-kvm.adoc @@ -13,7 +13,7 @@ You can use KVM provisioning to create hosts over a network connection or from a include::snip_prerequisites-common-compute-resource.adoc[] * A {SmartProxyServer} managing a network on the KVM server. Ensure no other DHCP services run on this network to avoid conflicts with {SmartProxyServer}. -For more information about network service configuration for {SmartProxyServers}, see {ProvisioningDocURL}Configuring_Networking[Configuring Networking] in _{ProvisioningDocTitle}_. +For more information about network service configuration for {SmartProxyServers}, see {ProvisioningDocURL}configuring-networking[Configuring Networking] in _{ProvisioningDocTitle}_. ifdef::satellite[] * A {RHEL} server running KVM virtualization tools (libvirt daemon). For more information, see the {RHELDocsBaseURL}8/html/configuring_and_managing_virtualization/index[_{RHEL}{nbsp}8 Configuring and managing virtualization_]. diff --git a/guides/common/modules/con_provisioning-virtual-machines-on-ovirt.adoc b/guides/common/modules/con_provisioning-virtual-machines-on-ovirt.adoc index 21b8c140921..24861d21294 100644 --- a/guides/common/modules/con_provisioning-virtual-machines-on-ovirt.adoc +++ b/guides/common/modules/con_provisioning-virtual-machines-on-ovirt.adoc @@ -15,7 +15,7 @@ This method does not require {Project} to connect to the provisioned virtual mac include::snip_prerequisites-common-compute-resource.adoc[] * A {SmartProxyServer} managing a logical network on the {oVirt} environment. Ensure no other DHCP services run on this network to avoid conflicts with {SmartProxyServer}. -For more information, see {ProvisioningDocURL}Configuring_Networking[Configuring Networking] in _{ProvisioningDocTitle}_. +For more information, see {ProvisioningDocURL}configuring-networking[Configuring Networking] in _{ProvisioningDocTitle}_. * An existing template, other than the `blank` template, if you want to use image-based provisioning. For more information about creating templates for virtual machines, see ifdef::satellite[] diff --git a/guides/common/modules/proc_adding-a-subnet.adoc b/guides/common/modules/proc_adding-a-subnet.adoc index 7d38084c8a5..563ea19ac07 100644 --- a/guides/common/modules/proc_adding-a-subnet.adoc +++ b/guides/common/modules/proc_adding-a-subnet.adoc @@ -17,7 +17,7 @@ To use the CLI instead of the {ProjectWebUI}, see the xref:cli-adding-a-subnet_{ . In the *Primary DNS server* field, enter a primary DNS for the subnet. . In the *Secondary DNS server*, enter a secondary DNS for the subnet. . From the *IPAM* list, select the method that you want to use for IP address management (IPAM). -For more information about IPAM, see xref:Configuring_Networking[]. +For more information about IPAM, see xref:configuring-networking[]. + . Enter the information for the IPAM method that you select. ifdef::satellite,orcharhino[] diff --git a/guides/common/modules/proc_configuring-the-security-token-validity-duration.adoc b/guides/common/modules/proc_configuring-the-security-token-validity-duration.adoc index abec2626633..7511a86db3b 100644 --- a/guides/common/modules/proc_configuring-the-security-token-validity-duration.adoc +++ b/guides/common/modules/proc_configuring-the-security-token-validity-duration.adoc @@ -1,4 +1,4 @@ -[id="Configuring_the_Security_Token_Validity_Duration"] +[id="configuring-the-security-token-validity-duration"] = Configuring the security token validity duration When performing any kind of provisioning, as a security measure, {Project} automatically generates a unique token and adds this token to the {provision-script} URL in the PXE configuration file (PXELinux, Grub2). diff --git a/guides/common/modules/proc_creating-hosts-from-discovered-hosts.adoc b/guides/common/modules/proc_creating-hosts-from-discovered-hosts.adoc index de6bf372ada..e1513c38813 100644 --- a/guides/common/modules/proc_creating-hosts-from-discovered-hosts.adoc +++ b/guides/common/modules/proc_creating-hosts-from-discovered-hosts.adoc @@ -13,7 +13,7 @@ include::snip_prerequisites-common-compute-resource.adoc[] * You have associated a `Discovery kexec`-kind template and `provisioning`-kind template with the operating system. For more information, see xref:Associating_Templates_with_Operating_Systems_{context}[]. -For information about the security tokens, see xref:Configuring_the_Security_Token_Validity_Duration[]. +For information about the security tokens, see xref:configuring-the-security-token-validity-duration[]. .Procedure . In the {ProjectWebUI}, navigate to *Hosts* > *Discovered hosts*. diff --git a/guides/common/modules/proc_creating-hosts-with-pxeless-provisioning.adoc b/guides/common/modules/proc_creating-hosts-with-pxeless-provisioning.adoc index 7f315df906e..8f65b969065 100644 --- a/guides/common/modules/proc_creating-hosts-with-pxeless-provisioning.adoc +++ b/guides/common/modules/proc_creating-hosts-with-pxeless-provisioning.adoc @@ -59,7 +59,7 @@ endif::[] ifndef::satellite[] *Host image* and *Full host image* contain provisioning tokens, therefore the generated image has limited lifespan. endif::[] -For more information about configuring security tokens, read xref:Configuring_the_Security_Token_Validity_Duration[]. +For more information about configuring security tokens, read xref:configuring-the-security-token-validity-duration[]. To use the CLI instead of the {ProjectWebUI}, see the xref:cli-creating-hosts-with-pxe-less-provisioning_{context}[]. diff --git a/guides/common/modules/snip_prerequisite-networking-for-provisioning.adoc b/guides/common/modules/snip_prerequisite-networking-for-provisioning.adoc index 688dc72969f..67334b9e396 100644 --- a/guides/common/modules/snip_prerequisite-networking-for-provisioning.adoc +++ b/guides/common/modules/snip_prerequisite-networking-for-provisioning.adoc @@ -1,2 +1,2 @@ * Configure a domain and subnet on {Project}. -For more information about networking requirements, see xref:Configuring_Networking[]. +For more information about networking requirements, see xref:configuring-networking[]. From 2766f7c5c000debfe612bd0a19d7149b597d7028 Mon Sep 17 00:00:00 2001 From: Zuzana Lena Ansorgova Date: Tue, 3 Dec 2024 19:38:18 +0100 Subject: [PATCH 07/28] Update context and guide attributes --- guides/common/assembly_introduction-to-provisioning.adoc | 2 +- .../modules/proc_creating-hosts-from-discovered-hosts.adoc | 2 +- .../proc_using-an-imagebuilder-image-for-provisioning.adoc | 2 +- guides/doc-Provisioning_Installer/master.adoc | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/guides/common/assembly_introduction-to-provisioning.adoc b/guides/common/assembly_introduction-to-provisioning.adoc index ff3b5365105..e58b1aa7299 100644 --- a/guides/common/assembly_introduction-to-provisioning.adoc +++ b/guides/common/assembly_introduction-to-provisioning.adoc @@ -12,7 +12,7 @@ ifdef::provisioning,provisioning-virtual[] include::modules/ref_supported-virtualization-infrastructures.adoc[leveloffset=+1] endif::[] -ifdef::provisioning,provisioning-netboot[] +ifdef::provisioning,provisioning-installer[] include::modules/con_network-boot-provisioning-workflow.adoc[leveloffset=+1] include::modules/ref_required-boot-order-for-network-boot.adoc[leveloffset=+1] diff --git a/guides/common/modules/proc_creating-hosts-from-discovered-hosts.adoc b/guides/common/modules/proc_creating-hosts-from-discovered-hosts.adoc index e1513c38813..81ca346b794 100644 --- a/guides/common/modules/proc_creating-hosts-from-discovered-hosts.adoc +++ b/guides/common/modules/proc_creating-hosts-from-discovered-hosts.adoc @@ -72,7 +72,7 @@ The host detects the DHCP service and starts installing the operating system. ifdef::provisioning[] The rest of the process is identical to the normal PXE workflow described in xref:Creating_Hosts_with_Unattended_Provisioning_{context}[]. endif::[] -ifdef::provisioning-netboot[] +ifdef::provisioning-installer[] The rest of the process is identical to the normal PXE workflow. For more information, see xref:creating-hosts-with-pxe-provisioning[]. endif::[] \ No newline at end of file diff --git a/guides/common/modules/proc_using-an-imagebuilder-image-for-provisioning.adoc b/guides/common/modules/proc_using-an-imagebuilder-image-for-provisioning.adoc index 011b4667c21..a82d8c9a451 100644 --- a/guides/common/modules/proc_using-an-imagebuilder-image-for-provisioning.adoc +++ b/guides/common/modules/proc_using-an-imagebuilder-image-for-provisioning.adoc @@ -35,7 +35,7 @@ You can use this image for bare-metal provisioning and provisioning using a comp For more information about bare-metal provisioning, see xref:Using_PXE_to_Provision_Hosts_{context}[]. For more information about provisioning with different compute resources, see the relevant chapter for the compute resource that you want to use. endif::[] -ifdef::provisioning-netboot[] +ifdef::provisioning-installer[] You can use this image for network-boot provisioning. For more information, see xref:using-network-boot-to-provision-hosts[]. endif::[] diff --git a/guides/doc-Provisioning_Installer/master.adoc b/guides/doc-Provisioning_Installer/master.adoc index 2719e9587bd..75994ac9ec6 100644 --- a/guides/doc-Provisioning_Installer/master.adoc +++ b/guides/doc-Provisioning_Installer/master.adoc @@ -1,7 +1,7 @@ include::common/attributes.adoc[] include::common/header.adoc[] -:context: provisioning-netboot -:provisioning-netboot: +:context: provisioning-installer +:provisioning-installer: = {ProvisioningNetbootDocTitle} From 8044280d555f6b9021f61f3cb93696a748beefe6 Mon Sep 17 00:00:00 2001 From: Zuzana Lena Ansorgova Date: Tue, 3 Dec 2024 19:52:45 +0100 Subject: [PATCH 08/28] Incorporate Secure Boot from #2145 --- ...using-network-boot-to-provision-hosts.adoc | 94 +++++++++++++++++++ ...using-network-boot-to-provision-hosts.adoc | 26 +++-- 2 files changed, 111 insertions(+), 9 deletions(-) diff --git a/guides/common/assembly_using-network-boot-to-provision-hosts.adoc b/guides/common/assembly_using-network-boot-to-provision-hosts.adoc index 298ebb08a4c..1921b33d504 100644 --- a/guides/common/assembly_using-network-boot-to-provision-hosts.adoc +++ b/guides/common/assembly_using-network-boot-to-provision-hosts.adoc @@ -6,6 +6,100 @@ include::modules/con_using-network-boot-to-provision-hosts.adoc[] include::modules/con_prerequisites-for-network-boot-provisioning.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=+1] + +: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=+1] + +: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=+1] + +: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=+1] + +// 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] diff --git a/guides/common/modules/con_using-network-boot-to-provision-hosts.adoc b/guides/common/modules/con_using-network-boot-to-provision-hosts.adoc index c751d2bc97c..6cc94fdaab3 100644 --- a/guides/common/modules/con_using-network-boot-to-provision-hosts.adoc +++ b/guides/common/modules/con_using-network-boot-to-provision-hosts.adoc @@ -40,31 +40,39 @@ Both BIOS and UEFI interfaces work as interpreters between the operating system .PXE loaders In {Project} provisioning, the PXE loader option defines the DHCP `filename` option to use during provisioning. -* For BIOS systems, use the *PXELinux BIOS* option to enable a provisioned host to download the `pxelinux.0` file over TFTP. -* For UEFI systems, use the *PXEGrub2 UEFI* option to enable a TFTP client to download `grub2/grubx64.efi` file, or use the *PXEGrub2 UEFI HTTP* option to enable an UEFI HTTP client to download `grubx64.efi` from {SmartProxy} with the HTTP Boot feature. +* For BIOS systems, select the *PXELinux BIOS* option to enable a provisioned host to download the `pxelinux.0` file over TFTP. +* For UEFI systems, select the *Grub2 UEFI* option to enable a TFTP client to download `grubx64.efi` file, or select the *Grub2 UEFI HTTP* option to enable an UEFI HTTP client to download `grubx64.efi` with the HTTP Boot feature. ifndef::satellite[] {ProjectName} supports UEFI Secure Boot. SecureBoot PXE loaders enable a client to download the `shim.efi` bootstrap boot loader that then loads the signed `grubx64.efi`. Use the *Grub2 UEFI SecureBoot* PXE loader for PXE-boot provisioning or *Grub2 UEFI HTTPS SecureBoot* for HTTP-boot provisioning. -[IMPORTANT] -==== -You can only use Secure Boot to provision hosts with the same operating system version, major and minor, that runs on your TFTP {SmartProxy}. -==== +By default, you can provision operating systems from the vendor of the operating system of your {ProjectServer} on Secure Boot enabled hosts. +To provision operating systems on Secure Boot enabled hosts from different vendors, you have to provide signed shim and GRUB2 binaries provided by the vendor of your operating system. +ifndef::orcharhino[] +For more information, see: + +* xref:configuring-{smart-proxy-context}-to-provision-almalinux-on-Secure-Boot-enabled-hosts[] +* xref:configuring-{smart-proxy-context}-to-provision-debian-on-Secure-Boot-enabled-hosts[] +* xref:configuring-{smart-proxy-context}-to-provision-rocky-on-Secure-Boot-enabled-hosts[] +* xref:configuring-{smart-proxy-context}-to-provision-ubuntu-on-Secure-Boot-enabled-hosts[] +endif::[] endif::[] ifdef::satellite[] For more information about supported workflows, see https://access.redhat.com/solutions/2674001[Supported architectures and provisioning scenarios]. endif::[] -ifndef::satellite[] -Other PXE loaders, such as PXELinux UEFI, Grub2 ELF, or iPXE Chain, require additional configuration. +ifndef::orcharhino,satellite[] +Other PXE loaders like *PXELinux UEFI*, *Grub2 ELF* or *iPXE Chain*, require additional configuration. These workflows are not documented. +endif::[] +ifndef::satellite[] .Template association with operating systems For BIOS provisioning, you must associate a PXELinux template with the operating system. For UEFI provisioning, you must associate a PXEGrub2 template with the operating system. -If you associate both PXELinux and PXEGrub2 templates, {Project} can deploy configuration files for both on a TFTP server, so that you can switch between PXE loaders easily. +If you associate both PXELinux and PXEGrub2 templates, {Project} deploys configuration files for both on a TFTP server, so that you can switch between PXE loaders easily. endif::[] .Bonded network interfaces From 76f601188b7bbe9b6e1bb3c8556de0c8ba191c17 Mon Sep 17 00:00:00 2001 From: Zuzana Lena Ansorgova Date: Tue, 3 Dec 2024 19:54:02 +0100 Subject: [PATCH 09/28] fixup! Rename the guide --- guides/doc-Provisioning_Installer/master.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guides/doc-Provisioning_Installer/master.adoc b/guides/doc-Provisioning_Installer/master.adoc index 75994ac9ec6..90075a42774 100644 --- a/guides/doc-Provisioning_Installer/master.adoc +++ b/guides/doc-Provisioning_Installer/master.adoc @@ -3,7 +3,7 @@ include::common/header.adoc[] :context: provisioning-installer :provisioning-installer: -= {ProvisioningNetbootDocTitle} += {ProvisioningInstallerDocTitle} // This guide is not ready for stable releases ifdef::HideDocumentOnStable[] From cb5a811e007a21529a2aa9b9280de17c2314a50c Mon Sep 17 00:00:00 2001 From: Zuzana Lena Ansorgova Date: Tue, 3 Dec 2024 20:18:03 +0100 Subject: [PATCH 10/28] Incorporate smaller suggestions from review --- .../assembly_using-boot-disks-to-provision-hosts.adoc | 5 +++-- .../assembly_using-network-boot-to-provision-hosts.adoc | 5 +++-- .../modules/con_configuring-provisionable-platforms.adoc | 2 -- .../modules/con_configuring-templates-for-provisioning.adoc | 2 +- .../con_prerequisites-for-network-boot-provisioning.adoc | 6 +++--- .../modules/con_using-network-boot-to-provision-hosts.adoc | 2 +- 6 files changed, 11 insertions(+), 11 deletions(-) diff --git a/guides/common/assembly_using-boot-disks-to-provision-hosts.adoc b/guides/common/assembly_using-boot-disks-to-provision-hosts.adoc index 7af55a6e27a..cd20e257611 100644 --- a/guides/common/assembly_using-boot-disks-to-provision-hosts.adoc +++ b/guides/common/assembly_using-boot-disks-to-provision-hosts.adoc @@ -1,5 +1,5 @@ :using-bootdisks-to-provision-hosts: -ifdef::context[:parent-context: {context}] +:parent-context: {context} :context: using-bootdisks include::modules/con_using-boot-disks-to-provision-hosts.adoc[] @@ -8,5 +8,6 @@ include::modules/proc_creating-hosts-with-pxeless-provisioning.adoc[leveloffset= include::modules/proc_deploying-ssh-keys-during-provisioning.adoc[leveloffset=+1] -ifdef::parent-context[:context: {parent-context}] +:context: {parent-context} +:!parent-context: :!using-bootdisks-to-provision-hosts: diff --git a/guides/common/assembly_using-network-boot-to-provision-hosts.adoc b/guides/common/assembly_using-network-boot-to-provision-hosts.adoc index 1921b33d504..9cdcbdde1a0 100644 --- a/guides/common/assembly_using-network-boot-to-provision-hosts.adoc +++ b/guides/common/assembly_using-network-boot-to-provision-hosts.adoc @@ -1,5 +1,5 @@ :using-network-boot-to-provision-hosts: -ifdef::context[:parent-context: {context}] +:parent-context: {context} :context: using-netboot include::modules/con_using-network-boot-to-provision-hosts.adoc[] @@ -106,5 +106,6 @@ include::modules/proc_creating-hosts-with-uefi-http-boot-provisioning.adoc[level include::modules/proc_deploying-ssh-keys-during-provisioning.adoc[leveloffset=+1] -ifdef::parent-context[:context: {parent-context}] +:context: {parent-context} +:!parent-context: :!using-network-boot-to-provision-hosts: diff --git a/guides/common/modules/con_configuring-provisionable-platforms.adoc b/guides/common/modules/con_configuring-provisionable-platforms.adoc index 74fab69aff2..cb098df1868 100644 --- a/guides/common/modules/con_configuring-provisionable-platforms.adoc +++ b/guides/common/modules/con_configuring-provisionable-platforms.adoc @@ -4,9 +4,7 @@ You have to configure the platforms that you will provision. That entails creating a hardware model, CPU architecture, and operating system. -ifndef::orcharhino[] [NOTE] ==== The records for Red{nbsp}Hat supported platforms are created automatically when you enable a Red{nbsp}Hat repository. ==== -endif::[] diff --git a/guides/common/modules/con_configuring-templates-for-provisioning.adoc b/guides/common/modules/con_configuring-templates-for-provisioning.adoc index e831d5b5c64..04584275d77 100644 --- a/guides/common/modules/con_configuring-templates-for-provisioning.adoc +++ b/guides/common/modules/con_configuring-templates-for-provisioning.adoc @@ -4,7 +4,7 @@ {Project} provides the following default template types: * Provisioning templates -* Templates of partition tables +* Partition tables You can use the default templates or create custom templates. diff --git a/guides/common/modules/con_prerequisites-for-network-boot-provisioning.adoc b/guides/common/modules/con_prerequisites-for-network-boot-provisioning.adoc index f46321c6084..e348a1f232e 100644 --- a/guides/common/modules/con_prerequisites-for-network-boot-provisioning.adoc +++ b/guides/common/modules/con_prerequisites-for-network-boot-provisioning.adoc @@ -3,13 +3,13 @@ The requirements for network-boot provisioning include: -* A {SmartProxyServer} managing the network for the network-booted machines. -For unattended provisioning and discovery-based provisioning, {ProjectServer} requires PXE server settings. +* {SmartProxy} managing the network for the network-booted machines. +For unattended provisioning and discovery-based provisioning, {Project} requires PXE server settings. + For more information about networking requirements, see xref:configuring-networking[]. + For more information about the Discovery service, xref:discovering-hosts-on-a-network[]. -+ + * A bare-metal host or a blank VM. include::snip_prerequisites-common-compute-resource.adoc[] diff --git a/guides/common/modules/con_using-network-boot-to-provision-hosts.adoc b/guides/common/modules/con_using-network-boot-to-provision-hosts.adoc index 6cc94fdaab3..8c8b9086d6f 100644 --- a/guides/common/modules/con_using-network-boot-to-provision-hosts.adoc +++ b/guides/common/modules/con_using-network-boot-to-provision-hosts.adoc @@ -28,7 +28,7 @@ endif::[] ifndef::satellite[] [NOTE] ==== -Discovery workflows are only available when the Discovery plugin is installed. +Discovery workflows are only available if the Discovery plug-in is installed. For more information, see xref:discovering-hosts-on-a-network[]. ==== endif::[] From cc638fec04d870e6a022a8c346abf2a7c86bb4ea Mon Sep 17 00:00:00 2001 From: Zuzana Lena Ansorgova Date: Tue, 3 Dec 2024 20:22:05 +0100 Subject: [PATCH 11/28] Move network boot info --- guides/common/assembly_introduction-to-provisioning.adoc | 2 +- .../assembly_using-network-boot-to-provision-hosts.adoc | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/guides/common/assembly_introduction-to-provisioning.adoc b/guides/common/assembly_introduction-to-provisioning.adoc index e58b1aa7299..78c0f062ecc 100644 --- a/guides/common/assembly_introduction-to-provisioning.adoc +++ b/guides/common/assembly_introduction-to-provisioning.adoc @@ -12,7 +12,7 @@ ifdef::provisioning,provisioning-virtual[] include::modules/ref_supported-virtualization-infrastructures.adoc[leveloffset=+1] endif::[] -ifdef::provisioning,provisioning-installer[] +ifdef::provisioning[] include::modules/con_network-boot-provisioning-workflow.adoc[leveloffset=+1] include::modules/ref_required-boot-order-for-network-boot.adoc[leveloffset=+1] diff --git a/guides/common/assembly_using-network-boot-to-provision-hosts.adoc b/guides/common/assembly_using-network-boot-to-provision-hosts.adoc index 9cdcbdde1a0..a5d41e99d03 100644 --- a/guides/common/assembly_using-network-boot-to-provision-hosts.adoc +++ b/guides/common/assembly_using-network-boot-to-provision-hosts.adoc @@ -4,8 +4,12 @@ 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] + ifndef::satellite[] :extract_deb_prefix: cd /tmp && ar x /tmp :extract_deb_xz_suffix: && tar -xf data.tar.xz && cd - From 73a99cec91fae7400d42d9befae0637edc0f4349 Mon Sep 17 00:00:00 2001 From: Zuzana Lena Ansorgova Date: Tue, 3 Dec 2024 20:36:20 +0100 Subject: [PATCH 12/28] Add concept for Secure Boot config --- ...assembly_using-network-boot-to-provision-hosts.adoc | 10 ++++++---- .../con_configuring-smartproxy-for-secure-boot.adoc | 4 ++++ 2 files changed, 10 insertions(+), 4 deletions(-) create mode 100644 guides/common/modules/con_configuring-smartproxy-for-secure-boot.adoc diff --git a/guides/common/assembly_using-network-boot-to-provision-hosts.adoc b/guides/common/assembly_using-network-boot-to-provision-hosts.adoc index a5d41e99d03..2d35e82d781 100644 --- a/guides/common/assembly_using-network-boot-to-provision-hosts.adoc +++ b/guides/common/assembly_using-network-boot-to-provision-hosts.adoc @@ -10,6 +10,8 @@ include::modules/con_prerequisites-for-network-boot-provisioning.adoc[leveloffse 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 - @@ -33,7 +35,7 @@ ifndef::satellite[] :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=+1] +include::modules/proc_configuring-smart-proxy-to-provision-secure-boot-enabled-hosts.adoc[leveloffset=+2] :client-os-context: debian :client-os: Debian @@ -48,7 +50,7 @@ include::modules/proc_configuring-smart-proxy-to-provision-secure-boot-enabled-h :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=+1] +include::modules/proc_configuring-smart-proxy-to-provision-secure-boot-enabled-hosts.adoc[leveloffset=+2] :client-os-context: rocky :client-os: Rocky Linux @@ -63,7 +65,7 @@ include::modules/proc_configuring-smart-proxy-to-provision-secure-boot-enabled-h :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=+1] +include::modules/proc_configuring-smart-proxy-to-provision-secure-boot-enabled-hosts.adoc[leveloffset=+2] :client-os-context: ubuntu :client-os: Ubuntu @@ -78,7 +80,7 @@ include::modules/proc_configuring-smart-proxy-to-provision-secure-boot-enabled-h :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=+1] +include::modules/proc_configuring-smart-proxy-to-provision-secure-boot-enabled-hosts.adoc[leveloffset=+2] // reset global attributes :client-os: {parent-client-os} diff --git a/guides/common/modules/con_configuring-smartproxy-for-secure-boot.adoc b/guides/common/modules/con_configuring-smartproxy-for-secure-boot.adoc new file mode 100644 index 00000000000..f4a211dbebd --- /dev/null +++ b/guides/common/modules/con_configuring-smartproxy-for-secure-boot.adoc @@ -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. From 5bd81c73ada9c4705497e7b39d61aa6aeb41d3bd Mon Sep 17 00:00:00 2001 From: Zuzana Lena Ansorgova Date: Tue, 3 Dec 2024 20:44:33 +0100 Subject: [PATCH 13/28] Move iPXE --- .../common/assembly_using-network-boot-to-provision-hosts.adoc | 2 ++ guides/doc-Provisioning_Installer/master.adoc | 2 -- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/guides/common/assembly_using-network-boot-to-provision-hosts.adoc b/guides/common/assembly_using-network-boot-to-provision-hosts.adoc index 2d35e82d781..4f9ee9b644b 100644 --- a/guides/common/assembly_using-network-boot-to-provision-hosts.adoc +++ b/guides/common/assembly_using-network-boot-to-provision-hosts.adoc @@ -112,6 +112,8 @@ include::modules/proc_creating-hosts-with-uefi-http-boot-provisioning.adoc[level 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: diff --git a/guides/doc-Provisioning_Installer/master.adoc b/guides/doc-Provisioning_Installer/master.adoc index 90075a42774..f032c9def0e 100644 --- a/guides/doc-Provisioning_Installer/master.adoc +++ b/guides/doc-Provisioning_Installer/master.adoc @@ -27,8 +27,6 @@ include::common/assembly_configuring-networking.adoc[leveloffset=+1] include::common/assembly_using-network-boot-to-provision-hosts.adoc[leveloffset=+1] -include::common/assembly_using-ipxe-to-reduce-provisioning-times.adoc[leveloffset=+1] - include::common/assembly_using-boot-disks-to-provision-hosts.adoc[leveloffset=+1] include::common/assembly_discovering-hosts-on-a-network.adoc[leveloffset=+1] From 53a6f189546860cc1f1a0ce5d62a5d870f1f73a0 Mon Sep 17 00:00:00 2001 From: Zuzana Lena Ansorgova Date: Tue, 3 Dec 2024 20:45:12 +0100 Subject: [PATCH 14/28] Hide prereqs for image-based provisioning --- guides/common/assembly_configuring-networking.adoc | 2 ++ 1 file changed, 2 insertions(+) diff --git a/guides/common/assembly_configuring-networking.adoc b/guides/common/assembly_configuring-networking.adoc index 1b1913f36a7..3f2579ff165 100644 --- a/guides/common/assembly_configuring-networking.adoc +++ b/guides/common/assembly_configuring-networking.adoc @@ -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] From 6709b5419e8ed228b01d1069820443c29798efa6 Mon Sep 17 00:00:00 2001 From: Zuzana Lena Ansorgova Date: Wed, 4 Dec 2024 10:44:10 +0100 Subject: [PATCH 15/28] Add Abstract --- guides/doc-Provisioning_Installer/docinfo.xml | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/guides/doc-Provisioning_Installer/docinfo.xml b/guides/doc-Provisioning_Installer/docinfo.xml index 7b63ec58b79..9fc88ce465d 100644 --- a/guides/doc-Provisioning_Installer/docinfo.xml +++ b/guides/doc-Provisioning_Installer/docinfo.xml @@ -1,12 +1,16 @@ {ProvisioningNetbootDocTitle} - Provision bare-metal or virtual machines by using installer-based methods, such as network booting and boot disk, and discover unknown hosts on your provisioning network + Provision bare-metal or virtual machines by using installer-based methods, such as network booting and boot disk, and discover unknown hosts on your network Red Hat Satellite {ProjectVersion} - TODO + This guide provides information on how to configure Satellite for installer-based provisioning and how to use network boot and boot disks to provision both bare metal and virtual machines. + Designed for Satellite users who have control over network services, such as DNS, DHCP, and TFTP, this guide helps you configure networking for network boot provisioning, including discovery of hosts on your provisioning network. + Certain boot disks can also overcome limitations for users who cannot control network services and still want to provision hosts by using installer automation. + The guide covers both configuration of Satellite and creation of new hosts, either manually or by using the Discovery service. + By the end of this guide, you will have a host fully provisioned by using the Anaconda installer with Kickstart automation. From 169943be70fa0a3d8d04559f966aad724d1f0a7d Mon Sep 17 00:00:00 2001 From: Zuzana Lena Ansorgova Date: Thu, 5 Dec 2024 20:31:15 +0100 Subject: [PATCH 16/28] Move settings to a special chapter --- .../assembly_configuring-provisionable-platforms.adoc | 4 ---- .../assembly_configuring-provisioning-content.adoc | 2 -- .../common/assembly_global-provisioning-settings.adoc | 9 +++++++++ .../modules/con_global-provisioning-settings.adoc | 10 ++++++++++ guides/doc-Provisioning_Installer/master.adoc | 2 ++ 5 files changed, 21 insertions(+), 6 deletions(-) create mode 100644 guides/common/assembly_global-provisioning-settings.adoc create mode 100644 guides/common/modules/con_global-provisioning-settings.adoc diff --git a/guides/common/assembly_configuring-provisionable-platforms.adoc b/guides/common/assembly_configuring-provisionable-platforms.adoc index 82ec42084c9..7e52a5f231e 100644 --- a/guides/common/assembly_configuring-provisionable-platforms.adoc +++ b/guides/common/assembly_configuring-provisionable-platforms.adoc @@ -46,12 +46,8 @@ include::modules/proc_creating-architectures.adoc[leveloffset=+1] include::modules/proc_creating-hardware-models.adoc[leveloffset=+1] -include::modules/proc_setting-a-default-encrypted-root-password.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] - -include::modules/proc_removing-a-virtual-machine-upon-host-deletion.adoc[leveloffset=+1] endif::[] diff --git a/guides/common/assembly_configuring-provisioning-content.adoc b/guides/common/assembly_configuring-provisioning-content.adoc index 9123ca67a7a..492caece7da 100644 --- a/guides/common/assembly_configuring-provisioning-content.adoc +++ b/guides/common/assembly_configuring-provisioning-content.adoc @@ -13,5 +13,3 @@ include::modules/proc_creating-an-installation-medium-for-ubuntu-22-04.adoc[leve include::modules/proc_provisioning-ubuntu-autoinstall-through-smart-proxies.adoc[leveloffset=+1] endif::[] - -include::modules/proc_configuring-the-security-token-validity-duration.adoc[leveloffset=+1] diff --git a/guides/common/assembly_global-provisioning-settings.adoc b/guides/common/assembly_global-provisioning-settings.adoc new file mode 100644 index 00000000000..b5af6427613 --- /dev/null +++ b/guides/common/assembly_global-provisioning-settings.adoc @@ -0,0 +1,9 @@ +include::modules/con_global-provisioning-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::[] diff --git a/guides/common/modules/con_global-provisioning-settings.adoc b/guides/common/modules/con_global-provisioning-settings.adoc new file mode 100644 index 00000000000..c027093ca30 --- /dev/null +++ b/guides/common/modules/con_global-provisioning-settings.adoc @@ -0,0 +1,10 @@ +[id="global-provisioning-settings"] += Global provisioning settings + +You can configure global settings for provisioning. + +This chapter only mentions notable settings. + +[role="_additional-resources"] +.Additional resources +* {AdministeringDocURL}provisioning_settings_admin[Provisioning settings] in _{AdministeringDocTitle}_ diff --git a/guides/doc-Provisioning_Installer/master.adoc b/guides/doc-Provisioning_Installer/master.adoc index f032c9def0e..1e521d7e420 100644 --- a/guides/doc-Provisioning_Installer/master.adoc +++ b/guides/doc-Provisioning_Installer/master.adoc @@ -25,6 +25,8 @@ include::common/assembly_configuring-templates-for-provisioning.adoc[leveloffset include::common/assembly_configuring-networking.adoc[leveloffset=+1] +include::common/assembly_global-provisioning-settings.adoc[leveloffset=+1] + include::common/assembly_using-network-boot-to-provision-hosts.adoc[leveloffset=+1] include::common/assembly_using-boot-disks-to-provision-hosts.adoc[leveloffset=+1] From 8f75bd267e8cf2ce0f5aca78d6ee0713a71eb698 Mon Sep 17 00:00:00 2001 From: Zuzana Lena Ansorgova Date: Thu, 5 Dec 2024 20:31:39 +0100 Subject: [PATCH 17/28] Remove 'Building cloud images' from this guide --- guides/doc-Provisioning_Installer/master.adoc | 5 ----- 1 file changed, 5 deletions(-) diff --git a/guides/doc-Provisioning_Installer/master.adoc b/guides/doc-Provisioning_Installer/master.adoc index 1e521d7e420..44ba7e4114f 100644 --- a/guides/doc-Provisioning_Installer/master.adoc +++ b/guides/doc-Provisioning_Installer/master.adoc @@ -36,11 +36,6 @@ include::common/assembly_discovering-hosts-on-a-network.adoc[leveloffset=+1] [appendix] include::common/assembly_provisioning-fips-compliant-hosts.adoc[leveloffset=+1] -ifdef::satellite[] -[appendix] -include::common/assembly_building_cloud-images.adoc[leveloffset=+1] -endif::[] - [appendix] include::common/modules/ref_host-parameter-hierarchy.adoc[leveloffset=+1] From 2f54109c3f779a825b8dc543bb230a5c0d289061 Mon Sep 17 00:00:00 2001 From: Zuzana Lena Ansorgova Date: Thu, 5 Dec 2024 20:35:02 +0100 Subject: [PATCH 18/28] Move provisioning contexts to a special chapter --- .../common/assembly_configuring-provisionable-platforms.adoc | 4 ---- guides/doc-Provisioning_Installer/master.adoc | 4 ++++ 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/guides/common/assembly_configuring-provisionable-platforms.adoc b/guides/common/assembly_configuring-provisionable-platforms.adoc index 7e52a5f231e..c36294bc9b7 100644 --- a/guides/common/assembly_configuring-provisionable-platforms.adoc +++ b/guides/common/assembly_configuring-provisionable-platforms.adoc @@ -1,9 +1,5 @@ include::modules/con_configuring-provisionable-platforms.adoc[] -include::modules/con_provisioning-contexts.adoc[leveloffset=+1] - -include::modules/proc_setting-the-provisioning-context.adoc[leveloffset=+1] - include::modules/proc_creating-operating-systems.adoc[leveloffset=+1] ifndef::satellite[] diff --git a/guides/doc-Provisioning_Installer/master.adoc b/guides/doc-Provisioning_Installer/master.adoc index 44ba7e4114f..7b5f97d8391 100644 --- a/guides/doc-Provisioning_Installer/master.adoc +++ b/guides/doc-Provisioning_Installer/master.adoc @@ -27,6 +27,10 @@ include::common/assembly_configuring-networking.adoc[leveloffset=+1] include::common/assembly_global-provisioning-settings.adoc[leveloffset=+1] +include::common/modules/con_provisioning-contexts.adoc[leveloffset=+1] + +include::common/modules/proc_setting-the-provisioning-context.adoc[leveloffset=+2] + include::common/assembly_using-network-boot-to-provision-hosts.adoc[leveloffset=+1] include::common/assembly_using-boot-disks-to-provision-hosts.adoc[leveloffset=+1] From 049dbc48d8ac5dfdb71c8ed55f57ca2ca87de121 Mon Sep 17 00:00:00 2001 From: Zuzana Lena Ansorgova Date: Thu, 5 Dec 2024 20:43:37 +0100 Subject: [PATCH 19/28] Fix title attribute in docinfo.xml --- guides/doc-Provisioning_Installer/docinfo.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guides/doc-Provisioning_Installer/docinfo.xml b/guides/doc-Provisioning_Installer/docinfo.xml index 9fc88ce465d..8314d72cdca 100644 --- a/guides/doc-Provisioning_Installer/docinfo.xml +++ b/guides/doc-Provisioning_Installer/docinfo.xml @@ -1,4 +1,4 @@ -{ProvisioningNetbootDocTitle} +{ProvisioningInstallerDocTitle} Provision bare-metal or virtual machines by using installer-based methods, such as network booting and boot disk, and discover unknown hosts on your network From 15ba29da9b80a153be5f01f6d38f900187b11abc Mon Sep 17 00:00:00 2001 From: Zuzana Lena Ansorgova Date: Tue, 10 Dec 2024 21:16:42 +0100 Subject: [PATCH 20/28] Incorporate suggestions from Max --- .../modules/con_prerequisites-for-using-ipxe.adoc | 2 +- .../proc_creating-hosts-with-pxe-provisioning.adoc | 12 ++++++------ ...ating-hosts-with-uefi-http-boot-provisioning.adoc | 2 +- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/guides/common/modules/con_prerequisites-for-using-ipxe.adoc b/guides/common/modules/con_prerequisites-for-using-ipxe.adoc index e0405089bb8..c571cadec0f 100644 --- a/guides/common/modules/con_prerequisites-for-using-ipxe.adoc +++ b/guides/common/modules/con_prerequisites-for-using-ipxe.adoc @@ -7,7 +7,7 @@ You can use iPXE to boot virtual machines in the following cases: * Your virtual machines are in BIOS mode. In this case, you can configure PXELinux to chainboot iPXE and boot by using the HTTP protocol. -For booting virtual machines in UEFI mode by using HTTP, you can follow xref:Creating_Hosts_with_UEFI_HTTP_Boot_Provisioning[] instead. +For booting virtual machines in UEFI mode by using HTTP, you can follow xref:creating-hosts-with-uefi-http-boot-provisioning[] instead. ifndef::orcharhino,satellite[] .BIOS and UEFI support diff --git a/guides/common/modules/proc_creating-hosts-with-pxe-provisioning.adoc b/guides/common/modules/proc_creating-hosts-with-pxe-provisioning.adoc index 25b148e5170..a8a55e7d0dc 100644 --- a/guides/common/modules/proc_creating-hosts-with-pxe-provisioning.adoc +++ b/guides/common/modules/proc_creating-hosts-with-pxe-provisioning.adoc @@ -7,7 +7,7 @@ You enter the host details on {ProjectServer} and boot your host. This method of provisioning hosts uses minimal interaction during the process. -To use the CLI instead of the {ProjectWebUI}, see the xref:cli-creating-hosts-with-unattended-provisioning_{context}[]. +To use the CLI instead of the {ProjectWebUI}, see the xref:cli-creating-hosts-with-pxe-provisioning[]. .Procedure include::snip_steps-create-a-host-tab-host.adoc[] @@ -23,7 +23,7 @@ If not, add an activation key. endif::[] . Click *Submit* to save the host details. + -For more information about network interfaces, see {ManagingHostsDocURL}Adding_Network_Interfaces_managing-hosts[Adding network interfaces] in _{ManagingHostsDocTitle}_. +For more information about network interfaces, see {ManagingHostsDocURL}configuring-network-interfaces[Configuring network interfaces] in _{ManagingHostsDocTitle}_. This creates the host entry and the relevant provisioning settings. This also includes creating the necessary directories and files for PXE booting the bare-metal host. @@ -33,13 +33,13 @@ ifdef::katello,satellite,orcharhino[] When the installation completes, the host also registers to {ProjectServer} using the activation key and installs the necessary configuration and management tools from the {project-client-name} repository. endif::[] -[id="cli-creating-hosts-with-unattended-provisioning_{context}"] +[id="cli-creating-hosts-with-pxe-provisioning"] .CLI procedure . Create the host with the `hammer host create` command: + [options="nowrap" subs="+quotes"] ---- -# hammer host create \ +$ hammer host create \ --build true \ --enabled true \ --hostgroup "_My_Host_Group_" \ @@ -49,10 +49,10 @@ endif::[] --name "_My_Host_Name_" \ --organization "_My_Organization_" ---- -. Ensure the network interface options are set using the `hammer host interface update` command: +. Configure the network interface: + ---- -# hammer host interface update \ +$ hammer host interface update \ --host "_My_Host_Name_" \ --managed true \ --primary true \ diff --git a/guides/common/modules/proc_creating-hosts-with-uefi-http-boot-provisioning.adoc b/guides/common/modules/proc_creating-hosts-with-uefi-http-boot-provisioning.adoc index a91f28e8207..ce4aab1ec9b 100644 --- a/guides/common/modules/proc_creating-hosts-with-uefi-http-boot-provisioning.adoc +++ b/guides/common/modules/proc_creating-hosts-with-uefi-http-boot-provisioning.adoc @@ -1,4 +1,4 @@ -[id="Creating_Hosts_with_UEFI_HTTP_Boot_Provisioning"] +[id="creating-hosts-with-uefi-http-boot-provisioning"] = Creating hosts with UEFI HTTP boot provisioning You can provision hosts from {Project} using the UEFI HTTP Boot. From d6d8df038fda0e461d9407d2043536fc9047db86 Mon Sep 17 00:00:00 2001 From: Zuzana Lena Ansorgova Date: Tue, 10 Dec 2024 21:32:53 +0100 Subject: [PATCH 21/28] Incorporate suggestions from Avital --- ...sioning-settings.adoc => assembly_security-settings.adoc} | 4 +++- ...provisioning-settings.adoc => con_security-settings.adoc} | 4 ++-- guides/doc-Provisioning_Installer/master.adoc | 5 +---- 3 files changed, 6 insertions(+), 7 deletions(-) rename guides/common/{assembly_global-provisioning-settings.adoc => assembly_security-settings.adoc} (73%) rename guides/common/modules/{con_global-provisioning-settings.adoc => con_security-settings.adoc} (79%) diff --git a/guides/common/assembly_global-provisioning-settings.adoc b/guides/common/assembly_security-settings.adoc similarity index 73% rename from guides/common/assembly_global-provisioning-settings.adoc rename to guides/common/assembly_security-settings.adoc index b5af6427613..4ebb680f9de 100644 --- a/guides/common/assembly_global-provisioning-settings.adoc +++ b/guides/common/assembly_security-settings.adoc @@ -1,4 +1,4 @@ -include::modules/con_global-provisioning-settings.adoc[] +include::modules/con_security-settings.adoc[] include::modules/proc_configuring-the-security-token-validity-duration.adoc[leveloffset=+1] @@ -7,3 +7,5 @@ include::modules/proc_setting-a-default-encrypted-root-password.adoc[leveloffset 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] diff --git a/guides/common/modules/con_global-provisioning-settings.adoc b/guides/common/modules/con_security-settings.adoc similarity index 79% rename from guides/common/modules/con_global-provisioning-settings.adoc rename to guides/common/modules/con_security-settings.adoc index c027093ca30..6849c1019e1 100644 --- a/guides/common/modules/con_global-provisioning-settings.adoc +++ b/guides/common/modules/con_security-settings.adoc @@ -1,5 +1,5 @@ -[id="global-provisioning-settings"] -= Global provisioning settings +[id="security-settings"] += Security settings You can configure global settings for provisioning. diff --git a/guides/doc-Provisioning_Installer/master.adoc b/guides/doc-Provisioning_Installer/master.adoc index 7b5f97d8391..5539ba1626c 100644 --- a/guides/doc-Provisioning_Installer/master.adoc +++ b/guides/doc-Provisioning_Installer/master.adoc @@ -25,7 +25,7 @@ include::common/assembly_configuring-templates-for-provisioning.adoc[leveloffset include::common/assembly_configuring-networking.adoc[leveloffset=+1] -include::common/assembly_global-provisioning-settings.adoc[leveloffset=+1] +include::common/assembly_security-settings.adoc[leveloffset=+1] include::common/modules/con_provisioning-contexts.adoc[leveloffset=+1] @@ -37,9 +37,6 @@ include::common/assembly_using-boot-disks-to-provision-hosts.adoc[leveloffset=+1 include::common/assembly_discovering-hosts-on-a-network.adoc[leveloffset=+1] -[appendix] -include::common/assembly_provisioning-fips-compliant-hosts.adoc[leveloffset=+1] - [appendix] include::common/modules/ref_host-parameter-hierarchy.adoc[leveloffset=+1] From 3cf5402fc21f27652a4ff9fabb075362ca37e191 Mon Sep 17 00:00:00 2001 From: Zuzana Lena Ansorgova Date: Wed, 18 Dec 2024 22:07:40 +0100 Subject: [PATCH 22/28] fixup after rebase --- .../modules/con_prerequisites-for-vmware-provisioning.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guides/common/modules/con_prerequisites-for-vmware-provisioning.adoc b/guides/common/modules/con_prerequisites-for-vmware-provisioning.adoc index 5d955ab21e5..345ddd2a993 100644 --- a/guides/common/modules/con_prerequisites-for-vmware-provisioning.adoc +++ b/guides/common/modules/con_prerequisites-for-vmware-provisioning.adoc @@ -12,7 +12,7 @@ The following versions have been fully tested with {Project}: * A {SmartProxyServer} managing a network on the vSphere environment. Ensure no other DHCP services run on this network to avoid conflicts with {SmartProxyServer}. ifndef::orcharhino[] -For more information, see xref:Configuring_Networking[]. +For more information, see xref:configuring-networking[]. endif::[] * An existing VMware template if you want to use image-based provisioning. include::snip_prerequisites-common-compute-resource.adoc[] From 0596f6bbb33e4610bd40a57c059f0762027c934a Mon Sep 17 00:00:00 2001 From: Zuzana Lena Ansorgova Date: Thu, 19 Dec 2024 21:59:34 +0100 Subject: [PATCH 23/28] Reword 'Configuring' to 'Preparing' --- ...orms.adoc => assembly_preparing-client-platforms.adoc} | 2 +- ...networking.adoc => assembly_preparing-networking.adoc} | 2 +- ....adoc => assembly_preparing-provisioning-content.adoc} | 2 +- ...=> assembly_preparing-templates-for-provisioning.adoc} | 2 +- guides/common/modules/con_infoblox-limitations.adoc | 2 +- ...platforms.adoc => con_preparing-client-platforms.adoc} | 4 ++-- ...ring-networking.adoc => con_preparing-networking.adoc} | 4 ++-- ...ntent.adoc => con_preparing-provisioning-content.adoc} | 4 ++-- ...adoc => con_preparing-templates-for-provisioning.adoc} | 4 ++-- .../con_prerequisites-for-bare-metal-provisioning.adoc | 2 +- .../con_prerequisites-for-network-boot-provisioning.adoc | 2 +- .../con_prerequisites-for-vmware-provisioning.adoc | 2 +- .../con_provisioning-cloud-instances-on-openstack.adoc | 2 +- .../con_provisioning-virtual-machines-on-kubevirt.adoc | 2 +- .../modules/con_provisioning-virtual-machines-on-kvm.adoc | 2 +- .../con_provisioning-virtual-machines-on-ovirt.adoc | 2 +- guides/common/modules/proc_adding-a-subnet.adoc | 2 +- .../snip_prerequisite-networking-for-provisioning.adoc | 2 +- guides/doc-Provisioning_Hosts/master.adoc | 2 +- guides/doc-Provisioning_Installer/master.adoc | 8 ++++---- 20 files changed, 27 insertions(+), 27 deletions(-) rename guides/common/{assembly_configuring-provisionable-platforms.adoc => assembly_preparing-client-platforms.adoc} (95%) rename guides/common/{assembly_configuring-networking.adoc => assembly_preparing-networking.adoc} (95%) rename guides/common/{assembly_configuring-provisioning-content.adoc => assembly_preparing-provisioning-content.adoc} (89%) rename guides/common/{assembly_configuring-templates-for-provisioning.adoc => assembly_preparing-templates-for-provisioning.adoc} (93%) rename guides/common/modules/{con_configuring-provisionable-platforms.adoc => con_preparing-client-platforms.adoc} (77%) rename guides/common/modules/{con_configuring-networking.adoc => con_preparing-networking.adoc} (95%) rename guides/common/modules/{con_configuring-provisioning-content.adoc => con_preparing-provisioning-content.adoc} (76%) rename guides/common/modules/{con_configuring-templates-for-provisioning.adoc => con_preparing-templates-for-provisioning.adoc} (89%) diff --git a/guides/common/assembly_configuring-provisionable-platforms.adoc b/guides/common/assembly_preparing-client-platforms.adoc similarity index 95% rename from guides/common/assembly_configuring-provisionable-platforms.adoc rename to guides/common/assembly_preparing-client-platforms.adoc index c36294bc9b7..b970b0d0396 100644 --- a/guides/common/assembly_configuring-provisionable-platforms.adoc +++ b/guides/common/assembly_preparing-client-platforms.adoc @@ -1,4 +1,4 @@ -include::modules/con_configuring-provisionable-platforms.adoc[] +include::modules/con_preparing-client-platforms.adoc[] include::modules/proc_creating-operating-systems.adoc[leveloffset=+1] diff --git a/guides/common/assembly_configuring-networking.adoc b/guides/common/assembly_preparing-networking.adoc similarity index 95% rename from guides/common/assembly_configuring-networking.adoc rename to guides/common/assembly_preparing-networking.adoc index 3f2579ff165..5268a396e4c 100644 --- a/guides/common/assembly_configuring-networking.adoc +++ b/guides/common/assembly_preparing-networking.adoc @@ -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] diff --git a/guides/common/assembly_configuring-provisioning-content.adoc b/guides/common/assembly_preparing-provisioning-content.adoc similarity index 89% rename from guides/common/assembly_configuring-provisioning-content.adoc rename to guides/common/assembly_preparing-provisioning-content.adoc index 492caece7da..73da6054708 100644 --- a/guides/common/assembly_configuring-provisioning-content.adoc +++ b/guides/common/assembly_preparing-provisioning-content.adoc @@ -1,4 +1,4 @@ -include::modules/con_configuring-provisioning-content.adoc[] +include::modules/con_preparing-provisioning-content.adoc[] include::modules/proc_using-a-synced-kickstart-repository.adoc[leveloffset=+1] diff --git a/guides/common/assembly_configuring-templates-for-provisioning.adoc b/guides/common/assembly_preparing-templates-for-provisioning.adoc similarity index 93% rename from guides/common/assembly_configuring-templates-for-provisioning.adoc rename to guides/common/assembly_preparing-templates-for-provisioning.adoc index 18f10ccd400..b17d1bbe3ba 100644 --- a/guides/common/assembly_configuring-templates-for-provisioning.adoc +++ b/guides/common/assembly_preparing-templates-for-provisioning.adoc @@ -1,4 +1,4 @@ -include::modules/con_configuring-templates-for-provisioning.adoc[] +include::modules/con_preparing-templates-for-provisioning.adoc[] include::modules/con_provisioning-templates.adoc[leveloffset=+1] diff --git a/guides/common/modules/con_infoblox-limitations.adoc b/guides/common/modules/con_infoblox-limitations.adoc index 2cc35a15baa..d609b91de85 100644 --- a/guides/common/modules/con_infoblox-limitations.adoc +++ b/guides/common/modules/con_infoblox-limitations.adoc @@ -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[Configuring networking] in _{ProvisioningDocTitle}_. +For more information, see {ProvisioningDocURL}preparing-networking[Preparing networking] in _{ProvisioningDocTitle}_. {Project} IPAM feature cannot be integrated with Infoblox. diff --git a/guides/common/modules/con_configuring-provisionable-platforms.adoc b/guides/common/modules/con_preparing-client-platforms.adoc similarity index 77% rename from guides/common/modules/con_configuring-provisionable-platforms.adoc rename to guides/common/modules/con_preparing-client-platforms.adoc index cb098df1868..02ea463b2c2 100644 --- a/guides/common/modules/con_configuring-provisionable-platforms.adoc +++ b/guides/common/modules/con_preparing-client-platforms.adoc @@ -1,5 +1,5 @@ -[id="configuring-provisionable-platforms"] -= Configuring provisionable platforms +[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. diff --git a/guides/common/modules/con_configuring-networking.adoc b/guides/common/modules/con_preparing-networking.adoc similarity index 95% rename from guides/common/modules/con_configuring-networking.adoc rename to guides/common/modules/con_preparing-networking.adoc index 0dd83042026..5400693d6a8 100644 --- a/guides/common/modules/con_configuring-networking.adoc +++ b/guides/common/modules/con_preparing-networking.adoc @@ -1,5 +1,5 @@ -[id="configuring-networking"] -= 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}. diff --git a/guides/common/modules/con_configuring-provisioning-content.adoc b/guides/common/modules/con_preparing-provisioning-content.adoc similarity index 76% rename from guides/common/modules/con_configuring-provisioning-content.adoc rename to guides/common/modules/con_preparing-provisioning-content.adoc index 6466945a242..cb7090f991c 100644 --- a/guides/common/modules/con_configuring-provisioning-content.adoc +++ b/guides/common/modules/con_preparing-provisioning-content.adoc @@ -1,5 +1,5 @@ -[id="configuring-provisioning-content"] -= Configuring provisioning content +[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. diff --git a/guides/common/modules/con_configuring-templates-for-provisioning.adoc b/guides/common/modules/con_preparing-templates-for-provisioning.adoc similarity index 89% rename from guides/common/modules/con_configuring-templates-for-provisioning.adoc rename to guides/common/modules/con_preparing-templates-for-provisioning.adoc index 04584275d77..aaa3cf515cb 100644 --- a/guides/common/modules/con_configuring-templates-for-provisioning.adoc +++ b/guides/common/modules/con_preparing-templates-for-provisioning.adoc @@ -1,5 +1,5 @@ -[id="configuring-templates-for-provisioning"] -= Configuring templates for provisioning +[id="preparing-templates-for-provisioning"] += Preparing templates for provisioning {Project} provides the following default template types: diff --git a/guides/common/modules/con_prerequisites-for-bare-metal-provisioning.adoc b/guides/common/modules/con_prerequisites-for-bare-metal-provisioning.adoc index d836269f08d..2c6030f1406 100644 --- a/guides/common/modules/con_prerequisites-for-bare-metal-provisioning.adoc +++ b/guides/common/modules/con_prerequisites-for-bare-metal-provisioning.adoc @@ -6,7 +6,7 @@ The requirements for bare-metal provisioning include: * A {SmartProxyServer} managing the network for bare-metal hosts. For unattended provisioning and discovery-based provisioning, {ProjectServer} requires PXE server settings. + -For more information about networking requirements, see xref:configuring-networking[]. +For more information about networking requirements, see xref:preparing-networking[]. + For more information about the Discovery service, xref:discovering-hosts-on-a-network[]. + diff --git a/guides/common/modules/con_prerequisites-for-network-boot-provisioning.adoc b/guides/common/modules/con_prerequisites-for-network-boot-provisioning.adoc index e348a1f232e..6c56552a558 100644 --- a/guides/common/modules/con_prerequisites-for-network-boot-provisioning.adoc +++ b/guides/common/modules/con_prerequisites-for-network-boot-provisioning.adoc @@ -6,7 +6,7 @@ The requirements for network-boot provisioning include: * {SmartProxy} managing the network for the network-booted machines. For unattended provisioning and discovery-based provisioning, {Project} requires PXE server settings. + -For more information about networking requirements, see xref:configuring-networking[]. +For more information about networking requirements, see xref:preparing-networking[]. + For more information about the Discovery service, xref:discovering-hosts-on-a-network[]. diff --git a/guides/common/modules/con_prerequisites-for-vmware-provisioning.adoc b/guides/common/modules/con_prerequisites-for-vmware-provisioning.adoc index 345ddd2a993..9ac13e29483 100644 --- a/guides/common/modules/con_prerequisites-for-vmware-provisioning.adoc +++ b/guides/common/modules/con_prerequisites-for-vmware-provisioning.adoc @@ -12,7 +12,7 @@ The following versions have been fully tested with {Project}: * A {SmartProxyServer} managing a network on the vSphere environment. Ensure no other DHCP services run on this network to avoid conflicts with {SmartProxyServer}. ifndef::orcharhino[] -For more information, see xref:configuring-networking[]. +For more information, see xref:preparing-networking[]. endif::[] * An existing VMware template if you want to use image-based provisioning. include::snip_prerequisites-common-compute-resource.adoc[] diff --git a/guides/common/modules/con_provisioning-cloud-instances-on-openstack.adoc b/guides/common/modules/con_provisioning-cloud-instances-on-openstack.adoc index ef3287270d5..bb99e66bfb6 100644 --- a/guides/common/modules/con_provisioning-cloud-instances-on-openstack.adoc +++ b/guides/common/modules/con_provisioning-cloud-instances-on-openstack.adoc @@ -8,7 +8,7 @@ In {Project}, you can interact with {OpenStack} REST API to create cloud instanc .Prerequisites include::snip_prerequisites-common-compute-resource.adoc[] * A {SmartProxyServer} managing a network in your OpenStack environment. -For more information, see {ProvisioningDocURL}configuring-networking[Configuring Networking] in _{ProvisioningDocTitle}_. +For more information, see {ProvisioningDocURL}preparing-networking[Configuring Networking] in _{ProvisioningDocTitle}_. * An image added to OpenStack Image Storage (glance) service for image-based provisioning. ifndef::orcharhino[] For more information, see the {RHDocsBaseURL}red_hat_openstack_platform/16.0/html/instances_and_images_guide/index[{OpenStack} _Instances and Images Guide_]. diff --git a/guides/common/modules/con_provisioning-virtual-machines-on-kubevirt.adoc b/guides/common/modules/con_provisioning-virtual-machines-on-kubevirt.adoc index 5f4fbd9abfe..355436222d4 100644 --- a/guides/common/modules/con_provisioning-virtual-machines-on-kubevirt.adoc +++ b/guides/common/modules/con_provisioning-virtual-machines-on-kubevirt.adoc @@ -25,7 +25,7 @@ include::snip_prerequisites-common-compute-resource.adoc[] * You must have `cluster-admin` permissions for the {Kubernetes} cluster. * A {SmartProxyServer} managing a network on the {Kubernetes} cluster. Ensure that no other DHCP services run on this network to avoid conflicts with {SmartProxyServer}. -For more information about network service configuration for {SmartProxyServers}, see {ProvisioningDocURL}configuring-networking[Configuring Networking] in _{ProvisioningDocTitle}_. +For more information about network service configuration for {SmartProxyServers}, see {ProvisioningDocURL}preparing-networking[Configuring Networking] in _{ProvisioningDocTitle}_. .Additional resources * For a list of permissions a non-admin user requires to provision hosts, see xref:permissions-required-to-provision-hosts_provisioning[]. diff --git a/guides/common/modules/con_provisioning-virtual-machines-on-kvm.adoc b/guides/common/modules/con_provisioning-virtual-machines-on-kvm.adoc index 6c21d967852..facb3ce3887 100644 --- a/guides/common/modules/con_provisioning-virtual-machines-on-kvm.adoc +++ b/guides/common/modules/con_provisioning-virtual-machines-on-kvm.adoc @@ -13,7 +13,7 @@ You can use KVM provisioning to create hosts over a network connection or from a include::snip_prerequisites-common-compute-resource.adoc[] * A {SmartProxyServer} managing a network on the KVM server. Ensure no other DHCP services run on this network to avoid conflicts with {SmartProxyServer}. -For more information about network service configuration for {SmartProxyServers}, see {ProvisioningDocURL}configuring-networking[Configuring Networking] in _{ProvisioningDocTitle}_. +For more information about network service configuration for {SmartProxyServers}, see {ProvisioningDocURL}preparing-networking[Configuring Networking] in _{ProvisioningDocTitle}_. ifdef::satellite[] * A {RHEL} server running KVM virtualization tools (libvirt daemon). For more information, see the {RHELDocsBaseURL}8/html/configuring_and_managing_virtualization/index[_{RHEL}{nbsp}8 Configuring and managing virtualization_]. diff --git a/guides/common/modules/con_provisioning-virtual-machines-on-ovirt.adoc b/guides/common/modules/con_provisioning-virtual-machines-on-ovirt.adoc index 24861d21294..719672f8e62 100644 --- a/guides/common/modules/con_provisioning-virtual-machines-on-ovirt.adoc +++ b/guides/common/modules/con_provisioning-virtual-machines-on-ovirt.adoc @@ -15,7 +15,7 @@ This method does not require {Project} to connect to the provisioned virtual mac include::snip_prerequisites-common-compute-resource.adoc[] * A {SmartProxyServer} managing a logical network on the {oVirt} environment. Ensure no other DHCP services run on this network to avoid conflicts with {SmartProxyServer}. -For more information, see {ProvisioningDocURL}configuring-networking[Configuring Networking] in _{ProvisioningDocTitle}_. +For more information, see {ProvisioningDocURL}preparing-networking[Configuring Networking] in _{ProvisioningDocTitle}_. * An existing template, other than the `blank` template, if you want to use image-based provisioning. For more information about creating templates for virtual machines, see ifdef::satellite[] diff --git a/guides/common/modules/proc_adding-a-subnet.adoc b/guides/common/modules/proc_adding-a-subnet.adoc index 563ea19ac07..0e674292bd9 100644 --- a/guides/common/modules/proc_adding-a-subnet.adoc +++ b/guides/common/modules/proc_adding-a-subnet.adoc @@ -17,7 +17,7 @@ To use the CLI instead of the {ProjectWebUI}, see the xref:cli-adding-a-subnet_{ . In the *Primary DNS server* field, enter a primary DNS for the subnet. . In the *Secondary DNS server*, enter a secondary DNS for the subnet. . From the *IPAM* list, select the method that you want to use for IP address management (IPAM). -For more information about IPAM, see xref:configuring-networking[]. +For more information about IPAM, see xref:preparing-networking[]. + . Enter the information for the IPAM method that you select. ifdef::satellite,orcharhino[] diff --git a/guides/common/modules/snip_prerequisite-networking-for-provisioning.adoc b/guides/common/modules/snip_prerequisite-networking-for-provisioning.adoc index 67334b9e396..3731c56f012 100644 --- a/guides/common/modules/snip_prerequisite-networking-for-provisioning.adoc +++ b/guides/common/modules/snip_prerequisite-networking-for-provisioning.adoc @@ -1,2 +1,2 @@ * Configure a domain and subnet on {Project}. -For more information about networking requirements, see xref:configuring-networking[]. +For more information about networking requirements, see xref:preparing-networking[]. diff --git a/guides/doc-Provisioning_Hosts/master.adoc b/guides/doc-Provisioning_Hosts/master.adoc index bf7ec405f4b..b488b85fc11 100644 --- a/guides/doc-Provisioning_Hosts/master.adoc +++ b/guides/doc-Provisioning_Hosts/master.adoc @@ -19,7 +19,7 @@ include::common/assembly_introduction-to-provisioning.adoc[leveloffset=+1] include::common/assembly_configuring-provisioning-resources.adoc[leveloffset=+1] -include::common/assembly_configuring-networking.adoc[leveloffset=+1] +include::common/assembly_preparing-networking.adoc[leveloffset=+1] include::common/assembly_using-pxe-to-provision-hosts.adoc[leveloffset=+1] diff --git a/guides/doc-Provisioning_Installer/master.adoc b/guides/doc-Provisioning_Installer/master.adoc index 5539ba1626c..9600d2721da 100644 --- a/guides/doc-Provisioning_Installer/master.adoc +++ b/guides/doc-Provisioning_Installer/master.adoc @@ -17,13 +17,13 @@ endif::[] include::common/assembly_introduction-to-provisioning.adoc[leveloffset=+1] -include::common/assembly_configuring-provisioning-content.adoc[leveloffset=+1] +include::common/assembly_preparing-provisioning-content.adoc[leveloffset=+1] -include::common/assembly_configuring-provisionable-platforms.adoc[leveloffset=+1] +include::common/assembly_preparing-client-platforms.adoc[leveloffset=+1] -include::common/assembly_configuring-templates-for-provisioning.adoc[leveloffset=+1] +include::common/assembly_preparing-templates-for-provisioning.adoc[leveloffset=+1] -include::common/assembly_configuring-networking.adoc[leveloffset=+1] +include::common/assembly_preparing-networking.adoc[leveloffset=+1] include::common/assembly_security-settings.adoc[leveloffset=+1] From 9566c0b03218677bf090421716c0286209451c7b Mon Sep 17 00:00:00 2001 From: Zuzana Lena Ansorgova Date: Thu, 19 Dec 2024 22:01:59 +0100 Subject: [PATCH 24/28] Change the title of the guide --- guides/common/attributes-satellite.adoc | 2 +- guides/common/attributes-titles.adoc | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/guides/common/attributes-satellite.adoc b/guides/common/attributes-satellite.adoc index 44079666d40..262dc130d27 100644 --- a/guides/common/attributes-satellite.adoc +++ b/guides/common/attributes-satellite.adoc @@ -28,7 +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_installer_automation/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# diff --git a/guides/common/attributes-titles.adoc b/guides/common/attributes-titles.adoc index a09ab114c93..d04a0360ec1 100644 --- a/guides/common/attributes-titles.adoc +++ b/guides/common/attributes-titles.adoc @@ -24,7 +24,7 @@ :MonitoringDocTitle: Monitoring {Project} performance :PlanningDocTitle: Planning for {ProjectName} :ProvisioningDocTitle: Provisioning hosts -:ProvisioningInstallerDocTitle: Provisioning hosts by using installer automation +: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} @@ -51,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::[] From 7bb21f26573a835c1a0d0268a6e276fb1cb1a3ec Mon Sep 17 00:00:00 2001 From: Zuzana Lena Ansorgova Date: Thu, 19 Dec 2024 22:39:54 +0100 Subject: [PATCH 25/28] Rename two headings --- .../common/assembly_configuring-provisioning-resources.adoc | 2 +- guides/common/assembly_preparing-provisioning-content.adoc | 4 ++-- ...onfiguring-project-to-provision-from-a-builder-image.adoc} | 4 ++-- ...> proc_preparing-a-synchronized-kickstart-repository.adoc} | 4 ++-- guides/doc-Provisioning_Hosts/master.adoc | 2 +- 5 files changed, 8 insertions(+), 8 deletions(-) rename guides/common/modules/{proc_using-an-imagebuilder-image-for-provisioning.adoc => proc_configuring-project-to-provision-from-a-builder-image.adoc} (94%) rename guides/common/modules/{proc_using-a-synced-kickstart-repository.adoc => proc_preparing-a-synchronized-kickstart-repository.adoc} (92%) diff --git a/guides/common/assembly_configuring-provisioning-resources.adoc b/guides/common/assembly_configuring-provisioning-resources.adoc index 690700e2364..ade7e3fa635 100644 --- a/guides/common/assembly_configuring-provisioning-resources.adoc +++ b/guides/common/assembly_configuring-provisioning-resources.adoc @@ -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] diff --git a/guides/common/assembly_preparing-provisioning-content.adoc b/guides/common/assembly_preparing-provisioning-content.adoc index 73da6054708..3e8657354cd 100644 --- a/guides/common/assembly_preparing-provisioning-content.adoc +++ b/guides/common/assembly_preparing-provisioning-content.adoc @@ -1,8 +1,8 @@ include::modules/con_preparing-provisioning-content.adoc[] -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_using-an-imagebuilder-image-for-provisioning.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] diff --git a/guides/common/modules/proc_using-an-imagebuilder-image-for-provisioning.adoc b/guides/common/modules/proc_configuring-project-to-provision-from-a-builder-image.adoc similarity index 94% rename from guides/common/modules/proc_using-an-imagebuilder-image-for-provisioning.adoc rename to guides/common/modules/proc_configuring-project-to-provision-from-a-builder-image.adoc index a82d8c9a451..d14c834b4f6 100644 --- a/guides/common/modules/proc_using-an-imagebuilder-image-for-provisioning.adoc +++ b/guides/common/modules/proc_configuring-project-to-provision-from-a-builder-image.adoc @@ -1,5 +1,5 @@ -[id="Using_an_Image_Builder_Image_for_Provisioning_{context}"] -= Using a {LoraxCompose} image for provisioning +[id="configuring-{project-context}-to-provision-from-a-builder-image"] += Configuring {Project} to provision from a {LoraxCompose} image In {Project}, you can enable integration with {the-Cockpit} to perform actions and monitor your hosts. Using {the-Cockpit}, you can access {LoraxCompose} and build images that you can then upload to an HTTP server and use this image to provision hosts. diff --git a/guides/common/modules/proc_using-a-synced-kickstart-repository.adoc b/guides/common/modules/proc_preparing-a-synchronized-kickstart-repository.adoc similarity index 92% rename from guides/common/modules/proc_using-a-synced-kickstart-repository.adoc rename to guides/common/modules/proc_preparing-a-synchronized-kickstart-repository.adoc index 59bc8668a1d..b6deba1b205 100644 --- a/guides/common/modules/proc_using-a-synced-kickstart-repository.adoc +++ b/guides/common/modules/proc_preparing-a-synchronized-kickstart-repository.adoc @@ -1,5 +1,5 @@ -[id="using-a-synchronized-kickstart-repository-as-an-installation-medium"] -= Using a synchronized Kickstart repository as an installation medium +[id="preparing-a-synchronized-kickstart-repository"] += Preparing a synchronized Kickstart repository ifdef::foreman-el,katello[] The following feature is provided by the Katello plugin. diff --git a/guides/doc-Provisioning_Hosts/master.adoc b/guides/doc-Provisioning_Hosts/master.adoc index b488b85fc11..858a7322c92 100644 --- a/guides/doc-Provisioning_Hosts/master.adoc +++ b/guides/doc-Provisioning_Hosts/master.adoc @@ -27,7 +27,7 @@ include::common/assembly_using-ipxe-to-reduce-provisioning-times.adoc[leveloffse include::common/assembly_discovering-hosts-on-a-network.adoc[leveloffset=+1] -include::common/modules/proc_using-an-imagebuilder-image-for-provisioning.adoc[leveloffset=+1] +include::common/modules/proc_configuring-project-to-provision-from-a-builder-image.adoc[leveloffset=+1] include::common/assembly_provisioning-virtual-machines-kvm.adoc[leveloffset=+1] From 80299e43a057780ca5c18508af6193d88aad7003 Mon Sep 17 00:00:00 2001 From: Zuzana Lena Ansorgova Date: Fri, 20 Dec 2024 18:11:27 +0100 Subject: [PATCH 26/28] Fix link labels --- .../modules/con_provisioning-cloud-instances-on-openstack.adoc | 2 +- .../modules/con_provisioning-virtual-machines-on-kubevirt.adoc | 2 +- .../modules/con_provisioning-virtual-machines-on-kvm.adoc | 2 +- .../modules/con_provisioning-virtual-machines-on-ovirt.adoc | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/guides/common/modules/con_provisioning-cloud-instances-on-openstack.adoc b/guides/common/modules/con_provisioning-cloud-instances-on-openstack.adoc index bb99e66bfb6..d144f20b041 100644 --- a/guides/common/modules/con_provisioning-cloud-instances-on-openstack.adoc +++ b/guides/common/modules/con_provisioning-cloud-instances-on-openstack.adoc @@ -8,7 +8,7 @@ In {Project}, you can interact with {OpenStack} REST API to create cloud instanc .Prerequisites include::snip_prerequisites-common-compute-resource.adoc[] * A {SmartProxyServer} managing a network in your OpenStack environment. -For more information, see {ProvisioningDocURL}preparing-networking[Configuring Networking] in _{ProvisioningDocTitle}_. +For more information, see {ProvisioningDocURL}preparing-networking[Preparing networking] in _{ProvisioningDocTitle}_. * An image added to OpenStack Image Storage (glance) service for image-based provisioning. ifndef::orcharhino[] For more information, see the {RHDocsBaseURL}red_hat_openstack_platform/16.0/html/instances_and_images_guide/index[{OpenStack} _Instances and Images Guide_]. diff --git a/guides/common/modules/con_provisioning-virtual-machines-on-kubevirt.adoc b/guides/common/modules/con_provisioning-virtual-machines-on-kubevirt.adoc index 355436222d4..0d0d07acd1d 100644 --- a/guides/common/modules/con_provisioning-virtual-machines-on-kubevirt.adoc +++ b/guides/common/modules/con_provisioning-virtual-machines-on-kubevirt.adoc @@ -25,7 +25,7 @@ include::snip_prerequisites-common-compute-resource.adoc[] * You must have `cluster-admin` permissions for the {Kubernetes} cluster. * A {SmartProxyServer} managing a network on the {Kubernetes} cluster. Ensure that no other DHCP services run on this network to avoid conflicts with {SmartProxyServer}. -For more information about network service configuration for {SmartProxyServers}, see {ProvisioningDocURL}preparing-networking[Configuring Networking] in _{ProvisioningDocTitle}_. +For more information about network service configuration for {SmartProxyServers}, see {ProvisioningDocURL}preparing-networking[Preparing networking] in _{ProvisioningDocTitle}_. .Additional resources * For a list of permissions a non-admin user requires to provision hosts, see xref:permissions-required-to-provision-hosts_provisioning[]. diff --git a/guides/common/modules/con_provisioning-virtual-machines-on-kvm.adoc b/guides/common/modules/con_provisioning-virtual-machines-on-kvm.adoc index facb3ce3887..1c5cbd8cf9e 100644 --- a/guides/common/modules/con_provisioning-virtual-machines-on-kvm.adoc +++ b/guides/common/modules/con_provisioning-virtual-machines-on-kvm.adoc @@ -13,7 +13,7 @@ You can use KVM provisioning to create hosts over a network connection or from a include::snip_prerequisites-common-compute-resource.adoc[] * A {SmartProxyServer} managing a network on the KVM server. Ensure no other DHCP services run on this network to avoid conflicts with {SmartProxyServer}. -For more information about network service configuration for {SmartProxyServers}, see {ProvisioningDocURL}preparing-networking[Configuring Networking] in _{ProvisioningDocTitle}_. +For more information about network service configuration for {SmartProxyServers}, see {ProvisioningDocURL}preparing-networking[Preparing networking] in _{ProvisioningDocTitle}_. ifdef::satellite[] * A {RHEL} server running KVM virtualization tools (libvirt daemon). For more information, see the {RHELDocsBaseURL}8/html/configuring_and_managing_virtualization/index[_{RHEL}{nbsp}8 Configuring and managing virtualization_]. diff --git a/guides/common/modules/con_provisioning-virtual-machines-on-ovirt.adoc b/guides/common/modules/con_provisioning-virtual-machines-on-ovirt.adoc index 719672f8e62..7ba0dfdc8ec 100644 --- a/guides/common/modules/con_provisioning-virtual-machines-on-ovirt.adoc +++ b/guides/common/modules/con_provisioning-virtual-machines-on-ovirt.adoc @@ -15,7 +15,7 @@ This method does not require {Project} to connect to the provisioned virtual mac include::snip_prerequisites-common-compute-resource.adoc[] * A {SmartProxyServer} managing a logical network on the {oVirt} environment. Ensure no other DHCP services run on this network to avoid conflicts with {SmartProxyServer}. -For more information, see {ProvisioningDocURL}preparing-networking[Configuring Networking] in _{ProvisioningDocTitle}_. +For more information, see {ProvisioningDocURL}preparing-networking[Preparing networking] in _{ProvisioningDocTitle}_. * An existing template, other than the `blank` template, if you want to use image-based provisioning. For more information about creating templates for virtual machines, see ifdef::satellite[] From 3a0fd7682d83d5f27431613007a5758f7384d8b9 Mon Sep 17 00:00:00 2001 From: Zuzana Lena Ansorgova Date: Fri, 20 Dec 2024 20:18:28 +0100 Subject: [PATCH 27/28] Refactor TFTP boot --- ...assembly_using-network-boot-to-provision-hosts.adoc | 2 +- .../proc_creating-hosts-from-discovered-hosts.adoc | 2 +- ...oc_creating-hosts-with-tftp-boot-provisioning.adoc} | 10 +++++----- 3 files changed, 7 insertions(+), 7 deletions(-) rename guides/common/modules/{proc_creating-hosts-with-pxe-provisioning.adoc => proc_creating-hosts-with-tftp-boot-provisioning.adoc} (89%) diff --git a/guides/common/assembly_using-network-boot-to-provision-hosts.adoc b/guides/common/assembly_using-network-boot-to-provision-hosts.adoc index 4f9ee9b644b..2ee2412282c 100644 --- a/guides/common/assembly_using-network-boot-to-provision-hosts.adoc +++ b/guides/common/assembly_using-network-boot-to-provision-hosts.adoc @@ -106,7 +106,7 @@ include::modules/proc_configuring-smart-proxy-to-provision-secure-boot-enabled-h :!shim_efi_tmp_binary_path: endif::[] -include::modules/proc_creating-hosts-with-pxe-provisioning.adoc[leveloffset=+1] +include::modules/proc_creating-hosts-with-tftp-boot-provisioning.adoc[leveloffset=+1] include::modules/proc_creating-hosts-with-uefi-http-boot-provisioning.adoc[leveloffset=+1] diff --git a/guides/common/modules/proc_creating-hosts-from-discovered-hosts.adoc b/guides/common/modules/proc_creating-hosts-from-discovered-hosts.adoc index 81ca346b794..f084da7f2f4 100644 --- a/guides/common/modules/proc_creating-hosts-from-discovered-hosts.adoc +++ b/guides/common/modules/proc_creating-hosts-from-discovered-hosts.adoc @@ -70,7 +70,7 @@ This removes the host from the discovered host listing and creates a host entry The Discovery image automatically reboots the host to PXE or initiates kernel execution. The host detects the DHCP service and starts installing the operating system. ifdef::provisioning[] -The rest of the process is identical to the normal PXE workflow described in xref:Creating_Hosts_with_Unattended_Provisioning_{context}[]. +The rest of the process is identical to the normal PXE workflow described in xref:creating-hosts-with-tftp-boot-provisioning[]. endif::[] ifdef::provisioning-installer[] The rest of the process is identical to the normal PXE workflow. diff --git a/guides/common/modules/proc_creating-hosts-with-pxe-provisioning.adoc b/guides/common/modules/proc_creating-hosts-with-tftp-boot-provisioning.adoc similarity index 89% rename from guides/common/modules/proc_creating-hosts-with-pxe-provisioning.adoc rename to guides/common/modules/proc_creating-hosts-with-tftp-boot-provisioning.adoc index a8a55e7d0dc..d700b5d1641 100644 --- a/guides/common/modules/proc_creating-hosts-with-pxe-provisioning.adoc +++ b/guides/common/modules/proc_creating-hosts-with-tftp-boot-provisioning.adoc @@ -1,5 +1,5 @@ -[id="creating-hosts-with-pxe-provisioning"] -= Creating hosts with PXE provisioning +[id="creating-hosts-with-tftp-boot-provisioning"] += Creating hosts with TFTP boot provisioning Unattended provisioning is the simplest form of host provisioning. You enter the host details on {ProjectServer} and boot your host. @@ -7,7 +7,7 @@ You enter the host details on {ProjectServer} and boot your host. This method of provisioning hosts uses minimal interaction during the process. -To use the CLI instead of the {ProjectWebUI}, see the xref:cli-creating-hosts-with-pxe-provisioning[]. +To use the CLI instead of the {ProjectWebUI}, see the xref:cli-creating-hosts-with-tftp-provisioning[]. .Procedure include::snip_steps-create-a-host-tab-host.adoc[] @@ -33,7 +33,7 @@ ifdef::katello,satellite,orcharhino[] When the installation completes, the host also registers to {ProjectServer} using the activation key and installs the necessary configuration and management tools from the {project-client-name} repository. endif::[] -[id="cli-creating-hosts-with-pxe-provisioning"] +[id="cli-creating-hosts-with-tftp-provisioning"] .CLI procedure . Create the host with the `hammer host create` command: + @@ -49,7 +49,7 @@ $ hammer host create \ --name "_My_Host_Name_" \ --organization "_My_Organization_" ---- -. Configure the network interface: +. Ensure the network interface options are set using the `hammer host interface update` command: + ---- $ hammer host interface update \ From 5cb540b5d51e9df3294c43404ac5eca233bbab93 Mon Sep 17 00:00:00 2001 From: Zuzana Lena Ansorgova Date: Fri, 20 Dec 2024 20:29:20 +0100 Subject: [PATCH 28/28] fixup! Refactor TFTP boot --- .../modules/proc_creating-hosts-from-discovered-hosts.adoc | 4 ++-- .../proc_creating-hosts-with-tftp-boot-provisioning.adoc | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/guides/common/modules/proc_creating-hosts-from-discovered-hosts.adoc b/guides/common/modules/proc_creating-hosts-from-discovered-hosts.adoc index f084da7f2f4..ecd7e4a5f03 100644 --- a/guides/common/modules/proc_creating-hosts-from-discovered-hosts.adoc +++ b/guides/common/modules/proc_creating-hosts-from-discovered-hosts.adoc @@ -70,9 +70,9 @@ This removes the host from the discovered host listing and creates a host entry The Discovery image automatically reboots the host to PXE or initiates kernel execution. The host detects the DHCP service and starts installing the operating system. ifdef::provisioning[] -The rest of the process is identical to the normal PXE workflow described in xref:creating-hosts-with-tftp-boot-provisioning[]. +The rest of the process is identical to the normal PXE workflow described in xref:Creating_Hosts_with_Unattended_Provisioning_{context}[]. endif::[] ifdef::provisioning-installer[] The rest of the process is identical to the normal PXE workflow. -For more information, see xref:creating-hosts-with-pxe-provisioning[]. +For more information, see xref:creating-hosts-with-tftp-boot-provisioning[]. endif::[] \ No newline at end of file diff --git a/guides/common/modules/proc_creating-hosts-with-tftp-boot-provisioning.adoc b/guides/common/modules/proc_creating-hosts-with-tftp-boot-provisioning.adoc index d700b5d1641..8b76aceaa48 100644 --- a/guides/common/modules/proc_creating-hosts-with-tftp-boot-provisioning.adoc +++ b/guides/common/modules/proc_creating-hosts-with-tftp-boot-provisioning.adoc @@ -7,7 +7,7 @@ You enter the host details on {ProjectServer} and boot your host. This method of provisioning hosts uses minimal interaction during the process. -To use the CLI instead of the {ProjectWebUI}, see the xref:cli-creating-hosts-with-tftp-provisioning[]. +To use the CLI instead of the {ProjectWebUI}, see the xref:cli-creating-hosts-with-tftp-boot-provisioning[]. .Procedure include::snip_steps-create-a-host-tab-host.adoc[] @@ -33,7 +33,7 @@ ifdef::katello,satellite,orcharhino[] When the installation completes, the host also registers to {ProjectServer} using the activation key and installs the necessary configuration and management tools from the {project-client-name} repository. endif::[] -[id="cli-creating-hosts-with-tftp-provisioning"] +[id="cli-creating-hosts-with-tftp-boot-provisioning"] .CLI procedure . Create the host with the `hammer host create` command: +