FairwindsOps / goldilocks

Get your resource requests "Just Right"
https://fairwinds.com
Apache License 2.0
2.48k stars 133 forks source link

Provide opencontainers labels in Dockerfile #410

Closed mstoetzer closed 2 years ago

mstoetzer commented 2 years ago

It could be a nice addition to provide official opencontainers labels in the Dockerfile of goldilocks:

LABEL org.opencontainers.image.authors="xxxx" \
      org.opencontainers.image.source="https://github.com/FairwindsOps/goldilocks" \
      org.opencontainers.image.description="Goldilocks is a utility that can help you identify a starting point for resource requests and limits." \
      org.opencontainers.image.documentation="https://goldilocks.docs.fairwinds.com/" \
      org.opencontainers.image.licenses="Apache License 2.0" \
      org.opencontainers.image.title="goldilocks" \
      org.opencontainers.image.url="https://github.com/FairwindsOps/goldilocks" \
      org.opencontainers.image.vendor="FairwindsOps"

One example why this is useful is dependabot or renovatebot. When these tools update the dockerimage version, they can extract the release notes from the source label and provide it in the pullrequest. See the renovate docs

What do you think?

sudermanjr commented 2 years ago

I think it's a great idea. If you would like to add that via Pull Request we would be totally onboard.

hummelh commented 2 years ago

+1

For reference: https://github.com/opencontainers/image-spec/blob/main/annotations.md