1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Files
openshift-docs/modules/installation-aws-add-zone-locations.adoc

97 lines
3.5 KiB
Plaintext

// Module included in the following assemblies:
//
// * installing/installing-aws-localzone.adoc (Installing a cluster on AWS with worker nodes on AWS Local Zones)
// * installing/installing-aws-wavelength-zone.adoc (Installing a cluster on AWS with worker nodes on AWS Wavelength Zones)
// * installing/installing_aws/aws-compute-edge-zone-tasks.adoc
ifeval::["{context}" == "installing-aws-localzone"]
:local-zone:
endif::[]
ifeval::["{context}" == "installing-aws-wavelength-zone"]
:wavelength-zone:
endif::[]
ifeval::["{context}" == "aws-compute-edge-zone-tasks"]
:post-aws-zones:
endif::[]
:_mod-docs-content-type: PROCEDURE
[id="installation-aws-add-zone-locations_{context}"]
ifdef::local-zone[]
= Opting in to an AWS {zone-type}
endif::local-zone[]
ifdef::wavelength-zone[]
= Opting in to an AWS {zone-type}
endif::wavelength-zone[]
ifdef::post-aws-zones[]
= Opting in to AWS Local Zones or Wavelength Zones
endif::post-aws-zones[]
If you plan to create subnets in AWS {zone-type}, you must opt in to each zone group separately.
.Prerequisites
* You have installed the AWS CLI.
* You have determined an AWS Region for where you want to deploy your {product-title} cluster.
* You have attached a permissive IAM policy to a user or role account that opts in to the zone group.
.Procedure
. List the zones that are available in your AWS Region by running the following command:
ifdef::local-zone,post-aws-zones[]
+
.Example command for listing available AWS Local Zones in an AWS Region
[source,terminal]
----
$ aws --region "<value_of_AWS_Region>" ec2 describe-availability-zones \
--query 'AvailabilityZones[].[{ZoneName: ZoneName, GroupName: GroupName, Status: OptInStatus}]' \
--filters Name=zone-type,Values=local-zone \
--all-availability-zones
----
endif::local-zone,post-aws-zones[]
ifdef::wavelength-zone,post-aws-zones[]
+
.Example command for listing available AWS Wavelength Zones in an AWS Region
[source,terminal]
----
$ aws --region "<value_of_AWS_Region>" ec2 describe-availability-zones \
--query 'AvailabilityZones[].[{ZoneName: ZoneName, GroupName: GroupName, Status: OptInStatus}]' \
--filters Name=zone-type,Values=wavelength-zone \
--all-availability-zones
----
endif::wavelength-zone,post-aws-zones[]
+
Depending on the AWS Region, the list of available zones might be long. The command returns the following fields:
+
`ZoneName`:: The name of the {zone-type}.
`GroupName`:: The group that comprises the zone. To opt in to the Region, save the name.
`Status`:: The status of the {zone-type} group. If the status is `not-opted-in`, you must opt in the `GroupName` as described in the next step.
. Opt in to the zone group on your AWS account by running the following command:
+
[source,terminal]
----
$ aws ec2 modify-availability-zone-group \
--group-name "<value_of_GroupName>" \// <1>
--opt-in-status opted-in
----
<1> Replace `<value_of_GroupName>` with the name of the group of the {zone-type} where you want to create subnets.
ifdef::local-zone[]
For example, specify `us-east-1-nyc-1` to use the zone `us-east-1-nyc-1a` (US East New York).
endif::local-zone[]
ifdef::wavelength-zone[]
As an example for Wavelength Zones, specify `us-east-1-wl1` to use the zone `us-east-1-wl1-nyc-wlz-1` (US East New York).
endif::wavelength-zone[]
ifeval::["{context}" == "installing-aws-localzone"]
:!local-zone:
endif::[]
ifeval::["{context}" == "installing-aws-wavelength-zone"]
:!wavelength-zone:
endif::[]
ifeval::["{context}" == "aws-compute-edge-zone-tasks"]
:!post-aws-zones:
endif::[]