4.0.1 • Published 6 months ago

cdk-ecr-deployment v4.0.1

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
6 months ago

cdk-ecr-deployment

Release npm version PyPI npm PyPI - Downloads

CDK construct to synchronize single docker image between docker registries.

!IMPORTANT

Please use the latest version of this package, which is v4.

(Older versions are no longer supported).

Features

  • Copy image from ECR/external registry to (another) ECR/external registry
  • Copy an archive tarball image from s3 to ECR/external registry

Examples

import { DockerImageAsset } from 'aws-cdk-lib/aws-ecr-assets';

const image = new DockerImageAsset(this, 'CDKDockerImage', {
  directory: path.join(__dirname, 'docker'),
});

// Copy from cdk docker image asset to another ECR.
new ecrdeploy.ECRDeployment(this, 'DeployDockerImage1', {
  src: new ecrdeploy.DockerImageName(image.imageUri),
  dest: new ecrdeploy.DockerImageName(`${cdk.Aws.ACCOUNT_ID}.dkr.ecr.us-west-2.amazonaws.com/my-nginx:latest`),
});

// Copy from docker registry to ECR.
new ecrdeploy.ECRDeployment(this, 'DeployDockerImage2', {
  src: new ecrdeploy.DockerImageName('nginx:latest'),
  dest: new ecrdeploy.DockerImageName(`${cdk.Aws.ACCOUNT_ID}.dkr.ecr.us-west-2.amazonaws.com/my-nginx2:latest`),
});

// Copy from private docker registry to ECR.
// The format of secret in aws secrets manager must be either:
// - plain text in format <username>:<password>
// - json in format {"username":"<username>","password":"<password>"}
new ecrdeploy.ECRDeployment(this, 'DeployDockerImage3', {
  src: new ecrdeploy.DockerImageName('javacs3/nginx:latest', 'username:password'),
  // src: new ecrdeploy.DockerImageName('javacs3/nginx:latest', 'aws-secrets-manager-secret-name'),
  // src: new ecrdeploy.DockerImageName('javacs3/nginx:latest', 'arn:aws:secretsmanager:us-west-2:000000000000:secret:id'),
  dest: new ecrdeploy.DockerImageName(`${cdk.Aws.ACCOUNT_ID}.dkr.ecr.us-west-2.amazonaws.com/my-nginx3:latest`),
}).addToPrincipalPolicy(new iam.PolicyStatement({
  effect: iam.Effect.ALLOW,
  actions: [
    'secretsmanager:GetSecretValue',
  ],
  resources: ['*'],
}));

Sample: test/example.ecr-deployment.ts

After cloning the repository, install dependencies and run a full build:

yarn --frozen-lockfile --check-files
yarn build

Then run the example like this:

# Run the following command to try the sample.
npx cdk deploy -a "npx ts-node -P tsconfig.dev.json --prefer-ts-exts test/example.ecr-deployment.ts"

To run the DockerHub example you will first need to setup a Secret in AWS Secrets Manager to provide DockerHub credentials. Replace username:access-token with your credentials. Please note that Secrets will occur a cost.

aws secretsmanager create-secret --name DockerHubCredentials --secret-string "username:access-token"

From the output, copy the ARN of your new secret and export it as env variable

export DOCKERHUB_SECRET_ARN="<ARN>"

Finally run:

# Run the following command to try the sample.
npx cdk deploy -a "npx ts-node -P tsconfig.dev.json --prefer-ts-exts test/dockerhub-example.ecr-deployment.ts"

If your Secret is encrypted, you might have to adjust the example to also grant decrypt permissions.

API

Tech Details & Contribution

The core of this project relies on containers/image which is used by Skopeo. Please take a look at those projects before contribution.

To support a new docker image source(like docker tarball in s3), you need to implement image transport interface. You could take a look at docker-archive transport for a good start.

Any error in the custom resource provider will show up in the CloudFormation error log as Invalid PhysicalResourceId, because of this: https://github.com/aws/aws-lambda-go/issues/107. You need to go into the CloudWatch Log Group to find the real error.

3.2.2

6 months ago

3.2.1

6 months ago

3.2.0

6 months ago

4.0.1

6 months ago

4.0.0

6 months ago

3.1.13

6 months ago

3.3.1

6 months ago

3.3.0

6 months ago

3.1.12

6 months ago

3.1.11

6 months ago

3.1.10

6 months ago

3.1.9

7 months ago

3.1.8

7 months ago

3.1.7

8 months ago

3.1.6

8 months ago

3.1.5

8 months ago

3.1.3

8 months ago

3.1.4

8 months ago

3.1.2

9 months ago

3.1.1

9 months ago

3.1.0

9 months ago

3.0.154

9 months ago

3.0.153

9 months ago

3.0.150

9 months ago

3.0.152

9 months ago

3.0.151

9 months ago

3.0.149

9 months ago

3.0.148

9 months ago

3.0.147

9 months ago

3.0.145

10 months ago

3.0.146

10 months ago

3.0.144

10 months ago

3.0.141

10 months ago

3.0.143

10 months ago

3.0.142

10 months ago

3.0.140

10 months ago

3.0.138

10 months ago

3.0.139

10 months ago

3.0.134

10 months ago

3.0.136

10 months ago

3.0.135

10 months ago

3.0.137

10 months ago

3.0.133

10 months ago

3.0.132

10 months ago

3.0.130

11 months ago

3.0.131

10 months ago

3.0.129

11 months ago

3.0.128

11 months ago

3.0.127

11 months ago

3.0.126

11 months ago

3.0.125

11 months ago

3.0.123

11 months ago

3.0.124

11 months ago

3.0.122

11 months ago

3.0.121

11 months ago

3.0.119

11 months ago

3.0.120

11 months ago

3.0.112

12 months ago

3.0.114

11 months ago

3.0.113

12 months ago

3.0.116

11 months ago

3.0.115

11 months ago

3.0.118

11 months ago

3.0.117

11 months ago

3.0.98

1 year ago

3.0.99

1 year ago

3.0.92

1 year ago

3.0.93

1 year ago

3.0.90

1 year ago

3.0.91

1 year ago

3.0.96

1 year ago

3.0.97

1 year ago

3.0.94

1 year ago

3.0.95

1 year ago

3.0.109

12 months ago

3.0.108

12 months ago

3.0.111

12 months ago

3.0.110

12 months ago

3.0.101

12 months ago

3.0.100

1 year ago

3.0.103

12 months ago

3.0.102

12 months ago

3.0.105

12 months ago

3.0.104

12 months ago

3.0.107

12 months ago

3.0.106

12 months ago

3.0.89

1 year ago

3.0.87

1 year ago

3.0.88

1 year ago

3.0.85

1 year ago

3.0.86

1 year ago

3.0.84

1 year ago

3.0.83

1 year ago

3.0.81

1 year ago

3.0.82

1 year ago

3.0.80

1 year ago

3.0.78

1 year ago

3.0.79

1 year ago

3.0.77

1 year ago

3.0.76

1 year ago

3.0.68

1 year ago

3.0.69

1 year ago

3.0.70

1 year ago

3.0.71

1 year ago

3.0.74

1 year ago

3.0.75

1 year ago

3.0.72

1 year ago

3.0.73

1 year ago

3.0.67

1 year ago

3.0.66

1 year ago

3.0.65

1 year ago

3.0.64

1 year ago

3.0.60

1 year ago

3.0.63

1 year ago

3.0.61

1 year ago

3.0.62

1 year ago

3.0.59

1 year ago

3.0.58

1 year ago

3.0.57

1 year ago

3.0.56

1 year ago

3.0.55

1 year ago

3.0.54

1 year ago

3.0.53

1 year ago

3.0.52

1 year ago

3.0.51

1 year ago

3.0.49

1 year ago

3.0.50

1 year ago

3.0.48

1 year ago

3.0.47

1 year ago

3.0.46

1 year ago

3.0.45

1 year ago

3.0.44

1 year ago

3.0.43

1 year ago

3.0.42

1 year ago

3.0.41

1 year ago

3.0.40

1 year ago

3.0.39

1 year ago

3.0.38

1 year ago

3.0.37

1 year ago

3.0.36

1 year ago

3.0.34

1 year ago

3.0.35

1 year ago

3.0.33

2 years ago

3.0.32

2 years ago

3.0.30

2 years ago

3.0.31

2 years ago

3.0.29

2 years ago

3.0.28

2 years ago

3.0.27

2 years ago

3.0.26

2 years ago

3.0.25

2 years ago

3.0.24

2 years ago

3.0.23

2 years ago

3.0.21

2 years ago

3.0.22

2 years ago

3.0.20

2 years ago

3.0.19

2 years ago

3.0.17

2 years ago

3.0.18

2 years ago

3.0.16

2 years ago

3.0.15

2 years ago

3.0.14

2 years ago

3.0.13

2 years ago

3.0.12

2 years ago

3.0.11

2 years ago

3.0.10

2 years ago

3.0.9

2 years ago

3.0.8

2 years ago

3.0.7

2 years ago

3.0.6

2 years ago

3.0.5

2 years ago

3.0.4

2 years ago

3.0.3

2 years ago

3.0.2

2 years ago

3.0.1

2 years ago

3.0.0

2 years ago

2.5.41

2 years ago

2.5.40

2 years ago

2.5.39

2 years ago

2.5.36

2 years ago

2.5.37

2 years ago

2.5.38

2 years ago

2.5.32

2 years ago

2.5.33

2 years ago

2.5.34

2 years ago

2.5.35

2 years ago

2.5.31

2 years ago

2.5.29

2 years ago

2.5.28

2 years ago

2.5.30

2 years ago

2.5.15

2 years ago

2.5.25

2 years ago

2.5.26

2 years ago

2.5.27

2 years ago

2.5.24

2 years ago

2.5.21

2 years ago

2.5.22

2 years ago

2.5.23

2 years ago

2.5.6

3 years ago

2.5.5

3 years ago

2.5.2

3 years ago

2.5.4

3 years ago

2.5.3

3 years ago

2.4.1

4 years ago

2.4.0

4 years ago

2.4.3

3 years ago

2.4.2

3 years ago

2.4.4

3 years ago

2.5.0

3 years ago

2.5.1

3 years ago

2.3.0

4 years ago

2.3.2

4 years ago

2.3.1

4 years ago

2.2.0

4 years ago

0.0.84

4 years ago

0.0.85

4 years ago

0.0.86

4 years ago

0.0.87

4 years ago

0.0.88

4 years ago

0.0.89

4 years ago

0.0.82

4 years ago

0.0.83

4 years ago

2.0.3

4 years ago

2.0.2

4 years ago

2.0.5

4 years ago

2.0.4

4 years ago

2.0.7

4 years ago

2.0.6

4 years ago

2.0.9

4 years ago

2.0.8

4 years ago

2.0.1

4 years ago

2.0.0

4 years ago

1.0.2

4 years ago

1.0.1

4 years ago

1.0.0

4 years ago

2.1.2

4 years ago

2.1.1

4 years ago

2.1.4

4 years ago

2.1.3

4 years ago

2.0.11

4 years ago

2.0.10

4 years ago

2.1.0

4 years ago

0.0.81

4 years ago

0.0.80

4 years ago

0.0.79

4 years ago

0.0.76

4 years ago

0.0.75

4 years ago

0.0.73

4 years ago

0.0.74

4 years ago

0.0.70

4 years ago

0.0.71

4 years ago

0.0.72

4 years ago

0.0.69

4 years ago

0.0.66

4 years ago

0.0.67

4 years ago

0.0.68

4 years ago

0.0.65

4 years ago

0.0.64

4 years ago

0.0.62

4 years ago

0.0.63

4 years ago

0.0.61

4 years ago

0.0.60

4 years ago

0.0.59

4 years ago

0.0.57

4 years ago

0.0.58

4 years ago

0.0.55

4 years ago

0.0.56

4 years ago

0.0.54

4 years ago

0.0.53

4 years ago

0.0.52

4 years ago

0.0.51

4 years ago

0.0.50

4 years ago

0.0.49

4 years ago

0.0.46

4 years ago

0.0.47

4 years ago

0.0.48

4 years ago

0.0.44

4 years ago

0.0.45

4 years ago

0.0.41

4 years ago

0.0.42

4 years ago

0.0.43

4 years ago

0.0.40

4 years ago

0.0.39

4 years ago

0.0.37

4 years ago

0.0.38

4 years ago

0.0.35

4 years ago

0.0.36

4 years ago

0.0.20

4 years ago

0.0.21

4 years ago

0.0.22

4 years ago

0.0.23

4 years ago

0.0.24

4 years ago

0.0.25

4 years ago

0.0.18

4 years ago

0.0.19

4 years ago

0.0.30

4 years ago

0.0.31

4 years ago

0.0.32

4 years ago

0.0.33

4 years ago

0.0.34

4 years ago

0.0.26

4 years ago

0.0.27

4 years ago

0.0.28

4 years ago

0.0.29

4 years ago

0.0.10

4 years ago

0.0.11

4 years ago

0.0.12

4 years ago

0.0.13

4 years ago

0.0.14

4 years ago

0.0.9

4 years ago

0.0.8

4 years ago

0.0.7

4 years ago

0.0.6

4 years ago

0.0.3

4 years ago

0.0.1

4 years ago