feat(aws-eks): add construct library for EKS (#1655)

Construct library to set up an EKS cluster and add nodes to it.

Generalizes adding AutoScalingGroup capacity and make it the same
between both ECS and EKS clusters. Fixes naming inconsistencies
among properties of `AutoScalingGroup`, and between EC2 AutoScaling and
Application AutoScaling.

This PR takes #991 but reimplements the API in the style of the ECS library.

BREAKING CHANGE: For `AutoScalingGroup`, renamed `minSize` =>
`minCapacity`, `maxSize` => `maxCapacity`, for consistency with
`desiredCapacity` and also Application AutoScaling.

For ECS's `addDefaultAutoScalingGroupCapacity()`, `instanceCount` =>
`desiredCapacity` and the function now takes an ID (pass
`"DefaultAutoScalingGroup"` to avoid interruption to your deployments).

Author: rix0rrr

packages/@aws-cdk/aws-autoscaling/lib/auto-scaling-group.ts

@@ -18,27 +18,25 @@ import { BaseTargetTrackingProps, PredefinedMetric, TargetTrackingScalingPolicy
 const NAME_TAG: string = 'Name';
 
 /**
- * Properties of a Fleet
+ * Basic properties of an AutoScalingGroup, except the exact machines to run and where they should run
+ *
+ * Constructs that want to create AutoScalingGroups can inherit
+ * this interface and specialize the essential parts in various ways.
  */
-export interface AutoScalingGroupProps {
-  /**
-   * Type of instance to launch
-   */
-  instanceType: ec2.InstanceType;
-
+export interface CommonAutoScalingGroupProps {
   /**
    * Minimum number of instances in the fleet
    *
    * @default 1
    */
-  minSize?: number;
+  minCapacity?: number;
 
   /**
    * Maximum number of instances in the fleet
    *
    * @default desiredCapacity
    */
-  maxSize?: number;
+  maxCapacity?: number;
 
   /**
    * Initial amount of instances in the fleet
@@ -52,16 +50,6 @@ export interface AutoScalingGroupProps {
    */
   keyName?: string;
 
-  /**
-   * AMI to launch
-   */
-  machineImage: ec2.IMachineImageSource;
-
-  /**
-   * VPC to launch these instances in.
-   */
-  vpc: ec2.IVpcNetwork;
-
   /**
    * Where to place instances within the VPC
    */
@@ -153,6 +141,26 @@ export interface AutoScalingGroupProps {
   associatePublicIpAddress?: boolean;
 }
 
+/**
+ * Properties of a Fleet
+ */
+export interface AutoScalingGroupProps extends CommonAutoScalingGroupProps {
+  /**
+   * VPC to launch these instances in.
+   */
+  vpc: ec2.IVpcNetwork;
+
+  /**
+   * Type of instance to launch
+   */
+  instanceType: ec2.InstanceType;
+
+  /**
+   * AMI to launch
+   */
+  machineImage: ec2.IMachineImageSource;
+}
+
 /**
  * A Fleet represents a managed set of EC2 instances
  *
@@ -236,19 +244,19 @@ export class AutoScalingGroup extends cdk.Construct implements IAutoScalingGroup
 
     const desiredCapacity =
         (props.desiredCapacity !== undefined ? props.desiredCapacity :
-        (props.minSize !== undefined ? props.minSize :
-        (props.maxSize !== undefined ? props.maxSize : 1)));
-    const minSize = props.minSize !== undefined ? props.minSize : 1;
-    const maxSize = props.maxSize !== undefined ? props.maxSize : desiredCapacity;
+        (props.minCapacity !== undefined ? props.minCapacity :
+        (props.maxCapacity !== undefined ? props.maxCapacity : 1)));
+    const minCapacity = props.minCapacity !== undefined ? props.minCapacity : 1;
+    const maxCapacity = props.maxCapacity !== undefined ? props.maxCapacity : desiredCapacity;
 
-    if (desiredCapacity < minSize || desiredCapacity > maxSize) {
-      throw new Error(`Should have minSize (${minSize}) <= desiredCapacity (${desiredCapacity}) <= maxSize (${maxSize})`);
+    if (desiredCapacity < minCapacity || desiredCapacity > maxCapacity) {
+      throw new Error(`Should have minCapacity (${minCapacity}) <= desiredCapacity (${desiredCapacity}) <= maxCapacity (${maxCapacity})`);
     }
 
     const asgProps: CfnAutoScalingGroupProps = {
       cooldown: props.cooldownSeconds !== undefined ? `${props.cooldownSeconds}` : undefined,
-      minSize: minSize.toString(),
-      maxSize: maxSize.toString(),
+      minSize: minCapacity.toString(),
+      maxSize: maxCapacity.toString(),
       desiredCapacity: desiredCapacity.toString(),
       launchConfigurationName: launchConfig.ref,
       loadBalancerNames: new cdk.Token(() => this.loadBalancerNames.length > 0 ? this.loadBalancerNames : undefined),

packages/@aws-cdk/aws-autoscaling/test/test.auto-scaling-group.ts

@@ -126,16 +126,16 @@ export = {
     test.done();
   },
 
-  'can set minSize, maxSize, desiredCapacity to 0'(test: Test) {
+  'can set minCapacity, maxCapacity, desiredCapacity to 0'(test: Test) {
     const stack = new cdk.Stack(undefined, 'MyStack', { env: { region: 'us-east-1', account: '1234' }});
     const vpc = mockVpc(stack);
 
     new autoscaling.AutoScalingGroup(stack, 'MyFleet', {
       instanceType: new ec2.InstanceTypePair(ec2.InstanceClass.M4, ec2.InstanceSize.Micro),
       machineImage: new ec2.AmazonLinuxImage(),
       vpc,
-      minSize: 0,
-      maxSize: 0,
+      minCapacity: 0,
+      maxCapacity: 0,
       desiredCapacity: 0
     });
 
@@ -159,7 +159,7 @@ export = {
       instanceType: new ec2.InstanceTypePair(ec2.InstanceClass.M4, ec2.InstanceSize.Micro),
       machineImage: new ec2.AmazonLinuxImage(),
       vpc,
-      minSize: 10
+      minCapacity: 10
     });
 
     // THEN
@@ -183,7 +183,7 @@ export = {
       instanceType: new ec2.InstanceTypePair(ec2.InstanceClass.M4, ec2.InstanceSize.Micro),
       machineImage: new ec2.AmazonLinuxImage(),
       vpc,
-      maxSize: 10
+      maxCapacity: 10
     });
 
     // THEN
@@ -415,8 +415,8 @@ export = {
       instanceType: new ec2.InstanceTypePair(ec2.InstanceClass.M4, ec2.InstanceSize.Micro),
       machineImage: new ec2.AmazonLinuxImage(),
       vpc,
-      minSize: 0,
-      maxSize: 0,
+      minCapacity: 0,
+      maxCapacity: 0,
       desiredCapacity: 0,
       associatePublicIpAddress: true,
     });
@@ -438,8 +438,8 @@ export = {
       instanceType: new ec2.InstanceTypePair(ec2.InstanceClass.M4, ec2.InstanceSize.Micro),
       machineImage: new ec2.AmazonLinuxImage(),
       vpc,
-      minSize: 0,
-      maxSize: 0,
+      minCapacity: 0,
+      maxCapacity: 0,
       desiredCapacity: 0,
       associatePublicIpAddress: false,
     });
@@ -461,8 +461,8 @@ export = {
       instanceType: new ec2.InstanceTypePair(ec2.InstanceClass.M4, ec2.InstanceSize.Micro),
       machineImage: new ec2.AmazonLinuxImage(),
       vpc,
-      minSize: 0,
-      maxSize: 0,
+      minCapacity: 0,
+      maxCapacity: 0,
       desiredCapacity: 0,
     });
 

packages/@aws-cdk/aws-ec2/lib/machine-image.ts

@@ -190,7 +190,7 @@ export class GenericLinuxImage implements IMachineImageSource  {
   public getImage(scope: Construct): MachineImage {
     const stack = Stack.find(scope);
     const region = stack.requireRegion('AMI cannot be determined');
-    const ami = this.amiMap[region];
+    const ami = region !== 'test-region' ? this.amiMap[region] : 'ami-12345';
     if (!ami) {
       throw new Error(`Unable to find AMI in AMI map: no AMI specified for region '${region}'`);
     }

packages/@aws-cdk/aws-ecs/README.md

@@ -21,7 +21,7 @@ const cluster = new ecs.Cluster(this, 'Cluster', {
 });
 
 // Add capacity to it
-cluster.addDefaultAutoScalingGroupCapacity({
+cluster.addDefaultAutoScalingGroupCapacity('Capacity', {
   instanceType: new ec2.InstanceType("t2.xlarge"),
   instanceCount: 3,
 });

packages/@aws-cdk/aws-ecs/lib/cluster.ts

@@ -74,15 +74,13 @@ export class Cluster extends cdk.Construct implements ICluster {
    *
    * Returns the AutoScalingGroup so you can add autoscaling settings to it.
    */
-  public addDefaultAutoScalingGroupCapacity(options: AddDefaultAutoScalingGroupOptions): autoscaling.AutoScalingGroup {
-    const autoScalingGroup = new autoscaling.AutoScalingGroup(this, 'DefaultAutoScalingGroup', {
+  public addDefaultAutoScalingGroupCapacity(id: string, options: AddDefaultAutoScalingGroupOptions): autoscaling.AutoScalingGroup {
+    const autoScalingGroup = new autoscaling.AutoScalingGroup(this, id, {
+      ...options,
       vpc: this.vpc,
-      instanceType: options.instanceType,
       machineImage: new EcsOptimizedAmi(),
-      updateType: autoscaling.UpdateType.ReplacingUpdate,
-      minSize: options.minCapacity,
-      maxSize: options.maxCapacity,
-      desiredCapacity: options.instanceCount,
+      updateType: options.updateType || autoscaling.UpdateType.ReplacingUpdate,
+      instanceType: options.instanceType,
     });
 
     this.addAutoScalingGroupCapacity(autoScalingGroup, options);
@@ -375,31 +373,9 @@ export interface AddAutoScalingGroupCapacityOptions {
 /**
  * Properties for adding autoScalingGroup
  */
-export interface AddDefaultAutoScalingGroupOptions extends AddAutoScalingGroupCapacityOptions {
-
+export interface AddDefaultAutoScalingGroupOptions extends AddAutoScalingGroupCapacityOptions, autoscaling.CommonAutoScalingGroupProps {
   /**
    * The type of EC2 instance to launch into your Autoscaling Group
    */
   instanceType: ec2.InstanceType;
-
-  /**
-   * Number of container instances registered in your ECS Cluster
-   *
-   * @default 1
-   */
-  instanceCount?: number;
-
-  /**
-   * Maximum number of instances
-   *
-   * @default Same as instanceCount
-   */
-  maxCapacity?: number;
-
-  /**
-   * Minimum number of instances
-   *
-   * @default Same as instanceCount
-   */
-  minCapacity?: number;
 }

packages/@aws-cdk/aws-ecs/test/ec2/integ.event-task.lit.ts

@@ -12,7 +12,7 @@ class EventStack extends cdk.Stack {
     const vpc = new ec2.VpcNetwork(this, 'Vpc', { maxAZs: 1 });
 
     const cluster = new ecs.Cluster(this, 'EcsCluster', { vpc });
-    cluster.addDefaultAutoScalingGroupCapacity({
+    cluster.addDefaultAutoScalingGroupCapacity('DefaultAutoScalingGroup', {
       instanceType: new ec2.InstanceType('t2.micro')
     });
 

packages/@aws-cdk/aws-ecs/test/ec2/integ.lb-awsvpc-nw.ts

@@ -10,7 +10,7 @@ const stack = new cdk.Stack(app, 'aws-ecs-integ');
 const vpc = new ec2.VpcNetwork(stack, 'Vpc', { maxAZs: 2 });
 
 const cluster = new ecs.Cluster(stack, 'EcsCluster', { vpc });
-cluster.addDefaultAutoScalingGroupCapacity({
+cluster.addDefaultAutoScalingGroupCapacity('DefaultAutoScalingGroup', {
   instanceType: new ec2.InstanceType('t2.micro')
 });
 

packages/@aws-cdk/aws-ecs/test/ec2/integ.lb-bridge-nw.ts

@@ -10,7 +10,7 @@ const stack = new cdk.Stack(app, 'aws-ecs-integ-ecs');
 const vpc = new ec2.VpcNetwork(stack, 'Vpc', { maxAZs: 2 });
 
 const cluster = new ecs.Cluster(stack, 'EcsCluster', { vpc });
-cluster.addDefaultAutoScalingGroupCapacity({
+cluster.addDefaultAutoScalingGroupCapacity('DefaultAutoScalingGroup', {
   instanceType: new ec2.InstanceType('t2.micro')
 });
 
@@ -44,4 +44,4 @@ listener.addTargets('ECS', {
 
 new cdk.Output(stack, 'LoadBalancerDNS', { value: lb.dnsName, });
 
-app.run();
+app.run();

packages/@aws-cdk/aws-ecs/test/ec2/test.ec2-event-rule-target.ts

@@ -11,7 +11,7 @@ export = {
     const stack = new cdk.Stack();
     const vpc = new ec2.VpcNetwork(stack, 'Vpc', { maxAZs: 1 });
     const cluster = new ecs.Cluster(stack, 'EcsCluster', { vpc });
-    cluster.addDefaultAutoScalingGroupCapacity({
+    cluster.addDefaultAutoScalingGroupCapacity('DefaultAutoScalingGroup', {
       instanceType: new ec2.InstanceType('t2.micro')
     });
 
@@ -58,4 +58,4 @@ export = {
 
     test.done();
   }
-};
+};