Skip to content

Commit aaa756d

Browse files
authored
Merge pull request #28288 from jeana-redhat/terms-form-update-machine-mgmt
API terminology and formatting updates for machine mgmt book
2 parents 313b63d + d6dcfe0 commit aaa756d

File tree

45 files changed

+259
-620
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+259
-620
lines changed

machine_management/applying-autoscaling.adoc

Lines changed: 11 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -5,29 +5,25 @@ include::modules/common-attributes.adoc[]
55

66
toc::[]
77

8-
Applying autoscaling to an {product-title} cluster involves deploying a
9-
ClusterAutoscaler and then deploying MachineAutoscalers for each Machine type
10-
in your cluster.
8+
Applying autoscaling to an {product-title} cluster involves deploying a cluster autoscaler and then deploying machine autoscalers for each Machine type in your cluster.
119

1210
[IMPORTANT]
1311
====
14-
You can configure the ClusterAutoscaler only in clusters where the machine API is operational.
12+
You can configure the cluster autoscaler only in clusters where the machine API is operational.
1513
====
1614

1715
include::modules/cluster-autoscaler-about.adoc[leveloffset=+1]
1816

1917
include::modules/machine-autoscaler-about.adoc[leveloffset=+1]
2018

2119
[id="configuring-clusterautoscaler"]
22-
== Configuring the ClusterAutoscaler
20+
== Configuring the cluster autoscaler
2321

24-
First, deploy the ClusterAutoscaler to manage automatic resource scaling in
25-
your {product-title} cluster.
22+
First, deploy the cluster autoscaler to manage automatic resource scaling in your {product-title} cluster.
2623

2724
[NOTE]
2825
====
29-
Because the ClusterAutoscaler is scoped to the entire cluster, you can make only
30-
one ClusterAutoscaler for the cluster.
26+
Because the cluster autoscaler is scoped to the entire cluster, you can make only one cluster autoscaler for the cluster.
3127
====
3228

3329
include::modules/cluster-autoscaler-cr.adoc[leveloffset=+2]
@@ -37,27 +33,21 @@ include::modules/deploying-resource.adoc[leveloffset=+2]
3733

3834
== Next steps
3935

40-
* After you configure the ClusterAutoscaler, you must configure at least one
41-
MachineAutoscaler.
36+
* After you configure the cluster autoscaler, you must configure at least one machine autoscaler.
4237

4338
[id="configuring-machineautoscaler"]
44-
== Configuring the MachineAutoscalers
39+
== Configuring the machine autoscalers
4540

46-
After you deploy the ClusterAutoscaler,
47-
deploy MachineAutoscaler resources that reference the MachineSets that are used
48-
to scale the cluster.
41+
After you deploy the cluster autoscaler, deploy `MachineAutoscaler` resources that reference the machine sets that are used to scale the cluster.
4942

5043
[IMPORTANT]
5144
====
52-
You must deploy at least one MachineAutoscaler resource after you deploy the
53-
ClusterAutoscaler resource.
45+
You must deploy at least one `MachineAutoscaler` resource after you deploy the `ClusterAutoscaler` resource.
5446
====
5547

5648
[NOTE]
5749
====
58-
You must configure separate resources for each MachineSet. Remember that
59-
MachineSets are different in each region, so consider whether you want to
60-
enable machine scaling in multiple regions. The MachineSet that you scale must have at least one machine in it.
50+
You must configure separate resources for each machine set. Remember that machine sets are different in each region, so consider whether you want to enable machine scaling in multiple regions. The machine set that you scale must have at least one machine in it.
6151
====
6252

6353
include::modules/machine-autoscaler-cr.adoc[leveloffset=+2]
@@ -67,5 +57,4 @@ include::modules/deploying-resource.adoc[leveloffset=+2]
6757

6858
== Additional resources
6959

70-
* For more information about pod priority, see
71-
xref:../nodes/pods/nodes-pods-priority.adoc#nodes-pods-priority[Including pod priority in pod scheduling decisions in {product-title}].
60+
* For more information about pod priority, see xref:../nodes/pods/nodes-pods-priority.adoc#nodes-pods-priority[Including pod priority in pod scheduling decisions in {product-title}].

machine_management/creating-infrastructure-machinesets.adoc

Lines changed: 13 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,40 @@
11
[id="creating-infrastructure-machinesets"]
2-
= Creating infrastructure MachineSets
2+
= Creating infrastructure machine sets
33
include::modules/common-attributes.adoc[]
44
:context: creating-infrastructure-machinesets
55

66
toc::[]
77

8-
You can create a MachineSet to host only infrastructure components.
9-
You apply specific Kubernetes labels to these Machines and then
10-
update the infrastructure components to run on only those Machines. These
11-
infrastructure nodes are not counted toward the total number of subscriptions
12-
that are required to run the environment.
8+
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.
139

1410
[IMPORTANT]
1511
====
16-
Unlike earlier versions of {product-title}, you cannot move the infrastructure
17-
components to the master Machines. To move the components, you must create a
18-
new MachineSet.
12+
Unlike earlier versions of {product-title}, you cannot move the infrastructure components to the master machines. To move the components, you must create a new machine set.
1913
====
2014

2115
include::modules/infrastructure-components.adoc[leveloffset=+1]
2216

2317
[id="creating-infrastructure-machinesets-production"]
24-
== Creating infrastructure MachineSets for production environments
18+
== Creating infrastructure machine sets for production environments
2519

26-
In a production deployment, deploy at least three MachineSets to hold
27-
infrastructure components. Both the logging aggregation solution and
28-
the service mesh deploy Elasticsearch, and Elasticsearch requires three
29-
instances that are installed on different nodes. For high availability, install
30-
deploy these nodes to different availability zones. Since you need different
31-
MachineSets for each availability zone, create at least three MachineSets.
20+
In a production deployment, deploy at least three machine sets to hold infrastructure components. Both the logging aggregation solution and the service mesh deploy Elasticsearch, and Elasticsearch requires three instances that are installed on different nodes. For high availability, deploy these nodes to different availability zones. Since you need different machine sets for each availability zone, create at least three machine sets.
3221

3322
[id="creating-infrastructure-machinesets-clouds"]
34-
=== Creating MachineSets for different clouds
23+
=== Creating machine sets for different clouds
3524

36-
Use the sample MachineSet for your cloud.
25+
Use the sample machine set for your cloud.
3726

3827
include::modules/machineset-yaml-aws.adoc[leveloffset=+3]
3928

40-
MachineSets running on AWS support non-guaranteed xref:../machine_management/creating_machinesets/creating-machineset-aws.adoc#machineset-non-guaranteed-instance_creating-machineset-aws[Spot Instances].
41-
You can save on costs by using Spot Instances at a lower price compared to
42-
On-Demand Instances on AWS. xref:../machine_management/creating_machinesets/creating-machineset-aws.adoc#machineset-creating-non-guaranteed-instance_creating-machineset-aws[Configure Spot Instances]
43-
by adding `spotMarketOptions` to the MachineSet YAML file.
29+
Machine sets running on AWS support non-guaranteed xref:../machine_management/creating_machinesets/creating-machineset-aws.adoc#machineset-non-guaranteed-instance_creating-machineset-aws[Spot Instances]. You can save on costs by using Spot Instances at a lower price compared to On-Demand Instances on AWS. xref:../machine_management/creating_machinesets/creating-machineset-aws.adoc#machineset-creating-non-guaranteed-instance_creating-machineset-aws[Configure Spot Instances] by adding `spotMarketOptions` to the machine set YAML file.
4430

4531
include::modules/machineset-yaml-azure.adoc[leveloffset=+3]
4632

47-
MachineSets running on Azure support non-guaranteed xref:../machine_management/creating_machinesets/creating-machineset-azure.adoc#machineset-non-guaranteed-instance_creating-machineset-azure[Spot VMs].
48-
You can save on costs by using Spot VMs at a lower price compared to
49-
standard VMs on Azure. You can xref:../machine_management/creating_machinesets/creating-machineset-azure.adoc#machineset-creating-non-guaranteed-instance_creating-machineset-azure[configure Spot VMs]
50-
by adding `spotVMOptions` to the MachineSet YAML file.
33+
Machine sets running on Azure support non-guaranteed xref:../machine_management/creating_machinesets/creating-machineset-azure.adoc#machineset-non-guaranteed-instance_creating-machineset-azure[Spot VMs]. You can save on costs by using Spot VMs at a lower price compared to standard VMs on Azure. You can xref:../machine_management/creating_machinesets/creating-machineset-azure.adoc#machineset-creating-non-guaranteed-instance_creating-machineset-azure[configure Spot VMs] by adding `spotVMOptions` to the machine set YAML file.
5134

5235
include::modules/machineset-yaml-gcp.adoc[leveloffset=+3]
5336

54-
MachineSets running on GCP support non-guaranteed xref:../machine_management/creating_machinesets/creating-machineset-gcp.adoc#machineset-non-guaranteed-instance_creating-machineset-gcp[preemptible VM instances].
55-
You can save on costs by using preemptible VM instances at a lower price
56-
compared to normal instances on GCP. You can xref:../machine_management/creating_machinesets/creating-machineset-gcp.adoc#machineset-creating-non-guaranteed-instance_creating-machineset-gcp[configure preemptible VM instances]
57-
by adding `preemptible` to the MachineSet YAML file.
37+
Machine sets running on GCP support non-guaranteed xref:../machine_management/creating_machinesets/creating-machineset-gcp.adoc#machineset-non-guaranteed-instance_creating-machineset-gcp[preemptible VM instances]. You can save on costs by using preemptible VM instances at a lower price compared to normal instances on GCP. You can xref:../machine_management/creating_machinesets/creating-machineset-gcp.adoc#machineset-creating-non-guaranteed-instance_creating-machineset-gcp[configure preemptible VM instances] by adding `preemptible` to the machine set YAML file.
5838

5939
include::modules/machineset-yaml-osp.adoc[leveloffset=+3]
6040

@@ -74,14 +54,12 @@ include::modules/binding-infra-node-workloads-using-taints-tolerations.adoc[leve
7454
.Additional resources
7555

7656
* See xref:../nodes/scheduling/nodes-scheduler-about.adoc#nodes-scheduler-about[Controlling pod placement using the scheduler] for general information on scheduling a pod to a node.
77-
* See xref:moving-resources-to-infrastructure-machinesets[Moving resources to infrastructure machine sets]
78-
for instructions on scheduling pods to infra nodes.
57+
* See xref:moving-resources-to-infrastructure-machinesets[Moving resources to infrastructure machine sets] for instructions on scheduling pods to infra nodes.
7958

8059
[id="moving-resources-to-infrastructure-machinesets"]
81-
== Moving resources to infrastructure MachineSets
60+
== Moving resources to infrastructure machine sets
8261

83-
Some of the infrastructure resources are deployed in your cluster by default.
84-
You can move them to the infrastructure MachineSets that you created.
62+
Some of the infrastructure resources are deployed in your cluster by default. You can move them to the infrastructure machine sets that you created.
8563

8664
include::modules/infrastructure-moving-router.adoc[leveloffset=+2]
8765

machine_management/creating_machinesets/creating-machineset-aws.adoc

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
11
[id="creating-machineset-aws"]
2-
= Creating a MachineSet in AWS
2+
= Creating a machine set in AWS
33
include::modules/common-attributes.adoc[]
44
:context: creating-machineset-aws
55

6-
You can create a different MachineSet to serve a specific purpose in your
7-
{product-title} cluster on Amazon Web Services (AWS). For example, you might
8-
create infrastructure MachineSets and related Machines so that you can move
9-
supporting workloads to the new Machines.
6+
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.
107

118
toc::[]
129

machine_management/creating_machinesets/creating-machineset-azure.adoc

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
11
[id="creating-machineset-azure"]
2-
= Creating a MachineSet in Azure
2+
= Creating a machine set in Azure
33
include::modules/common-attributes.adoc[]
44
:context: creating-machineset-azure
55

6-
You can create a different MachineSet to serve a specific purpose in your
7-
{product-title} cluster on Microsoft Azure. For example, you might
8-
create infrastructure MachineSets and related Machines so that you can move
9-
supporting workloads to the new Machines.
6+
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.
107

118
toc::[]
129

machine_management/creating_machinesets/creating-machineset-gcp.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
[id="creating-machineset-gcp"]
2-
= Creating a MachineSet in GCP
2+
= Creating a machine set in GCP
33
include::modules/common-attributes.adoc[]
44
:context: creating-machineset-gcp
55

6-
You can create a different MachineSet to serve a specific purpose in your
6+
You can create a different machine set to serve a specific purpose in your
77
{product-title} cluster on Google Cloud Platform (GCP). For example, you might
8-
create infrastructure MachineSets and related Machines so that you can move
8+
create infrastructure machine sets and related Machines so that you can move
99
supporting workloads to the new Machines.
1010

1111
toc::[]

machine_management/creating_machinesets/creating-machineset-osp.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
[id="creating-machineset-osp"]
2-
= Creating a MachineSet on OpenStack
2+
= Creating a machine set on OpenStack
33
include::modules/common-attributes.adoc[]
44
:context: creating-machineset-osp
55

6-
You can create a different MachineSet to serve a specific purpose in your
6+
You can create a different machine set to serve a specific purpose in your
77
{product-title} cluster on {rh-openstack-first}. For example, you might
8-
create infrastructure MachineSets and related Machines so that you can move
8+
create infrastructure machine sets and related Machines so that you can move
99
supporting workloads to the new Machines.
1010

1111
toc::[]

machine_management/creating_machinesets/creating-machineset-vsphere.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
[id="creating-machineset-vsphere"]
2-
= Creating a MachineSet on vSphere
2+
= Creating a machine set on vSphere
33
include::modules/common-attributes.adoc[]
44
:context: creating-machineset-vsphere
55

66
toc::[]
77

8-
You can create a different MachineSet to serve a specific purpose in your {product-title} cluster on VMware vSphere. For example, you might create infrastructure MachineSets and related Machines so that you can move supporting workloads to the new Machines.
8+
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.
99

1010
include::modules/machine-api-overview.adoc[leveloffset=+1]
1111

machine_management/deploying-machine-health-checks.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@ include::modules/common-attributes.adoc[]
44
:context: deploying-machine-health-checks
55
toc::[]
66

7-
You can configure and deploy a machine health check to automatically repair
8-
damaged machines in a machine pool.
7+
You can configure and deploy a machine health check to automatically repair damaged machines in a machine pool.
98

109
include::modules/machine-user-provisioned-limitations.adoc[leveloffset=+1]
1110

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
[id="manually-scaling-machineset"]
2-
= Manually scaling a MachineSet
2+
= Manually scaling a machine set
33
include::modules/common-attributes.adoc[]
44
:context: manually-scaling-machineset
55

66
toc::[]
77

8-
You can add or remove an instance of a machine in a MachineSet.
8+
You can add or remove an instance of a machine in a machine set.
99

1010
[NOTE]
1111
====
12-
If you need to modify aspects of a MachineSet outside of scaling,
13-
see xref:../machine_management/modifying-machineset.adoc#modifying-machineset[Modifying a MachineSet].
12+
If you need to modify aspects of a machine set outside of scaling, see xref:../machine_management/modifying-machineset.adoc#modifying-machineset[Modifying a machine set].
1413
====
1514

1615
== Prerequisites
@@ -21,4 +20,4 @@ include::modules/machine-user-provisioned-limitations.adoc[leveloffset=+1]
2120

2221
include::modules/machineset-manually-scaling.adoc[leveloffset=+1]
2322

24-
include::modules/machineset-delete-policy.adoc[leveloffset=+1]
23+
include::modules/machineset-delete-policy.adoc[leveloffset=+1]

machine_management/modifying-machineset.adoc

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,16 @@
11
[id="modifying-machineset"]
2-
= Modifying a MachineSet
2+
= Modifying a machine set
33
include::modules/common-attributes.adoc[]
44
:context: modifying-machineset
55

66
toc::[]
77

88

9-
You can make changes to a MachineSet, such as adding labels, changing the instance type,
10-
or changing block storage.
9+
You can make changes to a machine set, such as adding labels, changing the instance type, or changing block storage.
1110

1211
[NOTE]
1312
====
14-
If you need to scale a MachineSet without making other changes,
15-
see xref:../machine_management/manually-scaling-machineset.adoc#manually-scaling-machineset[Manually scaling a MachineSet].
13+
If you need to scale a machine set without making other changes, see xref:../machine_management/manually-scaling-machineset.adoc#manually-scaling-machineset[Manually scaling a machine set].
1614
====
1715

1816

0 commit comments

Comments
 (0)