Skip to content

Commit 4785b47

Browse files
committed
BZ1878374 specifying supported instance types
1 parent 4add08e commit 4785b47

12 files changed

+133
-226
lines changed

installing/installing_aws/installing-aws-customizations.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,8 @@ include::modules/installation-initializing.adoc[leveloffset=+1]
5656

5757
include::modules/installation-configuration-parameters.adoc[leveloffset=+2]
5858

59+
include::modules/installation-supported-aws-machine-types.adoc[leveloffset=+2]
60+
5961
include::modules/installation-aws-config-yaml.adoc[leveloffset=+2]
6062

6163
// Removing; Proxy not supported for AWS IPI for 4.2

installing/installing_aws/installing-aws-government-region.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
5656

5757
include::modules/installation-initializing-manual.adoc[leveloffset=+1]
5858
include::modules/installation-configuration-parameters.adoc[leveloffset=+2]
59+
include::modules/installation-supported-aws-machine-types.adoc[leveloffset=+2]
5960
include::modules/installation-aws-config-yaml.adoc[leveloffset=+2]
6061
include::modules/installation-aws-regions-with-no-ami.adoc[leveloffset=+2]
6162
include::modules/installation-aws-upload-custom-rhcos-ami.adoc[leveloffset=+2]

installing/installing_aws/installing-aws-network-customizations.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,8 @@ include::modules/installation-initializing.adoc[leveloffset=+1]
6060

6161
include::modules/installation-configuration-parameters.adoc[leveloffset=+2]
6262

63+
include::modules/installation-supported-aws-machine-types.adoc[leveloffset=+2]
64+
6365
include::modules/installation-aws-config-yaml.adoc[leveloffset=+2]
6466

6567
// Removing; Proxy not supported for AWS IPI for 4.2

installing/installing_aws/installing-aws-private.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ include::modules/installation-initializing-manual.adoc[leveloffset=+1]
5555

5656
include::modules/installation-configuration-parameters.adoc[leveloffset=+2]
5757

58+
include::modules/installation-supported-aws-machine-types.adoc[leveloffset=+2]
59+
5860
include::modules/installation-aws-config-yaml.adoc[leveloffset=+2]
5961

6062
include::modules/installation-configure-proxy.adoc[leveloffset=+2]

installing/installing_aws/installing-aws-user-infra.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@ include::modules/cluster-entitlements.adoc[leveloffset=+1]
4545

4646
include::modules/installation-aws-user-infra-requirements.adoc[leveloffset=+1]
4747

48+
include::modules/installation-supported-aws-machine-types.adoc[leveloffset=+2]
49+
4850
include::modules/installation-aws-permissions.adoc[leveloffset=+2]
4951

5052
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]

installing/installing_aws/installing-aws-vpc.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,8 @@ include::modules/installation-initializing.adoc[leveloffset=+1]
5151

5252
include::modules/installation-configuration-parameters.adoc[leveloffset=+2]
5353

54+
include::modules/installation-supported-aws-machine-types.adoc[leveloffset=+2]
55+
5456
include::modules/installation-aws-config-yaml.adoc[leveloffset=+2]
5557

5658
include::modules/installation-configure-proxy.adoc[leveloffset=+2]

installing/installing_aws/installing-restricted-networks-aws.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,8 @@ include::modules/cluster-entitlements.adoc[leveloffset=+1]
6666

6767
include::modules/installation-aws-user-infra-requirements.adoc[leveloffset=+1]
6868

69+
include::modules/installation-supported-aws-machine-types.adoc[leveloffset=+2]
70+
6971
include::modules/installation-aws-permissions.adoc[leveloffset=+2]
7072

7173
//You extract the installation program from the mirrored content.

modules/installation-aws-user-infra-requirements.adoc

Lines changed: 18 additions & 166 deletions
Original file line numberDiff line numberDiff line change
@@ -21,172 +21,6 @@ By using the provided CloudFormation templates, you can create stacks of AWS res
2121

2222
Alternatively, you can manually create the components or you can reuse existing infrastructure that meets the cluster requirements. Review the CloudFormation templates for more details about how the components interrelate.
2323

24-
[id="installation-aws-user-infra-cluster-machines_{context}"]
25-
== Cluster machines
26-
27-
You need `AWS::EC2::Instance` objects for the following machines:
28-
29-
* A bootstrap machine. This machine is required during installation, but you can remove it after your cluster deploys.
30-
* Three control plane machines. The control plane machines are not governed by a machine set.
31-
* Compute machines. You must create at least two compute machines, which are also known as worker machines, during installation. These machines are not governed by a machine set.
32-
33-
////
34-
You can also create and control them by using a MachineSet after your
35-
control plane initializes and you can access the cluster API by using the `oc`
36-
command line interface.
37-
////
38-
39-
You can use the following instance types for the cluster machines with the provided CloudFormation templates.
40-
41-
42-
[IMPORTANT]
43-
====
44-
If `m4` instance types are not available in your region, such as with `eu-west-3`, use `m5` types instead.
45-
====
46-
47-
.Instance types for machines
48-
[cols="2a,2a,2a,2a",options="header"]
49-
|===
50-
51-
|Instance type
52-
|Bootstrap
53-
|Control plane
54-
|Compute
55-
56-
|`i3.large`
57-
|x
58-
|
59-
|
60-
61-
| `m4.large`
62-
|
63-
|
64-
|x
65-
66-
| `m4.xlarge`
67-
|
68-
|x
69-
|x
70-
71-
| `m4.2xlarge`
72-
|
73-
|x
74-
|x
75-
76-
| `m4.4xlarge`
77-
|
78-
|x
79-
|x
80-
81-
| `m4.8xlarge`
82-
|
83-
|x
84-
|x
85-
86-
| `m4.10xlarge`
87-
|
88-
|x
89-
|x
90-
91-
| `m4.16xlarge`
92-
|
93-
|x
94-
|x
95-
96-
| `m5.large`
97-
|
98-
|
99-
|x
100-
101-
| `m5.xlarge`
102-
|
103-
|x
104-
|x
105-
106-
| `m5.2xlarge`
107-
|
108-
|x
109-
|x
110-
111-
| `m5.4xlarge`
112-
|
113-
|x
114-
|x
115-
116-
| `m5.8xlarge`
117-
|
118-
|x
119-
|x
120-
121-
| `m5.10xlarge`
122-
|
123-
|x
124-
|x
125-
126-
| `m5.16xlarge`
127-
|
128-
|x
129-
|x
130-
131-
| `c4.large`
132-
|
133-
|
134-
|x
135-
136-
| `c4.xlarge`
137-
|
138-
|
139-
|x
140-
141-
| `c4.2xlarge`
142-
|
143-
|x
144-
|x
145-
146-
| `c4.4xlarge`
147-
|
148-
|x
149-
|x
150-
151-
| `c4.8xlarge`
152-
|
153-
|x
154-
|x
155-
156-
| `r4.large`
157-
|
158-
|
159-
|x
160-
161-
| `r4.xlarge`
162-
|
163-
|x
164-
|x
165-
166-
| `r4.2xlarge`
167-
|
168-
|x
169-
|x
170-
171-
| `r4.4xlarge`
172-
|
173-
|x
174-
|x
175-
176-
| `r4.8xlarge`
177-
|
178-
|x
179-
|x
180-
181-
| `r4.16xlarge`
182-
|
183-
|x
184-
|x
185-
186-
|===
187-
188-
You might be able to use other instance types that meet the specifications of these instance types.
189-
19024
[id="csr-management-aws_{context}"]
19125
== Certificate signing requests management
19226

@@ -589,3 +423,21 @@ or the following individual permissions.
589423
|`*`
590424

591425
|===
426+
427+
[id="installation-aws-user-infra-cluster-machines_{context}"]
428+
== Cluster machines
429+
430+
You need `AWS::EC2::Instance` objects for the following machines:
431+
432+
* A bootstrap machine. This machine is required during installation, but you
433+
can remove it after your cluster deploys.
434+
* At least three control plane machines. The control plane machines are not
435+
governed by a MachineSet.
436+
* Compute machines. You must create at least two compute machines, which are also known as worker machines,
437+
during installation. These machines are not governed by a MachineSet.
438+
439+
////
440+
You can also create and control them by using a MachineSet after your
441+
control plane initializes and you can access the cluster API by using the `oc`
442+
command line interface.
443+
////

modules/installation-configuration-parameters.adoc

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ The string must be 14 characters or fewer long.
169169
endif::osp[]
170170

171171
|`platform`
172-
|The configuration for the specific platform upon which to perform the installation: `aws`, `baremetal`, `azure`, `openstack`, `ovirt`, `vsphere`. For additional information about `platform.<platform>` parameters, consult the following table for your specific platform.
172+
|The configuration for the specific platform upon which to perform the installation: `aws`, `baremetal`, `azure`, `openstack`, `ovirt`, `vsphere`. For additional information about `platform.<platform>` parameters, consult the table for your specific platform that follows.
173173
|Object
174174

175175
ifndef::openshift-origin[]
@@ -206,7 +206,7 @@ endif::[]
206206

207207
|`compute`
208208
|The configuration for the machines that comprise the compute nodes.
209-
|Array of machine-pool objects. For details, see the following "Machine-pool" table.
209+
|Array of `MachinePool` objects. For details, see the following "Machine-pool" table.
210210

211211
|`compute.architecture`
212212
|Determines the instruction set architecture of the machines in the pool. Currently, heteregeneous clusters are not supported, so all pools must specify the same architecture. Valid values are `amd64` (the default).
@@ -420,7 +420,8 @@ such as `io1`.
420420

421421
|`compute.platform.aws.type`
422422
|The EC2 instance type for the compute machines.
423-
|Valid link:https://aws.amazon.com/ec2/instance-types/[AWS instance type], such as `c5.9xlarge`.
423+
|Valid AWS instance type, such as `m4.2xlarge`. See the *Instance types for machines* table that follows.
424+
//add an xref when possible.
424425

425426
|`compute.platform.aws.zones`
426427
|The availability zones where the installation program creates machines for the compute machine pool. If you provide your own VPC, you must provide a subnet in that availability zone.
@@ -441,7 +442,8 @@ link:https://yaml.org/spec/1.2/spec.html#sequence//[YAML sequence].
441442

442443
|`controlPlane.platform.aws.type`
443444
|The EC2 instance type for the control plane machines.
444-
|Valid link:https://aws.amazon.com/ec2/instance-types/[AWS instance type], such as `c5.9xlarge`.
445+
|Valid AWS instance type, such as `m5.xlarge`. See the *Instance types for machines* table that follows.
446+
//add an xref when possible
445447

446448
|`controlPlane.platform.aws.zones`
447449
|The availability zones where the installation program creates machines for the

modules/installation-creating-aws-control-plane.adoc

Lines changed: 6 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ requires:
9191
},
9292
{
9393
"ParameterKey": "MasterInstanceType", <21>
94-
"ParameterValue": "m4.xlarge" <22>
94+
"ParameterValue": "m5.xlarge" <22>
9595
},
9696
{
9797
"ParameterKey": "AutoRegisterELB", <23>
@@ -150,32 +150,12 @@ directory. This value is the long string with the format
150150
the CloudFormation template for the security group and roles.
151151
<21> The type of AWS instance to use for the control plane machines.
152152
<22> Allowed values:
153-
* `m4.xlarge`
154-
* `m4.2xlarge`
155-
* `m4.4xlarge`
156-
* `m4.8xlarge`
157-
* `m4.10xlarge`
158-
* `m4.16xlarge`
159-
* `m5.xlarge`
160-
* `m5.2xlarge`
161-
* `m5.4xlarge`
162-
* `m5.8xlarge`
163-
* `m5.10xlarge`
164-
* `m5.16xlarge`
165-
* `c4.2xlarge`
153+
* `m5a.xlarge`
154+
* `c5a.2xlarge`
155+
* `r5.xlarge`
156+
* `r5a.xlarge`
166157
* `c4.4xlarge`
167-
* `c4.8xlarge`
168-
* `r4.xlarge`
169-
* `r4.2xlarge`
170-
* `r4.4xlarge`
171-
* `r4.8xlarge`
172-
* `r4.16xlarge`
173-
+
174-
[IMPORTANT]
175-
====
176-
If `m4` instance types are not available in your region, such as with
177-
`eu-west-3`, specify an `m5` type, such as `m5.xlarge`, instead.
178-
====
158+
* `m5.xlarge`
179159
<23> Whether or not to register a network load balancer (NLB).
180160
<24> Specify `yes` or `no`. If you specify `yes`, you must provide a Lambda
181161
Amazon Resource Name (ARN) value.

0 commit comments

Comments
 (0)