Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(ecr): add imageTagMutability prop #10557

Merged
merged 11 commits into from
Mar 9, 2021
Merged

feat(ecr): add imageTagMutability prop #10557

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
9f12867
feat(ecr): add imageTagMutability prop
ap00rv Sep 26, 2020
50b47ff
Merge branch 'master' into ecr-tag-mutability
ap00rv Sep 26, 2020
be1423e
docs(ecr): update README.md
ap00rv Sep 26, 2020
f2d89d2
doc(ecr): add imageTagMutability prop exclusion to awslint
ap00rv Sep 26, 2020
c3317e7
fix(ecr): revert setting imageTagMutability prop by default
ap00rv Sep 26, 2020
5a39a76
Merge pull request #2 from aws/master
ap00rv Oct 17, 2020
31494b9
fix(ecr): set tag mutability in cfn resource
ap00rv Oct 18, 2020
fa30051
Merge branch 'master' into ecr-tag-mutability
ap00rv Oct 18, 2020
db94331
Merge branch 'master' into ecr-tag-mutability
ap00rv Nov 16, 2020
e5b167f
Merge remote-tracking branch 'origin/master' into ecr-tag-mutability
MrArnoldPalmer Mar 9, 2021
d3306b5
Merge branch 'master' into ecr-tag-mutability
mergify[bot] Mar 9, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions packages/@aws-cdk/aws-ecr/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,13 @@ repository.onImageScanCompleted('ImageScanComplete')
.addTarget(...)
```

### Image tag immutability

You can set tag immutability on images in our repository using the `imageTagMutability` construct prop.

```ts
new ecr.Repository(stack, 'Repo', { imageTagMutability: ecr.TagMutability.IMMUTABLE });
```

### Automatically clean up repositories

Expand Down
30 changes: 30 additions & 0 deletions packages/@aws-cdk/aws-ecr/lib/repository.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,6 +324,13 @@ export interface RepositoryProps {
* @default false
*/
readonly imageScanOnPush?: boolean;

/**
* The tag mutability setting for the repository. If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten.
*
* @default TagMutability.MUTABLE
*/
readonly imageTagMutability?: TagMutability;
}

export interface RepositoryAttributes {
Expand Down Expand Up @@ -407,6 +414,7 @@ export class Repository extends RepositoryBase {
public readonly repositoryArn: string;
private readonly lifecycleRules = new Array<LifecycleRule>();
private readonly registryId?: string;
public readonly imageTagMutability?: string
private policyDocument?: iam.PolicyDocument;

constructor(scope: Construct, id: string, props: RepositoryProps = {}) {
Expand Down Expand Up @@ -435,6 +443,12 @@ export class Repository extends RepositoryBase {
resourceName: this.physicalName,
});

// repository image tag mutability
if (props.imageTagMutability !== undefined) {
this.imageTagMutability = props.imageTagMutability;
resource.imageTagMutability = props.imageTagMutability;
}

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd say we should just move passing this property to the L1 resource up into the constructor. Like

       const resource = new CfnRepository(this, 'Resource', {
      repositoryName: this.physicalName,
      // It says "Text", but they actually mean "Object".
      repositoryPolicyText: Lazy.anyValue({ produce: () => this.policyDocument }),
      lifecyclePolicy: Lazy.anyValue({ produce: () => this.renderLifecyclePolicy() }),
      imageTagMutability: props.imageTagMutability,
    });

If its undefined the property won't be included in synth output.

Copy link
Contributor Author

@ap00rv ap00rv Oct 15, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agreed, will make this change soon, thanks.

// image scanOnPush
if (props.imageScanOnPush) {
new cr.AwsCustomResource(this, 'ImageScanOnPush', {
Expand Down Expand Up @@ -607,3 +621,19 @@ const enum CountType {
*/
SINCE_IMAGE_PUSHED = 'sinceImagePushed',
}

/**
* The tag mutability setting for your repository.
*/
export enum TagMutability {
/**
* allow image tags to be overwritten.
*/
MUTABLE = 'MUTABLE',

/**
* all image tags within the repository will be immutable which will prevent them from being overwritten.
*/
IMMUTABLE = 'IMMUTABLE',

}
1 change: 1 addition & 0 deletions packages/@aws-cdk/aws-ecr/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@
"import:@aws-cdk/aws-ecr.Repository",
"construct-base-is-private:@aws-cdk/aws-ecr.RepositoryBase",
"docs-public-apis:@aws-cdk/aws-ecr.Repository.fromRepositoryArn",
"docs-public-apis:@aws-cdk/aws-ecr.Repository.imageTagMutability",
"docs-public-apis:@aws-cdk/aws-ecr.Repository.fromRepositoryName",
"props-default-doc:@aws-cdk/aws-ecr.LifecycleRule.maxImageAge",
"props-default-doc:@aws-cdk/aws-ecr.LifecycleRule.maxImageCount",
Expand Down
14 changes: 14 additions & 0 deletions packages/@aws-cdk/aws-ecr/test/test.repository.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,20 @@ export = {
test.done();
},


'image tag mutability can be set'(test: Test) {
// GIVEN
const stack = new cdk.Stack();
new ecr.Repository(stack, 'Repo', { imageTagMutability: ecr.TagMutability.IMMUTABLE });

// THEN
expect(stack).to(haveResource('AWS::ECR::Repository', {
ImageTagMutability: 'IMMUTABLE',
}));

test.done();
},

'add day-based lifecycle policy'(test: Test) {
// GIVEN
const stack = new cdk.Stack();
Expand Down