Merge pull request openshift#41036 from kelbrown20/OSDOCS-3178-update-aws-optional-parameters

michaelryanpeter · web-flow · commit 8679f61b4675 · 2022-02-10T16:48:36.000-05:00
OSDOCS-3178: Updating AWS optional parameters and new arm64 AMI ID chart
diff --git a/modules/installation-aws-ami-stream-metadata.adoc b/modules/installation-aws-ami-stream-metadata.adoc
@@ -26,7 +26,7 @@ To parse the stream metadata, use one of the following methods:
 
 * From a command-line utility that handles JSON data, such as `jq`:
 
-** Print the current `x86_64` AMI for an AWS region, such as `us-west-1`:
+** Print the current `x86_64` or `arm64` AMI for an AWS region, such as `us-west-1`:
 +
 [source,terminal]
 ----
@@ -39,4 +39,4 @@ $ openshift-install coreos print-stream-json | jq -r '.architectures.x86_64.imag
 ami-0d3e625f84626bbda
 ----
 +
-The output of this command is the AWS AMI ID for the `us-west-1` region. The AMI must belong to the same region as the cluster.
+The output of this command is the AWS AMI ID for your designated architecture and the `us-west-1` region. The AMI must belong to the same region as the cluster.
diff --git a/modules/installation-aws-user-infra-rhcos-ami.adoc b/modules/installation-aws-user-infra-rhcos-ami.adoc
@@ -6,15 +6,15 @@
 [id="installation-aws-user-infra-rhcos-ami_{context}"]
 = {op-system} AMIs for the AWS infrastructure
 
-Red Hat provides {op-system-first} AMIs that are valid for the various AWS regions that you can manually specify for your {product-title} nodes.
+Red Hat provides {op-system-first} AMIs that are valid for the various AWS regions and instance architectures that you can manually specify for your {product-title} nodes.
 
 [NOTE]
 ====
 By importing your own AMI, you can also install to regions that do not have a published {op-system} AMI.
 ====
 
 ifndef::openshift-origin[]
-.{op-system} AMIs
+.x86_64 {op-system} AMIs
 
 [cols="2a,2a",options="header"]
 |===
@@ -85,5 +85,72 @@ ifndef::openshift-origin[]
 |`us-west-2`
 |`ami-084fb1316cd1ed4cc`
 
+|===
+
+.arm64 {op-system} AMIs
+
+[cols="2a,2a",options="header"]
+|===
+
+|AWS zone
+|AWS AMI
+
+|`ap-east`
+|`ami-0f8195c36da4edbd7`
+
+|`ap-northeast-1`
+|`ami-000a86fa0a0b76144`
+
+|`ap-northeast-2`
+|`ami-0f772f5dc2347a954`
+
+|`ap-south-1`
+|`ami-02ab23e25b8e8af97`
+
+|`ap-southeast-1`
+|`ami-085ae5a7dcbfb056d`
+
+|`ap-southeast-2`
+|`ami-085ff9f4e8d4d66e0`
+
+|`ca-central-1`
+|`ami-0050cdf32f76ba82c`
+
+|`eu-central-1`
+|`ami-092527fcf7c21fe42`
+
+|`eu-north-1`
+|`ami-07d673450675ea033`
+
+|`eu-south-1`
+|`ami-0f165ac29cc9d27bf`
+
+|`eu-west-1`
+|`ami-0e0cd7d2eb949538d`
+
+|`eu-west-2`
+|`ami-0790ba70a444fe74d`
+
+|`eu-west-3`
+|`ami-0d16af5bd22cc5227`
+
+|`me-south-1`
+|`ami-05e1ba911ce321052`
+
+|`sa-east-1`
+|`ami-04b124534c7f05cd2`
+
+|`us-east-1`
+|`ami-09bbec91849ca85bc`
+
+|`us-east-2`
+|`ami-048ac599f7315a0bc`
+
+|`us-west-1`
+|`ami-0af1d3b7fa5be2131`
+
+|`us-west-2`
+|`ami-0bd3bf54ee678e2a6`
+
 |===
 endif::openshift-origin[]
diff --git a/modules/installation-configuration-parameters.adoc b/modules/installation-configuration-parameters.adoc
@@ -457,7 +457,7 @@ Optional installation configuration parameters are described in the following ta
 
 |`cgroupsV2`
 |Enables link:https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html[Linux control groups version 2] (cgroups v2) on specific nodes in your cluster. The {product-title} process for enabling cgroups v2 disables all cgroup version 1 controllers and hierarchies. The {product-title} cgroups version 2 feature is in Developer Preview and is not supported by Red Hat at this time.
-|`true` 
+|`true`
 
 |`compute`
 |The configuration for the machines that comprise the compute nodes.
@@ -468,7 +468,7 @@ endif::rhv[]
 
 ifndef::ibm-z,ibm-power[]
 |`compute.architecture`
-|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).
+|Determines the instruction set architecture of the machines in the pool. Currently, clusters with varied architectures are not supported. All pools must specify the same architecture. Valid values are `amd64` and `arm64`. See _Supported installation methods for different platforms_ in _Installing_ documentation for information about instance availability.
 |String
 endif::ibm-z,ibm-power[]
 
@@ -514,7 +514,7 @@ endif::rhv[]
 
 ifndef::ibm-z,ibm-power[]
 |`controlPlane.architecture`
-|Determines the instruction set architecture of the machines in the pool. Currently, heterogeneous clusters are not supported, so all pools must specify the same architecture. Valid values are `amd64` (the default).
+|Determines the instruction set architecture of the machines in the pool. Currently, clusters with varied architectures are not supported. All pools must specify the same architecture. Valid values are `amd64` and `arm64`. See _Supported installation methods for different platforms_ in _Installing_ documentation for information about instance availability.
 |String
 endif::ibm-z,ibm-power[]
 
@@ -624,7 +624,7 @@ Optional AWS configuration parameters are described in the following table:
 
 |`compute.platform.aws.amiID`
 |The AWS AMI used to boot compute machines for the cluster. This is required for regions that require a custom {op-system} AMI.
-|Any published or custom {op-system} AMI that belongs to the set AWS region.
+|Any published or custom {op-system} AMI that belongs to the set AWS region. See _RHCOS AMIs for AWS infrastructure_ for available AMI IDs.
 
 |`compute.platform.aws.iamRole`
 |A pre-existing AWS IAM role applied to the compute machine pool instance profiles. You can use these fields to match naming schemes and include predefined permissions boundaries for your IAM roles. If undefined, the installation program creates a new IAM role.
@@ -645,7 +645,7 @@ such as `io1`.
 
 |`compute.platform.aws.type`
 |The EC2 instance type for the compute machines.
-|Valid AWS instance type, such as `m4.2xlarge`. See the *Instance types for machines* table that follows.
+|Valid AWS instance type, such as `m4.2xlarge`. See the *Supported AWS machine types* table that follows.
 //add an xref when possible.
 
 |`compute.platform.aws.zones`
@@ -656,18 +656,23 @@ link:https://yaml.org/spec/1.2/spec.html#sequence//[YAML sequence].
 |`compute.aws.region`
 |The AWS region that the installation program creates compute resources in.
 |Any valid link:https://docs.aws.amazon.com/general/latest/gr/rande.html[AWS region], such as `us-east-1`.
+[IMPORTANT]
+====
+When running on ARM based AWS A1 instances, ensure that you enter a region where AWS Graviton processors are available. See link:https://aws.amazon.com/ec2/graviton/#Global_availability[Global availability] map in the AWS documentation.
+====
+
 
 |`controlPlane.platform.aws.amiID`
 |The AWS AMI used to boot control plane machines for the cluster.  This is required for regions that require a custom {op-system} AMI.
-|Any published or custom {op-system} AMI that belongs to the set AWS region.
+|Any published or custom {op-system} AMI that belongs to the set AWS region. See _RHCOS AMIs for AWS infrastructure_ for available AMI IDs.
 
 |`controlPlane.platform.aws.iamRole`
 |A pre-existing AWS IAM role applied to the control plane machine pool instance profiles. You can use these fields to match naming schemes and include predefined permissions boundaries for your IAM roles. If undefined, the installation program creates a new IAM role.
 |The name of a valid AWS IAM role.
 
 |`controlPlane.platform.aws.type`
 |The EC2 instance type for the control plane machines.
-|Valid AWS instance type, such as `m5.xlarge`. See the *Instance types for machines* table that follows.
+|Valid AWS instance type, such as `m5.xlarge`. See the *Supported AWS machine types* table that follows.
 //add an xref when possible
 
 |`controlPlane.platform.aws.zones`
@@ -682,7 +687,7 @@ control plane machine pool.
 |`platform.aws.amiID`
 |The AWS AMI used to boot all machines for the cluster. If set, the AMI must
 belong to the same region as the cluster. This is required for regions that require a custom {op-system} AMI.
-|Any published or custom {op-system} AMI that belongs to the set AWS region.
+|Any published or custom {op-system} AMI that belongs to the set AWS region. See _RHCOS AMIs for AWS infrastructure_ for available AMI IDs.
 
 |`platform.aws.hostedZone`
 |An existing Route 53 private hosted zone for the cluster. You can only use a pre-existing hosted zone when also supplying your own VPC. The hosted zone must already be associated with the user-provided VPC before installation. Also, the domain of the hosted zone must be the cluster domain or a parent of the cluster domain. If undefined, the installation program creates a new hosted zone.

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ To parse the stream metadata, use one of the following methods:`
`26`	`26`
`27`	`27`	* From a command-line utility that handles JSON data, such as `jq`:
`28`	`28`
`29`		-** Print the current `x86_64` AMI for an AWS region, such as `us-west-1`:
	`29`	+** Print the current `x86_64` or `arm64` AMI for an AWS region, such as `us-west-1`:
`30`	`30`	`+`
`31`	`31`	`[source,terminal]`
`32`	`32`	`----`
`@@ -39,4 +39,4 @@ $ openshift-install coreos print-stream-json \| jq -r '.architectures.x86_64.imag`
`39`	`39`	`ami-0d3e625f84626bbda`
`40`	`40`	`----`
`41`	`41`	`+`
`42`		-The output of this command is the AWS AMI ID for the `us-west-1` region. The AMI must belong to the same region as the cluster.
	`42`	+The output of this command is the AWS AMI ID for your designated architecture and the `us-west-1` region. The AMI must belong to the same region as the cluster.