cdk-assets

A library for publishing CDK assets to AWS environments.

This is a library, for integrating into applications like the CDK Toolkit
CLI. If you just want to upload assets as a
user, use the cdk-assets CLI

Overview

@aws-cdk/cdk-assets-lib requires an asset manifest file called assets.json, in a CDK
CloudAssembly (cdk.out/assets.json). It will take the assets listed in the
manifest, prepare them as required and upload them to the locations indicated in
the manifest.

Currently the following asset types are supported:

- Files and archives, uploaded to S3
- Docker Images, uploaded to ECR
- Files, archives, and Docker images built by external utilities

S3 buckets and ECR repositories to upload to are expected to exist already.

We expect assets to be immutable, and we expect that immutability to be
reflected both in the asset ID and in the destination location. This reflects
itself in the following behaviors:

- If the indicated asset already exists in the given destination location, it
will not be packaged and uploaded.
- If some locally cached artifact (depending on the asset type a file or an
image in the local Docker cache) already exists named after the asset's ID, it
will not be packaged, but will be uploaded directly to the destination
location.

For assets build by external utilities, the contract is such that cdk-assets
expects the utility to manage dedupe detection as well as path/image tag generation.
This means that cdk-assets will call the external utility every time generation
is warranted, and it is up to the utility to a) determine whether to do a
full rebuild; and b) to return only one thing on stdout: the path to the file/archive
asset, or the name of the local Docker image.

Usage

Usage looks like this:

``ts
const manifest = AssetManifest.fromPath(args.path);
const someAssets = manifest.select([DestinationPattern.parse('...')]);

// Or implement your own AWS host
const aws: IAws = new DefaultAwsClient('PROFILENAME');

// Or implement your own progress listener
const progressListener: IProgressListener = new ConsoleProgress();


const pub = new AssetPublishing(manifest, {
aws,
progressListener,
});

await pub.publish();
`

Manifest Example

An asset manifest looks like this:

`json
{
"version": "1.22.0",
"files": {
"7aac5b80b050e7e4e168f84feffa5893": {
"source": {
"path": "some_directory",
"packaging": "zip"
},
"destinations": {
"us-east-1": {
"region": "us-east-1",
"assumeRoleArn": "arn:aws:iam::12345789012:role/my-account",
"bucketName": "MyBucket",
"objectKey": "7aac5b80b050e7e4e168f84feffa5893.zip"
}
}
},
"3dfe2b80b050e7e4e168f84feff678d4": {
"source": {
"executable": ["myzip"]
},
"destinations": {
"us-east-1": {
"region": "us-east-1",
"assumeRoleArn": "arn:aws:iam::12345789012:role/my-account",
"bucketName": "MySpecialBucket",
"objectKey": "3dfe2b80b050e7e4e168f84feff678d4.zip"
}
}
}
},
"dockerImages": {
"b48783c58a86f7b8c68a4591c4f9be31": {
"source": {
"directory": "dockerdir"
},
"destinations": {
"us-east-1": {
"region": "us-east-1",
"assumeRoleArn": "arn:aws:iam::12345789012:role/my-account",
"repositoryName": "MyRepository",
"imageTag": "b48783c58a86f7b8c68a4591c4f9be31",
"imageUri": "123456789012.dkr.ecr.us-east-1.amazonaws.com/MyRepository:1234567891b48783c58a86f7b8c68a4591c4f9be31"
}
}
},
"d92753c58a86f7b8c68a4591c4f9cf28": {
"source": {
"executable": ["mytool", "package", "dockerdir"]
},
"destinations": {
"us-east-1": {
"region": "us-east-1",
"assumeRoleArn": "arn:aws:iam::12345789012:role/my-account",
"repositoryName": "MyRepository2",
"imageTag": "d92753c58a86f7b8c68a4591c4f9cf28",
"imageUri": "123456789987.dkr.ecr.us-east-1.amazonaws.com/MyRepository2:1234567891b48783c58a86f7b8c68a4591c4f9be31"
}
}
}
}
}
`

$3

The destination block of an asset manifest may contain the following region
and account placeholders:

- ${AWS::Region}
- ${AWS::AccountId}

These will be substituted with the region and account IDs currently configured
on the AWS SDK (through environment variables or ~/.aws/... config files).

- The ${AWS::AccountId} placeholder will _not_ be re-evaluated after
performing the AssumeRole call.
- If ${AWS::Region} is used, it will principally be replaced with the value
in the region key. If the default region is intended, leave the region
key out of the manifest at all.

Docker image credentials

For Docker image asset publishing, cdk-assets will docker login with
credentials from ECR GetAuthorizationToken prior to building and publishing, so
that the Dockerfile can reference images in the account's ECR repo.

cdk-assets can also be configured to read credentials from both ECR and
SecretsManager prior to build by creating a credential configuration at
'~/.cdk/cdk-docker-creds.json' (override this location by setting the
CDK_DOCKER_CREDS_FILE environment variable). The credentials file has the
following format:

`json
{
"version": "1.0",
"domainCredentials": {
"domain1.example.com": {
"secretsManagerSecretId": "mySecret", // Can be the secret ID or full ARN
"roleArn": "arn:aws:iam::0123456789012:role/my-role" // (Optional) role with permissions to the secret
},
"domain2.example.com": {
"ecrRepository": true,
"roleArn": "arn:aws:iam::0123456789012:role/my-role" // (Optional) role with permissions to the repo
}
}
}
`

If the credentials file is present, docker will be configured to use the
docker-credential-cdk-assets credential helper for each of the domains listed
in the file. This helper will assume the role provided (if present), and then fetch
the login credentials from either SecretsManager or ECR.

Using Drop-in Docker Replacements

By default, the AWS CDK will build and publish Docker image assets using the
docker command. However, by specifying the CDK_DOCKER` environment variable,
you can override the command that will be used to build and publish your
assets.