You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-supported-features-aws.adoc
= Changing the Amazon Web Services instance type by using a control plane machine set
8
+
= Changing the {aws-full} instance type by using a control plane machine set
16
9
17
10
[role="_abstract"]
18
-
You can change the {aws-first} instance type that your control plane machines use by updating the specification in the control plane machine set custom resource (CR).
19
-
20
-
ifdef::scale-host[]
21
-
** For clusters that use the default `RollingUpdate` update strategy, the Operator automatically propagates the changes to your control plane configuration.
22
-
23
-
** For clusters that are configured to use the `OnDelete` update strategy, you must replace your control plane machines manually.
24
-
endif::scale-host[]
11
+
If you need more resources for your control plane machines, you can change the {aws-first} instance type that they use.
12
+
To change the instance type, you update the instance type value in the control plane machine set custom resource (CR).
25
13
26
14
.Prerequisites
27
15
16
+
* You have access to the {oc-first} as a user with administrator privileges.
17
+
28
18
* Your {aws-short} cluster uses a control plane machine set.
29
19
30
20
.Procedure
31
21
32
-
ifdef::scale-host[]
33
22
. Edit your control plane machine set CR by running the following command:
. Edit the following line under the `providerSpec` field:
29
+
. Update the CR to implement your configuration changes:
42
30
+
43
31
[source,yaml]
44
32
----
45
-
providerSpec:
46
-
value:
47
-
...
48
-
instanceType: <compatible_aws_instance_type>
33
+
apiVersion: machine.openshift.io/v1
34
+
kind: ControlPlaneMachineSet
35
+
# ...
36
+
spec:
37
+
template:
38
+
machines_v1beta1_machine_openshift_io:
39
+
spec:
40
+
providerSpec:
41
+
value:
42
+
instanceType: <compatible_aws_instance_type>
49
43
----
50
-
**`<compatible_aws_instance_type>`: Specifies a larger {aws-short} instance type with the same base as the previous selection. For example, you can change `m6i.xlarge` to `m6i.2xlarge` or `m6i.4xlarge`.
44
+
+
45
+
where `<compatible_aws_instance_type>` specifies a larger {aws-short} instance type with the same base.
46
+
For example, you can change this value from `m6i.xlarge` to `m6i.2xlarge` or `m6i.4xlarge`.
51
47
52
-
. Save your changes.
48
+
. Save your changes and exit the object specification.
49
+
+
50
+
When you save an update to the control plane machine set, the Control Plane Machine Set Operator updates the control plane machines according to your configured update strategy.
** For clusters that use the default `RollingUpdate` update strategy, the Operator automatically propagates the changes to your control plane configuration.
53
+
54
+
** For clusters that are configured to use the `OnDelete` update strategy, you must replace your control plane machines manually.
= Assigning machines to placement groups for Elastic Fabric Adapter instances by using machine sets
13
13
14
-
You can configure a machine set to deploy machines on link:https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html[Elastic Fabric Adapter] (EFA) instances within an existing AWS placement group.
14
+
[role="_abstract"]
15
+
To improve network performance, you can configure a machine set to deploy machines on link:https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html[Elastic Fabric Adapter] (EFA) instances within an AWS placement group.
15
16
16
-
EFA instances do not require placement groups, and you can use placement groups for purposes other than configuring an EFA. This example uses both to demonstrate a configuration that can improve network performance for machines within the specified placement group.
17
+
EFA instances do not require placement groups, and you can use placement groups for purposes other than configuring an EFA.
18
+
This example uses both to demonstrate a configuration that can improve network performance for machines within the specified placement group.
17
19
18
20
.Prerequisites
19
21
22
+
* You have access to the {oc-first} as a user with administrator privileges.
23
+
20
24
* You created a placement group in the AWS console.
21
25
+
22
26
[NOTE]
23
27
====
24
28
Ensure that the link:https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html#limitations-placement-groups[rules and limitations] for the type of placement group that you create are compatible with your intended use case.
25
29
ifdef::cpmso[]
26
-
The control plane machine set spreads the control plane machines across multiple failure domains when possible. To use placement groups for the control plane, you must use a placement group type that can span multiple Availability Zones.
30
+
The control plane machine set spreads the control plane machines across multiple failure domains when possible.
31
+
To use placement groups for the control plane, you must use a placement group type that can span multiple Availability Zones.
27
32
endif::cpmso[]
28
33
====
29
34
30
35
.Procedure
31
36
32
-
. In a text editor, open the YAML file for an existing machine set or create a new one.
33
-
34
-
. Edit the following lines under the `providerSpec` field:
37
+
ifdef::cpmso[]
38
+
. Edit your control plane machine set custom resource (CR) by running the following command:
<1> Specify an instance type that link:https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html#efa-instance-types[supports EFAs].
62
-
<2> Specify the `EFA` network interface type.
63
-
<3> Specify the zone, for example, `us-east-1a`.
64
-
<4> Specify the region, for example, `us-east-1`.
65
-
<5> Specify the name of the existing AWS placement group to deploy machines in.
66
-
<6> Optional: Specify the partition number of the existing AWS placement group to deploy machines in.
90
+
+
91
+
where:
92
+
93
+
`<supported_instance_type>`::
94
+
Specifies an instance type that link:https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html#efa-instance-types[supports EFAs].
95
+
96
+
`<interface_type>`::
97
+
Specifies the network interface type.
98
+
To use an EFA, set this value to `EFA`.
99
+
100
+
`<zone>`::
101
+
Specifies the zone; for example, `us-east-1a`.
102
+
103
+
`<region>`::
104
+
Specifies the region; for example, `us-east-1`.
105
+
106
+
`<placement_group>`::
107
+
Specifies the name of the existing AWS placement group to deploy machines in.
108
+
109
+
`<placement_group_partition_number>`::
110
+
Optional: Specifies the partition number of the existing AWS placement group to deploy machines in.
111
+
112
+
. Save your changes and exit the object specification.
113
+
ifdef::cpmso[]
114
+
+
115
+
When you save an update to the control plane machine set, the Control Plane Machine Set Operator updates the control plane machines according to your configured update strategy.
116
+
117
+
** For clusters that use the default `RollingUpdate` update strategy, the Operator automatically propagates the changes to your control plane configuration.
118
+
119
+
** For clusters that are configured to use the `OnDelete` update strategy, you must replace your control plane machines manually.
120
+
endif::cpmso[]
67
121
68
122
.Verification
69
123
70
124
* In the AWS console, find a machine that the machine set created and verify the following in the machine properties:
71
125
72
126
** The placement group field has the value that you specified for the `placementGroupName` parameter in the machine set.
73
127
74
-
**The partition number field has the value that you specified for the `placementGroupPartition` parameter in the machine set.
128
+
**If you specified a partition number, the partition number field has the value that you specified for the `placementGroupPartition` parameter in the machine set.
75
129
76
130
** The interface type field indicates that it uses an EFA.
0 commit comments