Merge pull request #41327 from cherraz/BZ2040707

BZ2040707: Style fixes on ZTP assembly

Author: stevsmit

modules/ztp-about-ztp-and-distributed-units-on-single-node-openshift-clusters.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// *scalability_and_performance/ztp-zero-touch-provisioning.adoc
+// *scalability_and_performance/ztp-deploying-disconnected.adoc
 
 :_content-type: CONCEPT
 [id="about-ztp-and-distributed-units-on-single-node-clusters_{context}"]
@@ -16,10 +16,10 @@ With ZTP and AI, you can provision {product-title} single nodes to run your DUs
 
 * A hub cluster running ACM manages a disconnected internal registry that mirrors the {product-title} release images. The internal registry is used to provision the spoke single nodes.
 
-* You manage the bare metal host machines for your DUs in an inventory file that uses YAML for formatting. You store the inventory file in a Git repository.
+* You manage the bare-metal host machines for your DUs in an inventory file that uses YAML for formatting. You store the inventory file in a Git repository.
 
 
-* You install the DU bare metal host machines on site, and make the hosts ready for provisioning. To be ready for provisioning, the following is required for each bare metal host:
+* You install the DU bare-metal host machines on site, and make the hosts ready for provisioning. To be ready for provisioning, the following is required for each bare-metal host:
 
 ** Network connectivity - including DNS for your network. Hosts should be reachable through the hub and managed spoke clusters. Ensure there is layer 3 connectivity between the hub and the host where you want to install your hub cluster.
 
@@ -57,7 +57,7 @@ CRs are as follows:
 This is the final step of the manifest creation phase.
 
 |BareMetalHost
-|Describes the details of the bare metal host, including BMC and credentials details.
+|Describes the details of the bare-metal host, including BMC and credentials details.
 |===
 
 * When a change is detected in the host inventory repository, a host management event is triggered to provision the new or updated host.

modules/ztp-acm-installing-disconnected-rhacm.adoc

@@ -4,6 +4,7 @@
 
 :_content-type: PROCEDURE
 [id="installing-disconnected-rhacm_{context}"]
+:_content-type: PROCEDURE
 = Installing Red Hat Advanced Cluster Management in a disconnected environment
 
 You use {rh-rhacm-first} on a hub cluster in the disconnected environment to manage the deployment of distributed unit (DU) profiles on multiple managed spoke clusters.

modules/ztp-acm-preparing-to-install-disconnected-acm.adoc

@@ -2,6 +2,7 @@
 // Module included in the following assemblies:
 //
 // scalability_and_performance/ztp-deploying-disconnected.adoc
+:_content-type: CONCEPT
 [id="ztp-acm-preparing-to-install-disconnected-acm_{context}"]
 = Preparing the disconnected environment
 

modules/ztp-applying-source-custom-resource-policies.adoc

@@ -2,6 +2,7 @@
 //
 // scalability_and_performance/ztp-deploying-disconnected.adoc
 
+:_content-type: PROCEDURE
 [id="ztp-applying-source-custom-resource-policies_{context}"]
 = Applying source custom resource policies
 

modules/ztp-applying-the-ran-policies-for-monitoring-cluster-activity.adoc

@@ -2,6 +2,7 @@
 //
 // scalability_and_performance/ztp-deploying-disconnected.adoc
 
+:_content-type: CONCEPT
 [id="ztp-applying-the-ran-policies-for-monitoring-cluster-activity_{context}"]
 = Applying the RAN policies for monitoring cluster activity
 

modules/ztp-checking-the-installation-status.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// *scalability_and_performance/ztp-zero-touch-provisioning.adoc
+// *scalability_and_performance/ztp-deploying-disconnected.adoc
 
 :_content-type: PROCEDURE
 [id="ztp-checking-the-installation-status_{context}"]
@@ -14,7 +14,7 @@ The ArgoCD pipeline detects the `SiteConfig` and `PolicyGenTemplate` custom reso
 +
 [source,terminal]
 ----
-$ export CLUSTER=<clusterName>
+$ export CLUSTER=<cluster_name>
 ----
 +
 [source,terminal]

modules/ztp-checking-the-managed-cluster-status.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// *scalability_and_performance/ztp-zero-touch-provisioning.adoc
+// *scalability_and_performance/ztp-deploying-disconnected.adoc
 
 :_content-type: PROCEDURE
 [id="ztp-checking-the-managed-cluster-status_{context}"]
@@ -28,40 +28,40 @@ $ oc get managedcluster
 +
 [source,terminal]
 ----
-$ oc get agent -n <cluster-name>
+$ oc get agent -n <cluster_name>
 ----
 
 . Use the `describe` command to provide an in-depth description of the agent’s condition. Statuses to be aware of include `BackendError`, `InputError`, `ValidationsFailing`, `InstallationFailed`, and `AgentIsConnected`. These statuses are relevant to the `Agent` and `AgentClusterInstall` custom resources.
 +
 [source,terminal]
 ----
-$ oc describe agent -n <cluster-name>
+$ oc describe agent -n <cluster_name>
 ----
 
 . Check the cluster provisioning status:
 +
 [source,terminal]
 ----
-$ oc get agentclusterinstall -n <cluster-name>
+$ oc get agentclusterinstall -n <cluster_name>
 ----
 
 . Use the `describe` command to provide an in-depth description of the cluster provisioning status:
 +
 [source,terminal]
 ----
-$ oc describe agentclusterinstall -n <cluster-name>
+$ oc describe agentclusterinstall -n <cluster_name>
 ----
 
 . Check the status of the managed cluster’s add-on services:
 +
 [source,terminal]
 ----
-$ oc get managedclusteraddon -n <cluster-name>
+$ oc get managedclusteraddon -n <cluster_name>
 ----
 
 . Retrieve the authentication information of the `kubeconfig` file for the managed cluster:
 +
 [source,terminal]
 ----
-$ oc get secret -n <cluster-name> <cluster-name>-admin-kubeconfig -o jsonpath={.data.kubeconfig} | base64 -d > <directory>/<cluster-name>-kubeconfig
+$ oc get secret -n <cluster_name> <cluster_name>-admin-kubeconfig -o jsonpath={.data.kubeconfig} | base64 -d > <directory>/<cluster_name>-kubeconfig
 ----

modules/ztp-cluster-provisioning.adoc

@@ -2,6 +2,7 @@
 //
 // scalability_and_performance/ztp-deploying-disconnected.adoc
 
+:_content-type: CONCEPT
 [id="ztp-cluster-provisioning_{context}"]
 = Cluster provisioning
 

modules/ztp-configuring-a-static-ip.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// *scalability_and_performance/ztp-zero-touch-provisioning.adoc
+// *scalability_and_performance/ztp-deploying-disconnected.adoc
 
 :_content-type: PROCEDURE
 [id="ztp-configuring-a-static-ip_{context}"]
@@ -26,10 +26,10 @@ You must create this custom resource before creating the `ClusterDeployment` cus
 apiVersion: agent-install.openshift.io/v1beta1
 kind: NMStateConfig
 metadata:
- name: <cluster-name>
- namespace: <cluster-name>
+ name: <cluster_name>
+ namespace: <cluster_name>
  labels:
-   sno-cluster-<cluster-name>: <cluster-name>
+   sno-cluster-<cluster-name>: <cluster_name>
 spec:
  config:
    interfaces:
@@ -39,13 +39,13 @@ spec:
        ipv4:
          enabled: true
          address:
-           - ip: <ip-address> <1>
-             prefix-length: <public-network-prefix> <2>
+           - ip: <ip_address> <1>
+             prefix-length: <public_network_prefix> <2>
          dhcp: false
    dns-resolver:
      config:
        server:
-         - <dns-resolver> <3>
+         - <dns_resolver> <3>
    routes:
      config:
        - destination: 0.0.0.0/0
@@ -54,16 +54,16 @@ spec:
          table-id: 254
  interfaces:
    - name: "eth0" <5>
-     macAddress: <mac-address> <6>
+     macAddress: <mac_address> <6>
 ----
-<1> `ip-address` is the static IP address of the target bare metal machine.
-<2> `public-network-prefix` is the static IP address’s subnet prefix for the target bare metal machine.
-<3> `dns-resolver` is the DNS server for the target bare metal machine.
-<4> `gateway` is the gateway for the target bare metal machine.
-<5> `name` must match the name specified in the `interfaces` section.
-<6> `mac-address` is the mac address of the interface.
+<1>  The static IP address of the target bare-metal host.
+<2>  The static IP address’s subnet prefix for the target bare-metal host.
+<3>  The DNS server for the target bare-metal host.
+<4>  The gateway for the target bare-metal host.
+<5>  Must match the name specified in the `interfaces` section.
+<6>  The mac address of the interface.
 
-. When creating the `BareMetalHost` custom resource, ensure that one of its mac addresses matches a mac address in the `NMStateConfig` target bare metal machine.
+. When creating the `BareMetalHost` custom resource, ensure that one of its mac addresses matches a mac address in the `NMStateConfig` target bare-metal host.
 
 . When creating the `InfraEnv` custom resource, reference the label from the `NMStateConfig` custom resource in the `InfraEnv` custom resource:
 +
@@ -72,19 +72,19 @@ spec:
 apiVersion: agent-install.openshift.io/v1beta1
 kind: InfraEnv
 metadata:
-  name: <cluster-name>
-  namespace: <cluster-name>
+  name: <cluster_name>
+  namespace: <cluster_name>
 spec:
   clusterRef:
-    name: <cluster-name>
-    namespace: <cluster-name>
-  sshAuthorizedKey: <public-key>
+    name: <cluster_name>
+    namespace: <cluster_name>
+  sshAuthorizedKey: <public_key>
   agentLabelSelector:
     matchLabels:
-      cluster-name: <cluster-name>
+      cluster-name: <cluster_name>
   pullSecretRef:
     name: assisted-deployment-pull-secret
   nmStateConfigLabelSelector:
     matchLabels:
-      sno-cluster-<cluster-name>: <cluster-name> # Match this label
+      sno-cluster-<cluster-name>: <cluster_name> # Match this label
 ----

modules/ztp-configuring-ipv6.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// *scalability_and_performance/ztp-zero-touch-provisioning.adoc
+// *scalability_and_performance/ztp-deploying-disconnected.adoc
 
 :_content-type: PROCEDURE
 [id="ztp-configuring-ipv6_{context}"]
@@ -20,25 +20,25 @@ metadata:
   # Only include the annotation if using OVN, otherwise omit the annotation
   annotations:
     agent-install.openshift.io/install-config-overrides: '{"networking":{"networkType":"OVNKubernetes"}}'
-  name: <cluster-name>
-  namespace: <cluster-name>
+  name: <cluster_name>
+  namespace: <cluster_name>
 spec:
   clusterDeploymentRef:
-    name: <cluster-name>
+    name: <cluster_name>
   imageSetRef:
-    name: <cluster-image-set>
+    name: <cluster_image_set>
   networking:
     clusterNetwork:
     - cidr: "fd01::/48"
       hostPrefix: 64
     machineNetwork:
-    - cidr: <machine-network-cidr>
+    - cidr: <machine_network_cidr>
     serviceNetwork:
     - "fd02::/112"
   provisionRequirements:
     controlPlaneAgents: 1
     workerAgents: 0
-  sshPublicKey: <public-key>
+  sshPublicKey: <public_key>
 ----
 
 . Update the `NMStateConfig` custom resource with the IPv6 addresses you defined.