terascope / teraslice

Scalable data processing pipelines in JavaScript
https://terascope.github.io/teraslice/
Apache License 2.0
50 stars 13 forks source link

Teraslice Docker Images Should have Annotations (labels) #3257

Closed godber closed 2 months ago

godber commented 2 years ago

The Teraslice Docker Image should have an image LABEL or annotation:

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

For example

https://github.com/opensearch-project/opensearch-build/blob/main/docker/release/dockerfiles/opensearch.al2.dockerfile#L97-L106

or

https://github.com/elastic/dockerfiles/blob/8.1/elasticsearch/Dockerfile#L138-L156

mkhpalm commented 8 months ago

How about adding this to Dockerfile for opencontainers image spec

LABEL org.opencontainers.image.version="$TERASLICE_VERSION" \
  org.opencontainers.image.created="$BUILD_TIMESTAMP" \
  org.opencontainers.image.documentation="https://terascope.github.io/teraslice/docs/overview" \
  org.opencontainers.image.licenses="Apache-2.0" \
  org.opencontainers.image.revision="$GITHUB_SHA" \
  org.opencontainers.image.source="https://github.com/terascope/teraslice" \
  org.opencontainers.image.title="Teraslice" \
  org.opencontainers.image.url="https://terascope.github.io/teraslice" \
  org.opencontainers.image.vendor="Terascope"
busma13 commented 3 months ago

Are TERASLICE_VERSION and BUILD_TIMESTAMP environmental variables that will be available in CI? I know GITHUB_SHA is. I can grab the teraslice version out of the package.json if needed.