token-injectable-docker-builder 1.13.4 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +260 -143
- package/API.md +196 -136
- package/README.md +156 -71
- package/ecrReplication/ecrReplication.js +156 -0
- package/isComplete/isComplete.js +45 -1
- package/lib/build-spec.d.ts +24 -0
- package/lib/build-spec.js +104 -0
- package/lib/builder.d.ts +206 -0
- package/lib/builder.js +289 -0
- package/lib/constants.d.ts +7 -0
- package/lib/constants.js +11 -0
- package/lib/ecr.d.ts +16 -0
- package/lib/ecr.js +30 -0
- package/lib/index.d.ts +2 -261
- package/lib/index.js +6 -402
- package/lib/provider.d.ts +63 -0
- package/lib/provider.js +212 -0
- package/package.json +10 -5
package/isComplete/isComplete.js
CHANGED
|
@@ -6,6 +6,35 @@ const {
|
|
|
6
6
|
CloudWatchLogsClient,
|
|
7
7
|
GetLogEventsCommand,
|
|
8
8
|
} = require('@aws-sdk/client-cloudwatch-logs');
|
|
9
|
+
const {
|
|
10
|
+
ECRClient,
|
|
11
|
+
BatchGetImageCommand,
|
|
12
|
+
} = require('@aws-sdk/client-ecr');
|
|
13
|
+
|
|
14
|
+
async function checkReplicaAvailability(repositoryName, imageTag, replicaRegions) {
|
|
15
|
+
for (const region of replicaRegions) {
|
|
16
|
+
const ecr = new ECRClient({ region });
|
|
17
|
+
try {
|
|
18
|
+
const resp = await ecr.send(new BatchGetImageCommand({
|
|
19
|
+
repositoryName,
|
|
20
|
+
imageIds: [{ imageTag }],
|
|
21
|
+
}));
|
|
22
|
+
const images = resp.images || [];
|
|
23
|
+
if (images.length === 0) {
|
|
24
|
+
console.log(`Replica ${region}: repo exists but tag ${imageTag} not yet present.`);
|
|
25
|
+
return false;
|
|
26
|
+
}
|
|
27
|
+
console.log(`Replica ${region}: image present.`);
|
|
28
|
+
} catch (err) {
|
|
29
|
+
if (err.name === 'RepositoryNotFoundException') {
|
|
30
|
+
console.log(`Replica ${region}: destination repo not yet created by ECR replication.`);
|
|
31
|
+
return false;
|
|
32
|
+
}
|
|
33
|
+
throw err;
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
return true;
|
|
37
|
+
}
|
|
9
38
|
|
|
10
39
|
exports.handler = async (event) => {
|
|
11
40
|
console.log('--- isComplete Handler Invoked ---');
|
|
@@ -86,9 +115,24 @@ exports.handler = async (event) => {
|
|
|
86
115
|
return { IsComplete: false };
|
|
87
116
|
}
|
|
88
117
|
|
|
89
|
-
// If build succeeded,
|
|
118
|
+
// If build succeeded, optionally wait for cross-region replicas to land
|
|
119
|
+
// before signalling complete. ECR replication is async (most images
|
|
120
|
+
// <30 min, rare cases longer) — without this, a consumer stack in
|
|
121
|
+
// another region may try to pull the image before it's been
|
|
122
|
+
// replicated and fail with "Source image does not exist".
|
|
90
123
|
if (buildStatus === 'SUCCEEDED') {
|
|
91
124
|
const imageTag = event.ResourceProperties?.ImageTag || process.env.IMAGE_TAG;
|
|
125
|
+
const repositoryName = event.ResourceProperties?.RepositoryName;
|
|
126
|
+
const replicaRegions = JSON.parse(event.ResourceProperties?.ReplicaRegions || '[]');
|
|
127
|
+
|
|
128
|
+
if (replicaRegions.length > 0 && repositoryName) {
|
|
129
|
+
const ready = await checkReplicaAvailability(repositoryName, imageTag, replicaRegions);
|
|
130
|
+
if (!ready) {
|
|
131
|
+
console.log('Build succeeded; waiting for replicas to catch up.');
|
|
132
|
+
return { IsComplete: false };
|
|
133
|
+
}
|
|
134
|
+
}
|
|
135
|
+
|
|
92
136
|
return {
|
|
93
137
|
IsComplete: true,
|
|
94
138
|
Data: {
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Parse a .dockerignore file at `sourcePath` (if present) and combine it with
|
|
3
|
+
* a user-supplied exclude list. The Dockerfile itself is never excluded —
|
|
4
|
+
* `.dockerignore` patterns matching `dockerFile` are filtered out so the
|
|
5
|
+
* S3 asset always contains the Dockerfile.
|
|
6
|
+
*/
|
|
7
|
+
export declare function resolveExcludes(sourcePath: string, dockerFile: string, exclude: string[] | undefined): string[] | undefined;
|
|
8
|
+
export interface BuildSpecOptions {
|
|
9
|
+
readonly imageTag: string;
|
|
10
|
+
readonly dockerFile?: string;
|
|
11
|
+
readonly buildArgs?: {
|
|
12
|
+
[key: string]: string;
|
|
13
|
+
};
|
|
14
|
+
readonly dockerLoginSecretArn?: string;
|
|
15
|
+
readonly installCommands?: string[];
|
|
16
|
+
readonly preBuildCommands?: string[];
|
|
17
|
+
readonly cacheDisabled: boolean;
|
|
18
|
+
readonly platform: 'linux/amd64' | 'linux/arm64';
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* Assemble the plain buildspec object that the construct passes to
|
|
22
|
+
* `BuildSpec.fromObject`. Pure function — easy to unit test.
|
|
23
|
+
*/
|
|
24
|
+
export declare function buildBuildSpec(opts: BuildSpecOptions): Record<string, unknown>;
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.resolveExcludes = resolveExcludes;
|
|
4
|
+
exports.buildBuildSpec = buildBuildSpec;
|
|
5
|
+
const fs = require("fs");
|
|
6
|
+
const path = require("path");
|
|
7
|
+
/**
|
|
8
|
+
* Parse a .dockerignore file at `sourcePath` (if present) and combine it with
|
|
9
|
+
* a user-supplied exclude list. The Dockerfile itself is never excluded —
|
|
10
|
+
* `.dockerignore` patterns matching `dockerFile` are filtered out so the
|
|
11
|
+
* S3 asset always contains the Dockerfile.
|
|
12
|
+
*/
|
|
13
|
+
function resolveExcludes(sourcePath, dockerFile, exclude) {
|
|
14
|
+
let effective = exclude;
|
|
15
|
+
if (!effective) {
|
|
16
|
+
const dockerignorePath = path.join(sourcePath, '.dockerignore');
|
|
17
|
+
if (fs.existsSync(dockerignorePath)) {
|
|
18
|
+
const fileContent = fs.readFileSync(dockerignorePath, 'utf8');
|
|
19
|
+
effective = fileContent
|
|
20
|
+
.split('\n')
|
|
21
|
+
.map((line) => line.trim())
|
|
22
|
+
.filter((line) => line.length > 0 && !line.startsWith('#'));
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
if (!effective)
|
|
26
|
+
return undefined;
|
|
27
|
+
return effective.filter((pattern) => {
|
|
28
|
+
const escaped = pattern.replace(/[.+^${}()|[\]\\]/g, '\\$&');
|
|
29
|
+
const regex = new RegExp(`^${escaped.replace(/\*/g, '.*').replace(/\?/g, '.')}$`, 'i');
|
|
30
|
+
return !regex.test(dockerFile);
|
|
31
|
+
});
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Assemble the plain buildspec object that the construct passes to
|
|
35
|
+
* `BuildSpec.fromObject`. Pure function — easy to unit test.
|
|
36
|
+
*/
|
|
37
|
+
function buildBuildSpec(opts) {
|
|
38
|
+
const { imageTag, dockerFile, buildArgs, dockerLoginSecretArn, installCommands, preBuildCommands, cacheDisabled, platform, } = opts;
|
|
39
|
+
const buildArgsString = buildArgs
|
|
40
|
+
? Object.entries(buildArgs)
|
|
41
|
+
.map(([k, v]) => `--build-arg ${k}=${v}`)
|
|
42
|
+
.join(' ')
|
|
43
|
+
: '';
|
|
44
|
+
const dockerFileFlag = dockerFile ? `-f $CODEBUILD_SRC_DIR/${dockerFile}` : '';
|
|
45
|
+
const dockerLoginCommands = dockerLoginSecretArn
|
|
46
|
+
? [
|
|
47
|
+
'echo "Retrieving Docker credentials..."',
|
|
48
|
+
'apt-get update -y && apt-get install -y jq',
|
|
49
|
+
`DOCKER_USERNAME=$(aws secretsmanager get-secret-value --secret-id ${dockerLoginSecretArn} --query SecretString --output text | jq -r .username)`,
|
|
50
|
+
`DOCKER_PASSWORD=$(aws secretsmanager get-secret-value --secret-id ${dockerLoginSecretArn} --query SecretString --output text | jq -r .password)`,
|
|
51
|
+
'echo "Logging in to Docker Hub..."',
|
|
52
|
+
'echo $DOCKER_PASSWORD | docker login --username $DOCKER_USERNAME --password-stdin',
|
|
53
|
+
]
|
|
54
|
+
: ['echo "No Docker credentials. Skipping Docker Hub login."'];
|
|
55
|
+
const buildxInstallCommands = cacheDisabled
|
|
56
|
+
? []
|
|
57
|
+
: [
|
|
58
|
+
'echo "Setting up Docker buildx for ECR layer cache..."',
|
|
59
|
+
'docker buildx create --driver docker-container --name ecr-cache-builder --use 2>/dev/null || docker buildx use ecr-cache-builder',
|
|
60
|
+
];
|
|
61
|
+
const platformFlag = `--platform ${platform}`;
|
|
62
|
+
// --provenance=false --sbom=false: Docker Buildx v0.10+ adds attestations by default,
|
|
63
|
+
// producing OCI image indexes that AWS Lambda does not support.
|
|
64
|
+
const buildCommand = cacheDisabled
|
|
65
|
+
? `docker build ${platformFlag} ${dockerFileFlag} ${buildArgsString} -t $ECR_REPO_URI:${imageTag} $CODEBUILD_SRC_DIR`
|
|
66
|
+
: `docker buildx build --push ${platformFlag} --provenance=false --sbom=false --cache-from type=registry,ref=$ECR_REPO_URI:cache --cache-to type=registry,ref=$ECR_REPO_URI:cache,mode=max,image-manifest=true ${dockerFileFlag} ${buildArgsString} -t $ECR_REPO_URI:${imageTag} $CODEBUILD_SRC_DIR`;
|
|
67
|
+
return {
|
|
68
|
+
version: '0.2',
|
|
69
|
+
phases: {
|
|
70
|
+
install: {
|
|
71
|
+
commands: [
|
|
72
|
+
'echo "Beginning install phase..."',
|
|
73
|
+
...(installCommands ?? []),
|
|
74
|
+
...buildxInstallCommands,
|
|
75
|
+
],
|
|
76
|
+
},
|
|
77
|
+
pre_build: {
|
|
78
|
+
commands: [
|
|
79
|
+
...(preBuildCommands ?? []),
|
|
80
|
+
...dockerLoginCommands,
|
|
81
|
+
'echo "Retrieving AWS Account ID..."',
|
|
82
|
+
'export ACCOUNT_ID=$(aws sts get-caller-identity --query Account --output text)',
|
|
83
|
+
'echo "Logging into Amazon ECR..."',
|
|
84
|
+
'aws ecr get-login-password --region $AWS_DEFAULT_REGION | docker login --username AWS --password-stdin $ACCOUNT_ID.dkr.ecr.$AWS_DEFAULT_REGION.amazonaws.com',
|
|
85
|
+
],
|
|
86
|
+
},
|
|
87
|
+
build: {
|
|
88
|
+
commands: [
|
|
89
|
+
`echo "Building Docker image with tag ${imageTag}..."`,
|
|
90
|
+
buildCommand,
|
|
91
|
+
],
|
|
92
|
+
},
|
|
93
|
+
...(cacheDisabled && {
|
|
94
|
+
post_build: {
|
|
95
|
+
commands: [
|
|
96
|
+
`echo "Pushing Docker image with tag ${imageTag}..."`,
|
|
97
|
+
`docker push $ECR_REPO_URI:${imageTag}`,
|
|
98
|
+
],
|
|
99
|
+
},
|
|
100
|
+
}),
|
|
101
|
+
},
|
|
102
|
+
};
|
|
103
|
+
}
|
|
104
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"build-spec.js","sourceRoot":"","sources":["../src/build-spec.ts"],"names":[],"mappings":";;AASA,0CAwBC;AAiBD,wCAkFC;AApID,yBAAyB;AACzB,6BAA6B;AAE7B;;;;;GAKG;AACH,SAAgB,eAAe,CAC7B,UAAkB,EAClB,UAAkB,EAClB,OAA6B;IAE7B,IAAI,SAAS,GAAG,OAAO,CAAC;IACxB,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,gBAAgB,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;QAChE,IAAI,EAAE,CAAC,UAAU,CAAC,gBAAgB,CAAC,EAAE,CAAC;YACpC,MAAM,WAAW,GAAG,EAAE,CAAC,YAAY,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC;YAC9D,SAAS,GAAG,WAAW;iBACpB,KAAK,CAAC,IAAI,CAAC;iBACX,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;iBAC1B,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;QAChE,CAAC;IACH,CAAC;IAED,IAAI,CAAC,SAAS;QAAE,OAAO,SAAS,CAAC;IAEjC,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE;QAClC,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC;QAC7D,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACvF,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;AACL,CAAC;AAaD;;;GAGG;AACH,SAAgB,cAAc,CAAC,IAAsB;IACnD,MAAM,EACJ,QAAQ,EACR,UAAU,EACV,SAAS,EACT,oBAAoB,EACpB,eAAe,EACf,gBAAgB,EAChB,aAAa,EACb,QAAQ,GACT,GAAG,IAAI,CAAC;IAET,MAAM,eAAe,GAAG,SAAS;QAC/B,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC;aACxB,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;aACxC,IAAI,CAAC,GAAG,CAAC;QACZ,CAAC,CAAC,EAAE,CAAC;IAEP,MAAM,cAAc,GAAG,UAAU,CAAC,CAAC,CAAC,yBAAyB,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAE/E,MAAM,mBAAmB,GAAG,oBAAoB;QAC9C,CAAC,CAAC;YACA,yCAAyC;YACzC,4CAA4C;YAC5C,qEAAqE,oBAAoB,wDAAwD;YACjJ,qEAAqE,oBAAoB,wDAAwD;YACjJ,oCAAoC;YACpC,mFAAmF;SACpF;QACD,CAAC,CAAC,CAAC,0DAA0D,CAAC,CAAC;IAEjE,MAAM,qBAAqB,GAAG,aAAa;QACzC,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC;YACA,wDAAwD;YACxD,kIAAkI;SACnI,CAAC;IAEJ,MAAM,YAAY,GAAG,cAAc,QAAQ,EAAE,CAAC;IAE9C,sFAAsF;IACtF,gEAAgE;IAChE,MAAM,YAAY,GAAG,aAAa;QAChC,CAAC,CAAC,gBAAgB,YAAY,IAAI,cAAc,IAAI,eAAe,qBAAqB,QAAQ,qBAAqB;QACrH,CAAC,CAAC,8BAA8B,YAAY,qKAAqK,cAAc,IAAI,eAAe,qBAAqB,QAAQ,qBAAqB,CAAC;IAEvS,OAAO;QACL,OAAO,EAAE,KAAK;QACd,MAAM,EAAE;YACN,OAAO,EAAE;gBACP,QAAQ,EAAE;oBACR,mCAAmC;oBACnC,GAAG,CAAC,eAAe,IAAI,EAAE,CAAC;oBAC1B,GAAG,qBAAqB;iBACzB;aACF;YACD,SAAS,EAAE;gBACT,QAAQ,EAAE;oBACR,GAAG,CAAC,gBAAgB,IAAI,EAAE,CAAC;oBAC3B,GAAG,mBAAmB;oBACtB,qCAAqC;oBACrC,gFAAgF;oBAChF,mCAAmC;oBACnC,8JAA8J;iBAC/J;aACF;YACD,KAAK,EAAE;gBACL,QAAQ,EAAE;oBACR,wCAAwC,QAAQ,MAAM;oBACtD,YAAY;iBACb;aACF;YACD,GAAG,CAAC,aAAa,IAAI;gBACnB,UAAU,EAAE;oBACV,QAAQ,EAAE;wBACR,uCAAuC,QAAQ,MAAM;wBACrD,6BAA6B,QAAQ,EAAE;qBACxC;iBACF;aACF,CAAC;SACH;KACF,CAAC;AACJ,CAAC","sourcesContent":["import * as fs from 'fs';\nimport * as path from 'path';\n\n/**\n * Parse a .dockerignore file at `sourcePath` (if present) and combine it with\n * a user-supplied exclude list. The Dockerfile itself is never excluded —\n * `.dockerignore` patterns matching `dockerFile` are filtered out so the\n * S3 asset always contains the Dockerfile.\n */\nexport function resolveExcludes(\n  sourcePath: string,\n  dockerFile: string,\n  exclude: string[] | undefined,\n): string[] | undefined {\n  let effective = exclude;\n  if (!effective) {\n    const dockerignorePath = path.join(sourcePath, '.dockerignore');\n    if (fs.existsSync(dockerignorePath)) {\n      const fileContent = fs.readFileSync(dockerignorePath, 'utf8');\n      effective = fileContent\n        .split('\\n')\n        .map((line) => line.trim())\n        .filter((line) => line.length > 0 && !line.startsWith('#'));\n    }\n  }\n\n  if (!effective) return undefined;\n\n  return effective.filter((pattern) => {\n    const escaped = pattern.replace(/[.+^${}()|[\\]\\\\]/g, '\\\\$&');\n    const regex = new RegExp(`^${escaped.replace(/\\*/g, '.*').replace(/\\?/g, '.')}$`, 'i');\n    return !regex.test(dockerFile);\n  });\n}\n\nexport interface BuildSpecOptions {\n  readonly imageTag: string;\n  readonly dockerFile?: string;\n  readonly buildArgs?: { [key: string]: string };\n  readonly dockerLoginSecretArn?: string;\n  readonly installCommands?: string[];\n  readonly preBuildCommands?: string[];\n  readonly cacheDisabled: boolean;\n  readonly platform: 'linux/amd64' | 'linux/arm64';\n}\n\n/**\n * Assemble the plain buildspec object that the construct passes to\n * `BuildSpec.fromObject`. Pure function — easy to unit test.\n */\nexport function buildBuildSpec(opts: BuildSpecOptions): Record<string, unknown> {\n  const {\n    imageTag,\n    dockerFile,\n    buildArgs,\n    dockerLoginSecretArn,\n    installCommands,\n    preBuildCommands,\n    cacheDisabled,\n    platform,\n  } = opts;\n\n  const buildArgsString = buildArgs\n    ? Object.entries(buildArgs)\n      .map(([k, v]) => `--build-arg ${k}=${v}`)\n      .join(' ')\n    : '';\n\n  const dockerFileFlag = dockerFile ? `-f $CODEBUILD_SRC_DIR/${dockerFile}` : '';\n\n  const dockerLoginCommands = dockerLoginSecretArn\n    ? [\n      'echo \"Retrieving Docker credentials...\"',\n      'apt-get update -y && apt-get install -y jq',\n      `DOCKER_USERNAME=$(aws secretsmanager get-secret-value --secret-id ${dockerLoginSecretArn} --query SecretString --output text | jq -r .username)`,\n      `DOCKER_PASSWORD=$(aws secretsmanager get-secret-value --secret-id ${dockerLoginSecretArn} --query SecretString --output text | jq -r .password)`,\n      'echo \"Logging in to Docker Hub...\"',\n      'echo $DOCKER_PASSWORD | docker login --username $DOCKER_USERNAME --password-stdin',\n    ]\n    : ['echo \"No Docker credentials. Skipping Docker Hub login.\"'];\n\n  const buildxInstallCommands = cacheDisabled\n    ? []\n    : [\n      'echo \"Setting up Docker buildx for ECR layer cache...\"',\n      'docker buildx create --driver docker-container --name ecr-cache-builder --use 2>/dev/null || docker buildx use ecr-cache-builder',\n    ];\n\n  const platformFlag = `--platform ${platform}`;\n\n  // --provenance=false --sbom=false: Docker Buildx v0.10+ adds attestations by default,\n  // producing OCI image indexes that AWS Lambda does not support.\n  const buildCommand = cacheDisabled\n    ? `docker build ${platformFlag} ${dockerFileFlag} ${buildArgsString} -t $ECR_REPO_URI:${imageTag} $CODEBUILD_SRC_DIR`\n    : `docker buildx build --push ${platformFlag} --provenance=false --sbom=false --cache-from type=registry,ref=$ECR_REPO_URI:cache --cache-to type=registry,ref=$ECR_REPO_URI:cache,mode=max,image-manifest=true ${dockerFileFlag} ${buildArgsString} -t $ECR_REPO_URI:${imageTag} $CODEBUILD_SRC_DIR`;\n\n  return {\n    version: '0.2',\n    phases: {\n      install: {\n        commands: [\n          'echo \"Beginning install phase...\"',\n          ...(installCommands ?? []),\n          ...buildxInstallCommands,\n        ],\n      },\n      pre_build: {\n        commands: [\n          ...(preBuildCommands ?? []),\n          ...dockerLoginCommands,\n          'echo \"Retrieving AWS Account ID...\"',\n          'export ACCOUNT_ID=$(aws sts get-caller-identity --query Account --output text)',\n          'echo \"Logging into Amazon ECR...\"',\n          'aws ecr get-login-password --region $AWS_DEFAULT_REGION | docker login --username AWS --password-stdin $ACCOUNT_ID.dkr.ecr.$AWS_DEFAULT_REGION.amazonaws.com',\n        ],\n      },\n      build: {\n        commands: [\n          `echo \"Building Docker image with tag ${imageTag}...\"`,\n          buildCommand,\n        ],\n      },\n      ...(cacheDisabled && {\n        post_build: {\n          commands: [\n            `echo \"Pushing Docker image with tag ${imageTag}...\"`,\n            `docker push $ECR_REPO_URI:${imageTag}`,\n          ],\n        },\n      }),\n    },\n  };\n}\n"]}
|
package/lib/builder.d.ts
ADDED
|
@@ -0,0 +1,206 @@
|
|
|
1
|
+
import { IVpc, ISecurityGroup, SubnetSelection } from 'aws-cdk-lib/aws-ec2';
|
|
2
|
+
import { ContainerImage } from 'aws-cdk-lib/aws-ecs';
|
|
3
|
+
import { DockerImageCode } from 'aws-cdk-lib/aws-lambda';
|
|
4
|
+
import { ILogGroup } from 'aws-cdk-lib/aws-logs';
|
|
5
|
+
import { Construct } from 'constructs';
|
|
6
|
+
import { TokenInjectableDockerBuilderProvider } from './provider';
|
|
7
|
+
/**
|
|
8
|
+
* Properties for the `TokenInjectableDockerBuilder` construct.
|
|
9
|
+
*/
|
|
10
|
+
export interface TokenInjectableDockerBuilderProps {
|
|
11
|
+
/**
|
|
12
|
+
* The path to the directory containing the Dockerfile or source code.
|
|
13
|
+
*/
|
|
14
|
+
readonly path: string;
|
|
15
|
+
/**
|
|
16
|
+
* Build arguments to pass to the Docker build process.
|
|
17
|
+
* These are transformed into `--build-arg KEY=VALUE` flags.
|
|
18
|
+
* @example
|
|
19
|
+
* {
|
|
20
|
+
* TOKEN: 'my-secret-token',
|
|
21
|
+
* ENV: 'production'
|
|
22
|
+
* }
|
|
23
|
+
*/
|
|
24
|
+
readonly buildArgs?: {
|
|
25
|
+
[key: string]: string;
|
|
26
|
+
};
|
|
27
|
+
/**
|
|
28
|
+
* The ARN of the AWS Secrets Manager secret containing Docker login credentials.
|
|
29
|
+
* The secret must store a JSON object: `{"username":"...","password":"..."}`.
|
|
30
|
+
* Must be in the same region as the stack.
|
|
31
|
+
*
|
|
32
|
+
* @default - No Docker Hub login.
|
|
33
|
+
*/
|
|
34
|
+
readonly dockerLoginSecretArn?: string;
|
|
35
|
+
/**
|
|
36
|
+
* The VPC in which the CodeBuild project will be deployed.
|
|
37
|
+
*
|
|
38
|
+
* @default - CodeBuild uses public internet.
|
|
39
|
+
*/
|
|
40
|
+
readonly vpc?: IVpc;
|
|
41
|
+
/**
|
|
42
|
+
* Security groups attached to the CodeBuild project.
|
|
43
|
+
*
|
|
44
|
+
* @default - No security groups attached.
|
|
45
|
+
*/
|
|
46
|
+
readonly securityGroups?: ISecurityGroup[];
|
|
47
|
+
/**
|
|
48
|
+
* Subnet selection within the VPC.
|
|
49
|
+
*
|
|
50
|
+
* @default - All subnets in the VPC.
|
|
51
|
+
*/
|
|
52
|
+
readonly subnetSelection?: SubnetSelection;
|
|
53
|
+
/**
|
|
54
|
+
* Custom commands to run during the install phase of CodeBuild.
|
|
55
|
+
*
|
|
56
|
+
* @default - No additional install commands.
|
|
57
|
+
*/
|
|
58
|
+
readonly installCommands?: string[];
|
|
59
|
+
/**
|
|
60
|
+
* Custom commands to run during the pre_build phase of CodeBuild.
|
|
61
|
+
*
|
|
62
|
+
* @default - No additional pre-build commands.
|
|
63
|
+
*/
|
|
64
|
+
readonly preBuildCommands?: string[];
|
|
65
|
+
/**
|
|
66
|
+
* Whether to enable KMS encryption for the ECR repository.
|
|
67
|
+
*
|
|
68
|
+
* @default false
|
|
69
|
+
*/
|
|
70
|
+
readonly kmsEncryption?: boolean;
|
|
71
|
+
/**
|
|
72
|
+
* File paths in the Docker directory to exclude from the build asset.
|
|
73
|
+
* Falls back to `.dockerignore` if present.
|
|
74
|
+
*
|
|
75
|
+
* @default - No file path exclusions.
|
|
76
|
+
*/
|
|
77
|
+
readonly exclude?: string[];
|
|
78
|
+
/**
|
|
79
|
+
* Name of the Dockerfile (passed as `-f`).
|
|
80
|
+
*
|
|
81
|
+
* @example 'Dockerfile.production'
|
|
82
|
+
* @default 'Dockerfile'
|
|
83
|
+
*/
|
|
84
|
+
readonly file?: string;
|
|
85
|
+
/**
|
|
86
|
+
* When `true`, disables Docker layer caching.
|
|
87
|
+
*
|
|
88
|
+
* @default false
|
|
89
|
+
*/
|
|
90
|
+
readonly cacheDisabled?: boolean;
|
|
91
|
+
/**
|
|
92
|
+
* CloudWatch log group for CodeBuild build logs.
|
|
93
|
+
*
|
|
94
|
+
* @default - CodeBuild default logging.
|
|
95
|
+
*/
|
|
96
|
+
readonly buildLogGroup?: ILogGroup;
|
|
97
|
+
/**
|
|
98
|
+
* Target platform for the Docker image.
|
|
99
|
+
*
|
|
100
|
+
* @default 'linux/amd64'
|
|
101
|
+
*/
|
|
102
|
+
readonly platform?: 'linux/amd64' | 'linux/arm64';
|
|
103
|
+
/**
|
|
104
|
+
* Shared provider for the custom resource Lambdas.
|
|
105
|
+
*
|
|
106
|
+
* Pass `TokenInjectableDockerBuilderProvider.getOrCreate(this, { queryInterval })`
|
|
107
|
+
* if you need a non-default query interval. Otherwise, the construct will
|
|
108
|
+
* call `getOrCreate(this)` itself and reuse the per-stack singleton.
|
|
109
|
+
*
|
|
110
|
+
* @default - Per-stack singleton provider, created on first use.
|
|
111
|
+
*/
|
|
112
|
+
readonly provider?: TokenInjectableDockerBuilderProvider;
|
|
113
|
+
/**
|
|
114
|
+
* ECR pull-through cache repository prefixes to grant pull access to.
|
|
115
|
+
*
|
|
116
|
+
* @example ['docker-hub', 'ghcr']
|
|
117
|
+
* @default - No pull-through cache access.
|
|
118
|
+
*/
|
|
119
|
+
readonly ecrPullThroughCachePrefixes?: string[];
|
|
120
|
+
/**
|
|
121
|
+
* When `true`, creates a CloudWatch log group outside of CloudFormation
|
|
122
|
+
* (`/docker-builder/<projectName>`) and directs CodeBuild output there.
|
|
123
|
+
* Survives stack rollbacks for debugging. 7-day retention.
|
|
124
|
+
*
|
|
125
|
+
* @default false
|
|
126
|
+
*/
|
|
127
|
+
readonly retainBuildLogs?: boolean;
|
|
128
|
+
/**
|
|
129
|
+
* Additional AWS regions to replicate the built image to via ECR's
|
|
130
|
+
* native registry replication. The image is pushed to the primary
|
|
131
|
+
* region's ECR as usual; ECR asynchronously replicates the same
|
|
132
|
+
* `repositoryName` + `imageTag` to each region listed here.
|
|
133
|
+
*
|
|
134
|
+
* Consumers in another region (a Lambda in `us-west-2` referencing an
|
|
135
|
+
* image built in `us-east-1`) can use `dockerImageCodeFor(region)` or
|
|
136
|
+
* `containerImageFor(region)` to import the replicated image.
|
|
137
|
+
*
|
|
138
|
+
* The custom resource waits for replication to complete before
|
|
139
|
+
* signalling deploy-complete, so downstream stacks can safely deploy
|
|
140
|
+
* immediately after.
|
|
141
|
+
*
|
|
142
|
+
* **Caveats:**
|
|
143
|
+
* - Cross-region replication is not supported between AWS partitions.
|
|
144
|
+
* - Replicas do **not** inherit the primary's encryption (defaults to
|
|
145
|
+
* AES-256), lifecycle policies, or repository policies.
|
|
146
|
+
* - Replicated repositories persist on stack deletion — AWS does not
|
|
147
|
+
* auto-delete them. Clean up manually via the ECR console / CLI if
|
|
148
|
+
* needed.
|
|
149
|
+
* - Both the builder stack and any consumer stack in another region
|
|
150
|
+
* must set `crossRegionReferences: true` for the image tag to flow.
|
|
151
|
+
* - Stacks must have a concrete region (`env: { account, region }`),
|
|
152
|
+
* not the env-agnostic default.
|
|
153
|
+
*
|
|
154
|
+
* @example ['us-west-2', 'eu-west-1']
|
|
155
|
+
* @default [] - no replication
|
|
156
|
+
*/
|
|
157
|
+
readonly replicaRegions?: string[];
|
|
158
|
+
}
|
|
159
|
+
/**
|
|
160
|
+
* A CDK construct to build and push Docker images to an ECR repository using
|
|
161
|
+
* CodeBuild and Lambda custom resources, **then** retrieve the final image tag
|
|
162
|
+
* so that ECS/Lambda references use the exact built image.
|
|
163
|
+
*/
|
|
164
|
+
export declare class TokenInjectableDockerBuilder extends Construct {
|
|
165
|
+
/** The ECR repository that stores the resulting Docker image. */
|
|
166
|
+
private readonly ecrRepository;
|
|
167
|
+
/** ECS-compatible container image reference (primary region). */
|
|
168
|
+
readonly containerImage: ContainerImage;
|
|
169
|
+
/** Lambda-compatible DockerImageCode reference (primary region). */
|
|
170
|
+
readonly dockerImageCode: DockerImageCode;
|
|
171
|
+
/** The ECR repository name — preserved across replica regions. */
|
|
172
|
+
readonly repositoryName: string;
|
|
173
|
+
/** The resolved image tag (CFN token; available at deploy time). */
|
|
174
|
+
readonly imageTag: string;
|
|
175
|
+
private readonly primaryRegion;
|
|
176
|
+
private readonly accountId;
|
|
177
|
+
private readonly replicaRegions;
|
|
178
|
+
constructor(scope: Construct, id: string, props: TokenInjectableDockerBuilderProps);
|
|
179
|
+
/**
|
|
180
|
+
* Format the ECR repository URI for a given region. The region must
|
|
181
|
+
* be either the primary region or one of `replicaRegions`.
|
|
182
|
+
*/
|
|
183
|
+
repositoryUriFor(region: string): string;
|
|
184
|
+
/**
|
|
185
|
+
* Import the replicated repository as an ECS-compatible
|
|
186
|
+
* `ContainerImage` in a consumer scope (typically a stack in `region`).
|
|
187
|
+
*
|
|
188
|
+
* The consumer's stack must have `crossRegionReferences: true` when
|
|
189
|
+
* `region` differs from the builder's region.
|
|
190
|
+
*/
|
|
191
|
+
containerImageFor(scope: Construct, region: string): ContainerImage;
|
|
192
|
+
/**
|
|
193
|
+
* Import the replicated repository as a Lambda-compatible
|
|
194
|
+
* `DockerImageCode` in a consumer scope (typically a stack in `region`).
|
|
195
|
+
*
|
|
196
|
+
* The consumer's stack must have `crossRegionReferences: true` when
|
|
197
|
+
* `region` differs from the builder's region.
|
|
198
|
+
*/
|
|
199
|
+
dockerImageCodeFor(scope: Construct, region: string): DockerImageCode;
|
|
200
|
+
private importRepoFor;
|
|
201
|
+
private assertRegionIsKnown;
|
|
202
|
+
private validateReplicaRegions;
|
|
203
|
+
private grantEcrAccess;
|
|
204
|
+
private grantPullThroughCacheAccess;
|
|
205
|
+
private grantBuildLogsAccess;
|
|
206
|
+
}
|