From 3953454ef7040a7ba313623c5844aa2ffd7749ec Mon Sep 17 00:00:00 2001 From: Sebastian Kopacz Date: Thu, 5 Dec 2024 16:42:49 -0500 Subject: [PATCH] adding contexts and IDs in Agent docs --- .../installing_oci/installing-oci-agent-based-installer.adoc | 4 ++-- .../preparing-an-agent-based-installed-cluster-for-mce.adoc | 1 + .../preparing-to-install-with-agent-based-installer.adoc | 4 ++-- .../understanding-disconnected-installation-mirroring.adoc | 2 +- modules/agent-install-networking.adoc | 2 ++ modules/understanding-agent-install.adoc | 3 ++- modules/validations-before-agent-iso-creation.adoc | 1 + 7 files changed, 11 insertions(+), 6 deletions(-) diff --git a/installing/installing_oci/installing-oci-agent-based-installer.adoc b/installing/installing_oci/installing-oci-agent-based-installer.adoc index 2952f95a6f..98a82de71d 100644 --- a/installing/installing_oci/installing-oci-agent-based-installer.adoc +++ b/installing/installing_oci/installing-oci-agent-based-installer.adoc @@ -37,7 +37,7 @@ include::modules/creating-config-files-cluster-install-oci.adoc[leveloffset=+1] * xref:../../architecture/architecture-installation.adoc#installation-overview_architecture-installation[About {product-title} installation] * xref:../../installing/overview/installing-preparing.adoc#installing-preparing-selecting-cluster-type[Selecting a cluster installation type] -* xref:../../installing/installing_with_agent_based_installer/preparing-to-install-with-agent-based-installer.adoc#about-the-agent-based-installer[Preparing to install with the Agent-based Installer] +* xref:../../installing/installing_with_agent_based_installer/preparing-to-install-with-agent-based-installer.adoc#preparing-to-install-with-agent-based-installer[Preparing to install with the Agent-based Installer] * xref:../../installing/installing_with_agent_based_installer/installing-with-agent-based-installer.adoc#installing-ocp-agent-retrieve_installing-with-agent-based-installer[Downloading the Agent-based Installer] * xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installation-mirror-repository_installing-mirroring-installation-images[Mirroring the {product-title} image repository] * xref:../../installing/installing_with_agent_based_installer/installing-with-agent-based-installer.adoc#installing-ocp-agent-ztp_installing-with-agent-based-installer[Optional: Using ZTP manifests] @@ -51,7 +51,7 @@ include::modules/running-cluster-oci-agent-based.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* xref:../../installing/installing_with_agent_based_installer/preparing-to-install-with-agent-based-installer.adoc#recommended-resources-for-topologies[Recommended resources for topologies] +* xref:../../installing/installing_with_agent_based_installer/preparing-to-install-with-agent-based-installer.adoc#agent-based-installer-recommended-resources_preparing-to-install-with-agent-based-installer[Recommended resources for topologies] * link:https://docs.oracle.com/iaas/Content/openshift-on-oci/installing-agent-about-instance-configurations.htm[Instance Sizing Recommendations for {product-title} on {oci} Nodes (Oracle documentation)] * link:https://docs.oracle.com/iaas/Content/openshift-on-oci/openshift-troubleshooting.htm[Troubleshooting {product-title} on {oci} (Oracle documentation)] diff --git a/installing/installing_with_agent_based_installer/preparing-an-agent-based-installed-cluster-for-mce.adoc b/installing/installing_with_agent_based_installer/preparing-an-agent-based-installed-cluster-for-mce.adoc index 78999cf18c..f40d8ce8d0 100644 --- a/installing/installing_with_agent_based_installer/preparing-an-agent-based-installed-cluster-for-mce.adoc +++ b/installing/installing_with_agent_based_installer/preparing-an-agent-based-installed-cluster-for-mce.adoc @@ -9,6 +9,7 @@ toc::[] You can install the {mce-short} and deploy a hub cluster with the Agent-based {product-title} Installer. The following procedure is partially automated and requires manual steps after the initial cluster is deployed. +[id="prerequisites_{context}"] == Prerequisites * You have read the following documentation: ** link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.9/html/clusters/cluster_mce_overview[Cluster lifecycle with multicluster engine operator overview]. diff --git a/installing/installing_with_agent_based_installer/preparing-to-install-with-agent-based-installer.adoc b/installing/installing_with_agent_based_installer/preparing-to-install-with-agent-based-installer.adoc index 78f6b0f41a..c9c6bd010a 100644 --- a/installing/installing_with_agent_based_installer/preparing-to-install-with-agent-based-installer.adoc +++ b/installing/installing_with_agent_based_installer/preparing-to-install-with-agent-based-installer.adoc @@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] -[id="about-the-agent-based-installer"] +[id="about-the-agent-based-installer_{context}"] == About the Agent-based Installer The Agent-based installation method provides the flexibility to boot your on-premises servers in any way that you choose. It combines the ease of use of the Assisted Installation service with the ability to run offline, including in air-gapped environments. @@ -87,7 +87,7 @@ include::modules/installation-bare-metal-agent-installer-config-yaml.adoc[levelo //Validation checks before agent ISO creation include::modules/validations-before-agent-iso-creation.adoc[leveloffset=+1] -[id="agent-based-installation-next-steps"] +[id="agent-based-installation-next-steps_{context}"] == Next steps * xref:../../installing/installing_with_agent_based_installer/installing-with-agent-based-installer.adoc#installing-with-agent-based-installer[Installing a cluster with the Agent-based Installer] diff --git a/installing/installing_with_agent_based_installer/understanding-disconnected-installation-mirroring.adoc b/installing/installing_with_agent_based_installer/understanding-disconnected-installation-mirroring.adoc index 986de35963..f7d55a7d62 100644 --- a/installing/installing_with_agent_based_installer/understanding-disconnected-installation-mirroring.adoc +++ b/installing/installing_with_agent_based_installer/understanding-disconnected-installation-mirroring.adoc @@ -9,7 +9,7 @@ toc::[] You can use a mirror registry for disconnected installations and to ensure that your clusters only use container images that satisfy your organization's controls on external content. Before you install a cluster on infrastructure that you provision in a disconnected environment, you must mirror the required container images into that environment. To mirror container images, you must have a registry for mirroring. -[id="agent-install-mirroring-images-disconnected"] +[id="agent-install-mirroring-images-disconnected_{context}"] == Mirroring images for a disconnected installation through the Agent-based Installer You can use one of the following procedures to mirror your {product-title} image repository to your mirror registry: diff --git a/modules/agent-install-networking.adoc b/modules/agent-install-networking.adoc index 123a810955..b889bc8b97 100644 --- a/modules/agent-install-networking.adoc +++ b/modules/agent-install-networking.adoc @@ -12,6 +12,7 @@ In an environment without a DHCP server, you can define IP addresses statically. In addition to static IP addresses, you can apply any network configuration that is in NMState format. This includes VLANs and NIC bonds. +[id="agent-install-networking-DHCP_{context}"] == DHCP .Preferred method: `install-config.yaml` and `agent-config.yaml` @@ -30,6 +31,7 @@ rendezvousIP: 192.168.111.80 <1> ---- <1> The IP address for the rendezvous host. +[id="agent-install-networking-static_{context}"] == Static networking .. Preferred method: `install-config.yaml` and `agent-config.yaml` diff --git a/modules/understanding-agent-install.adoc b/modules/understanding-agent-install.adoc index e25e0b1f4e..276173758e 100644 --- a/modules/understanding-agent-install.adoc +++ b/modules/understanding-agent-install.adoc @@ -29,7 +29,7 @@ Optional: ZTP manifests * `mirror/registries.conf` * `mirror/ca-bundle.crt` -[id="agent-based-installer-workflow"] +[id="agent-based-installer-workflow_{context}"] == Agent-based Installer workflow One of the control plane hosts runs the Assisted Service at the start of the boot process and eventually becomes the bootstrap host. This node is called the *rendezvous host* (node 0). The Assisted Service ensures that all the hosts meet the requirements and triggers an {product-title} cluster deployment. All the nodes have the Red Hat Enterprise Linux CoreOS (RHCOS) image written to the disk. The non-bootstrap nodes reboot and initiate a cluster deployment. @@ -44,6 +44,7 @@ You can install a disconnected {product-title} cluster through the `openshift-in * **A three-node {product-title} cluster** : A compact cluster that has three master nodes that are also worker nodes. * **Highly available {product-title} cluster (HA)**: Three master nodes with any number of worker nodes. +[id="agent-based-installer-recommended-resources_{context}"] == Recommended resources for topologies Recommended cluster resources for the following topologies: diff --git a/modules/validations-before-agent-iso-creation.adoc b/modules/validations-before-agent-iso-creation.adoc index 2d8a6e346d..5652109f39 100644 --- a/modules/validations-before-agent-iso-creation.adoc +++ b/modules/validations-before-agent-iso-creation.adoc @@ -24,6 +24,7 @@ is created. * World Wide Name (WWN) vendor extensions are not supported in root device hints. * The `role` parameter in the `host` object must have a value of either `master` or `worker`. +[id="agent-validations-ztp_{context}"] == ZTP manifests .`agent-cluster-install.yaml`