fix: Remove DockerHub constructor class (#1153)

We always recommended using `ContainerImage.fromDockerHub()` in the README, but examples were still showing the old syntax. BREAKING CHANGE: If you were using `DockerHub.image()` to reference docker hub images, use `ContainerImage.fromDockerHub()` instead.
aws · Nov 13, 2018 · ed14638 · ed14638
1 parent fbb091a
commit ed14638
Show file tree

Hide file tree

Showing 13 changed files with 55 additions and 65 deletions.
diff --git a/examples/cdk-examples-typescript/hello-cdk-ecs/index.ts b/examples/cdk-examples-typescript/hello-cdk-ecs/index.ts
@@ -22,9 +22,11 @@ class BonjourECS extends cdk.Stack {
     const ecsService = new ecs.LoadBalancedEc2Service(this, "Ec2Service", {
       cluster,
       memoryLimitMiB: 512,
-      image: ecs.DockerHub.image("amazon/amazon-ecs-sample"),
+      image: ecs.ContainerImage.fromDockerHub("amazon/amazon-ecs-sample"),
     });
 
+    // ecsService.addTracing
+
     // Output the DNS where you can access your service
     new cdk.Output(this, 'LoadBalancerDNS', { value: ecsService.loadBalancer.dnsName });
   }

diff --git a/examples/cdk-examples-typescript/hello-cdk-fargate/index.ts b/examples/cdk-examples-typescript/hello-cdk-fargate/index.ts
@@ -14,7 +14,7 @@ class BonjourFargate extends cdk.Stack {
     // Instantiate Fargate Service with just cluster and image
     const fargateService = new ecs.LoadBalancedFargateService(this, "FargateService", {
       cluster,
-      image: ecs.DockerHub.image("amazon/amazon-ecs-sample"),
+      image: ecs.ContainerImage.fromDockerHub("amazon/amazon-ecs-sample"),
     });
 
     // Output the DNS where you can access your service

diff --git a/packages/@aws-cdk/aws-ecs/README.md b/packages/@aws-cdk/aws-ecs/README.md
@@ -166,12 +166,12 @@ const taskDefinition = new ecs.TaskDefinition(this, 'TaskDef', {
 #### Images
 
 Images supply the software that runs inside the container. Images can be
-obtained from either DockerHub or from ECR repositories:
+obtained from either DockerHub or from ECR repositories, or built directly from a local Dockerfile.
 
 * `ecs.ContainerImage.fromDockerHub(imageName)`: use a publicly available image from
   DockerHub.
-* `ecs.ContaienrImage.fromEcrRepository(repo, tag)`: use the given ECR repository as the image
-  to start.
+* `ecs.ContainerImage.fromEcrRepository(repo, tag)`: use the given ECR repository as the image
+  to start. If no tag is provided, "latest" is assumed.
 * `ecs.ContainerImage.fromAsset(this, 'Image', { directory: './image' })`: build and upload an
   image directly from a `Dockerfile` in your source directory.
 
@@ -240,4 +240,4 @@ EC2 instance group so that your instance count scales with demand.
 
 - [ ] Instance AutoScaling
 - [ ] Service Discovery Integration
-- [ ] Private registry authentication
+- [ ] Private registry authentication
diff --git a/packages/@aws-cdk/aws-ecs/lib/images/dockerhub.ts b/packages/@aws-cdk/aws-ecs/lib/images/dockerhub.ts
@@ -1,18 +1,6 @@
 import { ContainerDefinition } from "../container-definition";
 import { IContainerImage } from "../container-image";
 
-/**
- * Factory for DockerHub images
- */
-export class DockerHub {
-  /**
-   * Reference an image on DockerHub
-   */
-  public static image(name: string): IContainerImage {
-    return new DockerHubImage(name);
-  }
-}
-
 /**
  * A DockerHub image
  */

diff --git a/packages/@aws-cdk/aws-ecs/lib/load-balanced-fargate-service-applet.ts b/packages/@aws-cdk/aws-ecs/lib/load-balanced-fargate-service-applet.ts
@@ -1,7 +1,7 @@
 import ec2 = require('@aws-cdk/aws-ec2');
 import cdk = require('@aws-cdk/cdk');
 import { Cluster } from './cluster';
-import { DockerHub } from './images/dockerhub';
+import { ContainerImage } from './container-image';
 import { LoadBalancedFargateService } from './load-balanced-fargate-service';
 
 /**
@@ -97,7 +97,7 @@ export class LoadBalancedFargateServiceApplet extends cdk.Stack {
       memoryMiB: props.memoryMiB,
       publicLoadBalancer: props.publicLoadBalancer,
       publicTasks: props.publicTasks,
-      image: DockerHub.image(props.image),
+      image: ContainerImage.fromDockerHub(props.image),
       desiredCount: props.desiredCount,
     });
   }

diff --git a/packages/@aws-cdk/aws-ecs/test/ec2/integ.lb-awsvpc-nw.ts b/packages/@aws-cdk/aws-ecs/test/ec2/integ.lb-awsvpc-nw.ts
@@ -19,7 +19,7 @@ const taskDefinition = new ecs.Ec2TaskDefinition(stack, 'TaskDef', {
 });
 
 const container = taskDefinition.addContainer('web', {
-  image: ecs.DockerHub.image("amazon/amazon-ecs-sample"),
+  image: ecs.ContainerImage.fromDockerHub("amazon/amazon-ecs-sample"),
   memoryLimitMiB: 256,
 });
 
@@ -42,4 +42,4 @@ listener.addTargets('ECS', {
 
 new cdk.Output(stack, 'LoadBalancerDNS', { value: lb.dnsName, });
 
-app.run();
+app.run();
diff --git a/packages/@aws-cdk/aws-ecs/test/ec2/integ.lb-bridge-nw.ts b/packages/@aws-cdk/aws-ecs/test/ec2/integ.lb-bridge-nw.ts
@@ -21,7 +21,7 @@ const taskDefinition = new ecs.Ec2TaskDefinition(stack, 'TaskDef', {
 });
 
 const container = taskDefinition.addContainer('web', {
-  image: ecs.DockerHub.image("amazon/amazon-ecs-sample"),
+  image: ecs.ContainerImage.fromDockerHub("amazon/amazon-ecs-sample"),
   memoryLimitMiB: 256,
 });
 container.addPortMappings({

diff --git a/packages/@aws-cdk/aws-ecs/test/ec2/test.ec2-service.ts b/packages/@aws-cdk/aws-ecs/test/ec2/test.ec2-service.ts
@@ -17,7 +17,7 @@ export = {
       const taskDefinition = new ecs.Ec2TaskDefinition(stack, 'Ec2TaskDef');
 
       taskDefinition.addContainer("web", {
-        image: ecs.DockerHub.image("amazon/amazon-ecs-sample"),
+        image: ecs.ContainerImage.fromDockerHub("amazon/amazon-ecs-sample"),
         memoryLimitMiB: 512
       });
 
@@ -97,7 +97,7 @@ export = {
       const taskDefinition = new ecs.Ec2TaskDefinition(stack, 'Ec2TaskDef');
 
       taskDefinition.addContainer("web", {
-        image: ecs.DockerHub.image("amazon/amazon-ecs-sample"),
+        image: ecs.ContainerImage.fromDockerHub("amazon/amazon-ecs-sample"),
         memoryLimitMiB: 512
       });
 
@@ -127,7 +127,7 @@ export = {
         });
 
         taskDefinition.addContainer("web", {
-          image: ecs.DockerHub.image("amazon/amazon-ecs-sample"),
+          image: ecs.ContainerImage.fromDockerHub("amazon/amazon-ecs-sample"),
           memoryLimitMiB: 512
         });
 
@@ -159,7 +159,7 @@ export = {
         });
 
         taskDefinition.addContainer("web", {
-          image: ecs.DockerHub.image("amazon/amazon-ecs-sample"),
+          image: ecs.ContainerImage.fromDockerHub("amazon/amazon-ecs-sample"),
           memoryLimitMiB: 512
         });
 
@@ -210,7 +210,7 @@ export = {
         });
 
         taskDefinition.addContainer("web", {
-          image: ecs.DockerHub.image("amazon/amazon-ecs-sample"),
+          image: ecs.ContainerImage.fromDockerHub("amazon/amazon-ecs-sample"),
           memoryLimitMiB: 512
         });
 
@@ -236,7 +236,7 @@ export = {
       const taskDefinition = new ecs.Ec2TaskDefinition(stack, 'Ec2TaskDef');
 
       taskDefinition.addContainer("web", {
-        image: ecs.DockerHub.image("amazon/amazon-ecs-sample"),
+        image: ecs.ContainerImage.fromDockerHub("amazon/amazon-ecs-sample"),
         memoryLimitMiB: 512
       });
 
@@ -265,7 +265,7 @@ export = {
       const taskDefinition = new ecs.Ec2TaskDefinition(stack, 'Ec2TaskDef');
 
       taskDefinition.addContainer("web", {
-        image: ecs.DockerHub.image("amazon/amazon-ecs-sample"),
+        image: ecs.ContainerImage.fromDockerHub("amazon/amazon-ecs-sample"),
         memoryLimitMiB: 512
       });
 
@@ -296,7 +296,7 @@ export = {
       const taskDefinition = new ecs.Ec2TaskDefinition(stack, 'Ec2TaskDef');
 
       taskDefinition.addContainer("web", {
-        image: ecs.DockerHub.image("amazon/amazon-ecs-sample"),
+        image: ecs.ContainerImage.fromDockerHub("amazon/amazon-ecs-sample"),
         memoryLimitMiB: 512
       });
 
@@ -327,7 +327,7 @@ export = {
       const taskDefinition = new ecs.Ec2TaskDefinition(stack, 'Ec2TaskDef');
 
       taskDefinition.addContainer("web", {
-        image: ecs.DockerHub.image("amazon/amazon-ecs-sample"),
+        image: ecs.ContainerImage.fromDockerHub("amazon/amazon-ecs-sample"),
         memoryLimitMiB: 512
       });
 
@@ -354,7 +354,7 @@ export = {
       const taskDefinition = new ecs.Ec2TaskDefinition(stack, 'Ec2TaskDef');
 
       taskDefinition.addContainer("web", {
-        image: ecs.DockerHub.image("amazon/amazon-ecs-sample"),
+        image: ecs.ContainerImage.fromDockerHub("amazon/amazon-ecs-sample"),
         memoryLimitMiB: 512
       });
 
@@ -384,7 +384,7 @@ export = {
       const taskDefinition = new ecs.Ec2TaskDefinition(stack, 'Ec2TaskDef');
 
       taskDefinition.addContainer("web", {
-        image: ecs.DockerHub.image("amazon/amazon-ecs-sample"),
+        image: ecs.ContainerImage.fromDockerHub("amazon/amazon-ecs-sample"),
         memoryLimitMiB: 512
       });
 
@@ -411,7 +411,7 @@ export = {
       const taskDefinition = new ecs.Ec2TaskDefinition(stack, 'Ec2TaskDef');
 
       taskDefinition.addContainer("web", {
-        image: ecs.DockerHub.image("amazon/amazon-ecs-sample"),
+        image: ecs.ContainerImage.fromDockerHub("amazon/amazon-ecs-sample"),
         memoryLimitMiB: 512
       });
 
@@ -442,7 +442,7 @@ export = {
       const taskDefinition = new ecs.Ec2TaskDefinition(stack, 'Ec2TaskDef');
 
       taskDefinition.addContainer("web", {
-        image: ecs.DockerHub.image("amazon/amazon-ecs-sample"),
+        image: ecs.ContainerImage.fromDockerHub("amazon/amazon-ecs-sample"),
         memoryLimitMiB: 512
       });
 
@@ -470,7 +470,7 @@ export = {
       cluster.addDefaultAutoScalingGroupCapacity({ instanceType: new ec2.InstanceType('t2.micro') });
       const taskDefinition = new ecs.Ec2TaskDefinition(stack, 'TD', { networkMode: ecs.NetworkMode.Host });
       const container = taskDefinition.addContainer('web', {
-        image: ecs.DockerHub.image('test'),
+        image: ecs.ContainerImage.fromDockerHub('test'),
         memoryLimitMiB: 1024,
       });
       container.addPortMappings({ containerPort: 808 });

diff --git a/packages/@aws-cdk/aws-ecs/test/ec2/test.ec2-task-definition.ts b/packages/@aws-cdk/aws-ecs/test/ec2/test.ec2-task-definition.ts
@@ -48,7 +48,7 @@ export = {
       const taskDefinition = new ecs.Ec2TaskDefinition(stack, 'Ec2TaskDef');
 
       const container = taskDefinition.addContainer("web", {
-        image: ecs.DockerHub.image("amazon/amazon-ecs-sample"),
+        image: ecs.ContainerImage.fromDockerHub("amazon/amazon-ecs-sample"),
         memoryLimitMiB: 512 // add validation?
       });
 
@@ -104,7 +104,7 @@ export = {
       const taskDefinition = new ecs.Ec2TaskDefinition(stack, 'Ec2TaskDef');
 
       const container = taskDefinition.addContainer("web", {
-        image: ecs.DockerHub.image("amazon/amazon-ecs-sample"),
+        image: ecs.ContainerImage.fromDockerHub("amazon/amazon-ecs-sample"),
         memoryLimitMiB: 512
       });
 
@@ -154,7 +154,7 @@ export = {
       });
 
       const container = taskDefinition.addContainer("web", {
-        image: ecs.DockerHub.image("amazon/amazon-ecs-sample"),
+        image: ecs.ContainerImage.fromDockerHub("amazon/amazon-ecs-sample"),
         memoryLimitMiB: 512
       });
 
@@ -200,7 +200,7 @@ export = {
 
       taskDefinition.addContainer("web", {
         memoryLimitMiB: 1024,
-        image: ecs.DockerHub.image("amazon/amazon-ecs-sample")
+        image: ecs.ContainerImage.fromDockerHub("amazon/amazon-ecs-sample")
       });
 
       // THEN
@@ -226,7 +226,7 @@ export = {
     //   });
 
     //   taskDefinition.addContainer("web", {
-    //     image: ecs.DockerHub.image("amazon/amazon-ecs-sample"),
+    //     image: ecs.ContainerImage.fromDockerHub("amazon/amazon-ecs-sample"),
     //     memoryLimitMiB: 512
     //   });
 
@@ -243,7 +243,7 @@ export = {
     //   const stack = new cdk.Stack();
     //   const taskDefinition = new ecs.Ec2TaskDefinition(stack, 'Ec2TaskDef', {});
     //   const container = taskDefinition.addContainer("web", {
-    //     image: ecs.DockerHub.image("amazon/amazon-ecs-sample"),
+    //     image: ecs.ContainerImage.fromDockerHub("amazon/amazon-ecs-sample"),
     //     memoryLimitMiB: 512 // add validation?
     //   });
 

diff --git a/packages/@aws-cdk/aws-ecs/test/fargate/integ.lb-awsvpc-nw.ts b/packages/@aws-cdk/aws-ecs/test/fargate/integ.lb-awsvpc-nw.ts
@@ -16,7 +16,7 @@ const taskDefinition = new ecs.FargateTaskDefinition(stack, 'TaskDef', {
 });
 
 const container = taskDefinition.addContainer('web', {
-  image: ecs.DockerHub.image("amazon/amazon-ecs-sample"),
+  image: ecs.ContainerImage.fromDockerHub("amazon/amazon-ecs-sample"),
 });
 
 container.addPortMappings({

diff --git a/packages/@aws-cdk/aws-ecs/test/fargate/test.fargate-service.ts b/packages/@aws-cdk/aws-ecs/test/fargate/test.fargate-service.ts
@@ -14,7 +14,7 @@ export = {
       const taskDefinition = new ecs.FargateTaskDefinition(stack, 'FargateTaskDef');
 
       taskDefinition.addContainer("web", {
-        image: ecs.DockerHub.image("amazon/amazon-ecs-sample"),
+        image: ecs.ContainerImage.fromDockerHub("amazon/amazon-ecs-sample"),
       });
 
       new ecs.FargateService(stack, "FargateService", {
@@ -107,7 +107,7 @@ export = {
       const taskDefinition = new ecs.FargateTaskDefinition(stack, 'FargateTaskDef');
 
       taskDefinition.addContainer("web", {
-        image: ecs.DockerHub.image("amazon/amazon-ecs-sample"),
+        image: ecs.ContainerImage.fromDockerHub("amazon/amazon-ecs-sample"),
       });
 
       new ecs.FargateService(stack, "FargateService", {
@@ -128,4 +128,4 @@ export = {
       test.done();
     },
   }
-};
+};