diff --git a/modules/installation-aws-config-yaml.adoc b/_unused_topics/installation-aws-config-yaml.adoc similarity index 100% rename from modules/installation-aws-config-yaml.adoc rename to _unused_topics/installation-aws-config-yaml.adoc diff --git a/installing/installing_aws/ipi/installing-aws-china.adoc b/installing/installing_aws/ipi/installing-aws-china.adoc index c09482e924..d879b60f36 100644 --- a/installing/installing_aws/ipi/installing-aws-china.adoc +++ b/installing/installing_aws/ipi/installing-aws-china.adoc @@ -40,7 +40,13 @@ include::modules/installation-initializing-manual.adoc[leveloffset=+1] .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-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] + include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] [role="_additional-resources"] diff --git a/installing/installing_aws/ipi/installing-aws-customizations.adoc b/installing/installing_aws/ipi/installing-aws-customizations.adoc index 0f31a04ca5..0ce90f1e86 100644 --- a/installing/installing_aws/ipi/installing-aws-customizations.adoc +++ b/installing/installing_aws/ipi/installing-aws-customizations.adoc @@ -35,6 +35,7 @@ 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] include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] @@ -48,7 +49,12 @@ include::modules/installation-aws-tested-machine-types.adoc[leveloffset=+2] include::modules/installation-aws-arm-tested-machine-types.adoc[leveloffset=+2] -include::modules/installation-aws-config-yaml.adoc[leveloffset=+2] +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] include::modules/installation-configure-proxy.adoc[leveloffset=+2] diff --git a/installing/installing_aws/ipi/installing-aws-government-region.adoc b/installing/installing_aws/ipi/installing-aws-government-region.adoc index 0734bd508d..63cdeb53c5 100644 --- a/installing/installing_aws/ipi/installing-aws-government-region.adoc +++ b/installing/installing_aws/ipi/installing-aws-government-region.adoc @@ -50,7 +50,12 @@ include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] include::modules/installation-aws-tested-machine-types.adoc[leveloffset=+2] include::modules/installation-aws-arm-tested-machine-types.adoc[leveloffset=+2] -include::modules/installation-aws-config-yaml.adoc[leveloffset=+2] +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] include::modules/installation-configure-proxy.adoc[leveloffset=+2] diff --git a/installing/installing_aws/ipi/installing-aws-network-customizations.adoc b/installing/installing_aws/ipi/installing-aws-network-customizations.adoc index 0e579a1df1..81bf34e67d 100644 --- a/installing/installing_aws/ipi/installing-aws-network-customizations.adoc +++ b/installing/installing_aws/ipi/installing-aws-network-customizations.adoc @@ -46,7 +46,12 @@ include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] include::modules/installation-aws-tested-machine-types.adoc[leveloffset=+2] include::modules/installation-aws-arm-tested-machine-types.adoc[leveloffset=+2] -include::modules/installation-aws-config-yaml.adoc[leveloffset=+2] +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] include::modules/installation-configure-proxy.adoc[leveloffset=+2] diff --git a/installing/installing_aws/ipi/installing-aws-private.adoc b/installing/installing_aws/ipi/installing-aws-private.adoc index a0a4580a74..d5c47a520c 100644 --- a/installing/installing_aws/ipi/installing-aws-private.adoc +++ b/installing/installing_aws/ipi/installing-aws-private.adoc @@ -44,7 +44,12 @@ include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] include::modules/installation-aws-tested-machine-types.adoc[leveloffset=+2] include::modules/installation-aws-arm-tested-machine-types.adoc[leveloffset=+2] -include::modules/installation-aws-config-yaml.adoc[leveloffset=+2] +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] include::modules/installation-configure-proxy.adoc[leveloffset=+2] diff --git a/installing/installing_aws/ipi/installing-aws-secret-region.adoc b/installing/installing_aws/ipi/installing-aws-secret-region.adoc index de3095c096..c75a021505 100644 --- a/installing/installing_aws/ipi/installing-aws-secret-region.adoc +++ b/installing/installing_aws/ipi/installing-aws-secret-region.adoc @@ -52,7 +52,13 @@ include::modules/installation-initializing-manual.adoc[leveloffset=+1] * 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-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] + include::modules/installation-configure-proxy.adoc[leveloffset=+2] include::modules/installation-applying-aws-security-groups.adoc[leveloffset=+2] diff --git a/installing/installing_aws/ipi/installing-aws-vpc.adoc b/installing/installing_aws/ipi/installing-aws-vpc.adoc index 8153d76cf3..e3b2e1cca7 100644 --- a/installing/installing_aws/ipi/installing-aws-vpc.adoc +++ b/installing/installing_aws/ipi/installing-aws-vpc.adoc @@ -42,7 +42,12 @@ include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] include::modules/installation-aws-tested-machine-types.adoc[leveloffset=+2] include::modules/installation-aws-arm-tested-machine-types.adoc[leveloffset=+2] -include::modules/installation-aws-config-yaml.adoc[leveloffset=+2] +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] include::modules/installation-configure-proxy.adoc[leveloffset=+2] diff --git a/installing/installing_aws/ipi/installing-restricted-networks-aws-installer-provisioned.adoc b/installing/installing_aws/ipi/installing-restricted-networks-aws-installer-provisioned.adoc index 6f8da5e08b..f918ada6ee 100644 --- a/installing/installing_aws/ipi/installing-restricted-networks-aws-installer-provisioned.adoc +++ b/installing/installing_aws/ipi/installing-restricted-networks-aws-installer-provisioned.adoc @@ -53,7 +53,12 @@ include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] * xref:../../../scalability_and_performance/optimization/optimizing-storage.adoc#optimizing-storage[Optimizing storage] -include::modules/installation-aws-config-yaml.adoc[leveloffset=+2] +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] include::modules/installation-configure-proxy.adoc[leveloffset=+2] diff --git a/modules/installation-aws-config-yaml-customizations.adoc b/modules/installation-aws-config-yaml-customizations.adoc new file mode 100644 index 0000000000..3408ee70de --- /dev/null +++ b/modules/installation-aws-config-yaml-customizations.adoc @@ -0,0 +1,50 @@ +// Module included in the following assemblies: +// +// * installing/installing_aws/ipi/installing-aws-customizations.adoc + +:_mod-docs-content-type: REFERENCE +[id="installation-aws-config-yaml-customizations_{context}"] += Sample customized install-config.yaml file for AWS + +You can customize the installation configuration file (`install-config.yaml`) to specify more details about your {product-title} cluster's platform or modify the values of the required parameters. + +[IMPORTANT] +==== +This sample YAML file is provided for reference only. You must obtain your `install-config.yaml` file by using the installation program and modify it. +For a full list and description of all installation configuration parameters, see _Installation configuration parameters for AWS_. +==== + +.Sample `install-config.yaml` file for {aws-short} +[source,yaml] +---- +apiVersion: v1 <1> +baseDomain: example.com +sshKey: ssh-ed25519 AAAA... +pullSecret: '{"auths": ...}' +metadata: + name: example-cluster +controlPlane: <2> + name: master + platform: + aws: + type: m6i.xlarge + replicas: 3 +compute: <3> +- name: worker + platform: + aws: + type: c5.4xlarge + replicas: 3 +networking: <4> + clusterNetwork: + - cidr: 10.128.0.0/14 + hostPrefix: 23 +platform: <5> + aws: + region: us-west-2 +---- +<1> Parameters at the first level of indentation apply to the cluster globally. +<2> The `controlPlane` stanza applies to control plane machines. +<3> The `compute` stanza applies to compute machines. +<4> The `networking` stanza applies to the cluster networking configuration. If you do not provide networking values, the installation program provides default values. +<5> The `platform` stanza applies to the infrastructure platform that hosts the cluster. \ No newline at end of file