Merge pull request #86605 from xenolinux/non-bm-heading-update

xenolinux · web-flow · commit 95f030b551d7 · 2024-12-26T17:32:14.000+05:30
OSDOCS#13015: Manage headings
diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml
@@ -2505,7 +2505,7 @@ Topics:
     File: hcp-deploy-bm
   - Name: Deploying hosted control planes on OpenShift Virtualization
     File: hcp-deploy-virt
-  - Name: Deploying hosted control planes on non-bare metal agent machines
+  - Name: Deploying hosted control planes on non-bare-metal agent machines
     File: hcp-deploy-non-bm
   - Name: Deploying hosted control planes on IBM Z
     File: hcp-deploy-ibmz
@@ -2520,7 +2520,7 @@ Topics:
     File: hcp-manage-bm
   - Name: Managing hosted control planes on OpenShift Virtualization
     File: hcp-manage-virt
-  - Name: Managing hosted control planes on non-bare metal agent machines
+  - Name: Managing hosted control planes on non-bare-metal agent machines
     File: hcp-manage-non-bm
   - Name: Managing hosted control planes on IBM Power
     File: hcp-manage-ibm-power
@@ -2579,7 +2579,7 @@ Topics:
     File: hcp-destroy-ibmz
   - Name: Destroying a hosted cluster on IBM Power
     File: hcp-destroy-ibm-power
-  - Name: Destroying a hosted cluster on non-bare metal agent machines
+  - Name: Destroying a hosted cluster on non-bare-metal agent machines
     File: hcp-destroy-non-bm
 - Name: Manually importing a hosted cluster
   File: hcp-import
diff --git a/hosted_control_planes/hcp-deploy/hcp-deploy-non-bm.adoc b/hosted_control_planes/hcp-deploy/hcp-deploy-non-bm.adoc
@@ -1,7 +1,7 @@
 :_mod-docs-content-type: ASSEMBLY
 [id="hcp-deploy-non-bm"]
 include::_attributes/common-attributes.adoc[]
-= Deploying {hcp} on non-bare metal agent machines
+= Deploying {hcp} on non-bare-metal agent machines
 :context: hcp-deploy-non-bm
 
 toc::[]
diff --git a/hosted_control_planes/hcp-destroy/hcp-destroy-non-bm.adoc b/hosted_control_planes/hcp-destroy/hcp-destroy-non-bm.adoc
@@ -1,12 +1,12 @@
 :_mod-docs-content-type: ASSEMBLY
 [id="hcp-destroy-non-bm"]
 include::_attributes/common-attributes.adoc[]
-= Destroying a hosted cluster on non-bare metal agent machines
+= Destroying a hosted cluster on non-bare-metal agent machines
 :context: hcp-destroy-non-bm
 
 toc::[]
 
-You can destroy hosted clusters on non-bare metal agent machines by using the command-line interface (CLI) or the {mce-short} web console.
+You can destroy hosted clusters on non-bare-metal agent machines by using the command-line interface (CLI) or the {mce-short} web console.
 
 include::modules/destroy-hc-non-bm-cli.adoc[leveloffset=+1]
 
diff --git a/hosted_control_planes/hcp-manage/hcp-manage-non-bm.adoc b/hosted_control_planes/hcp-manage/hcp-manage-non-bm.adoc
@@ -1,12 +1,12 @@
 :_mod-docs-content-type: ASSEMBLY
 [id="hcp-manage-non-bm"]
 include::_attributes/common-attributes.adoc[]
-= Managing {hcp} on non-bare metal agent machines
+= Managing {hcp} on non-bare-metal agent machines
 :context: hcp-manage-non-bm
 
 toc::[]
 
-After you deploy {hcp} on non-bare metal agent machines, you can manage a hosted cluster by completing the following tasks.
+After you deploy {hcp} on non-bare-metal agent machines, you can manage a hosted cluster by completing the following tasks.
 
 include::modules/hcp-bm-access.adoc[leveloffset=+1]
 include::modules/hcp-bm-scale-np.adoc[leveloffset=+1]
diff --git a/modules/destroy-hc-non-bm-cli.adoc b/modules/destroy-hc-non-bm-cli.adoc
@@ -4,9 +4,9 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="destroy-hc-non-bm-cli_{context}"]
-= Destroying a hosted cluster on non-bare metal agent machines
+= Destroying a hosted cluster on non-bare-metal agent machines
 
-You can use the `hcp` command-line interface (CLI) to destroy a hosted cluster on non-bare metal agent machines.
+You can use the `hcp` command-line interface (CLI) to destroy a hosted cluster on non-bare-metal agent machines.
 
 .Procedure
 
diff --git a/modules/destroy-hc-non-bm-console.adoc b/modules/destroy-hc-non-bm-console.adoc
@@ -4,9 +4,9 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="destroy-hc-non-bm-console_{context}"]
-= Destroying a hosted cluster on non-bare metal agent machines by using the web console
+= Destroying a hosted cluster on non-bare-metal agent machines by using the web console
 
-You can use the {mce-short} web console to destroy a hosted cluster on non-bare metal agent machines.
+You can use the {mce-short} web console to destroy a hosted cluster on non-bare-metal agent machines.
 
 .Procedure
 
diff --git a/modules/hcp-bm-ingress.adoc b/modules/hcp-bm-ingress.adoc
@@ -3,9 +3,19 @@
 // * hosted_control_planes/hcp-manage/hcp-manage-bm.adoc
 // * hosted_control_planes/hcp-manage/hcp-manage-non-bm.adoc
 
+ifeval::["{context}" == "hcp-manage-non-bm"]
+:non-bm:
+endif::[]
+
 :_mod-docs-content-type: PROCEDURE
 [id="hcp-bm-ingress_{context}"]
+ifndef::non-bm[]
 = Handling ingress in a hosted cluster on bare metal
+endif::non-bm[]
+
+ifdef::non-bm[]
+= Handling ingress in a hosted cluster on non-bare-metal agent machines
+endif::non-bm[]
 
 Every {product-title} cluster has a default application Ingress Controller that typically has an external DNS record associated with it. For example, if you create a hosted cluster named `example` with the base domain `krnl.es`, you can expect the wildcard domain `*.apps.example.krnl.es` to be routable.
 
@@ -195,3 +205,8 @@ clusteroperator.config.openshift.io/ingress
 ----
 +
 Replace `<4.x.y>` with the supported {product-title} version that you want to use, for example, `4.17.0-multi`.
+
+
+ifeval::["{context}" == "hcp-manage-non-bm"]
+:!non-bm:
+endif::[]
diff --git a/modules/hcp-bm-machine-health-disable.adoc b/modules/hcp-bm-machine-health-disable.adoc
@@ -3,9 +3,20 @@
 // * hosted_control_planes/hcp-manage/hcp-manage-bm.adoc
 // * hosted_control_planes/hcp-manage/hcp-manage-non-bm.adoc
 
+ifeval::["{context}" == "hcp-manage-non-bm"]
+:non-bm:
+endif::[]
+
 :_mod-docs-content-type: PROCEDURE
 [id="hcp-bm-machine-health-disable_{context}"]
+ifndef::non-bm[]
 = Disabling machine health checks on bare metal
+endif::non-bm[]
+
+ifdef::non-bm[]
+= Disabling machine health checks on non-bare-metal agent machines
+endif::non-bm[]
+
 
 To disable machine health checks for the managed cluster nodes, modify the `NodePool` resource.
 
@@ -24,3 +35,7 @@ $ oc patch nodepool -n <hosted_cluster_namespace> <nodepool_name> -p '{"spec": {
 ----
 $ oc get nodepool -n <hosted_cluster_namespace> <nodepool_name> -o yaml | grep autoRepair
 ----
+
+ifeval::["{context}" == "hcp-manage-non-bm"]
+:!non-bm:
+endif::[]
diff --git a/modules/hcp-bm-machine-health.adoc b/modules/hcp-bm-machine-health.adoc
@@ -3,9 +3,19 @@
 // * hosted_control_planes/hcp-manage/hcp-manage-bm.adoc
 // * hosted_control_planes/hcp-manage/hcp-manage-non-bm.adoc
 
+ifeval::["{context}" == "hcp-manage-non-bm"]
+:non-bm:
+endif::[]
+
 :_mod-docs-content-type: PROCEDURE
 [id="hcp-bm-machine-health_{context}"]
+ifndef::non-bm[]
 = Enabling machine health checks on bare metal
+endif::non-bm[]
+
+ifdef::non-bm[]
+= Enabling machine health checks on non-bare-metal agent machines
+endif::non-bm[]
 
 You can enable machine health checks on bare metal to repair and replace unhealthy managed cluster nodes automatically. You must have additional agent machines that are ready to install in the managed cluster.
 
@@ -53,3 +63,7 @@ $ oc patch nodepool -n <hosted_cluster_namespace> <nodepool_name> -p '{"spec": {
 ----
 $ oc get nodepool -n <hosted_cluster_namespace> <nodepool_name> -o yaml | grep autoRepair
 ----
+
+ifeval::["{context}" == "hcp-manage-non-bm"]
+:!non-bm:
+endif::[]
diff --git a/modules/hcp-non-bm-dns.adoc b/modules/hcp-non-bm-dns.adoc
@@ -4,7 +4,7 @@
 
 :_mod-docs-content-type: CONCEPT
 [id="hcp-non-bm-dns_{context}"]
-= Configuring DNS on non-bare metal agent machines
+= Configuring DNS on non-bare-metal agent machines
 
 The API Server for the hosted cluster is exposed as a `NodePort` service. A DNS entry must exist for `api.<hosted_cluster_name>.<basedomain>` that points to destination where the API Server can be reached.
 
diff --git a/modules/hcp-non-bm-firewall-port-svc-reqs.adoc b/modules/hcp-non-bm-firewall-port-svc-reqs.adoc
@@ -4,7 +4,7 @@
 
 :_mod-docs-content-type: CONCEPT
 [id="hcp-non-bm-firewall-port-svc-reqs_{context}"]
-= Firewall, port, and service requirements for non-bare metal agent machines
+= Firewall, port, and service requirements for non-bare-metal agent machines
 
 You must meet the firewall and port requirements so that ports can communicate between the management cluster, the control plane, and hosted clusters.
 
@@ -15,7 +15,7 @@ Services run on their default ports. However, if you use the `NodePort` publishi
 
 Use firewall rules, security groups, or other access controls to restrict access to only required sources. Avoid exposing ports publicly unless necessary. For production deployments, use a load balancer to simplify access through a single IP address.
 
-A hosted control plane exposes the following services on non-bare metal agent machines:
+A hosted control plane exposes the following services on non-bare-metal agent machines:
 
 * `APIServer`
 
@@ -39,7 +39,7 @@ A hosted control plane exposes the following services on non-bare metal agent ma
 ** The `Ignition` service runs on port 443 by default when you use the route and ingress to expose the service.
 ** If you use the `NodePort` publishing strategy, use a firewall rule for the `Ignition` service.
 
-You do not need the following services on non-bare metal agent machines:
+You do not need the following services on non-bare-metal agent machines:
 
 * `OVNSbDb`
 * `OIDC`
diff --git a/modules/hcp-non-bm-hc-console.adoc b/modules/hcp-non-bm-hc-console.adoc
@@ -4,9 +4,9 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="hcp-non-bm-hc-console_{context}"]
-= Creating a hosted cluster on non-bare metal agent machines by using the web console
+= Creating a hosted cluster on non-bare-metal agent machines by using the web console
 
-You can create a hosted cluster on non-bare metal agent machines by using the {product-title} web console.
+You can create a hosted cluster on non-bare-metal agent machines by using the {product-title} web console.
 
 .Prerequisites
 
diff --git a/modules/hcp-non-bm-hc-mirror.adoc b/modules/hcp-non-bm-hc-mirror.adoc
@@ -4,9 +4,9 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="hcp-non-bm-hc-mirror_{context}"]
-= Creating a hosted cluster on non-bare metal agent machines by using a mirror registry
+= Creating a hosted cluster on non-bare-metal agent machines by using a mirror registry
 
-You can use a mirror registry to create a hosted cluster on non-bare metal agent machines by specifying the `--image-content-sources` flag in the `hcp create cluster` command.
+You can use a mirror registry to create a hosted cluster on non-bare-metal agent machines by specifying the `--image-content-sources` flag in the `hcp create cluster` command.
 
 .Procedure
 
diff --git a/modules/hcp-non-bm-hc.adoc b/modules/hcp-non-bm-hc.adoc
@@ -4,7 +4,7 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="hcp-non-bm-hc_{context}"]
-= Creating a hosted cluster on non-bare metal agent machines by using the CLI
+= Creating a hosted cluster on non-bare-metal agent machines by using the CLI
 
 When you create a hosted cluster with the Agent platform, the HyperShift Operator installs the Agent Cluster API provider in the hosted control plane namespace. You can create a hosted cluster on bare metal or import one.
 
@@ -70,4 +70,4 @@ $ oc -n <hosted_control_plane_namespace> get pods
 NAME                                             READY   STATUS    RESTARTS   AGE
 catalog-operator-6cd867cc7-phb2q                 2/2     Running   0          2m50s
 control-plane-operator-f6b4c8465-4k5dh           1/1     Running   0          4m32s
-----
+----
diff --git a/modules/hcp-non-bm-infra-reqs.adoc b/modules/hcp-non-bm-infra-reqs.adoc
@@ -4,7 +4,7 @@
 
 :_mod-docs-content-type: CONCEPT
 [id="hcp-non-bm-infra-reqs_{context}"]
-= Infrastructure requirements for non-bare metal agent machines
+= Infrastructure requirements for non-bare-metal agent machines
 
 The Agent platform does not create any infrastructure, but it has the following infrastructure requirements:
 
diff --git a/modules/hcp-non-bm-prepare.adoc b/modules/hcp-non-bm-prepare.adoc
@@ -4,7 +4,7 @@
 
 :_mod-docs-content-type: CONCEPT
 [id="hcp-non-bm-prepare_{context}"]
-= Preparing to deploy {hcp} on non-bare metal agent machines
+= Preparing to deploy {hcp} on non-bare-metal agent machines
 
 As you prepare to deploy {hcp} on bare metal, consider the following information:
 
diff --git a/modules/hcp-non-bm-prereqs.adoc b/modules/hcp-non-bm-prereqs.adoc
@@ -4,9 +4,9 @@
 
 :_mod-docs-content-type: CONCEPT
 [id="hcp-non-bm-prereqs_{context}"]
-= Prerequisites for deploying {hcp} on non-bare metal agent machines
+= Prerequisites for deploying {hcp} on non-bare-metal agent machines
 
-You must review the following prerequisites before deploying {hcp} on non-bare metal agent machines:
+You must review the following prerequisites before deploying {hcp} on non-bare-metal agent machines:
 
 * You need the {mce} 2.5 and later installed on an {product-title} cluster. The {mce-short} is automatically installed when you install {rh-rhacm-first}. You can also install the {mce-short} without {rh-rhacm} as an Operator from the {product-title} OperatorHub.
 
diff --git a/modules/hcp-non-bm-verify.adoc b/modules/hcp-non-bm-verify.adoc
@@ -4,7 +4,7 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="hcp-non-bm-verify_{context}"]
-= Verifying hosted cluster creation on non-bare metal agent machines
+= Verifying hosted cluster creation on non-bare-metal agent machines
 
 After the deployment process is complete, you can verify that the hosted cluster was created successfully. Follow these steps a few minutes after you create the hosted cluster.
 
diff --git a/modules/hcp-requirements-platform-version.adoc b/modules/hcp-requirements-platform-version.adoc
@@ -32,7 +32,7 @@ The following table indicates which {product-title} versions are supported for e
 |4.14 - 4.16
 |4.14 - 4.16 (only)
 
-|Non-bare metal agent machines
+|Non-bare-metal agent machines
 |4.16
 |4.16 (only)
 |===
