mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
OSDOCS-15577:combining AWS assemblies
This commit is contained in:
Brendan Daly
@@ -39,5 +39,4 @@ include::modules/installation-aws-regions.adoc[leveloffset=+1]
|
||||
* Install an {product-title} cluster:
|
||||
** xref:../../installing/installing_aws/ipi/installing-aws-default.adoc#installing-aws-default[Quickly install a cluster] with default options on installer-provisioned infrastructure
|
||||
** xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-customizations[Install a cluster with cloud customizations on installer-provisioned infrastructure]
|
||||
** xref:../../installing/installing_aws/ipi/installing-aws-network-customizations.adoc#installing-aws-network-customizations[Install a cluster with network customizations on installer-provisioned infrastructure]
|
||||
** xref:../../installing/installing_aws/upi/installing-aws-user-infra.adoc#installing-aws-user-infra[Installing a cluster on user-provisioned infrastructure in AWS by using CloudFormation templates]
|
||||
@@ -1,16 +1,17 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="installing-aws-customizations"]
|
||||
= Installing a cluster on AWS with customizations
|
||||
= Installing a cluster on {aws-short} with customizations
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: installing-aws-customizations
|
||||
:platform: AWS
|
||||
|
||||
toc::[]
|
||||
|
||||
In {product-title} version {product-version}, you can install a customized
|
||||
cluster on infrastructure that the installation program provisions on
|
||||
Amazon Web Services (AWS). To customize the installation, you modify
|
||||
parameters in the `install-config.yaml` file before you install the cluster.
|
||||
In {product-title} version {product-version}, you can install a cluster on {aws-first} by using installer-provisioned infrastructure with customizations, including network configuration options. In each, you modify parameters in the `install-config.yaml` file before you install the cluster.
|
||||
|
||||
By customizing your network configuration, your cluster can coexist with existing IP address allocations in your environment and integrate with existing MTU and VXLAN configurations.
|
||||
|
||||
You must set most of the network configuration parameters during installation, and you can modify only `kubeProxy` configuration parameters in a running cluster.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
@@ -25,18 +26,20 @@ The scope of the {product-title} installation configurations is intentionally na
|
||||
+
|
||||
[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 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.
|
||||
If you have an {aws-short} 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-short} credentials to create {aws-short} resources for the entire life of the cluster, so you must use 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-short} documentation. You can supply the keys when you run the installation program.
|
||||
====
|
||||
* 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.
|
||||
|
||||
include::modules/installation-aws-marketplace-subscribe.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/nw-network-config.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-initializing.adoc[leveloffset=+1]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* xref:../../../installing/installing_aws/installation-config-parameters-aws.adoc#installation-config-parameters-aws[Installation configuration parameters for AWS]
|
||||
* xref:../../../installing/installing_aws/installation-config-parameters-aws.adoc#installation-config-parameters-aws[Installation configuration parameters for {aws-short}]
|
||||
|
||||
include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2]
|
||||
|
||||
@@ -54,7 +57,7 @@ include::modules/installation-aws-config-yaml-customizations.adoc[leveloffset=+2
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* xref:../../../installing/installing_aws/installation-config-parameters-aws.adoc#installation-config-parameters-aws[Installation configuration parameters for AWS]
|
||||
* xref:../../../installing/installing_aws/installation-config-parameters-aws.adoc#installation-config-parameters-aws[Installation configuration parameters for {aws-short}]
|
||||
|
||||
include::modules/installation-configure-proxy.adoc[leveloffset=+2]
|
||||
|
||||
@@ -65,14 +68,14 @@ By default, administrator secrets are stored in the `kube-system` project. If yo
|
||||
|
||||
* To manage long-term cloud credentials manually, follow the procedure in xref:../../../installing/installing_aws/ipi/installing-aws-customizations.adoc#manually-create-iam_installing-aws-customizations[Manually creating long-term credentials].
|
||||
|
||||
* To implement short-term credentials that are managed outside the cluster for individual components, follow the procedures in xref:../../../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-with-short-term-creds_installing-aws-customizations[Configuring an AWS cluster to use short-term credentials].
|
||||
* To implement short-term credentials that are managed outside the cluster for individual components, follow the procedures in xref:../../../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-with-short-term-creds_installing-aws-customizations[Configuring an {aws-short} cluster to use short-term credentials].
|
||||
|
||||
//Manually creating long-term credentials
|
||||
include::modules/manually-create-identity-access-management.adoc[leveloffset=+2]
|
||||
|
||||
//Supertask: Configuring an AWS cluster to use short-term credentials
|
||||
[id="installing-aws-with-short-term-creds_{context}"]
|
||||
=== Configuring an AWS cluster to use short-term credentials
|
||||
=== Configuring an {aws-short} 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.
|
||||
|
||||
@@ -81,13 +84,13 @@ include::modules/cco-ccoctl-configuring.adoc[leveloffset=+3]
|
||||
|
||||
//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
|
||||
==== Creating {aws-short} resources with the Cloud Credential Operator utility
|
||||
|
||||
You have the following options when creating AWS resources:
|
||||
You have the following options when creating {aws-short} 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/ipi/installing-aws-customizations.adoc#cco-ccoctl-creating-at-once_installing-aws-customizations[Creating AWS resources with a single command].
|
||||
* You can use the `ccoctl aws create-all` command to create the {aws-short} resources automatically. This is the quickest way to create the resources. See xref:../../../installing/installing_aws/ipi/installing-aws-customizations.adoc#cco-ccoctl-creating-at-once_installing-aws-customizations[Creating {aws-short} 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/ipi/installing-aws-customizations.adoc#cco-ccoctl-creating-individually_installing-aws-customizations[Creating AWS resources individually].
|
||||
* 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-short} resources individually. See xref:../../../installing/installing_aws/ipi/installing-aws-customizations.adoc#cco-ccoctl-creating-individually_installing-aws-customizations[Creating {aws-short} resources individually].
|
||||
|
||||
//Task part 2a: Creating the required AWS resources all at once
|
||||
include::modules/cco-ccoctl-creating-at-once.adoc[leveloffset=+4]
|
||||
@@ -98,6 +101,19 @@ include::modules/cco-ccoctl-creating-individually.adoc[leveloffset=+4]
|
||||
//Task part 3: Incorporating the Cloud Credential Operator utility manifests
|
||||
include::modules/cco-ccoctl-install-creating-manifests.adoc[leveloffset=+3]
|
||||
|
||||
// Network Operator specific configuration
|
||||
include::modules/nw-operator-cr.adoc[leveloffset=+1]
|
||||
include::modules/nw-modifying-operator-install-config.adoc[leveloffset=+1]
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
For more information on using a Network Load Balancer (NLB) on {aws-short}, see xref:../../../networking/ingress_load_balancing/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-aws.adoc#nw-configuring-ingress-cluster-traffic-aws-network-load-balancer_configuring-ingress-cluster-traffic-aws[Configuring Ingress cluster traffic on {aws-short} using a Network Load Balancer].
|
||||
====
|
||||
|
||||
include::modules/nw-aws-nlb-new-cluster.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/configuring-hybrid-ovnkubernetes.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-launching-installer.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
|
||||
|
||||
@@ -15,9 +15,7 @@ You can install a cluster on AWS infrastructure that is provisioned by the {prod
|
||||
|
||||
* **xref:../../installing/installing_aws/ipi/installing-aws-default.adoc#installing-aws-default[Installing a cluster quickly on AWS]**: You can install {product-title} on AWS infrastructure that is provisioned by the {product-title} installation program. You can install a cluster quickly by using the default configuration options.
|
||||
|
||||
* **xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-customizations[Installing a customized cluster on AWS]**: You can install a customized cluster on AWS infrastructure that the installation program provisions. The installation program allows for some customization to be applied at the installation stage. Many other customization options are available xref:../../post_installation_configuration/cluster-tasks.adoc#post-install-cluster-tasks[post-installation].
|
||||
|
||||
* **xref:../../installing/installing_aws/ipi/installing-aws-network-customizations.adoc#installing-aws-network-customizations[Installing a cluster on AWS with network customizations]**: You can customize your {product-title} network configuration during installation, so that your cluster can coexist with your existing IP address allocations and adhere to your network requirements.
|
||||
* **xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-customizations[Installing a customized cluster on AWS]**: You can install a customized cluster on AWS infrastructure that the installation program provisions. You can also customize your {product-title} network configuration during installation, so that your cluster can coexist with your existing IP address allocations and adhere to your network requirements. The installation program allows for some customization to be applied at the installation stage. Many other customization options are available xref:../../post_installation_configuration/cluster-tasks.adoc#post-install-cluster-tasks[post-installation].
|
||||
|
||||
* **xref:../../installing/installing_aws/ipi/installing-restricted-networks-aws-installer-provisioned.adoc#installing-restricted-networks-aws-installer-provisioned[Installing a cluster on AWS in a restricted network]**: You can install {product-title} on AWS on installer-provisioned infrastructure by using an internal mirror of the installation release content. You can use this method to install a cluster that does not require an active internet connection to obtain the software components.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user