Merge pull request #69537 from dfitzmau/OSDOCS-7061

OSDOCS-7061: Documented the AWS Wavelength zone feature

Author: mjpytlak

_topic_maps/_topic_map.yml

@@ -179,10 +179,12 @@ Topics:
     File: installing-aws-china
   - Name: Installing a cluster on AWS using CloudFormation templates
     File: installing-aws-user-infra
-  - Name: Installing a cluster on AWS with worker nodes on AWS Local Zones
-    File: installing-aws-localzone
   - Name: Installing a cluster on AWS in a restricted network with user-provisioned infrastructure
     File: installing-restricted-networks-aws
+  - Name: Installing a cluster on AWS with compute nodes on AWS Local Zones
+    File: installing-aws-localzone
+  - Name: Installing a cluster on AWS with compute nodes on AWS Wavelength Zones
+    File: installing-aws-wavelength-zone
   - Name: Installing a cluster on AWS with remote workers on AWS Outposts
     File: installing-aws-outposts-remote-workers
   - Name: Installing a three-node cluster on AWS
@@ -617,8 +619,8 @@ Topics:
 - Name: Fedora CoreOS (FCOS) image layering
   File: coreos-layering
   Distros: openshift-origin
-- Name: AWS Local Zone tasks
-  File: aws-compute-edge-tasks
+- Name: AWS Local Zone or Wavelength Zone tasks
+  File: aws-compute-edge-zone-tasks
   Distros: openshift-enterprise
 - Name: Adding failure domains to an existing Nutanix cluster
   File: adding-nutanix-failure-domains

installing/installing_aws/installing-aws-localzone.adoc

@@ -0,0 +1,210 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="installing-aws-wavelength-zone"]
+= Installing a cluster on AWS with compute nodes on AWS Wavelength Zones
+include::_attributes/common-attributes.adoc[]
+:context: installing-aws-wavelength-zone
+:zone-type: Wavelength Zones
+
+toc::[]
+
+You can quickly install an {product-title} cluster on Amazon Web Services (AWS) {zone-type} by setting the zone names in the edge compute pool of the `install-config.yaml` file, or install a cluster in an existing Amazon Virtual Private Cloud (VPC) with Wavelength Zone subnets.
+
+AWS {zone-type} is an infrastructure that AWS configured for mobile edge computing (MEC) applications. 
+
+A Wavelength Zone embeds AWS compute and storage services within the 5G network of a communication service provider (CSP). By placing application servers in a Wavelength Zone, the application traffic from your 5G devices can stay in the 5G network. The application traffic of the device reaches the target server directly, making latency a non-issue. 
+
+[role="_additional-resources"]
+.Additional resources
+
+* See link:https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-wavelength-zones[Wavelength Zones] in the AWS documentation.
+
+// Infrastructure prerequisites
+include::modules/aws-zones-prerequisites.adoc[leveloffset=+1]
+
+[id="about-aws-wavelength-zone-edge-compute-pool_{context}"]
+== About AWS Wavelength Zones and edge compute pool
+
+Read the following sections to understand infrastructure behaviors and cluster limitations in an AWS {zone-type} environment.
+
+// Cluster limitations
+include::modules/cluster-limitations-aws-zone.adoc[leveloffset=+2]
+
+// About edge compute pools
+include::modules/edge-machine-pools-aws-local-zones.adoc[leveloffset=+2]
+
+[role="_additional-resources"]
+.Additional resources
+
+* xref:../../networking/changing-cluster-network-mtu.adoc#mtu-value-selection_changing-cluster-network-mtu[MTU value selection]
+* xref:../../networking/changing-cluster-network-mtu.adoc#nw-ovn-ipsec-enable_configuring-ipsec-ovn[Changing the MTU for the cluster network]
+* xref:../../nodes/scheduling/nodes-scheduler-taints-tolerations.adoc#nodes-scheduler-taints-tolerations-about_nodes-scheduler-taints-tolerations[Understanding taints and tolerations]
+* xref:../../storage/understanding-persistent-storage.adoc#pvc-storage-class_understanding-persistent-storage[Storage classes]
+* xref:../../networking/ingress-sharding.html#nw-ingress-sharding_ingress-sharding[Ingress Controller sharding]
+
+[id="installation-prereqs-aws-wavelength-zone_{context}"]
+== Installation prerequisites
+
+Before you install a cluster in an AWS {zone-type} environment, you must configure your infrastructure so that it can adopt Wavelength Zone capabilities. 
+
+// Opting in to AWS Zones
+include::modules/installation-aws-add-zone-locations.adoc[leveloffset=+2]
+
+// Internet access for OpenShift Container Platform
+include::modules/cluster-entitlements.adoc[leveloffset=+2]
+
+// Obtaining an AWS Marketplace image
+include::modules/installation-aws-marketplace-subscribe.adoc[leveloffset=+2]
+
+//Installing the OpenShift CLI by downloading the binary
+include::modules/cli-installing-cli.adoc[leveloffset=+2]
+
+// Obtaining the installation program
+include::modules/installation-obtaining-installer.adoc[leveloffset=+2]
+
+// Generating a key pair for cluster node SSH access
+include::modules/ssh-agent-using.adoc[leveloffset=+2]
+
+[id="prep-installation-aws-wavelength-zone_{context}"]
+== Preparing for the installation
+
+Before you extend nodes to {zone-type}, you must prepare certain resources for the cluster installation environment.
+
+// Minimum resource requirements for cluster installation
+include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2]
+
+// Tested instance types for AWS
+include::modules/installation-aws-tested-machine-types.adoc[leveloffset=+2]
+
+[role="_additional-resources"]
+.Additional resources
+
+* See link:https://aws.amazon.com/wavelength/features/[AWS Wavelength features] in the AWS documentation.
+
+// Creating the installation files for AWS
+//include::modules/installation-user-infra-generate.adoc[leveloffset=+2] - Check with Marco if it is needed.
+
+// Creating the installation configuration file
+include::modules/installation-generate-aws-user-infra-install-config.adoc[leveloffset=+2]
+
+// Examples of installation configuration files with edge compute pools
+include::modules/installation-aws-edge-compute-pools-examples.adoc[leveloffset=+2]
+
+// Cluster installation options for an AWS Wavelength Zone environment
+include::modules/aws-cluster-installation-options-aws-lzs.adoc[leveloffset=+1]
+
+.Next steps
+
+Choose one of the following options to install an {product-title} cluster in an AWS {zone-type} environment:
+
+* xref:../../installing/installing_aws/installing-aws-wavelength-zone.adoc#installation-cluster-quickly-extend-compute-nodes_installing-aws-wavelength-zone[Installing a cluster quickly in AWS Wavelength Zones]
+* xref:../../installing/installing_aws/installing-aws-wavelength-zone.adoc#install-creating-install-config-aws-edge-zones_installing-aws-wavelength-zone[Modifying an installation configuration file to use AWS Wavelength Zones]
+
+// Installing a cluster quickly in AWS Wavelength Zones
+include::modules/installation-cluster-quickly-extend-compute-nodes.adoc[leveloffset=+1]
+
+// Modifying an installation configuration to use AWS Wavelength Zones
+include::modules/install-creating-install-config-aws-edge-zones.adoc[leveloffset=+2]
+
+[role="_additional-resources"]
+.Additional resources
+
+* xref:../../installing/installing_aws/installing-aws-wavelength-zone.adoc#installation-generate-aws-user-infra-install-config_installing-aws-wavelength-zone[Creating the installation configuration file]
+
+* xref:../../installing/installing_aws/installing-aws-wavelength-zone.adoc#cluster-limitations-aws-zone_installing-aws-wavelength-zone[Cluster limitations in AWS {zone-type}]
+
+.Next steps
+* xref:../../installing/installing_aws/installing-aws-wavelength-zone.adoc#installation-launching-installer_installing-aws-wavelength-zone[Deploying the cluster]
+
+[id="creating-aws-wavelength-zone-environment-existing_{context}"]
+== Installing a cluster in an existing VPC that has Wavelength Zone subnets
+
+You can install a cluster into an existing Amazon Virtual Private Cloud (VPC) on Amazon Web Services (AWS). The installation program provisions the rest of the required infrastructure, which you can further customize. To customize the installation, modify parameters in the `install-config.yaml` file before you install the cluster.
+
+Installing a cluster on AWS into an existing VPC requires extending compute nodes to the edge of the Cloud Infrastructure by using AWS {zone-type}.
+
+You can use a provided CloudFormation template to create network resources. Additionally, you can modify a template to customize your infrastructure or use the information that they contain to create AWS resources according to your company's policies.
+
+[IMPORTANT]
+====
+The steps for performing an installer-provisioned infrastructure installation are provided for example purposes only. Installing a cluster in an existing VPC requires that you have knowledge of the cloud provider and the installation process of {product-title}. You can use a CloudFormation template to assist you with completing these steps or to help model your own cluster installation. Instead of using the CloudFormation template to create resources, you can decide to use other methods for generating these resources.
+====
+
+// Creating a VPC in AWS
+include::modules/installation-creating-aws-vpc-localzone.adoc[leveloffset=+2]
+
+// CloudFormation template for the VPC
+include::modules/installation-cloudformation-vpc-localzone.adoc[leveloffset=+2]
+
+// Creating a VPC Carrier Gateway
+include::modules/installation-creating-aws-vpc-carrier-gw.adoc[leveloffset=+2]
+
+[role="_additional-resources"]
+.Additional resources
+
+* See link:https://aws.amazon.com/s3/[Amazon S3] in the AWS documentation.
+
+// CloudFormation template for the VPC Carrier Gateway
+include::modules/installation-cloudformation-vpc-carrier-gw.adoc[leveloffset=+2]
+
+// Creating subnets in Wavelength Zones
+include::modules/installation-creating-aws-vpc-subnets-wz.adoc[leveloffset=+2]
+
+// CloudFormation template for the subnet that uses AWS Wavelength Zones
+include::modules/installation-cloudformation-subnet-localzone.adoc[leveloffset=+2]
+
+// Modifying an installation configuration file to use AWS Wavelength Zones subnets
+include::modules/installing-aws-edge-zones-custom-vpc-config.adoc[leveloffset=+2]
+
+[role="_additional-resources"]
+.Additional resources
+
+* For more information about viewing the CloudFormation stacks that you created, see link:https://console.aws.amazon.com/cloudformation[AWS CloudFormation console].
+* For more information about AWS profile and credential configuration, see link:https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html[Configuration and credential file settings] in the AWS documentation.
+
+.Next steps
+* xref:../../installing/installing_aws/installing-aws-wavelength-zone.adoc#installation-launching-installer_installing-aws-wavelength-zone[Deploying the cluster]
+
+// Assign public IP to edge compute nodes (optional)
+include::modules/installing-with-edge-node-public.adoc[leveloffset=+1]
+
+//TODO: Put this back if QE validates it: ASK MARCO
+//include::modules/installation-configure-proxy.adoc[leveloffset=+2]
+
+//TODO: Verify removal due to automation. ASK MARCO
+//include::modules/installation-localzone-generate-k8s-manifest.adoc[leveloffset=+2]
+
+// Deploying the cluster
+include::modules/installation-launching-installer.adoc[leveloffset=+1]
+
+[id="verify-aws-wavelength-zone-deployed-cluster-status_{context}"]
+== Verifying the status of the deployed cluster
+
+Verify that your {product-title} successfully deployed on AWS {zone-type}.
+
+// Logging in to the cluster by using the CLI
+include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+2]
+
+// Logging in to the cluster by using the web console
+include::modules/logging-in-by-using-the-web-console.adoc[leveloffset=+2]
+
+[role="_additional-resources"]
+.Additional resources
+
+* For more information about accessing and understanding the {product-title} web console, see xref:../../web_console/web-console.adoc#web-console[Accessing the web console] for more details about accessing and understanding the {product-title} web console.
+
+// Verifying nodes that were created with edge compute pool
+include::modules/machine-edge-pool-review-nodes.adoc[leveloffset=+2]
+
+// Telemetry access for OpenShift Container Platform
+include::modules/cluster-telemetry.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+.Additional resources
+
+* For more information about the Telemetry service, see xref:../../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring].
+
+.Next steps
+
+//* xref:../../post_installation_configuration/aws-compute-edge-zone-tasks#installation-extend-edge-nodes-aws-local-zones_aws-compute-edge-zone-tasks[Creating user workloads in AWS Local Zones or Wavelength Zones]
+* xref:../../installing/validating-an-installation.adoc#validating-an-installation[Validating an installation].
+* If necessary, you can xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health].

installing/installing_aws/installing-aws-wavelength-zone.adoc

@@ -1,13 +1,32 @@
 // Module included in the following assemblies:
 //
-// * installing/installing_aws/installing-aws-localzone.adoc
+// * installing/installing-aws-localzone.adoc (Installing a cluster on AWS with compute nodes on AWS Local Zones)
+// * installing/installing-aws-wavelength.adoc (Installing a cluster on AWS with compute nodes on AWS Wavelength Zones) 
+
+ifeval::["{context}" == "installing-aws-localzone"]
+:local-zone:
+endif::[]
+ifeval::["{context}" == "installing-aws-wavelength-zone"]
+:wavelength-zone:
+endif::[]
 
 :_mod-docs-content-type: CONCEPT
 [id="aws-cluster-installation-options-aws-lzs_{context}"]
+ifdef::local-zone[]
 = Cluster installation options for an AWS Local Zones environment
+endif::local-zone[]
+ifdef::wavelength-zone[]
+= Cluster installation options for an AWS Wavelength Zones environment
+endif::wavelength-zone[]
 
-To install an {product-title} cluster in an AWS Local Zones environment on AWS infrastructure, choose one of the following installation options:
+Choose one of the following installation options to install an {product-title} cluster on AWS with edge compute nodes defined in {zone-type}:
 
-* Installing a cluster to quickly extend workers to edge compute pools, where the installation program automatically creates resources for the {product-title} cluster.
+* Fully automated option: Installing a cluster to quickly extend compute nodes to edge compute pools, where the installation program automatically creates infrastructure resources for the {product-title} cluster.
+* Existing VPC option: Installing a cluster on AWS into an existing VPC, where you supply {zone-type} subnets to the `install-config.yaml` file.
 
-* Installing a cluster on AWS into an existing VPC, where you must add Local Zone subnets to the `install-config.yaml` file.
+ifeval::["{context}" == "installing-aws-localzone"]
+:!local-zone:
+endif::[]
+ifeval::["{context}" == "installing-aws-wavelength-zone"]
+:!wavelength-zone:
+endif::[]

modules/aws-cluster-installation-options-aws-lzs.adoc

@@ -0,0 +1,88 @@
+// 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) 
+
+ifeval::["{context}" == "installing-aws-localzone"]
+:local-zone:
+endif::[]
+ifeval::["{context}" == "installing-aws-wavelength-zone"]
+:wavelength-zone:
+endif::[]
+
+:_mod-docs-content-type: CONCEPT
+[id="aws-zones-prerequisites_{context}"]
+= Infrastructure prerequisites
+
+* You reviewed details about xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
+* You are familiar with xref:../../installing/installing-preparing.adoc#installing-preparing[Selecting a cluster installation method and preparing it for users].
+* You xref:../../installing/installing_aws/installing-aws-account.adoc#installing-aws-account[configured an AWS account] to host the cluster.
++
+[WARNING]
+====
+If you have an AWS profile stored on your computer, it must not use a temporary session token that you generated while using a multi-factor authentication device. The cluster continues to use your current AWS credentials to create AWS resources for the entire life of the cluster, so you must use key-based, long-term credentials. To generate appropriate keys, see link:https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html[Managing Access Keys for IAM Users] in the AWS documentation. You can supply the keys when you run the installation program.
+====
+* You downloaded the AWS CLI and installed it on your computer. See link:https://docs.aws.amazon.com/cli/latest/userguide/install-bundle.html[Install the AWS CLI Using the Bundled Installer (Linux, macOS, or UNIX)] in the AWS documentation.
+* If you use a firewall, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster must access.
+ifdef::local-zone[]
+* You noted the region and supported link:https://aws.amazon.com/about-aws/global-infrastructure/localzones/locations[AWS Local Zones locations] to create the network resources in.
+* You read the link:https://aws.amazon.com/about-aws/global-infrastructure/localzones/features/[AWS Local Zones features] in the AWS documentation.
+* You added permissions for creating network resources that support AWS Local Zones to the Identity and Access Management (IAM) user or role. The following example enables a zone group that can provide a user or role access for creating network network resources that support AWS {zone-type}.
++
+.Example of an additional IAM policy with the `ec2:ModifyAvailabilityZoneGroup` permission attached to an IAM user or role. 
++
+[source,yaml]
+----
+{
+  "Version": "2012-10-17",
+  "Statement": [
+    {
+      "Action": [
+        "ec2:ModifyAvailabilityZoneGroup"
+      ],
+      "Effect": "Allow",
+      "Resource": "*"
+    }
+  ]
+}
+----
+endif::local-zone[]
+ifdef::wavelength-zone[]
+* You noted the region and supported link:https://aws.amazon.com/wavelength/locations[AWS Wavelength Zone locations] to create the network resources in.
+* You read link:https://aws.amazon.com/about-aws/global-infrastructure/localzones/features/[AWS Wavelength features] in the AWS documentation.
+* You read the link:https://docs.aws.amazon.com/wavelength/latest/developerguide/wavelength-quotas.html[Quotas and considerations for Wavelength Zones] in the AWS documentation.
+* You added permissions for creating network resources that support AWS Wavelength Zones to the Identity and Access Management (IAM) user or role. For example:
++
+.Example of an additional IAM policy that attached `ec2:ModifyAvailabilityZoneGroup`, `ec2:CreateCarrierGateway`, and `ec2:DeleteCarrierGateway` permissions to a user or role
++
+[source,yaml]
+----
+{
+  "Version": "2012-10-17",
+  "Statement": [
+    {
+      "Effect": "Allow",
+      "Action": [
+        "ec2:DeleteCarrierGateway",
+        "ec2:CreateCarrierGateway"
+      ],
+      "Resource": "*"
+    },
+    {
+      "Action": [
+        "ec2:ModifyAvailabilityZoneGroup"
+      ],
+      "Effect": "Allow",
+      "Resource": "*"
+    }
+  ]
+}
+----
+endif::wavelength-zone[]
+
+ifeval::["{context}" == "installing-aws-localzone"]
+:!local-zone:
+endif::[]
+ifeval::["{context}" == "installing-aws-wavelength-zone"]
+:!wavelength-zone:
+endif::[]

modules/aws-zones-prerequisites.adoc

@@ -172,7 +172,7 @@ When the new compute machine set is available, the `REPLICAS` and `AVAILABLE` va
 
 .Verification
 
-* To verify that the compute machine set is creating machines according to your desired configuration, you can review the lists of machines and nodes in the cluster.
+* To verify that the compute machine set is creating machines according to your required configuration, review the lists of machines and nodes in the cluster by using the following steps:
 
 ** To view the list of Cluster API machines, run the following command:
 +