Skip to content

fix(eks): default capacity uses desiredCapacity which is an anti-pattern #5651

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Jan 6, 2020
Merged

fix(eks): default capacity uses desiredCapacity which is an anti-pattern #5651

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bef1b5b
fix(eks): default capacity uses desiredCapacity which is an anti-pattern
Jan 5, 2020
4c751bb
Merge branch 'master' into benisrae/eks-use-min-capacity
Jan 6, 2020
10339f3
Update integ.eks-cluster.defaults.expected.json
Jan 6, 2020
1a25bf1
Merge branch 'master' into benisrae/eks-use-min-capacity
Jan 6, 2020
ca7f7ac
Merge branch 'master' into benisrae/eks-use-min-capacity
mergify[bot] Jan 6, 2020
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
4 changes: 2 additions & 2 deletions packages/@aws-cdk/aws-eks/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ You can add customized capacity through `cluster.addCapacity()` or
```ts
cluster.addCapacity('frontend-nodes', {
instanceType: new ec2.InstanceType('t2.medium'),
desiredCapacity: 3,
minCapacity: 3,
vpcSubnets: { subnetType: ec2.SubnetType.PUBLIC }
});
```
Expand Down Expand Up @@ -125,7 +125,7 @@ you can use `kubeletExtraArgs` to add custom node labels or taints.
// up to ten spot instances
cluster.addCapacity('spot', {
instanceType: new ec2.InstanceType('t3.large'),
desiredCapacity: 2,
minCapacity: 2,
bootstrapOptions: {
kubeletExtraArgs: '--node-labels foo=bar,goo=far',
awsApiRetryAttempts: 5
Expand Down
6 changes: 3 additions & 3 deletions packages/@aws-cdk/aws-eks/lib/cluster.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -401,10 +401,10 @@ export class Cluster extends Resource implements ICluster {
}

// allocate default capacity if non-zero (or default).
const desiredCapacity = props.defaultCapacity === undefined ? DEFAULT_CAPACITY_COUNT : props.defaultCapacity;
if (desiredCapacity > 0) {
const minCapacity = props.defaultCapacity === undefined ? DEFAULT_CAPACITY_COUNT : props.defaultCapacity;
if (minCapacity > 0) {
const instanceType = props.defaultCapacityInstance || DEFAULT_CAPACITY_TYPE;
this.defaultCapacity = this.addCapacity('DefaultCapacity', { instanceType, desiredCapacity });
this.defaultCapacity = this.addCapacity('DefaultCapacity', { instanceType, minCapacity });
}

const outputConfigCommand = props.outputConfigCommand === undefined ? true : props.outputConfigCommand;
Expand Down
5 changes: 2 additions & 3 deletions packages/@aws-cdk/aws-eks/test/integ.eks-cluster.defaults.expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1039,8 +1039,7 @@
"Type": "AWS::AutoScaling::AutoScalingGroup",
"Properties": {
"MaxSize": "2",
"MinSize": "1",
"DesiredCapacity": "2",
"MinSize": "2",
"LaunchConfigurationName": {
"Ref": "ClusterDefaultCapacityLaunchConfig72790CF7"
},
Expand Down Expand Up @@ -1380,4 +1379,4 @@
"Default": "/aws/service/eks/optimized-ami/1.14/amazon-linux-2/recommended/image_id"
}
}
}
}
1 change: 0 additions & 1 deletion packages/@aws-cdk/aws-eks/test/integ.eks-cluster.kubectl-disabled.expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -941,7 +941,6 @@
"Properties": {
"MaxSize": "1",
"MinSize": "1",
"DesiredCapacity": "1",
"LaunchConfigurationName": {
"Ref": "EKSClusterNodesLaunchConfig921F1106"
},
Expand Down
2 changes: 1 addition & 1 deletion packages/@aws-cdk/aws-eks/test/integ.eks-cluster.kubectl-disabled.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ class EksClusterStack extends TestStack {

cluster.addCapacity('Nodes', {
instanceType: new ec2.InstanceType('t2.medium'),
desiredCapacity: 1, // Raise this number to add more nodes
minCapacity: 1, // Raise this number to add more nodes
});
/// !hide
}
Expand Down
1 change: 0 additions & 1 deletion packages/@aws-cdk/aws-eks/test/integ.eks-cluster.lit.expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1040,7 +1040,6 @@
"Properties": {
"MaxSize": "1",
"MinSize": "1",
"DesiredCapacity": "1",
"LaunchConfigurationName": {
"Ref": "EKSClusterNodesLaunchConfig921F1106"
},
Expand Down
2 changes: 1 addition & 1 deletion packages/@aws-cdk/aws-eks/test/integ.eks-cluster.lit.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ class EksClusterStack extends TestStack {

cluster.addCapacity('Nodes', {
instanceType: new ec2.InstanceType('t2.medium'),
desiredCapacity: 1, // Raise this number to add more nodes
minCapacity: 1, // Raise this number to add more nodes
});
/// !hide
}
Expand Down
3 changes: 1 addition & 2 deletions packages/@aws-cdk/aws-eks/test/integ.eks-helm.lit.expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -948,8 +948,7 @@
"Type": "AWS::AutoScaling::AutoScalingGroup",
"Properties": {
"MaxSize": "3",
"MinSize": "1",
"DesiredCapacity": "3",
"MinSize": "3",
"LaunchConfigurationName": {
"Ref": "cluster22NodesLaunchConfig184BF3BA"
},
Expand Down
2 changes: 1 addition & 1 deletion packages/@aws-cdk/aws-eks/test/integ.eks-helm.lit.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ class ClusterStack extends TestStack {
// automatically be mapped via aws-auth to allow nodes to join the cluster.
this.cluster.addCapacity('Nodes', {
instanceType: new ec2.InstanceType('t2.medium'),
desiredCapacity: 3,
minCapacity: 3,
});

// add two Helm charts to the cluster. This will be the Kubernetes dashboard and the Nginx Ingress Controller
Expand Down
3 changes: 1 addition & 2 deletions packages/@aws-cdk/aws-eks/test/integ.eks-kubectl.lit.expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -948,8 +948,7 @@
"Type": "AWS::AutoScaling::AutoScalingGroup",
"Properties": {
"MaxSize": "3",
"MinSize": "1",
"DesiredCapacity": "3",
"MinSize": "3",
"LaunchConfigurationName": {
"Ref": "cluster22NodesLaunchConfig184BF3BA"
},
Expand Down
2 changes: 1 addition & 1 deletion packages/@aws-cdk/aws-eks/test/integ.eks-kubectl.lit.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ class ClusterStack extends TestStack {
// automatically be mapped via aws-auth to allow nodes to join the cluster.
this.cluster.addCapacity('Nodes', {
instanceType: new ec2.InstanceType('t2.medium'),
desiredCapacity: 3,
minCapacity: 3,
});

// add an arbitrary k8s manifest to the cluster. This will `kubectl apply`
Expand Down
3 changes: 1 addition & 2 deletions packages/@aws-cdk/aws-eks/test/integ.eks-spot.expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -871,8 +871,7 @@
"Type": "AWS::AutoScaling::AutoScalingGroup",
"Properties": {
"MaxSize": "2",
"MinSize": "1",
"DesiredCapacity": "2",
"MinSize": "2",
"LaunchConfigurationName": {
"Ref": "myClusterDefaultCapacityLaunchConfigCF6D4B81"
},
Expand Down
4 changes: 2 additions & 2 deletions packages/@aws-cdk/aws-eks/test/test.cluster.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ export = {

// THEN
test.ok(cluster.defaultCapacity);
expect(stack).to(haveResource('AWS::AutoScaling::AutoScalingGroup', { DesiredCapacity: '2' }));
expect(stack).to(haveResource('AWS::AutoScaling::AutoScalingGroup', { MinSize: '2', MaxSize: '2' }));
expect(stack).to(haveResource('AWS::AutoScaling::LaunchConfiguration', { InstanceType: 'm5.large' }));
test.done();
},
Expand All @@ -72,7 +72,7 @@ export = {

// THEN
test.ok(cluster.defaultCapacity);
expect(stack).to(haveResource('AWS::AutoScaling::AutoScalingGroup', { DesiredCapacity: '10' }));
expect(stack).to(haveResource('AWS::AutoScaling::AutoScalingGroup', { MinSize: '10', MaxSize: '10' }));
expect(stack).to(haveResource('AWS::AutoScaling::LaunchConfiguration', { InstanceType: 'm2.xlarge' }));
test.done();
},
Expand Down