mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
OSDOCS-7061: Documented the AWS Wavelenght zone feature
This commit is contained in:
dfitzmau
committed by
openshift-cherrypick-robot
openshift-cherrypick-robot
parent
43dd1ba910
commit
4d8abbe054
@@ -1,80 +1,55 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="installing-aws-localzone"]
|
||||
= Installing a cluster on AWS with worker nodes on AWS Local Zones
|
||||
= Installing a cluster on AWS with compute nodes on AWS Local Zones
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: installing-aws-localzone
|
||||
:zone-type: Local Zones
|
||||
|
||||
toc::[]
|
||||
|
||||
You can quickly install an {product-title} cluster in Amazon Web Services (AWS) Local Zones by setting the zone names in the edge compute pool of the `install-config.yaml` file, or install a cluster in an existing VPC that lists Local Zone subnets.
|
||||
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 Local Zone subnets.
|
||||
|
||||
AWS Local Zones are a type of infrastructure that place Cloud Resources close to metropolitan regions. For more information, see the link:https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-local-zones[AWS Local Zones Documentation].
|
||||
AWS {zone-type} is an infrastructure that place Cloud Resources close to metropolitan regions. For more information, see the link:https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-local-zones[AWS Local Zones Documentation].
|
||||
|
||||
[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.
|
||||
====
|
||||
// Infrastructure prerequisites
|
||||
include::modules/aws-zones-prerequisites.adoc[leveloffset=+1]
|
||||
|
||||
== Prerequisites
|
||||
[id="installation-about-local-zone-edge-compute-pool_{context}"]
|
||||
== About AWS Local Zones and edge compute pool
|
||||
|
||||
* 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": "*"
|
||||
}
|
||||
]
|
||||
}
|
||||
----
|
||||
Read the following sections to understand infrastructure behaviors and cluster limitations in an AWS {zone-type} environment.
|
||||
|
||||
// Cluster limitations in AWS Local Zones
|
||||
include::modules/cluster-limitations-local-zone.adoc[leveloffset=+1]
|
||||
// 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-local-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 Local Zone capabilities.
|
||||
|
||||
// Opting in to AWS Local Zones
|
||||
include::modules/installation-aws-add-zone-locations.adoc[leveloffset=+2]
|
||||
|
||||
// Internet access for OpenShift Container Platform
|
||||
include::modules/cluster-entitlements.adoc[leveloffset=+1]
|
||||
include::modules/cluster-entitlements.adoc[leveloffset=+2]
|
||||
|
||||
// Obtaining an AWS Marketplace image
|
||||
include::modules/installation-aws-marketplace-subscribe.adoc[leveloffset=+1]
|
||||
include::modules/installation-aws-marketplace-subscribe.adoc[leveloffset=+2]
|
||||
|
||||
//Installing the OpenShift CLI by downloading the binary: Moved up to precede `ccoctl` steps, which require the use of `oc`
|
||||
include::modules/cli-installing-cli.adoc[leveloffset=+1]
|
||||
|
||||
== Preparing for the installation
|
||||
|
||||
Before you extend nodes to local zones, you must prepare certain resources for the cluster installation environment.
|
||||
include::modules/cli-installing-cli.adoc[leveloffset=+2]
|
||||
|
||||
// Obtaining the installation program
|
||||
include::modules/installation-obtaining-installer.adoc[leveloffset=+2]
|
||||
@@ -82,8 +57,10 @@ 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]
|
||||
|
||||
// Creating the installation files for AWS
|
||||
include::modules/installation-user-infra-generate.adoc[leveloffset=+2]
|
||||
[id="prep-installation-aws-local-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]
|
||||
@@ -94,80 +71,44 @@ include::modules/installation-aws-tested-machine-types.adoc[leveloffset=+2]
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* See link:https://aws.amazon.com/about-aws/global-infrastructure/localzones/features/[AWS Local Zones features] in the AWS documentation for more information about AWS Local Zones and the supported instances types and services.
|
||||
* See link:https://aws.amazon.com/about-aws/global-infrastructure/localzones/features/[AWS Local Zones features] in the AWS documentation.
|
||||
|
||||
// Creating the installation configuration file
|
||||
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]
|
||||
// Examples of installation configuration files with edge compute pools
|
||||
include::modules/installation-aws-edge-compute-pools-examples.adoc[leveloffset=+2]
|
||||
|
||||
// Customizing Cluster Network MTU
|
||||
include::modules/installation-aws-cluster-network-mtu.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
|
||||
[id="installing-aws-with-short-term-creds_{context}"]
|
||||
== Optional: Configuring an AWS cluster to use short-term credentials
|
||||
|
||||
To install a cluster that is configured to use the AWS Security Token Service (STS), you must configure the CCO utility and create the required AWS resources for your cluster.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
To use the AWS STS, you must configure the Cloud Credential Operator (CCO) to run in manual mode. As part of the installation process, you set `credentialsMode` parameter to `Manual` after creating the `install-config.yaml` installation configuration file.
|
||||
====
|
||||
|
||||
//Task part 1: Configuring the Cloud Credential Operator utility
|
||||
include::modules/cco-ccoctl-configuring.adoc[leveloffset=+2]
|
||||
|
||||
//Task part 2: Creating the required AWS resources
|
||||
[id="sts-mode-create-aws-resources-ccoctl_{context}"]
|
||||
=== Creating AWS resources with the Cloud Credential Operator utility
|
||||
|
||||
You have the following options when creating AWS resources:
|
||||
|
||||
* You can use the `ccoctl aws create-all` command to create the AWS resources automatically. This is the quickest way to create the resources. See xref:../../installing/installing_aws/installing-aws-localzone.adoc#cco-ccoctl-creating-at-once_installing-aws-localzone[Creating AWS resources with a single command].
|
||||
|
||||
* If you need to review the JSON files that the `ccoctl` tool creates before modifying AWS resources, or if the process the `ccoctl` tool uses to create AWS resources automatically does not meet the requirements of your organization, you can create the AWS resources individually. See xref:../../installing/installing_aws/installing-aws-localzone.adoc#cco-ccoctl-creating-individually_installing-aws-localzone[Creating AWS resources individually].
|
||||
|
||||
//Task part 2a: Creating the required AWS resources all at once
|
||||
include::modules/cco-ccoctl-creating-at-once.adoc[leveloffset=+3]
|
||||
|
||||
//Task part 2b: Creating the required AWS resources individually
|
||||
include::modules/cco-ccoctl-creating-individually.adoc[leveloffset=+3]
|
||||
////
|
||||
|
||||
// Opting in to AWS Local Zones
|
||||
include::modules/installation-aws-add-local-zone-locations.adoc[leveloffset=+1]
|
||||
* For more information about the maximum supported maximum transmission unit (MTU) value, see link:https://docs.aws.amazon.com/local-zones/latest/ug/how-local-zones-work.html#considerations[AWS resources supported in Local Zones] in the AWS documentation.
|
||||
|
||||
// Cluster installation options for an AWS Local 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 Local Zones environment:
|
||||
Choose one of the following options to install an {product-title} cluster in an AWS {zone-type} environment:
|
||||
|
||||
* xref:../../installing/installing_aws/installing-aws-localzone.adoc#installation-cluster-quickly-extend-workers_installing-aws-localzone[Installing a cluster quickly in AWS Local Zones]
|
||||
* xref:../../installing/installing_aws/installing-aws-localzone.adoc#installation-cluster-quickly-extend-compute-nodes_installing-aws-localzone[Installing a cluster quickly in AWS Local Zones]
|
||||
* xref:../../installing/installing_aws/installing-aws-localzone.adoc#creating-aws-local-zone-environment-existing_installing-aws-localzone[Installing a cluster in an existing VPC with defined Local Zone subnets]
|
||||
|
||||
// Installing a cluster quickly in AWS Local Zones
|
||||
include::modules/installation-cluster-quickly-extend-workers.adoc[leveloffset=+1]
|
||||
include::modules/installation-cluster-quickly-extend-compute-nodes.adoc[leveloffset=+1]
|
||||
|
||||
// Modifying an installation configuration to use AWS Local Zones
|
||||
include::modules/install-creating-install-config-aws-local-zones.adoc[leveloffset=+2]
|
||||
include::modules/install-creating-install-config-aws-edge-zones.adoc[leveloffset=+2]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* xref:../../installing/installing_aws/installing-aws-localzone.adoc#cluster-limitations-local-zone_installing-aws-localzone[Creating the installation configuration file]
|
||||
* xref:../../installing/installing_aws/installing-aws-localzone.adoc#installation-generate-aws-user-infra-install-config_installing-aws-localzone[Creating the installation configuration file]
|
||||
|
||||
* xref:../../installing/installing_aws/installing-aws-localzone.adoc#cluster-limitations-local-zone_installing-aws-localzone[Cluster limitations in AWS Local Zones]
|
||||
* xref:../../installing/installing_aws/installing-aws-localzone.adoc#cluster-limitations-aws-zone_installing-aws-localzone[Cluster limitations in AWS Local Zones]
|
||||
|
||||
.Next steps
|
||||
* xref:../../installing/installing_aws/installing-aws-localzone.adoc#installation-launching-installer_installing-aws-localzone[Deploying the cluster]
|
||||
@@ -177,26 +118,32 @@ include::modules/install-creating-install-config-aws-local-zones.adoc[leveloffse
|
||||
|
||||
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 workers to the edge of the Cloud Infrastructure by using AWS Local Zones.
|
||||
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}.
|
||||
|
||||
Local Zone subnets extend regular workers' nodes to edge networks. Each edge worker nodes runs a user workload. After you create an Amazon Web Service (AWS) Local Zone environment, and you deploy your cluster, you can use edge worker nodes to create user workloads in Local Zone subnets.
|
||||
|
||||
You can use a provided CloudFormation template to create the VPC and public subnets. Additionally, you can modify a template to customize your infrastructure or use the information that they contain to create AWS objects according to your company's policies.
|
||||
Local Zone subnets extend regular compute nodes to edge networks. Each edge compute nodes runs a user workload. After you create an Amazon Web Service (AWS) Local Zone environment, and you deploy your cluster, you can use edge compute nodes to create user workloads in Local Zone subnets.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
If you want to create private subnets, you must either modify the provided CloudFormation template or create your own template.
|
||||
====
|
||||
|
||||
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]
|
||||
// Creating a subnet in AWS Local Zones
|
||||
include::modules/installation-creating-aws-subnet-localzone.adoc[leveloffset=+2]
|
||||
|
||||
// CloudFormation template for the VPC
|
||||
include::modules/installation-cloudformation-vpc-localzone.adoc[leveloffset=+2]
|
||||
// AWS security groups
|
||||
include::modules/installation-aws-security-groups.adoc[leveloffset=+2]
|
||||
// CloududFormation template for the subnet that uses AWS Local Zones
|
||||
|
||||
// Creating subnets in Local Zones
|
||||
include::modules/installation-creating-aws-vpc-subnets-lz.adoc[leveloffset=+2]
|
||||
|
||||
// CloudFormation template for the subnet that uses AWS Local Zones
|
||||
include::modules/installation-cloudformation-subnet-localzone.adoc[leveloffset=+2]
|
||||
|
||||
[role="_additional-resources"]
|
||||
@@ -204,57 +151,45 @@ include::modules/installation-cloudformation-subnet-localzone.adoc[leveloffset=+
|
||||
|
||||
* You can view details about the CloudFormation stacks that you create by navigating to the link:https://console.aws.amazon.com/cloudformation/[AWS CloudFormation console].
|
||||
|
||||
// Modifying an installation configuration file to use AWS Local Zones subnets
|
||||
include::modules/install-creating-install-config-aws-local-zones-subnets.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
|
||||
|
||||
* See link:https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html[Configuration and credential file settings] in the AWS documentation for more information about AWS profile and credential configuration.
|
||||
* 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.
|
||||
|
||||
//include::modules/installation-configure-proxy.adoc[leveloffset=+2]
|
||||
//Put this back if QE validates it.
|
||||
.Next steps
|
||||
* xref:../../installing/installing_aws/installing-aws-localzone.adoc#installation-launching-installer_installing-aws-localzone[Deploying the cluster]
|
||||
|
||||
// Verify removal due to automation.
|
||||
// include::modules/installation-localzone-generate-k8s-manifest.adoc[leveloffset=+2]
|
||||
// Optional: AWS security groups
|
||||
include::modules/installation-aws-security-groups.adoc[leveloffset=+1]
|
||||
|
||||
////
|
||||
// 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.
|
||||
[id="installing-aws-manual-modes_{context}"]
|
||||
== Alternatives to storing administrator-level secrets in the kube-system project
|
||||
|
||||
By default, administrator secrets are stored in the `kube-system` project. If you configured the `credentialsMode` parameter in the `install-config.yaml` file to `Manual`, you must use one of the following alternatives:
|
||||
|
||||
* If you configured the CCO utility (`ccoctl`) to implement short-term credentials for individual components, follow the procedure in xref:../../installing/installing_aws/installing-aws-localzone.adoc#cco-ccoctl-install-creating-manifests_installing-aws-localzone[Incorporating the Cloud Credential Operator utility manifests].
|
||||
|
||||
* If you will manage cloud credentials manually, follow the procedure in xref:../../installing/installing_aws/installing-aws-localzone.adoc#manually-create-iam_installing-aws-localzone[Manually creating long-term credentials].
|
||||
|
||||
// Additional steps for the Cloud Credential Operator utility (`ccoctl`)
|
||||
include::modules/cco-ccoctl-install-creating-manifests.adoc[leveloffset=+2]
|
||||
|
||||
//Manually creating IAM
|
||||
include::modules/manually-create-identity-access-management.adoc[leveloffset=+2]
|
||||
////
|
||||
// Optional: Assign public IP to edge compute nodes (optional)
|
||||
include::modules/installing-with-edge-node-public.adoc[leveloffset=+1]
|
||||
|
||||
// Deploying the cluster
|
||||
include::modules/installation-launching-installer.adoc[leveloffset=+1]
|
||||
|
||||
.Next steps
|
||||
* xref:../../post_installation_configuration/cluster-tasks.adoc#installation-extend-edge-nodes-aws-local-zones_post-install-cluster-tasks[Creating user workloads in AWS Local Zones]
|
||||
[id="verify-aws-local-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=+1]
|
||||
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=+1]
|
||||
include::modules/logging-in-by-using-the-web-console.adoc[leveloffset=+2]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* 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.
|
||||
* 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=+1]
|
||||
include::modules/machine-edge-pool-review-nodes.adoc[leveloffset=+2]
|
||||
|
||||
// Telemetry access for OpenShift Container Platform
|
||||
include::modules/cluster-telemetry.adoc[leveloffset=+1]
|
||||
@@ -262,16 +197,10 @@ include::modules/cluster-telemetry.adoc[leveloffset=+1]
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* See xref:../../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring] for more information about the Telemetry service.
|
||||
* 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].
|
||||
|
||||
[id="installing-aws-localzone-next-steps"]
|
||||
== Next steps
|
||||
.Next steps
|
||||
|
||||
* xref:../../post_installation_configuration/cluster-tasks.adoc#installation-extend-edge-nodes-aws-local-zones_post-install-cluster-tasks[Creating user workloads in AWS Local Zones].
|
||||
//* 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].
|
||||
* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster].
|
||||
* 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 reporting].
|
||||
////
|
||||
// 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.
|
||||
* If necessary, you can xref:../../post_installation_configuration/cluster-tasks.adoc#manually-removing-cloud-creds_post-install-cluster-tasks[remove cloud provider credentials].
|
||||
////
|
||||
* 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].
|
||||
|
||||
210
installing/installing_aws/installing-aws-wavelength-zone.adoc
Normal file
210
installing/installing_aws/installing-aws-wavelength-zone.adoc
Normal file
@@ -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].
|
||||
Reference in New Issue
Block a user