Merge pull request #35685 from jeana-redhat/machine-mgmt_copyediting

jeana-redhat · web-flow · commit 28e677818dde · 2021-08-26T09:38:15.000-04:00
Small changes noticed while reading "Machine management" book
diff --git a/machine_management/creating-infrastructure-machinesets.adoc b/machine_management/creating-infrastructure-machinesets.adoc
@@ -5,6 +5,8 @@ include::modules/common-attributes.adoc[]
 
 toc::[]
 
+include::modules/machine-user-provisioned-limitations.adoc[leveloffset=+1]
+
 You can create a machine set to host only infrastructure components. You apply specific Kubernetes labels to these machines and then update the infrastructure components to run on only those machines. These infrastructure nodes are not counted toward the total number of subscriptions that are required to run the environment.
 
 [IMPORTANT]
@@ -83,4 +85,4 @@ include::modules/infrastructure-moving-logging.adoc[leveloffset=+2]
 
 .Additional resources
 
-* See xref:../monitoring/configuring-the-monitoring-stack.adoc#moving-monitoring-components-to-different-nodes_configuring-the-monitoring-stack[the monitoring documentation] for the general instructions on moving {product-title} components.
+* See xref:../monitoring/configuring-the-monitoring-stack.adoc#moving-monitoring-components-to-different-nodes_configuring-the-monitoring-stack[the monitoring documentation] for the general instructions on moving {product-title} components.
diff --git a/machine_management/creating_machinesets/creating-machineset-aws.adoc b/machine_management/creating_machinesets/creating-machineset-aws.adoc
@@ -3,9 +3,11 @@
 include::modules/common-attributes.adoc[]
 :context: creating-machineset-aws
 
+toc::[]
+
 You can create a different machine set to serve a specific purpose in your {product-title} cluster on Amazon Web Services (AWS). For example, you might create infrastructure machine sets and related machines so that you can move supporting workloads to the new machines.
 
-toc::[]
+include::modules/machine-user-provisioned-limitations.adoc[leveloffset=+1]
 
 include::modules/machine-api-overview.adoc[leveloffset=+1]
 
diff --git a/machine_management/creating_machinesets/creating-machineset-azure.adoc b/machine_management/creating_machinesets/creating-machineset-azure.adoc
@@ -3,9 +3,11 @@
 include::modules/common-attributes.adoc[]
 :context: creating-machineset-azure
 
+toc::[]
+
 You can create a different machine set to serve a specific purpose in your {product-title} cluster on Microsoft Azure. For example, you might create infrastructure machine sets and related machines so that you can move supporting workloads to the new machines.
 
-toc::[]
+include::modules/machine-user-provisioned-limitations.adoc[leveloffset=+1]
 
 include::modules/machine-api-overview.adoc[leveloffset=+1]
 
diff --git a/machine_management/creating_machinesets/creating-machineset-gcp.adoc b/machine_management/creating_machinesets/creating-machineset-gcp.adoc
@@ -3,9 +3,11 @@
 include::modules/common-attributes.adoc[]
 :context: creating-machineset-gcp
 
+toc::[]
+
 You can create a different machine set to serve a specific purpose in your {product-title} cluster on Google Cloud Platform (GCP). For example, you might create infrastructure machine sets and related machines so that you can move supporting workloads to the new machines.
 
-toc::[]
+include::modules/machine-user-provisioned-limitations.adoc[leveloffset=+1]
 
 include::modules/machine-api-overview.adoc[leveloffset=+1]
 
diff --git a/machine_management/creating_machinesets/creating-machineset-osp.adoc b/machine_management/creating_machinesets/creating-machineset-osp.adoc
@@ -3,9 +3,11 @@
 include::modules/common-attributes.adoc[]
 :context: creating-machineset-osp
 
+toc::[]
+
 You can create a different machine set to serve a specific purpose in your {product-title} cluster on {rh-openstack-first}. For example, you might create infrastructure machine sets and related machines so that you can move supporting workloads to the new machines.
 
-toc::[]
+include::modules/machine-user-provisioned-limitations.adoc[leveloffset=+1]
 
 include::modules/machine-api-overview.adoc[leveloffset=+1]
 
@@ -22,4 +24,4 @@ include::modules/machineset-yaml-osp-sr-iov-port-security.adoc[leveloffset=+1]
 include::modules/machineset-creating.adoc[leveloffset=+1]
 
 // Mothballed - re-add when available
-// include::modules/machineset-osp-adding-bare-metal.adoc[leveloffset=+1]
+// include::modules/machineset-osp-adding-bare-metal.adoc[leveloffset=+1]
diff --git a/machine_management/creating_machinesets/creating-machineset-rhv.adoc b/machine_management/creating_machinesets/creating-machineset-rhv.adoc
@@ -3,9 +3,11 @@
 include::modules/common-attributes.adoc[]
 :context: creating-machineset-rhv
 
+toc::[]
+
 You can create a different machine set to serve a specific purpose in your {product-title} cluster on {rh-virtualization-first}. For example, you might create infrastructure machine sets and related machines so that you can move supporting workloads to the new machines.
 
-toc::[]
+include::modules/machine-user-provisioned-limitations.adoc[leveloffset=+1]
 
 include::modules/machine-api-overview.adoc[leveloffset=+1]
 
diff --git a/machine_management/creating_machinesets/creating-machineset-vsphere.adoc b/machine_management/creating_machinesets/creating-machineset-vsphere.adoc
@@ -7,6 +7,8 @@ toc::[]
 
 You can create a different machine set to serve a specific purpose in your {product-title} cluster on VMware vSphere. For example, you might create infrastructure machine sets and related machines so that you can move supporting workloads to the new machines.
 
+include::modules/machine-user-provisioned-limitations.adoc[leveloffset=+1]
+
 include::modules/machine-api-overview.adoc[leveloffset=+1]
 
 include::modules/machineset-yaml-vsphere.adoc[leveloffset=+1]
diff --git a/modules/machine-api-overview.adoc b/modules/machine-api-overview.adoc
@@ -18,7 +18,7 @@ For {product-title} {product-version} clusters, the Machine API performs all nod
 
 The two primary resources are:
 
-Machines:: A fundamental unit that describes the host for a Node. A machine has a `providerSpec` specification, which describes the types of compute nodes that are offered for different cloud platforms. For example, a machine type for a worker node on Amazon Web Services (AWS) might define a specific machine type and required metadata.
+Machines:: A fundamental unit that describes the host for a node. A machine has a `providerSpec` specification, which describes the types of compute nodes that are offered for different cloud platforms. For example, a machine type for a worker node on Amazon Web Services (AWS) might define a specific machine type and required metadata.
 
 Machine sets:: `MachineSet` resources are groups of machines. Machine sets are to machines as replica sets are to pods. If you need more machines or must scale them down, you change the *replicas* field on the machine set to meet your compute need.
 
diff --git a/modules/machine-user-provisioned-limitations.adoc b/modules/machine-user-provisioned-limitations.adoc
@@ -1,13 +1,17 @@
 // Module included in the following assemblies:
 //
-// * machine_management/applying_autoscaling.adoc
 // * machine_management/creating-infrastructure-machinesets.adoc
-// * machine_management/creating-machinesets.adoc
+// * machine_management/creating_machinesets/creating-machineset-aws.adoc
+// * machine_management/creating_machinesets/creating-machineset-azure.adoc
+// * machine_management/creating_machinesets/creating-machineset-gcp.adoc
+// * machine_management/creating_machinesets/creating-machineset-osp.adoc
+// * machine_management/creating_machinesets/creating-machineset-rhv.adoc
+// * machine_management/creating_machinesets/creating-machineset-vsphere.adoc
 // * machine_management/deploying-machine-health-checks.adoc
 // * machine_management/manually-scaling-machinesets.adoc
 // * post_installation_configuration/node-tasks.adoc
 
 [IMPORTANT]
 ====
-This process is not applicable to clusters where you manually provisioned the machines yourself. You can use the advanced machine management and scaling capabilities only in clusters where the machine API is operational.
+This process is not applicable for clusters with manually provisioned machines. You can use the advanced machine management and scaling capabilities only in clusters where the Machine API is operational.
 ====
diff --git a/modules/machineset-creating.adoc b/modules/machineset-creating.adoc
@@ -46,7 +46,7 @@ endif::vsphere[]
 +
 Ensure that you set the `<clusterID>` and `<role>` parameter values.
 
-.. If you are not sure about which value to set for a specific field, you can check an existing machine set from your cluster.
+.. If you are not sure which value to set for a specific field, you can check an existing machine set from your cluster:
 +
 [source,terminal]
 ----
diff --git a/modules/machineset-customer-managed-encryption-azure.adoc b/modules/machineset-customer-managed-encryption-azure.adoc
@@ -17,7 +17,7 @@ An Azure Key Vault, a disk encryption set, and an encryption key are required to
 
 .Procedure
 
-. Configure the disk encryption set under the `providerSpec` field in your machine set YAML file. For example:
+* Configure the disk encryption set under the `providerSpec` field in your machine set YAML file. For example:
 +
 [source,yaml]
 ----
diff --git a/modules/machineset-manually-scaling.adoc b/modules/machineset-manually-scaling.adoc
@@ -7,9 +7,9 @@
 [id="machineset-manually-scaling_{context}"]
 = Scaling a machine set manually
 
-If you must add or remove an instance of a machine in a machine set, you can manually scale the machine set.
+To add or remove an instance of a machine in a machine set, you can manually scale the machine set.
 
-This guidance is relevant to fully automated, installer-provisioned infrastructure installations. Customized, user-provisioned infrastructure installations does not have machine sets.
+This guidance is relevant to fully automated, installer-provisioned infrastructure installations. Customized, user-provisioned infrastructure installations do not have machine sets.
 
 .Prerequisites
 
diff --git a/modules/machineset-yaml-azure.adoc b/modules/machineset-yaml-azure.adoc
@@ -75,7 +75,7 @@ ifndef::infra[]
           node-role.kubernetes.io/<role>: "" <2>
 endif::infra[]
 ifdef::infra[]
-          node-role.kubernetes.io/infra: "" <2>      
+          node-role.kubernetes.io/infra: "" <2>
       taints: <4>
       - key: node-role.kubernetes.io/infra
         effect: NoSchedule
@@ -148,13 +148,13 @@ $  oc -n openshift-machine-api \
 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.
+<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.
 <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.
+<5> Specify the zone within your region to place machines on. Be sure that your region supports the zone that you specify.
 endif::infra[]
 
 ifeval::["{context}" == "creating-infrastructure-machinesets"]

Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ endif::vsphere[]`
`46`	`46`	`+`
`47`	`47`	Ensure that you set the `<clusterID>` and `<role>` parameter values.
`48`	`48`
`49`		`-.. If you are not sure about which value to set for a specific field, you can check an existing machine set from your cluster.`
	`49`	`+.. If you are not sure which value to set for a specific field, you can check an existing machine set from your cluster:`
`50`	`50`	`+`
`51`	`51`	`[source,terminal]`
`52`	`52`	`----`