Merge pull request #34310 from lbscorpio/machineset

Fix callouts in samples of machineset

Author: kalexand-rh

modules/installation-osp-configuring-sr-iov.adoc

@@ -58,7 +58,7 @@ $ openstack subnet create --network uplink --subnet-range <uplink_network_subnet
 // +
 // [source,terminal]
 // ----
-// $ openstack port os_port_worker_0 --network <infrastructure_ID>-network --security-group <infrastructure_ID>-worker --fixed-ip subnet=<infrastructure_ID>-nodes,ip-address=<fixed_IP_address> --allowed-address ip-address=<infrastructure_ID>-ingress-port
+// $ openstack port os_port_worker_0 --network <infrastructure_id>-network --security-group <infrastructure_id>-worker --fixed-ip subnet=<infrastructure_id>-nodes,ip-address=<fixed_IP_address> --allowed-address ip-address=<infrastructure_ID>-ingress-port
 // ----
 
 // . Create a port for SR-IOV traffic:
@@ -72,5 +72,5 @@ $ openstack subnet create --network uplink --subnet-range <uplink_network_subnet
 // +
 // [source,terminal]
 // ----
-// $ openstack server create --image <infrastructure_ID>-rhcos --flavor ocp --user-data <ocp project>/build-artifacts/worker.ign --nic port-id=<os_port_worker_0 ID> --nic port-id=<radio_port_ID> --config-drive true worker-<worker_ID>.<cluster_name>.<cluster_domain>
+// $ openstack server create --image <infrastructure_id>-rhcos --flavor ocp --user-data <ocp project>/build-artifacts/worker.ign --nic port-id=<os_port_worker_0 ID> --nic port-id=<radio_port_ID> --config-drive true worker-<worker_ID>.<cluster_name>.<cluster_domain>
 // ----

modules/machineset-osp-adding-bare-metal.adoc

@@ -35,24 +35,24 @@ apiVersion: machine.openshift.io/v1beta1
 kind: MachineSet
 metadata:
   labels:
-    machine.openshift.io/cluster-api-cluster: <infrastructure_ID>
+    machine.openshift.io/cluster-api-cluster: <infrastructure_id>
     machine.openshift.io/cluster-api-machine-role: <node_role>
     machine.openshift.io/cluster-api-machine-type: <node_role>
-  name: <infrastructure_ID>-<node_role>
+  name: <infrastructure_id>-<node_role>
   namespace: openshift-machine-api
 spec:
   replicas: <number_of_replicas>
   selector:
     matchLabels:
-      machine.openshift.io/cluster-api-cluster: <infrastructure_ID>
-      machine.openshift.io/cluster-api-machineset: <infrastructure_ID>-<node_role>
+      machine.openshift.io/cluster-api-cluster: <infrastructure_id>
+      machine.openshift.io/cluster-api-machineset: <infrastructure_id>-<node_role>
   template:
     metadata:
       labels:
-        machine.openshift.io/cluster-api-cluster: <infrastructure_ID>
+        machine.openshift.io/cluster-api-cluster: <infrastructure_id>
         machine.openshift.io/cluster-api-machine-role: <node_role>
         machine.openshift.io/cluster-api-machine-type: <node_role>
-        machine.openshift.io/cluster-api-machineset: <infrastructure_ID>-<node_role>
+        machine.openshift.io/cluster-api-machineset: <infrastructure_id>-<node_role>
     spec:
       providerSpec:
         value:
@@ -69,15 +69,15 @@ spec:
             subnets:
             - filter:
                 name: <subnet_name>
-                tags: openshiftClusterID=<infrastructure_ID>
+                tags: openshiftClusterID=<infrastructure_id>
           securityGroups:
           - filter: {}
-            name: <infrastructure_ID>-<node_role>
+            name: <infrastructure_id>-<node_role>
           serverMetadata:
-            Name: <infrastructure_ID>-<node_role>
-            openshiftClusterID: <infrastructure_ID>
+            Name: <infrastructure_id>-<node_role>
+            openshiftClusterID: <infrastructure_id>
           tags:
-          - openshiftClusterID=<infrastructure_ID>
+          - openshiftClusterID=<infrastructure_id>
           trunk: true
           userDataSecret:
             name: <node_role>-user-data

modules/machineset-yaml-aws.adoc

@@ -18,9 +18,9 @@ This sample YAML defines a machine set that runs in the `us-east-1a` Amazon Web
 ifndef::infra[`node-role.kubernetes.io/<role>: ""`.]
 ifdef::infra[`node-role.kubernetes.io/infra: ""`.]
 
-In this sample, `<infrastructureID>` is the infrastructure ID label that is based on the cluster ID that you set when you provisioned the cluster, and
+In this sample, `<infrastructure_id>` is the infrastructure ID label that is based on the cluster ID that you set when you provisioned the cluster, and
 ifndef::infra[`<role>`]
-ifdef::infra[`infra`]
+ifdef::infra[`<infra>`]
 is the node label to add.
 
 [source,yaml]
@@ -29,42 +29,42 @@ apiVersion: machine.openshift.io/v1beta1
 kind: MachineSet
 metadata:
   labels:
-    machine.openshift.io/cluster-api-cluster: <infrastructureID> <1>
+    machine.openshift.io/cluster-api-cluster: <infrastructure_id> <1>
 ifndef::infra[]
-  name: <infrastructureID>-<role>-<zone> <2>
+  name: <infrastructure_id>-<role>-<zone> <2>
 endif::infra[]
 ifdef::infra[]
-  name: <infrastructureID>-infra-<zone> <2>
+  name: <infrastructure_id>-infra-<zone> <2>
 endif::infra[]
   namespace: openshift-machine-api
 spec:
   replicas: 1
   selector:
     matchLabels:
-      machine.openshift.io/cluster-api-cluster: <infrastructureID> <1>
+      machine.openshift.io/cluster-api-cluster: <infrastructure_id> <1>
 ifndef::infra[]
-      machine.openshift.io/cluster-api-machineset: <infrastructureID>-<role>-<zone> <2>
+      machine.openshift.io/cluster-api-machineset: <infrastructure_id>-<role>-<zone> <2>
 endif::infra[]
 ifdef::infra[]
-      machine.openshift.io/cluster-api-machineset: <infrastructureID>-infra-<zone> <2>
+      machine.openshift.io/cluster-api-machineset: <infrastructure_id>-infra-<zone> <2>
 endif::infra[]
   template:
     metadata:
       labels:
-        machine.openshift.io/cluster-api-cluster: <infrastructureID> <1>
+        machine.openshift.io/cluster-api-cluster: <infrastructure_id> <1>
 ifndef::infra[]
         machine.openshift.io/cluster-api-machine-role: <role> <3>
         machine.openshift.io/cluster-api-machine-type: <role> <3>
 endif::infra[]
 ifdef::infra[]
-        machine.openshift.io/cluster-api-machine-role: infra <3>
-        machine.openshift.io/cluster-api-machine-type: infra <3>
+        machine.openshift.io/cluster-api-machine-role: <infra> <3>
+        machine.openshift.io/cluster-api-machine-type: <infra> <3>
 endif::infra[]
 ifndef::infra[]
-        machine.openshift.io/cluster-api-machineset: <infrastructureID>-<role>-<zone> <2>
+        machine.openshift.io/cluster-api-machineset: <infrastructure_id>-<role>-<zone> <2>
 endif::infra[]
 ifdef::infra[]
-        machine.openshift.io/cluster-api-machineset: <infrastructureID>-infra-<zone> <2>
+        machine.openshift.io/cluster-api-machineset: <infrastructure_id>-infra-<zone> <2>
 endif::infra[]
     spec:
       metadata:
@@ -97,7 +97,7 @@ endif::infra[]
             name: aws-cloud-credentials
           deviceIndex: 0
           iamInstanceProfile:
-            id: <infrastructureID>-worker-profile <1>
+            id: <infrastructure_id>-worker-profile <1>
           instanceType: m4.large
           kind: AWSMachineProviderConfig
           placement:
@@ -107,14 +107,14 @@ endif::infra[]
             - filters:
                 - name: tag:Name
                   values:
-                    - <infrastructureID>-worker-sg <1>
+                    - <infrastructure_id>-worker-sg <1>
           subnet:
             filters:
               - name: tag:Name
                 values:
-                  - <infrastructureID>-private-us-east-1a <1>
+                  - <infrastructure_id>-private-us-east-1a <1>
           tags:
-            - name: kubernetes.io/cluster/<infrastructureID> <1>
+            - name: kubernetes.io/cluster/<infrastructure_id> <1>
               value: owned
           userDataSecret:
             name: worker-user-data
@@ -125,16 +125,16 @@ endif::infra[]
 ----
 $ oc -n openshift-machine-api \
     -o jsonpath='{.spec.template.spec.providerSpec.value.ami.id}{"\n"}' \
-    get machineset/<infrastructureID>-worker-us-east-1a
+    get machineset/<infrastructure_id>-worker-us-east-1a
 ----
 ifndef::infra[]
 <2> Specify the infrastructure ID, node label, and zone.
 <3> Specify the node label to add.
 <4> Specify a valid {op-system-first} AMI for your AWS zone for your {product-title} nodes.
 endif::infra[]
 ifdef::infra[]
-<2> Specify the infrastructure ID, `infra` node label, and zone.
-<3> Specify the `infra` node label.
+<2> Specify the infrastructure ID, `<infra>` node label, and zone.
+<3> Specify the `<infra>` node label.
 <4> Specify a taint to prevent user workloads from being scheduled on infra nodes.
 <5> Specify a valid {op-system-first} AMI for your AWS zone for your {product-title} nodes.
 endif::infra[]

modules/machineset-yaml-azure.adoc

@@ -18,9 +18,9 @@ This sample YAML defines a machine set that runs in the `1` Microsoft Azure zone
 ifndef::infra[`node-role.kubernetes.io/<role>: ""`.]
 ifdef::infra[`node-role.kubernetes.io/infra: ""`.]
 
-In this sample, `<infrastructureID>` is the infrastructure ID label that is based on the cluster ID that you set when you provisioned the cluster, and
+In this sample, `<infrastructure_id>` is the infrastructure ID label that is based on the cluster ID that you set when you provisioned the cluster, and
 ifndef::infra[`<role>`]
-ifdef::infra[`infra`]
+ifdef::infra[`<infra>`]
 is the node label to add.
 
 [source,yaml]
@@ -29,43 +29,43 @@ apiVersion: machine.openshift.io/v1beta1
 kind: MachineSet
 metadata:
   labels:
-    machine.openshift.io/cluster-api-cluster: <infrastructureID> <1>
+    machine.openshift.io/cluster-api-cluster: <infrastructure_id> <1>
 ifndef::infra[]
     machine.openshift.io/cluster-api-machine-role: <role> <2>
     machine.openshift.io/cluster-api-machine-type: <role> <2>
-  name: <infrastructureID>-<role>-<region> <3>
+  name: <infrastructure_id>-<role>-<region> <3>
 endif::infra[]
 ifdef::infra[]
-    machine.openshift.io/cluster-api-machine-role: infra <2>
-    machine.openshift.io/cluster-api-machine-type: infra <2>
-  name: <infrastructureID>-infra-<region> <3>
+    machine.openshift.io/cluster-api-machine-role: <infra> <2>
+    machine.openshift.io/cluster-api-machine-type: <infra> <2>
+  name: <infrastructure_id>-infra-<region> <3>
 endif::infra[]
   namespace: openshift-machine-api
 spec:
   replicas: 1
   selector:
     matchLabels:
-      machine.openshift.io/cluster-api-cluster: <infrastructureID> <1>
+      machine.openshift.io/cluster-api-cluster: <infrastructure_id> <1>
 ifndef::infra[]
-      machine.openshift.io/cluster-api-machineset: <infrastructureID>-<role>-<region> <3>
+      machine.openshift.io/cluster-api-machineset: <infrastructure_id>-<role>-<region> <3>
 endif::infra[]
 ifdef::infra[]
-      machine.openshift.io/cluster-api-machineset: <infrastructureID>-infra-<region> <3>
+      machine.openshift.io/cluster-api-machineset: <infrastructure_id>-infra-<region> <3>
 endif::infra[]
   template:
     metadata:
       creationTimestamp: null
       labels:
-        machine.openshift.io/cluster-api-cluster: <infrastructureID> <1>
+        machine.openshift.io/cluster-api-cluster: <infrastructure_id> <1>
 ifndef::infra[]
         machine.openshift.io/cluster-api-machine-role: <role> <2>
         machine.openshift.io/cluster-api-machine-type: <role> <2>
-        machine.openshift.io/cluster-api-machineset: <infrastructureID>-<role>-<region> <3>
+        machine.openshift.io/cluster-api-machineset: <infrastructure_id>-<role>-<region> <3>
 endif::infra[]
 ifdef::infra[]
-        machine.openshift.io/cluster-api-machine-role: infra <2>
-        machine.openshift.io/cluster-api-machine-type: infra <2>
-        machine.openshift.io/cluster-api-machineset: <infrastructureID>-infra-<region> <3>
+        machine.openshift.io/cluster-api-machine-role: <infra> <2>
+        machine.openshift.io/cluster-api-machine-type: <infra> <2>
+        machine.openshift.io/cluster-api-machineset: <infrastructure_id>-infra-<region> <3>
 endif::infra[]
     spec:
       metadata:
@@ -89,13 +89,13 @@ endif::infra[]
           image:
             offer: ""
             publisher: ""
-            resourceID: /resourceGroups/<infrastructureID>-rg/providers/Microsoft.Compute/images/<infrastructureID>
+            resourceID: /resourceGroups/<infrastructure_id>-rg/providers/Microsoft.Compute/images/<infrastructure_id> <1>
             sku: ""
             version: ""
           internalLoadBalancer: ""
           kind: AzureMachineProviderSpec
           location: centralus
-          managedIdentity: <infrastructureID>-identity <1>
+          managedIdentity: <infrastructure_id>-identity <1>
           metadata:
             creationTimestamp: null
           natRule: null
@@ -107,14 +107,14 @@ endif::infra[]
             osType: Linux
           publicIP: false
           publicLoadBalancer: ""
-          resourceGroup: <infrastructureID>-rg <1>
+          resourceGroup: <infrastructure_id>-rg <1>
           sshPrivateKey: ""
           sshPublicKey: ""
-          subnet: <infrastructureID>-<role>-subnet <1> <2>
+          subnet: <infrastructure_id>-<role>-subnet <1> <2>
           userDataSecret:
             name: worker-user-data <2>
           vmSize: qeci-22538-vnet
-          vnet: <infrastructureID>-vnet <1>
+          vnet: <infrastructure_id>-vnet <1>
 ifndef::infra[]
           zone: "1" <4>
 endif::infra[]
@@ -135,24 +135,24 @@ You can obtain the subnet by running the following command:
 ----
 $  oc -n openshift-machine-api \
     -o jsonpath='{.spec.template.spec.providerSpec.value.subnet}{"\n"}' \
-    get machineset/<infrastructureID>-worker-centralus1
+    get machineset/<infrastructure_id>-worker-centralus1
 ----
 You can obtain the vnet by running the following command:
 +
 [source,terminal]
 ----
 $  oc -n openshift-machine-api \
     -o jsonpath='{.spec.template.spec.providerSpec.value.vnet}{"\n"}' \
-    get machineset/<infrastructureID>-worker-centralus1
+    get machineset/<infrastructure_id>-worker-centralus1
 ----
 ifndef::infra[]
 <2> Specify the node label to add.
 <3> Specify the infrastructure ID, node label, and region.
 <4> Specify the zone within your region to place Machines on. Be sure that your region supports the zone that you specify.
 endif::infra[]
 ifdef::infra[]
-<2> Specify the `infra` node label.
-<3> Specify the infrastructure ID, `infra` node label, and region.
+<2> Specify the `<infra>` node label.
+<3> Specify the infrastructure ID, `<infra>` node label, and region.
 <4> Specify a taint to prevent user workloads from being scheduled on infra nodes.
 <5> Specify the zone within your region to place Machines on. Be sure that your region supports the zone that you specify.
 endif::infra[]