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.

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

[YUNIKORN-2446] Add OCI annotations to public docker images #199

Closed
wants to merge 1 commit into from

Conversation

ryankert01
Copy link
Contributor

What is this PR for?

Related PR: apache/yunikorn-k8shim#889

source: #174 (comment)

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

I believe most Yunikorn users are using the docker images into which we push, and so we should consider following a public protocol to set attributions for our public images.

org.opencontainers.image.title="yunikorn-scheduler-k8s"
org.opencontainers.image.description="Apache Yunikorn"
org.opencontainers.image.created="${build_date}"
org.opencontainers.image.source="https://github.com/apache/yunikorn-k8shim"
org.opencontainers.image.url="https://hub.docker.com/r/apache/yunikorn"
org.opencontainers.image.revision="${build_revision}"
org.opencontainers.image.license="Apache-2.0"
org.opencontainers.image.documentation="https://yunikorn.apache.org"

Reference:
[1] Annotations and Labels in Container Images
[2] OCI annotation spec

What type of PR is it?

  • - Bug Fix
  • - Improvement
  • - Feature
  • - Documentation
  • - Hot Fix
  • - Refactoring

Todos

  • - Task

What is the Jira issue?

https://issues.apache.org/jira/browse/YUNIKORN-2446

How should this be tested?

Make all 3 images

make image

Inspect if oci annotations is added into config.labels

docker image inspect --format='{{json .Config.Labels}}' apache/yunikorn:web-amd64-latest | jq

Screenshots (if appropriate)

image

Questions:

  • - The licenses files need update.
  • - There is breaking changes for older versions.
  • - It needs documentation.

Copy link
Contributor

@craigcondit craigcondit left a comment

Choose a reason for hiding this comment

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

+1 LGTM.

dcoric pushed a commit to dcoric/yunikorn-web that referenced this pull request Aug 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants