diff --git a/guides/common/assembly_bootloader-binary-location.adoc b/guides/common/assembly_bootloader-binary-location.adoc index 97d5b96bd22..1068681de9e 100644 --- a/guides/common/assembly_bootloader-binary-location.adoc +++ b/guides/common/assembly_bootloader-binary-location.adoc @@ -4,6 +4,6 @@ include::modules/ref_boot-loader-types-in-project.adoc[leveloffset=+1] include::modules/ref_pxelinux-boot-loaders.adoc[leveloffset=+1] -include::modules/ref_grub2-uefi-boot-loaders.adoc[leveloffset=+1] +include::modules/ref_grub2-uefi-boot-loader-and-the-bootloader-universe-structure.adoc[leveloffset=+1] include::modules/ref_http-capable-boot-loaders.adoc[leveloffset=+1] diff --git a/guides/common/assembly_building-cloud-images-for-project.adoc b/guides/common/assembly_building-cloud-images-for-project.adoc index 7c2459e4e3a..2dc51b7af56 100644 --- a/guides/common/assembly_building-cloud-images-for-project.adoc +++ b/guides/common/assembly_building-cloud-images-for-project.adoc @@ -2,7 +2,7 @@ include::modules/con_building-cloud-images-for-project.adoc[] include::modules/ref_preconfigured-rhel-kvm-guest-images.adoc[leveloffset=+1] -include::modules/ref_host-requirements-for-custom-images.adoc[leveloffset=+1] +include::modules/ref_host-requirements-for-custom-rhel-images.adoc[leveloffset=+1] include::modules/ref_supported-clients-in-registration.adoc[leveloffset=+1] @@ -19,5 +19,5 @@ include::modules/proc_registering-a-host-by-using-ansible.adoc[leveloffset=+1] include::modules/proc_configuring-openvox-agent-on-a-host-manually.adoc[leveloffset=+1] ifdef::satellite[] -include::modules/proc_completing-the-rhel7-image.adoc[leveloffset=+1] +include::modules/proc_completing-the-rhel-7-image.adoc[leveloffset=+1] endif::[] diff --git a/guides/common/assembly_discovering-hosts-on-a-network.adoc b/guides/common/assembly_discovering-hosts-on-a-network.adoc index f9c9bb29251..80df8d659f7 100644 --- a/guides/common/assembly_discovering-hosts-on-a-network.adoc +++ b/guides/common/assembly_discovering-hosts-on-a-network.adoc @@ -7,7 +7,7 @@ include::modules/proc_installing-the-discovery-service.adoc[leveloffset=+1] // PXE Discovery include::modules/con_discovery-in-pxe-mode.adoc[leveloffset=+1] -include::modules/proc_setting-discovery-as-the-default-PXE-boot-option.adoc[leveloffset=+2] +include::modules/proc_setting-discovery-as-the-default-pxe-boot-option.adoc[leveloffset=+2] include::modules/proc_performing-discovery-in-pxe-mode.adoc[leveloffset=+2] @@ -20,7 +20,7 @@ endif::[] // PXE-less Discovery include::modules/con_discovery-in-pxeless-mode.adoc[leveloffset=+1] -include::modules/proc_performing-discovery-in-pxeless-mode.adoc[leveloffset=+2] +include::modules/proc_performing-discovery-in-pxe-less-mode.adoc[leveloffset=+2] include::modules/proc_customizing-the-discovery-iso.adoc[leveloffset=+2] 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 6d914bcfeab..84ec85d3453 100644 --- a/guides/common/assembly_using-boot-disks-to-provision-hosts.adoc +++ b/guides/common/assembly_using-boot-disks-to-provision-hosts.adoc @@ -9,7 +9,7 @@ include::modules/con_boot-disk-workflow.adoc[leveloffset=+1] include::modules/con_boot-disk-types.adoc[leveloffset=+1] ifndef::satellite[] -include::modules/proc_enabling-bootdisk-plugin.adoc[leveloffset=+1] +include::modules/proc_enabling-the-bootdisk-plugin.adoc[leveloffset=+1] endif::[] include::modules/proc_generating-a-full-host-boot-disk-by-using-web-ui.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 c1974fb2c0a..6d18d14c683 100644 --- a/guides/common/assembly_using-network-boot-to-provision-hosts.adoc +++ b/guides/common/assembly_using-network-boot-to-provision-hosts.adoc @@ -19,7 +19,7 @@ include::modules/ref_required-boot-order-for-network-boot.adoc[leveloffset=+1] :parent-client-pkg-ext: {client-pkg-ext} ifdef::foreman-el,foreman-deb,katello,almalinux,debian,red_hat_enterprise_linux,rocky_linux,ubuntu[] -include::modules/con_configuring-smartproxy-for-secure-boot.adoc[leveloffset=+1] +include::modules/con_configuring-smart-proxy-for-secure-boot.adoc[leveloffset=+1] endif::[] ifdef::foreman-el,foreman-deb,katello,almalinux[] @@ -37,7 +37,7 @@ ifdef::foreman-el,foreman-deb,katello,almalinux[] :shim_efi_tmp_binary_path: /tmp/boot/efi/EFI/{client-os-context}/shimx64.efi :extract_grub: {extract_rpm_prefix}/{grub_efi_downloaded_package_name} {extract_rpm_suffix} :extract_shim: {extract_rpm_prefix}/{shim_efi_downloaded_package_name} {extract_rpm_suffix} -include::modules/proc_configuring-smart-proxy-to-provision-secure-boot-enabled-hosts.adoc[leveloffset=+2] +include::modules/proc_configuring-smart-proxy-to-provision-client-os-on-secure-boot-enabled-hosts.adoc[leveloffset=+2] endif::[] ifdef::foreman-el,foreman-deb,katello,debian[] @@ -55,7 +55,7 @@ ifdef::foreman-el,foreman-deb,katello,debian[] :shim_efi_tmp_binary_path: /tmp/usr/lib/shim/shimx64.efi.signed :extract_grub: {extract_deb_prefix}/{grub_efi_downloaded_package_name} {extract_deb_xz_suffix} :extract_shim: {extract_deb_prefix}/{shim_efi_downloaded_package_name} {extract_deb_xz_suffix} -include::modules/proc_configuring-smart-proxy-to-provision-secure-boot-enabled-hosts.adoc[leveloffset=+2] +include::modules/proc_configuring-smart-proxy-to-provision-client-os-on-secure-boot-enabled-hosts.adoc[leveloffset=+2] endif::[] ifdef::foreman-el,foreman-deb,katello,satellite,red_hat_enterprise_linux[] @@ -75,10 +75,10 @@ ifdef::foreman-el,foreman-deb,katello,satellite,red_hat_enterprise_linux[] :extract_shim: {extract_rpm_prefix}/{shim_efi_downloaded_package_name} {extract_rpm_suffix} endif::[] ifdef::foreman-el,foreman-deb,katello,red_hat_enterprise_linux[] -include::modules/proc_configuring-smart-proxy-to-provision-secure-boot-enabled-hosts.adoc[leveloffset=+2] +include::modules/proc_configuring-smart-proxy-to-provision-client-os-on-secure-boot-enabled-hosts.adoc[leveloffset=+2] endif::[] ifdef::satellite[] -include::modules/proc_configuring-smart-proxy-to-provision-secure-boot-enabled-hosts.adoc[leveloffset=+1] +include::modules/proc_configuring-smart-proxy-to-provision-client-os-on-secure-boot-enabled-hosts.adoc[leveloffset=+1] endif::[] ifdef::foreman-el,foreman-deb,katello,rocky_linux[] @@ -96,7 +96,7 @@ ifdef::foreman-el,foreman-deb,katello,rocky_linux[] :shim_efi_tmp_binary_path: /tmp/boot/efi/EFI/{client-os-context}/shimx64.efi :extract_grub: {extract_rpm_prefix}/{grub_efi_downloaded_package_name} {extract_rpm_suffix} :extract_shim: {extract_rpm_prefix}/{shim_efi_downloaded_package_name} {extract_rpm_suffix} -include::modules/proc_configuring-smart-proxy-to-provision-secure-boot-enabled-hosts.adoc[leveloffset=+2] +include::modules/proc_configuring-smart-proxy-to-provision-client-os-on-secure-boot-enabled-hosts.adoc[leveloffset=+2] endif::[] ifdef::foreman-el,foreman-deb,katello,ubuntu[] @@ -114,7 +114,7 @@ ifdef::foreman-el,foreman-deb,katello,ubuntu[] :shim_efi_tmp_binary_path: /tmp/usr/lib/shim/shimx64.efi.signed.latest :extract_grub: {extract_deb_prefix}/{grub_efi_downloaded_package_name} {extract_deb_zst_suffix} :extract_shim: {extract_deb_prefix}/{shim_efi_downloaded_package_name} {extract_deb_xz_suffix} -include::modules/proc_configuring-smart-proxy-to-provision-secure-boot-enabled-hosts.adoc[leveloffset=+2] +include::modules/proc_configuring-smart-proxy-to-provision-client-os-on-secure-boot-enabled-hosts.adoc[leveloffset=+2] endif::[] // reset global attributes @@ -144,7 +144,7 @@ include::modules/proc_creating-hosts-with-pxe-boot-provisioning-by-using-web-ui. include::modules/proc_creating-hosts-with-pxe-boot-provisioning-by-using-cli.adoc[leveloffset=+1] -include::modules/proc_configuring-smartproxy-for-uefi-http-booting.adoc[leveloffset=+1] +include::modules/proc_configuring-smart-proxy-for-uefi-http-booting.adoc[leveloffset=+1] include::modules/proc_creating-hosts-with-uefi-http-boot-provisioning-by-using-web-ui.adoc[leveloffset=+1] diff --git a/guides/common/modules/con_configuring-provisioning.adoc b/guides/common/modules/con_configuring-provisioning.adoc index ecd6f55c1b0..3b3f625d149 100644 --- a/guides/common/modules/con_configuring-provisioning.adoc +++ b/guides/common/modules/con_configuring-provisioning.adoc @@ -16,7 +16,7 @@ The following {Project} features support automating the provisioning of your hos ifndef::satellite[] + This requires the Discovery plugin. -For more information, see {ProvisioningDocURL}Installing_the_Discovery_Service_provisioning[Installing the Discovery service] in _{ProvisioningDocTitle}_. +For more information, see {ProvisioningDocURL}installing-the-discovery-service[Installing the Discovery service] in _{ProvisioningDocTitle}_. endif::[] * Host groups enable you to standardize provisioning of host configurations. diff --git a/guides/common/modules/con_configuring-smartproxy-for-secure-boot.adoc b/guides/common/modules/con_configuring-smart-proxy-for-secure-boot.adoc similarity index 100% rename from guides/common/modules/con_configuring-smartproxy-for-secure-boot.adoc rename to guides/common/modules/con_configuring-smart-proxy-for-secure-boot.adoc diff --git a/guides/common/modules/con_prerequisites-for-using-discovery.adoc b/guides/common/modules/con_prerequisites-for-using-discovery.adoc index 875d9673f59..44e14776090 100644 --- a/guides/common/modules/con_prerequisites-for-using-discovery.adoc +++ b/guides/common/modules/con_prerequisites-for-using-discovery.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: CONCEPT -[id="prerequisites-for-using-discovery_{context}"] +[id="prerequisites-for-using-discovery"] = Prerequisites for using Discovery [role="_abstract"] diff --git a/guides/common/modules/con_using-ipxe-to-reduce-provisioning-times.adoc b/guides/common/modules/con_using-ipxe-to-reduce-provisioning-times.adoc index 67127bd4039..0286261c01e 100644 --- a/guides/common/modules/con_using-ipxe-to-reduce-provisioning-times.adoc +++ b/guides/common/modules/con_using-ipxe-to-reduce-provisioning-times.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: CONCEPT -[id="using-ipxe-to-reduce-provisioning-times_{context}"] +[id="using-ipxe-to-reduce-provisioning-times"] = Using iPXE to reduce provisioning times [role="_abstract"] diff --git a/guides/common/modules/proc_booting-virtual-machines.adoc b/guides/common/modules/proc_booting-virtual-machines.adoc index 4a86c1bdcd7..a66f1e853b0 100644 --- a/guides/common/modules/proc_booting-virtual-machines.adoc +++ b/guides/common/modules/proc_booting-virtual-machines.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: PROCEDURE -[id="Booting_Virtual_Machines_{context}"] +[id="booting-virtual-machines"] = Booting virtual machines [role="_abstract"] @@ -16,7 +16,7 @@ ifndef::satellite[] ** VMWare (https://ipxe.org/howto/vmware[via custom firmware]) endif::[] * You have configured your iPXE environment. -For more information, see xref:Configuring_iPXE_Environment_{context}[]. +For more information, see xref:configuring-ipxe-environment[]. .Procedure . In the {ProjectWebUI}, navigate to *Hosts* > *Templates* > *Provisioning Templates*. diff --git a/guides/common/modules/proc_building-a-custom-discovery-image.adoc b/guides/common/modules/proc_building-a-custom-discovery-image.adoc index baace6a89ca..fe9a3630433 100644 --- a/guides/common/modules/proc_building-a-custom-discovery-image.adoc +++ b/guides/common/modules/proc_building-a-custom-discovery-image.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: PROCEDURE -[id="Building_a_custom_Discovery_Image_{context}"] +[id="building-a-custom-discovery-image"] = Building a custom Discovery image [role="_abstract"] @@ -74,7 +74,7 @@ fdi.pxdns=192.168.140.2 proxy.url=https://{foreman-example-com}:8443 \ proxy.type=foreman fdi.pxmac=52:54:00:be:8e:8c fdi.pxauto=1" ---- + -For more information about configuration options, see xref:kernel-parameters-for-discovery-customization_{context}[]. +For more information about configuration options, see xref:kernel-parameters-for-discovery-customization[]. . Verify that your `./result/fdi-custom-XXXXXXX.iso` file is created: + [options="nowrap" subs="+quotes"] diff --git a/guides/common/modules/proc_chainbooting-ipxe-from-pxelinux.adoc b/guides/common/modules/proc_chainbooting-ipxe-from-pxelinux.adoc index 26226334688..89ea5705f32 100644 --- a/guides/common/modules/proc_chainbooting-ipxe-from-pxelinux.adoc +++ b/guides/common/modules/proc_chainbooting-ipxe-from-pxelinux.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: PROCEDURE -[id="Chainbooting_iPXE_from_PXELinux_{context}"] +[id="chainbooting-ipxe-from-pxelinux"] = Chainbooting iPXE from PXELinux [role="_abstract"] @@ -13,7 +13,7 @@ To use HTTP with iPXE, use the iPXE build with built-in drivers (`ipxe.lkrn`). .Prerequisites * You have configured your iPXE environment. -For more information, see xref:Configuring_iPXE_Environment_{context}[]. +For more information, see xref:configuring-ipxe-environment[]. .Procedure . In the {ProjectWebUI}, navigate to *Hosts* > *Templates* > *Provisioning Templates*. diff --git a/guides/common/modules/proc_completing-the-rhel7-image.adoc b/guides/common/modules/proc_completing-the-rhel-7-image.adoc similarity index 86% rename from guides/common/modules/proc_completing-the-rhel7-image.adoc rename to guides/common/modules/proc_completing-the-rhel-7-image.adoc index c54161546e2..40c6b763d0c 100644 --- a/guides/common/modules/proc_completing-the-rhel7-image.adoc +++ b/guides/common/modules/proc_completing-the-rhel-7-image.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: PROCEDURE -[id="Completing_the_RHEL7_Image_{context}"] +[id="completing-the-rhel-7-image"] = Completing the {RHEL} 7 image [role="_abstract"] @@ -9,64 +9,64 @@ To ensure that VMs deployed from your image are treated as clean and unique inst .Procedure . Update the system: + ------------ +---- # yum update ------------ +---- . Install the `cloud-init` packages: + [options="nowrap" subs="+quotes,attributes"] ------------ +---- # yum install cloud-utils-growpart cloud-init ------------ +---- . Open the `/etc/cloud/cloud.cfg` configuration file: + ------------ +---- # vi /etc/cloud/cloud.cfg ------------ +---- . Under the heading `cloud_init_modules`, add: + ------------ +---- - resolv-conf ------------ +---- + The `resolv-conf` option automatically configures the `resolv.conf` when an instance boots for the first time. This file contains information related to the instance such as `nameservers`, `domain` and other options. . Open the `/etc/sysconfig/network` file: + ------------ +---- # vi /etc/sysconfig/network ------------ +---- . Add the following line to avoid problems accessing the EC2 metadata service: + ------------ +---- NOZEROCONF=yes ------------ +---- . Un-register the virtual machine so that the resulting image does not contain the same subscription details for every instance cloned based on it: + ------------- +---- # subscription-manager repos --disable=* # subscription-manager unregister ------------- +---- . Power off the instance: + ------------ +---- # poweroff ------------ +---- . On your {RHEL} Workstation, connect to the terminal as the root user and navigate to the `/var/lib/libvirt/images/` directory: + ------------ +---- # cd /var/lib/libvirt/images/ ------------ +---- . Reset and clean the image using the `virt-sysprep` command so it can be used to create instances without issues: + ------------ +---- # virt-sysprep -d rhel7 ------------ +---- . Reduce image size using the `virt-sparsify` command. This command converts any free space within the disk image back to free space within the host: + ------------ +---- # virt-sparsify --compress rhel7.qcow2 rhel7-cloud.qcow2 ------------ +---- + This creates a new `rhel7-cloud.qcow2` file in the location where you enter the command. diff --git a/guides/common/modules/proc_configuring-a-host-for-registration.adoc b/guides/common/modules/proc_configuring-a-host-for-registration.adoc index d8f54c1f0d9..2a2cffa984c 100644 --- a/guides/common/modules/proc_configuring-a-host-for-registration.adoc +++ b/guides/common/modules/proc_configuring-a-host-for-registration.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: PROCEDURE -[id="Configuring_a_Host_for_Registration_{context}"] +[id="configuring-a-host-for-registration"] = Configuring a host for registration [role="_abstract"] @@ -9,7 +9,7 @@ You can use a configuration management tool to configure multiple hosts at once. .Prerequisites * The host must be using a supported operating system. -For more information, see xref:supported-clients-in-registration_{context}[]. +For more information, see xref:supported-clients-in-registration[]. ifdef::satellite,orcharhino,katello[] * The system clock on your {ProjectServer} and any {SmartProxyServers} must be synchronized across the network. If the system clock is not synchronized, SSL certificate verification might fail. diff --git a/guides/common/modules/proc_configuring-ipxe-environment.adoc b/guides/common/modules/proc_configuring-ipxe-environment.adoc index 5ed93a0e4b0..ac2d29659b0 100644 --- a/guides/common/modules/proc_configuring-ipxe-environment.adoc +++ b/guides/common/modules/proc_configuring-ipxe-environment.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: PROCEDURE -[id="Configuring_iPXE_Environment_{context}"] +[id="configuring-ipxe-environment"] = Configuring iPXE environment [role="_abstract"] diff --git a/guides/common/modules/proc_configuring-smartproxy-for-uefi-http-booting.adoc b/guides/common/modules/proc_configuring-smart-proxy-for-uefi-http-booting.adoc similarity index 100% rename from guides/common/modules/proc_configuring-smartproxy-for-uefi-http-booting.adoc rename to guides/common/modules/proc_configuring-smart-proxy-for-uefi-http-booting.adoc diff --git a/guides/common/modules/proc_configuring-smart-proxy-to-provision-secure-boot-enabled-hosts.adoc b/guides/common/modules/proc_configuring-smart-proxy-to-provision-client-os-on-secure-boot-enabled-hosts.adoc similarity index 99% rename from guides/common/modules/proc_configuring-smart-proxy-to-provision-secure-boot-enabled-hosts.adoc rename to guides/common/modules/proc_configuring-smart-proxy-to-provision-client-os-on-secure-boot-enabled-hosts.adoc index 3932dcd9c1b..d59db723ddb 100644 --- a/guides/common/modules/proc_configuring-smart-proxy-to-provision-secure-boot-enabled-hosts.adoc +++ b/guides/common/modules/proc_configuring-smart-proxy-to-provision-client-os-on-secure-boot-enabled-hosts.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: PROCEDURE -[id="configuring-{smart-proxy-context}-to-provision-{client-os-context}-on-Secure-Boot-enabled-hosts"] +[id="configuring-{smart-proxy-context}-to-provision-{client-os-context}-on-secure-boot-enabled-hosts"] = Configuring {SmartProxy} to provision {client-os} on Secure Boot enabled hosts [role="_abstract"] diff --git a/guides/common/modules/proc_customizing-the-discovery-iso.adoc b/guides/common/modules/proc_customizing-the-discovery-iso.adoc index 2c35f08823d..52b2dd0984a 100644 --- a/guides/common/modules/proc_customizing-the-discovery-iso.adoc +++ b/guides/common/modules/proc_customizing-the-discovery-iso.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: PROCEDURE -[id="customizing-the-discovery-iso_{context}"] +[id="customizing-the-discovery-iso"] = Customizing the Discovery ISO [role="_abstract"] @@ -33,7 +33,7 @@ fdi.pxfactvalue1=_My_Host_ \ fdi.pxmac=52:54:00:be:8e:8c fdi.pxauto=1" ---- + -For more information about kernel parameters, see xref:kernel-parameters-for-discovery-customization_{context}[]. +For more information about kernel parameters, see xref:kernel-parameters-for-discovery-customization[]. . Copy the new ISO to either a CD, DVD, or a USB stick. For example, to copy to a USB stick at `/dev/sdb`: + 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 8c039f8464b..d29ec757636 100644 --- a/guides/common/modules/proc_customizing-the-discovery-pxe-boot.adoc +++ b/guides/common/modules/proc_customizing-the-discovery-pxe-boot.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: PROCEDURE -[id="Customizing_the_Discovery_PXE_Boot_{context}"] +[id="customizing-the-discovery-pxe-boot"] = Customizing the Discovery PXE boot [role="_abstract"] @@ -28,7 +28,7 @@ The `APPEND` option contains kernel parameters. This snippet renders the Discovery GRUB2 menu entry. The `common` variable contains kernel parameters. -For information about the kernel parameters, see xref:kernel-parameters-for-discovery-customization_{context}[]. +For information about the kernel parameters, see xref:kernel-parameters-for-discovery-customization[]. .Procedure . In the {ProjectWebUI}, navigate to *Hosts* > *Templates* > *Provisioning Templates*. diff --git a/guides/common/modules/proc_enabling-bootdisk-plugin.adoc b/guides/common/modules/proc_enabling-the-bootdisk-plugin.adoc similarity index 92% rename from guides/common/modules/proc_enabling-bootdisk-plugin.adoc rename to guides/common/modules/proc_enabling-the-bootdisk-plugin.adoc index a93844700f5..21c42ffe765 100644 --- a/guides/common/modules/proc_enabling-bootdisk-plugin.adoc +++ b/guides/common/modules/proc_enabling-the-bootdisk-plugin.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE -[id="enabling-bootdisk-plugin"] -= Enabling Bootdisk plugin +[id="enabling-the-bootdisk-plugin"] += Enabling the Bootdisk plugin [role="_abstract"] Enable the Bootdisk plugin to perform boot disk-based host provisioning. diff --git a/guides/common/modules/proc_extending-the-discovery-image.adoc b/guides/common/modules/proc_extending-the-discovery-image.adoc index 574d1906fdf..be908a5ab89 100644 --- a/guides/common/modules/proc_extending-the-discovery-image.adoc +++ b/guides/common/modules/proc_extending-the-discovery-image.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: PROCEDURE -[id="Extending_the_Discovery_Image_{context}"] +[id="extending-the-discovery-image"] = Extending the Discovery image [role="_abstract"] @@ -45,7 +45,7 @@ For example, if you have two archives at `$TFTP/zip1.zip` and `$TFTP/boot/zip2.z fdi.zips=zip1.zip,boot/zip2.zip ---- + -For more information, see xref:Customizing_the_Discovery_PXE_Boot_{context}[]. +For more information, see xref:customizing-the-discovery-pxe-boot[]. + You can append new directives and options to the existing environment variables (`PATH`, `LD_LIBRARY_PATH`, `RUBYLIB` and `FACTERLIB`). If you want to specify the path explicitly in your scripts, the `.zip` file contents are extracted to the `/opt/extension` directory on the image. diff --git a/guides/common/modules/proc_installing-the-discovery-service.adoc b/guides/common/modules/proc_installing-the-discovery-service.adoc index 3c4cc80634c..e9043010566 100644 --- a/guides/common/modules/proc_installing-the-discovery-service.adoc +++ b/guides/common/modules/proc_installing-the-discovery-service.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: PROCEDURE -[id="Installing_the_Discovery_Service_{context}"] +[id="installing-the-discovery-service"] = Installing the Discovery service [role="_abstract"] diff --git a/guides/common/modules/proc_performing-discovery-in-pxeless-mode.adoc b/guides/common/modules/proc_performing-discovery-in-pxe-less-mode.adoc similarity index 90% rename from guides/common/modules/proc_performing-discovery-in-pxeless-mode.adoc rename to guides/common/modules/proc_performing-discovery-in-pxe-less-mode.adoc index 258c1de6ccc..7830cf08db7 100644 --- a/guides/common/modules/proc_performing-discovery-in-pxeless-mode.adoc +++ b/guides/common/modules/proc_performing-discovery-in-pxe-less-mode.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: PROCEDURE -[id="performing-discovery-in-pxeless-mode_{context}"] +[id="performing-discovery-in-pxe-less-mode"] = Performing Discovery in PXE-less mode [role="_abstract"] @@ -9,13 +9,13 @@ Discovery in PXE-less mode uses the Discovery ISO and requires you to attend to .Prerequisites ifdef::satellite,orcharhino[] * You have installed the Foreman Discovery image. -For more information, see xref:Installing_the_Discovery_Service_{context}[]. +For more information, see xref:installing-the-discovery-service[]. endif::[] ifndef::satellite,orcharhino[] * You have installed the Foreman Discovery image or built a custom Discovery image ISO. For more information, see one of the following resources: -** xref:Installing_the_Discovery_Service_{context}[] -** xref:Building_a_custom_Discovery_Image_{context}[] +** xref:installing-the-discovery-service[] +** xref:building-a-custom-discovery-image[] endif::[] .Procedure diff --git a/guides/common/modules/proc_performing-discovery-in-pxe-mode.adoc b/guides/common/modules/proc_performing-discovery-in-pxe-mode.adoc index 0c8f7f32dc9..ee23beca80b 100644 --- a/guides/common/modules/proc_performing-discovery-in-pxe-mode.adoc +++ b/guides/common/modules/proc_performing-discovery-in-pxe-mode.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: PROCEDURE -[id="performing-discovery-in-pxe-mode_{context}"] +[id="performing-discovery-in-pxe-mode"] = Performing Discovery in PXE mode [role="_abstract"] @@ -8,9 +8,9 @@ Discovery in PXE mode uses the Discovery PXE boot images and runs unattended. .Prerequisites * You have installed the Discovery service and image. -For more information, see xref:Installing_the_Discovery_Service_{context}[]. +For more information, see xref:installing-the-discovery-service[]. * You have set Discovery as the default booting option. -For more information, see xref:setting-discovery-as-the-default-PXE-boot-option_{context}[]. +For more information, see xref:setting-discovery-as-the-default-pxe-boot-option[]. .Procedure * Power on or reboot your host. diff --git a/guides/common/modules/proc_setting-discovery-as-the-default-PXE-boot-option.adoc b/guides/common/modules/proc_setting-discovery-as-the-default-pxe-boot-option.adoc similarity index 94% rename from guides/common/modules/proc_setting-discovery-as-the-default-PXE-boot-option.adoc rename to guides/common/modules/proc_setting-discovery-as-the-default-pxe-boot-option.adoc index 802777aac33..528b721e7e2 100644 --- a/guides/common/modules/proc_setting-discovery-as-the-default-PXE-boot-option.adoc +++ b/guides/common/modules/proc_setting-discovery-as-the-default-pxe-boot-option.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: PROCEDURE -[id="setting-discovery-as-the-default-PXE-boot-option_{context}"] +[id="setting-discovery-as-the-default-pxe-boot-option"] = Setting Discovery as the default PXE boot option [role="_abstract"] diff --git a/guides/common/modules/ref_automatic-contexts-for-discovered-hosts.adoc b/guides/common/modules/ref_automatic-contexts-for-discovered-hosts.adoc index ca4e0597497..a77efe430b5 100644 --- a/guides/common/modules/ref_automatic-contexts-for-discovered-hosts.adoc +++ b/guides/common/modules/ref_automatic-contexts-for-discovered-hosts.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: REFERENCE -[id="Automatic_Contexts_for_Discovered_Hosts_{context}"] +[id="automatic-contexts-for-discovered-hosts"] = Automatic contexts for discovered hosts [role="_abstract"] diff --git a/guides/common/modules/ref_grub2-uefi-boot-loaders.adoc b/guides/common/modules/ref_grub2-uefi-boot-loader-and-the-bootloader-universe-structure.adoc similarity index 97% rename from guides/common/modules/ref_grub2-uefi-boot-loaders.adoc rename to guides/common/modules/ref_grub2-uefi-boot-loader-and-the-bootloader-universe-structure.adoc index f08238df585..6b1d24b4185 100644 --- a/guides/common/modules/ref_grub2-uefi-boot-loaders.adoc +++ b/guides/common/modules/ref_grub2-uefi-boot-loader-and-the-bootloader-universe-structure.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: REFERENCE -[id="grub2-uefi-boot-loaders"] -= Grub2 UEFI boot loader and the `bootloader-universe` structure +[id="grub2-uefi-boot-loader-and-the-bootloader-universe-structure"] += Grub2 UEFI boot loader and the bootloader-universe structure [role="_abstract"] *PXEGrub2* GRUB-based PXE boot loader supports BIOS and UEFI environments, as well as Secure Boot environments. diff --git a/guides/common/modules/ref_host-requirements-for-custom-images.adoc b/guides/common/modules/ref_host-requirements-for-custom-rhel-images.adoc similarity index 96% rename from guides/common/modules/ref_host-requirements-for-custom-images.adoc rename to guides/common/modules/ref_host-requirements-for-custom-rhel-images.adoc index 86279dd7b5e..d348e6177d3 100644 --- a/guides/common/modules/ref_host-requirements-for-custom-images.adoc +++ b/guides/common/modules/ref_host-requirements-for-custom-rhel-images.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: REFERENCE -[id="host-requirements-for-custom-images_{context}"] +[id="host-requirements-for-custom-rhel-images"] = Host requirements for custom {RHEL} images [role="_abstract"] diff --git a/guides/common/modules/ref_kernel-parameters-for-discovery-customization.adoc b/guides/common/modules/ref_kernel-parameters-for-discovery-customization.adoc index 1f450ccc267..9b324c7803f 100644 --- a/guides/common/modules/ref_kernel-parameters-for-discovery-customization.adoc +++ b/guides/common/modules/ref_kernel-parameters-for-discovery-customization.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: REFERENCE -[id="kernel-parameters-for-discovery-customization_{context}"] +[id="kernel-parameters-for-discovery-customization"] = Kernel parameters for Discovery customization [role="_abstract"] @@ -107,11 +107,11 @@ fdi.vlan.primary=_My_VLAN_ID_ fdi.zips:: Filenames with extensions to be downloaded and started during boot. -For more information, see xref:Extending_the_Discovery_Image_{context}[]. +For more information, see xref:extending-the-discovery-image[]. fdi.zipserver:: TFTP server to use to download extensions from. -For more information, see xref:Extending_the_Discovery_Image_{context}[]. +For more information, see xref:extending-the-discovery-image[]. ifndef::orcharhino[] net.ifnames and biosdevname:: diff --git a/guides/common/modules/ref_prerequisites-for-using-ipxe.adoc b/guides/common/modules/ref_prerequisites-for-using-ipxe.adoc index d71ebac0e98..f9da357ff89 100644 --- a/guides/common/modules/ref_prerequisites-for-using-ipxe.adoc +++ b/guides/common/modules/ref_prerequisites-for-using-ipxe.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: REFERENCE -[id="prerequisites-for-using-ipxe_{context}"] +[id="prerequisites-for-using-ipxe"] = Prerequisites for using iPXE [role="_abstract"] diff --git a/guides/common/modules/ref_pxe-loaders-in-project.adoc b/guides/common/modules/ref_pxe-loaders-in-project.adoc index cf959fa00ba..6fb3d8fa0f0 100644 --- a/guides/common/modules/ref_pxe-loaders-in-project.adoc +++ b/guides/common/modules/ref_pxe-loaders-in-project.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: REFERENCE -[id="pxe-loaders-in-project"] +[id="pxe-loaders-in-{project-context}"] = PXE loaders in {Project} [role="_abstract"] @@ -80,6 +80,6 @@ endif::[] ifdef::satellite[] .Additional resources -* xref:configuring-{smart-proxy-context}-to-provision-rhel-on-Secure-Boot-enabled-hosts[] +* xref:configuring-{smart-proxy-context}-to-provision-rhel-on-secure-boot-enabled-hosts[] * https://access.redhat.com/solutions/2674001[Supported architectures and provisioning scenarios] endif::[] diff --git a/guides/common/modules/ref_required-boot-order-for-network-boot.adoc b/guides/common/modules/ref_required-boot-order-for-network-boot.adoc index c735e42dcfa..01ff5ccaaa0 100644 --- a/guides/common/modules/ref_required-boot-order-for-network-boot.adoc +++ b/guides/common/modules/ref_required-boot-order-for-network-boot.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: REFERENCE -[id="required-boot-order-for-network-boot_{context}"] +[id="required-boot-order-for-network-boot"] = Required boot order for network boot [role="_abstract"] diff --git a/guides/common/modules/ref_supported-clients-in-registration.adoc b/guides/common/modules/ref_supported-clients-in-registration.adoc index d33b315be2a..57c5e1c0888 100644 --- a/guides/common/modules/ref_supported-clients-in-registration.adoc +++ b/guides/common/modules/ref_supported-clients-in-registration.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: REFERENCE -[id="supported-clients-in-registration_{context}"] +[id="supported-clients-in-registration"] = Supported clients in registration [role="_abstract"] diff --git a/guides/common/modules/ref_troubleshooting-discovery-failures.adoc b/guides/common/modules/ref_troubleshooting-discovery-failures.adoc index cb3bf3cfbec..c79cb7c70d5 100644 --- a/guides/common/modules/ref_troubleshooting-discovery-failures.adoc +++ b/guides/common/modules/ref_troubleshooting-discovery-failures.adoc @@ -9,11 +9,11 @@ Inspect the following configuration areas to help isolate the problem: Inspecting prerequisites:: * Ensure that your {Project} and hosts meet the requirements. -For more information, see xref:prerequisites-for-using-discovery_{context}[]. +For more information, see xref:prerequisites-for-using-discovery[]. Inspecting problems on {Project}:: * Ensure you have set Discovery for booting and built the PXE boot configuration files. -For more information, see xref:setting-discovery-as-the-default-PXE-boot-option_{context}[]. +For more information, see xref:setting-discovery-as-the-default-pxe-boot-option[]. * Verify that these configuration files are present on your TFTP {SmartProxy} and have `discovery` set as the default boot option: ** `/var/lib/tftpboot/pxelinux.cfg/default` ** `/var/lib/tftpboot/grub2/grub.cfg` @@ -44,5 +44,5 @@ It prints out system logs, network configuration, list of facts, and other infor You can redirect this output to a file and copy it with the `scp` command for further investigation. .Additional resources -* xref:Customizing_the_Discovery_PXE_Boot_{context}[] -* xref:customizing-the-discovery-iso_{context}[] +* xref:customizing-the-discovery-pxe-boot[] +* xref:customizing-the-discovery-iso[] diff --git a/guides/common/modules/snip_registering-a-host-prerequisites.adoc b/guides/common/modules/snip_registering-a-host-prerequisites.adoc index e2d9d1cc64c..3d7fa75effa 100644 --- a/guides/common/modules/snip_registering-a-host-prerequisites.adoc +++ b/guides/common/modules/snip_registering-a-host-prerequisites.adoc @@ -4,7 +4,7 @@ * Root privileges are available on the host that you want to register. * Either `curl` or `wget` is installed on the host that you want to register. * Your host is configured for registration. -For more information, see xref:Configuring_a_Host_for_Registration_{context}[]. +For more information, see xref:configuring-a-host-for-registration[]. ifdef::satellite,orcharhino,katello[] + include::snip_prerequisite-activation-key-available.adoc[] diff --git a/guides/scripts/find_unused_modules b/guides/scripts/find_unused_modules index a5e3628eaed..393df5a2f49 100755 --- a/guides/scripts/find_unused_modules +++ b/guides/scripts/find_unused_modules @@ -69,7 +69,7 @@ non_containerized_satellite_content = [ 'guides/common/modules/con_usage-metrics-collection-in-project.adoc', 'guides/common/modules/proc_changing-the-method-the-bootstrap-script-uses-to-download-the-consumer-rpm.adoc', 'guides/common/modules/proc_cloning-to-the-target-server.adoc', - 'guides/common/modules/proc_completing-the-rhel7-image.adoc', + 'guides/common/modules/proc_completing-the-rhel-7-image.adoc', 'guides/common/modules/proc_configuring-repositories-proxy.adoc', 'guides/common/modules/proc_configuring-the-base-operating-system-with-offline-repositories.adoc', 'guides/common/modules/proc_creating-a-domain-for-a-host-during-registration.adoc', @@ -117,7 +117,7 @@ non_containerized_satellite_content = [ 'guides/common/modules/proc_upgrading-container-images-of-insights-iop.adoc', 'guides/common/modules/proc_upgrading-puppet-agent-7-to-openvox-agent-8.adoc', 'guides/common/modules/ref_advanced-bootstrap-script-configuration.adoc', - 'guides/common/modules/ref_host-requirements-for-custom-images.adoc', + 'guides/common/modules/ref_host-requirements-for-custom-rhel-images.adoc', 'guides/common/modules/ref_managing-packages-on-the-base-operating-system.adoc', 'guides/common/modules/ref_preconfigured-rhel-kvm-guest-images.adoc', 'guides/common/modules/ref_supported-usage-of-project-components.adoc',