(ecs): ContainerDefinition.addDockerLabel

[blimmer]

Describe the feature

It would be nice to be able to add docker labels after the container has been constructed.

For example, I can call addEnvironment to add an environment variable after the fact: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ContainerDefinition.html#addwbrenvironmentname-value

However, I can't do the same with docker labels.

Use Case

I have a construct that automatically applies Datadog monitoring information to a TaskDefinition with an application container. Datadog requires that I set some information as Docker Labels for observability:

However, I want to add these labels after the user already created their default container.

Proposed Solution

Add a .addDockerLabel method similar to .addEnvironment to the ContainerDefiniton construct. It'd be similar to #2559 / #17889

Other Information

You can hack this like so:

const defaultContainerAsAny = defaultContainer as any;
defaultContainerAsAny.props.dockerLabels = Object.assign(defaultContainerAsAny.props.dockerLabels || {}, {
  "com.datadoghq.tags.env": this.env,
  "com.datadoghq.tags.service": serviceName,

  // TODO: The ECS CircleCI orb doesn't expose the ability to set `dockerLabels` when deploying
  // a task definition update. See https://github.com/CircleCI-Public/aws-ecs-orb/issues/119
  // "com.datadoghq.tags.version": "",

  "com.datadoghq.ad.instances": JSON.stringify([
    { host: "%%host%%", port: defaultContainer.portMappings.length ? defaultContainer.ingressPort : null },
  ]),
  "com.datadoghq.ad.check_names": JSON.stringify([serviceName]),
  "com.datadoghq.ad.init_configs": JSON.stringify([{}]),
});

But it's not ideal

Acknowledgements

• I may be able to implement this feature request
• This feature might incur a breaking change

CDK version used

2.135.0

Environment details (OS name and version, etc.)

MacOS Sonoma

[khushail]

@blimmer ,thanks for reaching out with this request and volunteering for PR contribution.

[blimmer]

@khushail - I'm not sure when I'll be able to get to this. Would you mind also throwing a "good first issue" tag on it?

[khushail]

@khushail - I'm not sure when I'll be able to get to this. Would you mind also throwing a "good first issue" tag on it?

done!

[alpha951]

Hey @khushail , I'm looking for my first contribution here. Could you please assign this issue to me?

[khushail]

Thanks @alpha951 for volunteering to contribute. I just checked there is already a PR submitted.

[alpha951]

Let me know if there are any other beginner friendly issues are still open.

[khushail]

Let me know if there are any other beginner friendly issues are still open.

You can filter out the issues with label "good first issue" and would get a list like this and can pick to work on any issue, you want

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

[aws-cdk-automation]

Comments on closed issues and PRs are hard for our team to see. If you need help, please open a new issue that references this one.