Skip to content

Commit d6ce7c7

Browse files
committed
OSDOCS-10892 adding install config params for aws subnets
1 parent 8945b49 commit d6ce7c7

File tree

2 files changed

+38
-18
lines changed

2 files changed

+38
-18
lines changed

modules/installation-configuration-parameters.adoc

+30-13
Original file line numberDiff line numberDiff line change
@@ -1025,19 +1025,6 @@ You can add up to 25 user defined tags during installation. The remaining 25 tag
10251025
| A flag that directs in-cluster Operators to include the specified user tags in the tags of the AWS resources that the Operators create.
10261026
| Boolean values, for example `true` or `false`.
10271027

1028-
1029-
|platform:
1030-
aws:
1031-
subnets:
1032-
|If you provide the VPC instead of allowing the installation program to create the VPC for you, specify the subnet for the cluster to use. The subnet must be part of the same `machineNetwork[].cidr` ranges that you specify.
1033-
1034-
For a standard cluster, specify a public and a private subnet for each availability zone.
1035-
1036-
For a private cluster, specify a private subnet for each availability zone.
1037-
1038-
For clusters that use AWS Local Zones, you must add AWS Local Zone subnets to this list to ensure edge machine pool creation.
1039-
|Valid subnet IDs.
1040-
10411028
|platform:
10421029
aws:
10431030
publicIpv4Pool:
@@ -1055,6 +1042,36 @@ BYOIP can be enabled only for customized installations that have no network rest
10551042
|Prevents the S3 bucket from being deleted after completion of bootstrapping.
10561043
|`true` or `false`. The default value is `false`, which results in the S3 bucket being deleted.
10571044

1045+
|platform:
1046+
aws:
1047+
vpc:
1048+
subnets:
1049+
|A list of subnets in an existing VPC to be used in place of automatically created subnets. You specify a subnet by providing the subnet ID and an optional list of roles that apply to that subnet. If you specify subnet IDs but do not specify roles for any subnet, the subnets' roles will be decided automatically. If you do not specify any roles, you must ensure that any other subnets in your VPC have the `kubernetes.io/cluster/.*: .*` or `kubernetes.io/cluster/unmanaged: true` tags.
1050+
The subnets must be part of the same `machineNetwork[].cidr` ranges that you specify.
1051+
For a public cluster, specify a public and a private subnet for each availability zone.
1052+
For a private cluster, specify a private subnet for each availability zone.
1053+
For clusters that use AWS Local Zones, you must add AWS Local Zone subnets to this list to ensure edge machine pool creation.
1054+
|List of pairs of `id` and `roles` parameters.
1055+
1056+
|platform:
1057+
aws:
1058+
vpc:
1059+
subnets:
1060+
- id:
1061+
|The ID of an existing subnet to be used in place of a subnet created by the installation program.
1062+
|String. The subnet ID must be a unique ID containing only alphanumeric characters, beginning with "subnet-". The ID must be exactly 24 characters long.
1063+
1064+
|platform:
1065+
aws:
1066+
vpc:
1067+
subnets:
1068+
- id:
1069+
roles:
1070+
- type:
1071+
|One or more roles that apply to the subnet specified by `platform.aws.vpc.subnets.id`. If you specify a role for any subnet, each subnet must have at least one assigned role, and the `ClusterNode`, `IngressControllerLB`, `ControlPlaneExternalLB`, `BootstrapNode` and `ControlPlaneInternalLB` roles must be assigned to at least one subnet. However, if the cluster scope is internal, then the `ControlPlaneExternalLB` role is not required.
1072+
You can only assign the `EdgeNode` role to subnets in {aws-short} Local Zones.
1073+
|List of one or more role types. Valid values include `ClusterNode`, `EdgeNode`, `BootstrapNode`, `IngressControllerLB`, `ControlPlaneExternalLB`, and `ControlPlaneInternalLB`.
1074+
10581075
|====
10591076
endif::aws[]
10601077

modules/installation-initializing.adoc

+8-5
Original file line numberDiff line numberDiff line change
@@ -471,14 +471,17 @@ additionalTrustBundle: |
471471
The value must be the contents of the certificate file that you used for your mirror registry. The certificate file can be an existing, trusted certificate authority, or the self-signed certificate that you generated for the mirror registry.
472472
473473
ifdef::aws+restricted[]
474-
.. Define the subnets for the VPC to install the cluster in:
474+
.. Define the subnets for the VPC to install the cluster in, as in the following example:
475475
+
476476
[source,yaml]
477477
----
478-
subnets:
479-
- subnet-1
480-
- subnet-2
481-
- subnet-3
478+
platform:
479+
aws:
480+
vpc:
481+
subnets:
482+
- id: subnet-<id1>
483+
- id: subnet-<id2>
484+
- id: subnet-<id3>
482485
----
483486
endif::aws+restricted[]
484487
ifdef::azure+restricted[]

0 commit comments

Comments
 (0)