Skip to content

Commit

Permalink
OSDOCS-7061: Documented the AWS Wavelenght zone feature
Browse files Browse the repository at this point in the history
  • Loading branch information
dfitzmau committed Dec 20, 2023
1 parent cc83582 commit 52bcc85
Show file tree
Hide file tree
Showing 8 changed files with 436 additions and 168 deletions.
8 changes: 5 additions & 3 deletions _topic_maps/_topic_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 worker nodes on AWS Local Zones
File: installing-aws-localzone
- Name: Installing a cluster on AWS with worker 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
Expand Down Expand Up @@ -589,7 +591,7 @@ Topics:
- Name: Fedora CoreOS (FCOS) image layering
File: coreos-layering
Distros: openshift-origin
- Name: AWS Local Zone tasks
- Name: AWS Local Zone and Wavelength Zone tasks
File: aws-compute-edge-tasks
Distros: openshift-enterprise
---
Expand Down
71 changes: 21 additions & 50 deletions installing/installing_aws/installing-aws-localzone.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
= Installing a cluster on AWS with worker nodes on AWS Local Zones
include::_attributes/common-attributes.adoc[]
:context: installing-aws-localzone
:zone-type: Local Zones

toc::[]

Expand All @@ -15,54 +16,34 @@ AWS Local Zones are a type of infrastructure that place Cloud Resources close to
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.
====

== Prerequisites
// Prerequisites
include::modules/aws-zones-prerequisites.adoc[leveloffset=+1]

* You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
* You read the documentation on 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.
+
[IMPORTANT]
====
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 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/[Features] for each AWS Local Zones location.
* 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 requires access to.
+
[NOTE]
====
Be sure to also review this site list if you are configuring a proxy.
====
* Add permission for the user who creates the cluster to modify the Local Zone group with `ec2:ModifyAvailabilityZoneGroup`. For example:
+
.An example of a permissive IAM policy to attach to a user or role
[source,yaml]
----
{
"Version": "2012-10-17",
"Statement": [
{
"Action": [
"ec2:ModifyAvailabilityZoneGroup"
],
"Effect": "Allow",
"Resource": "*"
}
]
}
----

// Cluster limitations in AWS Local Zones
include::modules/cluster-limitations-local-zone.adoc[leveloffset=+1]
== About AWS Local Zones and edge compute pool

// Cluster limitations
include::modules/cluster-limitations-aws-zone.adoc[leveloffset=+1]

// Edge compute pools and AWS Local Zones
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[Changing the MTU for the cluster network]
* xref:../../networking/changing-cluster-network-mtu.adoc#nw-ovn-ipsec-enable_configuring-ipsec-ovn[Enabling IPsec encryption]
* 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]









// Internet access for OpenShift Container Platform
include::modules/cluster-entitlements.adoc[leveloffset=+1]

Expand Down Expand Up @@ -100,16 +81,6 @@ include::modules/installation-aws-tested-machine-types.adoc[leveloffset=+2]
include::modules/installation-generate-aws-user-infra-install-config.adoc[leveloffset=+2]
// Suggest to standarize edge-pool's specific files with same prefixes, like: machine-edge-pool-[...] or compute-edge-pool-[...] (which is more compatible with install-config.yaml/compute)

// Edge compute pools and AWS Local Zones
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[Changing the MTU for the cluster network]
* xref:../../networking/changing-cluster-network-mtu.adoc#nw-ovn-ipsec-enable_configuring-ipsec-ovn[Enabling IPsec encryption]
* xref:../../nodes/scheduling/nodes-scheduler-taints-tolerations.adoc#nodes-scheduler-taints-tolerations-about_nodes-scheduler-taints-tolerations[Understanding taints and tolerations]

////
// Revisit the need for the link to this section based on testing outcome of 4.15 Wavelenght Zone testing work that also assesses Manual STS, Manual long-term, and Mint routes.
//Supertask: Configuring an AWS cluster to use short-term credentials
Expand Down
Loading

0 comments on commit 52bcc85

Please sign in to comment.