Skip to content

Add more docker image labels #2784

@nitrocode

Description

@nitrocode

Community Note

  • Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request. Searching for pre-existing feature requests helps us consolidate datapoints for identical requirements into a single place, thank you!
  • Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.
  • If you are interested in working on this issue or have submitted a pull request, please leave a comment.

Describe the user story

I'd like to know more information on the images I use

Current labels

LABEL authors="Anubhav Mishra, Luke Kysow"

Describe the solution you'd like

Suggested labels prefixed with org.opencontainers.image

  • source: URL to get source code for building the image
  • revision: Source control revision identifier for the packaged software
  • base.digest: Digest (hash) of the image this image is based on
  • base.name: Image reference of the image this image is based on
  • version: Version of the packaged software

https://github.com/opencontainers/image-spec/blob/main/annotations.md#back-compatibility-with-label-schema

https://snyk.io/blog/how-and-when-to-use-docker-labels-oci-container-annotations/

https://github.com/docker/build-push-action

https://github.com/docker/metadata-action

https://docs.docker.com/build/ci/github-actions/examples/#manage-tags-and-labels

https://github.com/runatlantis/atlantis/blob/main/.github/workflows/atlantis-base.yml

https://github.com/runatlantis/atlantis/blob/main/.github/workflows/atlantis-image.yml

Edit: After #2897

✗ docker inspect ghcr.io/runatlantis/atlantis-base:latest-debian |
jq -r '.[0].Config.Labels'

{
  "org.opencontainers.image.created": "2022-12-29T21:32:22.723Z",
  "org.opencontainers.image.description": "Terraform Pull Request Automation",
  "org.opencontainers.image.licenses": "NOASSERTION",
  "org.opencontainers.image.revision": "b06e3f2c632612dd8a70a7a83713f8aa92bb3e06",
  "org.opencontainers.image.source": "https://github.com/runatlantis/atlantis",
  "org.opencontainers.image.title": "atlantis",
  "org.opencontainers.image.url": "https://github.com/runatlantis/atlantis",
  "org.opencontainers.image.version": "main"
}

✗ docker inspect ghcr.io/runatlantis/atlantis:dev-alpine |
jq -r '.[0].Config.Labels'

{
  "authors": "Anubhav Mishra, Luke Kysow",
  "org.opencontainers.image.created": "2022-12-29T21:32:34.237Z",
  "org.opencontainers.image.description": "Terraform Pull Request Automation",
  "org.opencontainers.image.licenses": "NOASSERTION",
  "org.opencontainers.image.revision": "b06e3f2c632612dd8a70a7a83713f8aa92bb3e06",
  "org.opencontainers.image.source": "https://github.com/runatlantis/atlantis",
  "org.opencontainers.image.title": "atlantis",
  "org.opencontainers.image.url": "https://github.com/runatlantis/atlantis",
  "org.opencontainers.image.version": "main"
}

Describe the drawbacks of your solution

None

Describe alternatives you've considered

Cutting a new image and labeling that. I already do this but id like to some base labels with the metadata i mentioned above

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions