Skip to content

OSDOCS-10892 adding install config params for aws subnets #93385

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 30 additions & 13 deletions modules/installation-configuration-parameters.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -1025,19 +1025,6 @@ You can add up to 25 user defined tags during installation. The remaining 25 tag
| A flag that directs in-cluster Operators to include the specified user tags in the tags of the AWS resources that the Operators create.
| Boolean values, for example `true` or `false`.


|platform:
aws:
subnets:
|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.

For a standard cluster, specify a public and a private subnet for each availability zone.

For a private cluster, specify a private subnet for each availability zone.

For clusters that use AWS Local Zones, you must add AWS Local Zone subnets to this list to ensure edge machine pool creation.
|Valid subnet IDs.

|platform:
aws:
publicIpv4Pool:
Expand All @@ -1055,6 +1042,36 @@ BYOIP can be enabled only for customized installations that have no network rest
|Prevents the S3 bucket from being deleted after completion of bootstrapping.
|`true` or `false`. The default value is `false`, which results in the S3 bucket being deleted.

|platform:
aws:
vpc:
subnets:
|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.
The subnets must be part of the same `machineNetwork[].cidr` ranges that you specify.
For a public cluster, specify a public and a private subnet for each availability zone.
For a private cluster, specify a private subnet for each availability zone.
For clusters that use AWS Local Zones, you must add AWS Local Zone subnets to this list to ensure edge machine pool creation.
|List of pairs of `id` and `roles` parameters.

|platform:
aws:
vpc:
subnets:
- id:
|The ID of an existing subnet to be used in place of a subnet created by the installation program.
|String. The subnet ID must be a unique ID containing only alphanumeric characters, beginning with "subnet-". The ID must be exactly 24 characters long.

|platform:
aws:
vpc:
subnets:
- id:
roles:
- type:
|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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs an Oxford comma here:

Suggested change
|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.
|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.

You can only assign the `EdgeNode` role to subnets in {aws-short} Local Zones.
|List of one or more role types. Valid values include `ClusterNode`, `EdgeNode`, `BootstrapNode`, `IngressControllerLB`, `ControlPlaneExternalLB`, and `ControlPlaneInternalLB`.

|====
endif::aws[]

Expand Down
13 changes: 8 additions & 5 deletions modules/installation-initializing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -471,14 +471,17 @@ additionalTrustBundle: |
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.

ifdef::aws+restricted[]
.. Define the subnets for the VPC to install the cluster in:
.. Define the subnets for the VPC to install the cluster in, as in the following example:
+
[source,yaml]
----
subnets:
- subnet-1
- subnet-2
- subnet-3
platform:
aws:
vpc:
subnets:
- id: subnet-<id1>
- id: subnet-<id2>
- id: subnet-<id3>
Comment on lines +482 to +484
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Idk if this would look better or worse, but maybe an underscore between ID and the numbers?

Suggested change
- id: subnet-<id1>
- id: subnet-<id2>
- id: subnet-<id3>
- id: subnet-<id_1>
- id: subnet-<id_2>
- id: subnet-<id_3>

Up to you

----
endif::aws+restricted[]
ifdef::azure+restricted[]
Expand Down