Merge pull request #57889 from ktothill/OCPBUGS-9944

OCPBUGS-9944: Updating User-Replaced Values to Use Underscores

Author: jab-rh

modules/ipi-install-troubleshooting-api-not-accessible.adoc

@@ -28,12 +28,12 @@ $ hostnamectl set-hostname <hostname>
 +
 [source,terminal]
 ----
-$ dig api.<cluster-name>.example.com
+$ dig api.<cluster_name>.example.com
 ----
 +
 [source,terminal]
 ----
-; <<>> DiG 9.11.4-P2-RedHat-9.11.4-26.P2.el8 <<>> api.<cluster-name>.example.com
+; <<>> DiG 9.11.4-P2-RedHat-9.11.4-26.P2.el8 <<>> api.<cluster_name>.example.com
 ;; global options: +cmd
 ;; Got answer:
 ;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 37551
@@ -43,21 +43,21 @@ $ dig api.<cluster-name>.example.com
 ; EDNS: version: 0, flags:; udp: 4096
 ; COOKIE: 866929d2f8e8563582af23f05ec44203d313e50948d43f60 (good)
 ;; QUESTION SECTION:
-;api.<cluster-name>.example.com. IN A
+;api.<cluster_name>.example.com. IN A
 
 ;; ANSWER SECTION:
-api.<cluster-name>.example.com. 10800 IN	A 10.19.13.86
+api.<cluster_name>.example.com. 10800 IN	A 10.19.13.86
 
 ;; AUTHORITY SECTION:
-<cluster-name>.example.com. 10800 IN NS	<cluster-name>.example.com.
+<cluster_name>.example.com. 10800 IN NS	<cluster_name>.example.com.
 
 ;; ADDITIONAL SECTION:
-<cluster-name>.example.com. 10800 IN A	10.19.14.247
+<cluster_name>.example.com. 10800 IN A	10.19.14.247
 
 ;; Query time: 0 msec
 ;; SERVER: 10.19.14.247#53(10.19.14.247)
 ;; WHEN: Tue May 19 20:30:59 UTC 2020
 ;; MSG SIZE  rcvd: 140
 ----
 +
-The output in the foregoing example indicates that the appropriate IP address for the `api.<cluster-name>.example.com` VIP is `10.19.13.86`. This IP address should reside on the `baremetal` network.
+The output in the foregoing example indicates that the appropriate IP address for the `api.<cluster_name>.example.com` VIP is `10.19.13.86`. This IP address should reside on the `baremetal` network.

modules/ipi-install-troubleshooting-bootstrap-vm-cannot-boot.adoc

@@ -28,10 +28,10 @@ $ ssh [email protected]
 +
 [source,terminal]
 ----
-[core@localhost ~]$ sudo podman logs -f <container-name>
+[core@localhost ~]$ sudo podman logs -f <container_name>
 ----
 +
-Replace `<container-name>` with one of `ironic` or `ironic-inspector`. If you encounter an issue where the control plane nodes are not booting up from PXE, check the `ironic` pod. The `ironic` pod contains information about the attempt to boot the cluster nodes, because it attempts to log in to the node over IPMI.
+Replace `<container_name>` with one of `ironic` or `ironic-inspector`. If you encounter an issue where the control plane nodes are not booting up from PXE, check the `ironic` pod. The `ironic` pod contains information about the attempt to boot the cluster nodes, because it attempts to log in to the node over IPMI.
 
 .Potential reason
 The cluster nodes might be in the `ON` state when deployment started.
@@ -42,5 +42,5 @@ installation over IPMI:
 
 [source,terminal]
 ----
-$ ipmitool -I lanplus -U root -P <password> -H <out-of-band-ip> power off
+$ ipmitool -I lanplus -U root -P <password> -H <out_of_band_ip> power off
 ----

modules/ipi-install-troubleshooting-cleaning-up-previous-installations.adoc

@@ -14,7 +14,7 @@ In the event of a previous failed deployment, remove the artifacts from the fail
 +
 [source,terminal]
 ----
-$ ipmitool -I lanplus -U <user> -P <password> -H <management-server-ip> power off
+$ ipmitool -I lanplus -U <user> -P <password> -H <management_server_ip> power off
 ----
 
 . Remove all old bootstrap resources if any are left over from a previous deployment attempt:

modules/ipi-install-troubleshooting-misc-issues.adoc

@@ -129,10 +129,10 @@ Where `X` is the control plane node number.
 +
 [source,terminal]
 ----
-[core@master-X ~]$ sudo nmcli con up "<bare-metal-nic>"
+[core@master-X ~]$ sudo nmcli con up "<bare_metal_nic>"
 ----
 +
-Replace `<bare-metal-nic>` with the wired connection corresponding to the `baremetal` network.
+Replace `<bare_metal_nic>` with the wired connection corresponding to the `baremetal` network.
 
 . Check `hostname` again:
 +

modules/ipi-install-troubleshooting-ntp-out-of-sync.adoc

@@ -35,7 +35,7 @@ $ oc get bmh -n openshift-machine-api
 +
 [source,terminal]
 ----
-master-1   error registering master-1  ipmi://<out-of-band-ip>
+master-1   error registering master-1  ipmi://<out_of_band_ip>
 ----
 +
 [source,terminal]
@@ -78,7 +78,7 @@ storage:
     overwrite: true
     contents:
       inline: |
-        server <NTP-server> iburst <1>
+        server <NTP_server> iburst <1>
         stratumweight 0
         driftfile /var/lib/chrony/drift
         rtcsync
@@ -92,7 +92,7 @@ storage:
         logchange 0.5
         logdir /var/log/chrony
 ----
-<1> Replace `<NTP-server>` with the IP address of the NTP server.
+<1> Replace `<NTP_server>` with the IP address of the NTP server.
 
 . Use Butane to generate a `MachineConfig` object file, `99-master-chrony.yaml`, containing the configuration to be delivered to the nodes:
 +

modules/ipi-install-troubleshooting-registry-issues.adoc

@@ -40,6 +40,6 @@ disconnected environment:
 +
 [source,terminal]
 ----
-$ curl -k -u <user>:<password> https://registry.example.com:<registry-port>/v2/_catalog
-{"repositories":["<Repo-Name>"]}
+$ curl -k -u <user>:<password> https://registry.example.com:<registry_port>/v2/_catalog
+{"repositories":["<Repo_Name>"]}
 ----