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

add opencontainers labels to the docker images #1053

Open
mikaello opened this issue May 8, 2024 · 5 comments
Open

add opencontainers labels to the docker images #1053

mikaello opened this issue May 8, 2024 · 5 comments
Labels

Comments

@mikaello
Copy link

mikaello commented May 8, 2024

Request: Make the published docker images contain org.opencontainers.image.source label for easy reference back to this repository when the image gets updates. This is useful for tools like Renovate that makes updates to repositories when this image gets updates. OCI has standardized a few labels for adding metadata to images: https://github.com/opencontainers/image-spec/blob/main/annotations.md

You have currently a few labels already, but it would have been nice if the mentioned org.opencontainers.image.source label were added, and preferable also the other standardized labels.

Example of labels in javascript-node:

$ docker pull mcr.microsoft.com/devcontainers/javascript-node:latest
$ docker inspect mcr.microsoft.com/devcontainers/javascript-node:latest --format '{{ json .Config.Labels }}'

Output:

{
  "dev.containers.id": "javascript-node",
  "dev.containers.release": "v0.3.36",
  "dev.containers.source": "https://github.com/devcontainers/images",
  "dev.containers.timestamp": "Tue, 07 May 2024 23:52:33 GMT",
  "dev.containers.variant": "22-bookworm",
  "devcontainer.metadata": "[ {\"id\":\"ghcr.io/devcontainers/features/common-utils:2\"}, {\"id\":\"ghcr.io/devcontainers/features/git:1\"}, {\"id\":\"ghcr.io/devcontainers/features/node:1\",\"customizations\":{\"vscode\":{\"extensions\":[\"dbaeumer.vscode-eslint\"]}}}, {\"customizations\":{\"vscode\":{\"extensions\":[\"dbaeumer.vscode-eslint\"]}},\"remoteUser\":\"node\"} ]",
  "version": "1.1.0"
}
@samruddhikhandale
Copy link
Member

Hi 👋

With the migration of the Dev Containers Spec to an Open Spec, I believe the Dev Container Images can also be standardized by the Open Containers Initiative (OCI).

Hence, I think it makes sense to add some well-perceived labels to the images we publish from this repo

Looping in @bamurtaugh @craiglpeters for any other thoughts.

@bamurtaugh
Copy link
Member

Thanks for opening this issue and for looping me in! I agree with what's been mentioned so far.

@mikaello
Copy link
Author

mikaello commented May 9, 2024

Thanks both of you for your fast acknowledgement.

I try to keep up to date with the development of features and the community, but haven't heard of "Open Spec" before, do you have any pointers/references to more information on that migration?

@bamurtaugh
Copy link
Member

haven't heard of "Open Spec" before, do you have any pointers/references to more information on that migration?

Apologies for lack of clarity! We just mean that dev containers are an open source specification. You can explore all the repos part of the spec in the devcontainers org on GitHub, and read more about our work on https://containers.dev/.

@KuCoinEneko
Copy link

https://containers.dev/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants