Skip to content

Commit e3dbbaf

Browse files
bscott-rhopenshift-cherrypick-robot
authored and
openshift-cherrypick-robot
committed
OSDOCS-12546 unconditionalize AWS sample install config doc
1 parent 31b229a commit e3dbbaf

10 files changed

+101
-8
lines changed

installing/installing_aws/ipi/installing-aws-china.adoc

+7-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,13 @@ include::modules/installation-initializing-manual.adoc[leveloffset=+1]
4040
.Additional resources
4141
* xref:../../../installing/installing_aws/installation-config-parameters-aws.adoc#installation-config-parameters-aws[Installation configuration parameters for AWS]
4242

43-
include::modules/installation-aws-config-yaml.adoc[leveloffset=+2]
43+
include::modules/installation-aws-config-yaml-customizations.adoc[leveloffset=+2]
44+
45+
[role="_additional-resources"]
46+
.Additional resources
47+
48+
* xref:../../../installing/installing_aws/installation-config-parameters-aws.adoc#installation-config-parameters-aws[Installation configuration parameters for AWS]
49+
4450
include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2]
4551

4652
[role="_additional-resources"]

installing/installing_aws/ipi/installing-aws-customizations.adoc

+7-1
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ include::modules/installation-initializing.adoc[leveloffset=+1]
3535

3636
[role="_additional-resources"]
3737
.Additional resources
38+
3839
* xref:../../../installing/installing_aws/installation-config-parameters-aws.adoc#installation-config-parameters-aws[Installation configuration parameters for AWS]
3940

4041
include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2]
@@ -48,7 +49,12 @@ include::modules/installation-aws-tested-machine-types.adoc[leveloffset=+2]
4849

4950
include::modules/installation-aws-arm-tested-machine-types.adoc[leveloffset=+2]
5051

51-
include::modules/installation-aws-config-yaml.adoc[leveloffset=+2]
52+
include::modules/installation-aws-config-yaml-customizations.adoc[leveloffset=+2]
53+
54+
[role="_additional-resources"]
55+
.Additional resources
56+
57+
* xref:../../../installing/installing_aws/installation-config-parameters-aws.adoc#installation-config-parameters-aws[Installation configuration parameters for AWS]
5258

5359
include::modules/installation-configure-proxy.adoc[leveloffset=+2]
5460

installing/installing_aws/ipi/installing-aws-government-region.adoc

+6-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,12 @@ include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2]
5050

5151
include::modules/installation-aws-tested-machine-types.adoc[leveloffset=+2]
5252
include::modules/installation-aws-arm-tested-machine-types.adoc[leveloffset=+2]
53-
include::modules/installation-aws-config-yaml.adoc[leveloffset=+2]
53+
include::modules/installation-aws-config-yaml-customizations.adoc[leveloffset=+2]
54+
55+
[role="_additional-resources"]
56+
.Additional resources
57+
58+
* xref:../../../installing/installing_aws/installation-config-parameters-aws.adoc#installation-config-parameters-aws[Installation configuration parameters for AWS]
5459

5560
include::modules/installation-configure-proxy.adoc[leveloffset=+2]
5661

installing/installing_aws/ipi/installing-aws-network-customizations.adoc

+6-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,12 @@ include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2]
4646
include::modules/installation-aws-tested-machine-types.adoc[leveloffset=+2]
4747
include::modules/installation-aws-arm-tested-machine-types.adoc[leveloffset=+2]
4848

49-
include::modules/installation-aws-config-yaml.adoc[leveloffset=+2]
49+
include::modules/installation-aws-config-yaml-customizations.adoc[leveloffset=+2]
50+
51+
[role="_additional-resources"]
52+
.Additional resources
53+
54+
* xref:../../../installing/installing_aws/installation-config-parameters-aws.adoc#installation-config-parameters-aws[Installation configuration parameters for AWS]
5055

5156
include::modules/installation-configure-proxy.adoc[leveloffset=+2]
5257

installing/installing_aws/ipi/installing-aws-private.adoc

+6-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,12 @@ include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2]
4444
include::modules/installation-aws-tested-machine-types.adoc[leveloffset=+2]
4545
include::modules/installation-aws-arm-tested-machine-types.adoc[leveloffset=+2]
4646

47-
include::modules/installation-aws-config-yaml.adoc[leveloffset=+2]
47+
include::modules/installation-aws-config-yaml-customizations.adoc[leveloffset=+2]
48+
49+
[role="_additional-resources"]
50+
.Additional resources
51+
52+
* xref:../../../installing/installing_aws/installation-config-parameters-aws.adoc#installation-config-parameters-aws[Installation configuration parameters for AWS]
4853

4954
include::modules/installation-configure-proxy.adoc[leveloffset=+2]
5055

installing/installing_aws/ipi/installing-aws-secret-region.adoc

+7-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,13 @@ include::modules/installation-initializing-manual.adoc[leveloffset=+1]
5252
* xref:../../../installing/installing_aws/installation-config-parameters-aws.adoc#installation-config-parameters-aws[Installation configuration parameters for AWS]
5353

5454
include::modules/installation-aws-tested-machine-types.adoc[leveloffset=+2]
55-
include::modules/installation-aws-config-yaml.adoc[leveloffset=+2]
55+
include::modules/installation-aws-config-yaml-customizations.adoc[leveloffset=+2]
56+
57+
[role="_additional-resources"]
58+
.Additional resources
59+
60+
* xref:../../../installing/installing_aws/installation-config-parameters-aws.adoc#installation-config-parameters-aws[Installation configuration parameters for AWS]
61+
5662
include::modules/installation-configure-proxy.adoc[leveloffset=+2]
5763
include::modules/installation-applying-aws-security-groups.adoc[leveloffset=+2]
5864

installing/installing_aws/ipi/installing-aws-vpc.adoc

+6-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,12 @@ include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2]
4242
include::modules/installation-aws-tested-machine-types.adoc[leveloffset=+2]
4343
include::modules/installation-aws-arm-tested-machine-types.adoc[leveloffset=+2]
4444

45-
include::modules/installation-aws-config-yaml.adoc[leveloffset=+2]
45+
include::modules/installation-aws-config-yaml-customizations.adoc[leveloffset=+2]
46+
47+
[role="_additional-resources"]
48+
.Additional resources
49+
50+
* xref:../../../installing/installing_aws/installation-config-parameters-aws.adoc#installation-config-parameters-aws[Installation configuration parameters for AWS]
4651

4752
include::modules/installation-configure-proxy.adoc[leveloffset=+2]
4853

installing/installing_aws/ipi/installing-restricted-networks-aws-installer-provisioned.adoc

+6-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,12 @@ include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2]
5353

5454
* xref:../../../scalability_and_performance/optimization/optimizing-storage.adoc#optimizing-storage[Optimizing storage]
5555

56-
include::modules/installation-aws-config-yaml.adoc[leveloffset=+2]
56+
include::modules/installation-aws-config-yaml-customizations.adoc[leveloffset=+2]
57+
58+
[role="_additional-resources"]
59+
.Additional resources
60+
61+
* xref:../../../installing/installing_aws/installation-config-parameters-aws.adoc#installation-config-parameters-aws[Installation configuration parameters for AWS]
5762

5863
include::modules/installation-configure-proxy.adoc[leveloffset=+2]
5964

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing/installing_aws/ipi/installing-aws-customizations.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="installation-aws-config-yaml-customizations_{context}"]
7+
= Sample customized install-config.yaml file for AWS
8+
9+
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.
10+
11+
[IMPORTANT]
12+
====
13+
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.
14+
For a full list and description of all installation configuration parameters, see _Installation configuration parameters for AWS_.
15+
====
16+
17+
.Sample `install-config.yaml` file for {aws-short}
18+
[source,yaml]
19+
----
20+
apiVersion: v1 <1>
21+
baseDomain: example.com
22+
sshKey: ssh-ed25519 AAAA...
23+
pullSecret: '{"auths": ...}'
24+
metadata:
25+
name: example-cluster
26+
controlPlane: <2>
27+
name: master
28+
platform:
29+
aws:
30+
type: m6i.xlarge
31+
replicas: 3
32+
compute: <3>
33+
- name: worker
34+
platform:
35+
aws:
36+
type: c5.4xlarge
37+
replicas: 3
38+
networking: <4>
39+
clusterNetwork:
40+
- cidr: 10.128.0.0/14
41+
hostPrefix: 23
42+
platform: <5>
43+
aws:
44+
region: us-west-2
45+
----
46+
<1> Parameters at the first level of indentation apply to the cluster globally.
47+
<2> The `controlPlane` stanza applies to control plane machines.
48+
<3> The `compute` stanza applies to compute machines.
49+
<4> The `networking` stanza applies to the cluster networking configuration. If you do not provide networking values, the installation program provides default values.
50+
<5> The `platform` stanza applies to the infrastructure platform that hosts the cluster.

0 commit comments

Comments
 (0)