fix(ec2): Vpc.fromVpcAttributes cannot be used with EKS #12569
Merged
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
This PR has a fix similar to #12040, and introduces more explanations and safeguards around the mechanism of importing a VPC using `fromVpcAttributes()`. This is not the recommended way of importing VPCs, but many users really don't want to use lookups so we'd better make it a little safer. This PR contains: * A fix in the EKS library to have it stop logging subnet IDs to metadata if it looks like the subnet ID will lead to the aforementioned synthesis error (similar to the fix in the linked PR). * A validation in the EKS library to stop a similar-but-different error from occurring if people select multiple VPC subnet groups from a VPC imported from token lists; this can never work and we might as well tell them directly. * A metadata warning added to VPCs imported using `Vpc.fromVpcAttributes()`, to inform users that their VPC imported in this way has a good chance of not working in all cases they expect it to. * A mechanism to specify the length of deploy-time lists at synthesis time, by passing an `assumedLength` parameter to `Fn.split()`. This will produce a list that is safe for manipulation. * A note on how to use `Vpc.fromVpcAttributes()` in the `ec2` README. Fixes #12160.
|
|
github-actions
bot
added
the
@aws-cdk/aws-ec2
eladb
reviewed
Jan 18, 2021
| @@ -961,8 +961,13 @@ export class Cluster extends ClusterBase { | |||
|
|
|||
| this.vpcSubnets = props.vpcSubnets ?? [{ subnetType: ec2.SubnetType.PUBLIC }, { subnetType: ec2.SubnetType.PRIVATE }]; | |||
|
|
|||
| const selectedSubnetIds = this.vpcSubnets.map(s => this.vpc.selectSubnets(s).subnetIds); | |||
| if (selectedSubnetIds.some(Token.isUnresolved) && selectedSubnetIds.length > 1) { | |||
| throw new Error('eks.Cluster: cannot select multiple subnet groups from a VPC imported from list tokens with unknown length. Select only one subnet group, pass a length to Fn.split, or switch to Vpc.fromLookup.'); | |||
There was a problem hiding this comment.
Maybe refer to the docs for an example?
adriantaut
approved these changes
Jan 18, 2021
iliapolo
approved these changes
Jan 18, 2021
| @@ -961,8 +961,13 @@ export class Cluster extends ClusterBase { | |||
|
|
|||
| this.vpcSubnets = props.vpcSubnets ?? [{ subnetType: ec2.SubnetType.PUBLIC }, { subnetType: ec2.SubnetType.PRIVATE }]; | |||
|
|
|||
| const selectedSubnetIds = this.vpcSubnets.map(s => this.vpc.selectSubnets(s).subnetIds); | |||
There was a problem hiding this comment.
Suggested change
| const selectedSubnetIds = this.vpcSubnets.map(s => this.vpc.selectSubnets(s).subnetIds); | |
| const selectedSubnetIdsPerGroup = this.vpcSubnets.map(s => this.vpc.selectSubnets(s).subnetIds); |
Or something, the current name makes it sound like these are individual subnets.
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
mohanrajendran
pushed a commit
to mohanrajendran/aws-cdk
that referenced
this pull request
Jan 24, 2021
This PR has a fix similar to aws#12040, and introduces more explanations and safeguards around the mechanism of importing a VPC using `fromVpcAttributes()`. This is not the recommended way of importing VPCs, but many users really don't want to use lookups so we'd better make it a little safer. This PR contains: * A fix in the EKS library to have it stop logging subnet IDs to metadata if it looks like the subnet ID will lead to the aforementioned synthesis error (similar to the fix in the linked PR). * A validation in the EKS library to stop a similar-but-different error from occurring if people select multiple VPC subnet groups from a VPC imported from token lists; this can never work and we might as well tell them directly. * A metadata warning added to VPCs imported using `Vpc.fromVpcAttributes()`, to inform users that their VPC imported in this way has a good chance of not working in all cases they expect it to. * A mechanism to specify the length of deploy-time lists at synthesis time, by passing an `assumedLength` parameter to `Fn.split()`. This will produce a list that is safe for manipulation, and removes the limitations addressed by the previous bullets. * A note on how to use `Vpc.fromVpcAttributes()` in the `ec2` README. Fixes aws#12160. ---- *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.
This PR has a fix similar to #12040, and introduces more explanations
and safeguards around the mechanism of importing a VPC using
fromVpcAttributes(). This is not the recommended way of importingVPCs, but many users really don't want to use lookups so we'd better
make it a little safer.
This PR contains:
metadata if it looks like the subnet ID will lead to the
aforementioned synthesis error (similar to the fix in the linked
PR).
error from occurring if people select multiple VPC subnet groups
from a VPC imported from token lists; this can never work and we
might as well tell them directly.
Vpc.fromVpcAttributes(), to inform users that their VPC importedin this way has a good chance of not working in all cases they
expect it to.
time, by passing an
assumedLengthparameter toFn.split(). Thiswill produce a list that is safe for manipulation, and removes the limitations
addressed by the previous bullets.
Vpc.fromVpcAttributes()in theec2README.Fixes #12160.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license