diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index f2590bcb61..a665d8edf0 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -189,6 +189,8 @@ Topics: File: installing-aws-three-node - Name: Uninstalling a cluster on AWS File: uninstalling-cluster-aws + - Name: Installation configuration parameters for AWS + File: installation-config-parameters-aws - Name: Installing on Azure Dir: installing_azure Distros: openshift-origin,openshift-enterprise @@ -216,7 +218,7 @@ Topics: - Name: Installing a cluster on Azure using ARM templates File: installing-azure-user-infra - Name: Installing a cluster on Azure in a restricted network - File: installing-restricted-networks-azure-installer-provisioned + File: installing-restricted-networks-azure-installer-provisioned - Name: Installing a three-node cluster on Azure File: installing-azure-three-node - Name: Uninstalling a cluster on Azure @@ -2758,7 +2760,7 @@ Topics: - Name: About installing OADP File: about-installing-oadp - Name: Installing the OADP Operator - File: oadp-installing-operator + File: oadp-installing-operator - Name: Configuring OADP with AWS File: installing-oadp-aws - Name: Configuring OADP with Azure @@ -2771,7 +2773,7 @@ Topics: File: installing-oadp-ocs - Name: Uninstalling OADP Dir: installing - Topics: + Topics: - Name: Uninstalling OADP File: uninstalling-oadp - Name: OADP backing up diff --git a/installing/installing_aws/installation-config-parameters-aws.adoc b/installing/installing_aws/installation-config-parameters-aws.adoc new file mode 100644 index 0000000000..ec213a2194 --- /dev/null +++ b/installing/installing_aws/installation-config-parameters-aws.adoc @@ -0,0 +1,12 @@ +:_content-type: ASSEMBLY +[id="installation-config-parameters-aws"] += Installation configuration parameters for AWS +include::_attributes/common-attributes.adoc[] +:context: installation-config-parameters-aws +:platform: AWS + +toc::[] + +Before you deploy an {product-title} cluster on AWS, you provide parameters to customize your cluster and the platform that hosts it. When you create the `install-config.yaml` file, you provide values for the required parameters through the command line. You can then modify the `install-config.yaml` file to customize your cluster further. + +include::modules/installation-configuration-parameters.adoc[leveloffset=+1] diff --git a/installing/installing_aws/installing-aws-china.adoc b/installing/installing_aws/installing-aws-china.adoc index a90a6c2b32..64a426bf00 100644 --- a/installing/installing_aws/installing-aws-china.adoc +++ b/installing/installing_aws/installing-aws-china.adoc @@ -74,7 +74,11 @@ include::modules/cco-ccoctl-creating-at-once.adoc[leveloffset=+3] include::modules/cco-ccoctl-creating-individually.adoc[leveloffset=+3] include::modules/installation-initializing-manual.adoc[leveloffset=+1] -include::modules/installation-configuration-parameters.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] + include::modules/installation-aws-config-yaml.adoc[leveloffset=+2] include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] diff --git a/installing/installing_aws/installing-aws-customizations.adoc b/installing/installing_aws/installing-aws-customizations.adoc index 8bb4eea4c3..576d4e5d6f 100644 --- a/installing/installing_aws/installing-aws-customizations.adoc +++ b/installing/installing_aws/installing-aws-customizations.adoc @@ -72,7 +72,9 @@ include::modules/cco-ccoctl-creating-individually.adoc[leveloffset=+3] include::modules/installation-initializing.adoc[leveloffset=+1] -include::modules/installation-configuration-parameters.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] include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] diff --git a/installing/installing_aws/installing-aws-government-region.adoc b/installing/installing_aws/installing-aws-government-region.adoc index 4cc60a7593..decd33abfe 100644 --- a/installing/installing_aws/installing-aws-government-region.adoc +++ b/installing/installing_aws/installing-aws-government-region.adoc @@ -75,7 +75,10 @@ include::modules/cco-ccoctl-creating-at-once.adoc[leveloffset=+3] include::modules/cco-ccoctl-creating-individually.adoc[leveloffset=+3] include::modules/installation-initializing-manual.adoc[leveloffset=+1] -include::modules/installation-configuration-parameters.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] include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] diff --git a/installing/installing_aws/installing-aws-network-customizations.adoc b/installing/installing_aws/installing-aws-network-customizations.adoc index d332b33f99..d92838f71c 100644 --- a/installing/installing_aws/installing-aws-network-customizations.adoc +++ b/installing/installing_aws/installing-aws-network-customizations.adoc @@ -73,7 +73,9 @@ include::modules/nw-network-config.adoc[leveloffset=+1] include::modules/installation-initializing.adoc[leveloffset=+1] -include::modules/installation-configuration-parameters.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] include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] diff --git a/installing/installing_aws/installing-aws-outposts-remote-workers.adoc b/installing/installing_aws/installing-aws-outposts-remote-workers.adoc index d038f6ccc9..0e3dc06c1f 100644 --- a/installing/installing_aws/installing-aws-outposts-remote-workers.adoc +++ b/installing/installing_aws/installing-aws-outposts-remote-workers.adoc @@ -85,7 +85,9 @@ include::modules/installation-identify-supported-aws-outposts-instance-types.ado include::modules/installation-initializing.adoc[leveloffset=+1] -include::modules/installation-configuration-parameters.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] include::modules/installation-aws-config-yaml.adoc[leveloffset=+2] include::modules/installation-applying-aws-security-groups.adoc[leveloffset=+2] diff --git a/installing/installing_aws/installing-aws-private.adoc b/installing/installing_aws/installing-aws-private.adoc index 64daa8d80c..c3d2f2976d 100644 --- a/installing/installing_aws/installing-aws-private.adoc +++ b/installing/installing_aws/installing-aws-private.adoc @@ -69,7 +69,9 @@ include::modules/cco-ccoctl-creating-individually.adoc[leveloffset=+3] include::modules/installation-initializing-manual.adoc[leveloffset=+1] -include::modules/installation-configuration-parameters.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] include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] diff --git a/installing/installing_aws/installing-aws-secret-region.adoc b/installing/installing_aws/installing-aws-secret-region.adoc index 261ca82434..10b1d6730a 100644 --- a/installing/installing_aws/installing-aws-secret-region.adoc +++ b/installing/installing_aws/installing-aws-secret-region.adoc @@ -78,7 +78,11 @@ include::modules/cco-ccoctl-creating-at-once.adoc[leveloffset=+3] include::modules/cco-ccoctl-creating-individually.adoc[leveloffset=+3] include::modules/installation-initializing-manual.adoc[leveloffset=+1] -include::modules/installation-configuration-parameters.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] + include::modules/installation-aws-tested-machine-types.adoc[leveloffset=+2] include::modules/installation-aws-config-yaml.adoc[leveloffset=+2] include::modules/installation-configure-proxy.adoc[leveloffset=+2] diff --git a/installing/installing_aws/installing-aws-vpc.adoc b/installing/installing_aws/installing-aws-vpc.adoc index 6fc4a9c252..b4cc9d9eff 100644 --- a/installing/installing_aws/installing-aws-vpc.adoc +++ b/installing/installing_aws/installing-aws-vpc.adoc @@ -65,7 +65,9 @@ include::modules/cco-ccoctl-creating-individually.adoc[leveloffset=+3] include::modules/installation-initializing.adoc[leveloffset=+1] -include::modules/installation-configuration-parameters.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] include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] diff --git a/installing/installing_aws/installing-restricted-networks-aws-installer-provisioned.adoc b/installing/installing_aws/installing-restricted-networks-aws-installer-provisioned.adoc index c50752e75a..d6245c36d6 100644 --- a/installing/installing_aws/installing-restricted-networks-aws-installer-provisioned.adoc +++ b/installing/installing_aws/installing-restricted-networks-aws-installer-provisioned.adoc @@ -79,7 +79,9 @@ include::modules/cco-ccoctl-creating-individually.adoc[leveloffset=+3] include::modules/installation-initializing.adoc[leveloffset=+1] -include::modules/installation-configuration-parameters.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] include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] diff --git a/modules/installation-configuration-parameters.adoc b/modules/installation-configuration-parameters.adoc index 8ee783c061..e2f1d2b448 100644 --- a/modules/installation-configuration-parameters.adoc +++ b/modules/installation-configuration-parameters.adoc @@ -1,14 +1,5 @@ // Module included in the following assemblies: // -// * installing/installing_aws/installing-aws-china.adoc -// * installing/installing_aws/installing-aws-customizations.adoc -// * installing/installing_aws/installing-aws-government-region.adoc -// * installing/installing_aws/installing-aws-network-customizations.adoc -// * installing/installing_aws/installing-aws-private.adoc -// * installing/installing_aws/installing-aws-secret-region.adoc -// * installing/installing_aws/installing-aws-vpc.adoc -// * installing/installing_aws/installing-restricted-networks-aws-installer-provisioned.adoc -// * installing/installing_aws/installing-aws-outposts-remote-workers.adoc // * installing/installing_vsphere/installation-config-parameters-vsphere.adoc // * installing/installing_gcp/installation-config-parameters-gcp.adoc // * installing/installing_ibm_z/installation-config-parameters-ibm-z.adoc @@ -21,35 +12,8 @@ // * installing/installing_nutanix/installation-config-parameters-nutanix.adoc // * installing/installing_openstack/installation-config-parameters-openstack.adoc // * installing/installing_azure/installation-config-parameters-azure.adoc -// * installing/installing-restricted-networks-azure-installer-provisioned.adoc +// * installing/installing_aws/installation-config-parameters-aws.adoc -ifeval::["{context}" == "installing-aws-customizations"] -:aws: -endif::[] -ifeval::["{context}" == "installing-aws-government-region"] -:aws: -endif::[] -ifeval::["{context}" == "installing-aws-secret-region"] -:aws: -endif::[] -ifeval::["{context}" == "installing-aws-network-customizations"] -:aws: -endif::[] -ifeval::["{context}" == "installing-aws-private"] -:aws: -endif::[] -ifeval::["{context}" == "installing-aws-vpc"] -:aws: -endif::[] -ifeval::["{context}" == "installing-restricted-networks-aws-installer-provisioned"] -:aws: -endif::[] -ifeval::["{context}" == "installing-aws-outposts-remote-workers"] -:aws: -endif::[] -ifeval::["{context}" == "installing-aws-customizations"] -:aws: -endif::[] ifeval::["{context}" == "installation-config-parameters-vsphere"] :vsphere: endif::[] @@ -86,53 +50,19 @@ endif::[] ifeval::["{context}" == "installation-config-parameters-azure"] :azure: endif::[] -ifeval::["{context}" == "installing-restricted-networks-azure-installer-provisioned"] -:azure: +ifeval::["{context}" == "installation-config-parameters-aws"] +:aws: endif::[] - :_content-type: CONCEPT [id="installation-configuration-parameters_{context}"] -ifndef::vsphere,gcp,ibm-z,ibm-power,ash,bare,ibm-cloud,alibaba-cloud,ibm-power-vs,nutanix,osp,azure[] -= Installation configuration parameters -endif::vsphere,gcp,ibm-z,ibm-power,ash,bare,ibm-cloud,alibaba-cloud,ibm-power-vs,nutanix,osp,azure[] - -// Managing headings is required as part of the effort for https://issues.redhat.com/browse/OSDOCS-6493. -// This accommodates the existing IA of the installation assemblies, while the improvement is implemented. -// As part of the updates for the last provider, the conditions can be removed and the following heading can be used. -ifdef::vsphere,gcp,ibm-z,ibm-power,ash,bare,ibm-cloud,alibaba-cloud,ibm-power-vs,nutanix,osp,azure[] = Available installation configuration parameters for {platform} -endif::vsphere,gcp,ibm-z,ibm-power,ash,bare,ibm-cloud,alibaba-cloud,ibm-power-vs,nutanix,osp,azure[] - -// If install-config.yaml is generated by openshift-install -// The addition of providers beyond bare,ibm-power,ibm-z,ash is necessary as part of the effort for https://issues.redhat.com/browse/OSDOCS-6493 -// This accommodates the existing IA of the installation assemblies, while the improvement is implemented. -// As part of the updates for the last provider, content between lines 277-292 can be completely removed. -ifndef::bare,ibm-power,ibm-z,ash,vsphere,gcp,ibm-cloud,alibaba-cloud,ibm-power-vs,nutanix,osp,azure[] -Before you deploy an {product-title} cluster, you provide parameter values to describe your account on the cloud platform that hosts your cluster and optionally customize your cluster's platform. When you create the `install-config.yaml` installation configuration file, you provide values for the required parameters through the command line. If you customize your cluster, you can modify the `install-config.yaml` file to provide more details about the platform. -endif::bare,ibm-power,ibm-z,ash,vsphere,gcp,ibm-cloud,alibaba-cloud,ibm-power-vs,nutanix,osp,azure[] - -// A condition for this note is required as part of the effort for https://issues.redhat.com/browse/OSDOCS-6493. -// This accommodates the existing content for installation assemblies, while the improvement is implemented. -// As part of the updates for the last provider, this note can be removed from the module. -ifndef::vsphere,gcp,ibm-z,ibm-power,ash,bare,ibm-cloud,alibaba-cloud,ibm-power-vs,nutanix,osp,azure[] -[NOTE] -==== -After installation, you cannot modify these parameters in the `install-config.yaml` file. -==== -endif::vsphere,gcp,ibm-z,ibm-power,ash,bare,ibm-cloud,alibaba-cloud,ibm-power-vs,nutanix,osp,azure[] - -// This condition is required as part of the effort for https://issues.redhat.com/browse/OSDOCS-6493. -// As part of the update for each provider, this content applies to the net new provider-specific installation configuration parameter assembly. -// As part of the updates for the last provider, the conditions can be completely removed. -ifdef::vsphere,gcp,ibm-z,ibm-power,ash,bare,ibm-cloud,alibaba-cloud,ibm-power-vs,nutanix,osp,azure[] The following tables specify the required, optional, and {platform}-specific installation configuration parameters that you can set as part of the installation process. [NOTE] ==== After installation, you cannot modify these parameters in the `install-config.yaml` file. ==== -endif::vsphere,gcp,ibm-z,ibm-power,ash,bare,ibm-cloud,alibaba-cloud,ibm-power-vs,nutanix,osp,azure[] [id="installation-configuration-parameters-required_{context}"] == Required configuration parameters @@ -467,7 +397,7 @@ endif::aws,bare,gcp,ibm-power,ibm-z,azure,ibm-power-vs[] ifdef::aws,azure,gcp,bare[] |`compute.architecture` -|Determines the instruction set architecture of the machines in the pool. Currently, clusters with varied architectures are not supported. All pools must specify the same architecture. Valid values are `amd64` and `arm64`. +|Determines the instruction set architecture of the machines in the pool. Currently, clusters with varied architectures are not supported. All pools must specify the same architecture. Valid values are `amd64` and `arm64`. ifdef::aws,azure[] Not all installation options support the 64-bit ARM architecture. To verify if your installation option is supported on your platform, see _Supported installation methods for different platforms_ in _Selecting a cluster installation method and preparing it for users_. endif::aws,azure[] @@ -537,7 +467,7 @@ endif::aws,bare,gcp,ibm-z,ibm-power,azure,ibm-power-vs[] ifdef::aws,azure,gcp,bare[] |`controlPlane.architecture` -|Determines the instruction set architecture of the machines in the pool. Currently, clusters with varied architectures are not supported. All pools must specify the same architecture. Valid values are `amd64` and `arm64`. +|Determines the instruction set architecture of the machines in the pool. Currently, clusters with varied architectures are not supported. All pools must specify the same architecture. Valid values are `amd64` and `arm64`. ifdef::aws,azure[] Not all installation options support the 64-bit ARM architecture. To verify if your installation option is supported on your platform, see _Supported installation methods for different platforms_ in _Selecting a cluster installation method and preparing it for users_. endif::aws,azure[] @@ -855,7 +785,7 @@ Additional {rh-openstack} configuration parameters are described in the followin |`platform.openstack.cloud` |The name of the {rh-openstack} cloud to use from the list of clouds in the `clouds.yaml` file. -In the cloud configuration in the `clouds.yaml` file, if possible, use application credentials rather than a user name and password combination. Using application credentials avoids disruptions from secret propogation that follow user name and password rotation. +In the cloud configuration in the `clouds.yaml` file, if possible, use application credentials rather than a user name and password combination. Using application credentials avoids disruptions from secret propogation that follow user name and password rotation. |String, for example `MyCloud`. @@ -2095,33 +2025,6 @@ Additional Nutanix configuration parameters are described in the following table -- endif::nutanix[] -ifeval::["{context}" == "installing-aws-customizations"] -:!aws: -endif::[] -ifeval::["{context}" == "installing-aws-government-region"] -:!aws: -endif::[] -ifeval::["{context}" == "installing-aws-secret-region"] -:!aws: -endif::[] -ifeval::["{context}" == "installing-aws-network-customizations"] -:!aws: -endif::[] -ifeval::["{context}" == "installing-aws-private"] -:!aws: -endif::[] -ifeval::["{context}" == "installing-aws-vpc"] -:!aws: -endif::[] -ifeval::["{context}" == "installing-restricted-networks-aws-installer-provisioned"] -:!aws: -endif::[] -ifeval::["{context}" == "installing-aws-outposts-remote-workers"] -:!aws: -endif::[] -ifeval::["{context}" == "installing-aws-customizations"] -:!aws: -endif::[] ifeval::["{context}" == "installation-config-parameters-vsphere"] :!vsphere: endif::[] @@ -2158,7 +2061,7 @@ endif::[] ifeval::["{context}" == "installation-config-parameters-azure"] :!azure: endif::[] -:!platform: -ifeval::["{context}" == "installing-restricted-networks-azure-installer-provisioned"] -:!azure: +ifeval::["{context}" == "installation-config-parameters-aws"] +:!aws: endif::[] +:!platform: