docs(eks): remove description about incorrect requirement for vpcSubnets #27931
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
admired-contributor
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
aws-cdk-automation
added
the
pr/needs-community-review
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
aws-cdk-automation
removed
the
pr/needs-community-review
mikewrighton
pushed a commit
that referenced
this pull request
Nov 13, 2023
…ets (#27931) It seems that the description for vpcSubnets in EKS Cluster class includes incorrect requirement. https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_eks.Cluster.html#vpcsubnets > If you want to create public load balancers, this must include public subnets. The requirements for subnets where control plane ENIs are placed are described in the following document. https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html#network-requirements-subnets > The subnets that you specify when you create or update a cluster must meet the following requirements: > > The subnets must each have at least six IP addresses for use by Amazon EKS. However, we recommend at least 16 IP addresses. > The subnets can't reside in AWS Outposts, AWS Wavelength, or an AWS Local Zone. However, if you have them in your VPC, you can deploy self-managed nodes and Kubernetes resources to these types of subnets. > The subnets can be a public or private. However, we recommend that you specify private subnets, if possible. A public subnet is a subnet with a route table that includes a route to an internet gateway, whereas a private subnet is a subnet with a route table that doesn't include a route to an internet gateway. Other components such as nodes, Kubernetes resources or ELB can be located in different subnets from the above subnets. This is also described in the above document as below. > You can deploy nodes and Kubernetes resources to the same subnets that you specify when you create your cluster. However, this isn't necessary. This is because you can also deploy nodes and Kubernetes resources to subnets that you didn't specify when you created the cluster. So, this PR simply removes the incorrect sentence from CDK doc. Closes #27923 ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It seems that the description for vpcSubnets in EKS Cluster class includes incorrect requirement.
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_eks.Cluster.html#vpcsubnets
The requirements for subnets where control plane ENIs are placed are described in the following document.
https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html#network-requirements-subnets
Other components such as nodes, Kubernetes resources or ELB can be located in different subnets from the above subnets. This is also described in the above document as below.
So, this PR simply removes the incorrect sentence from CDK doc.
Closes #27923
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license