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

build: apply standard Docker image labels #2400

Merged
merged 2 commits into from
Apr 3, 2020

Conversation

jpeach
Copy link
Contributor

@jpeach jpeach commented Mar 30, 2020

Apply Docker image labels standardized in the OCI container image spec.
This improves our ability to trace the provenance of a Contour image
back to the corresponding source code.

This fixes #2392.

Signed-off-by: James Peach [email protected]

Apply Docker image labels standardized in the OCI container image spec.
This improves our ability to trace the provenance of a Contour image
back to the corresponding source code.

This fixes projectcontour#2392.

Signed-off-by: James Peach <[email protected]>
@jpeach
Copy link
Contributor Author

jpeach commented Mar 30, 2020

$ make container
...
Successfully tagged projectcontour/contour:v1.2.0-91-g7696eb2
$ docker inspect projectcontour/contour:v1.2.0-91-g7696eb2
...
            "Labels": {
                "org.opencontainers.image.created": "2020-03-30T04:46:32+0000",
                "org.opencontainers.image.description": "High performance ingress controller for Kubernetes",
                "org.opencontainers.image.documentation": "https://projectcontour.io/",
                "org.opencontainers.image.licenses": "Apache-2.0",
                "org.opencontainers.image.revision": "7696eb2a6ab51cd0f2d2c1f08086b3c927ba3be6",
                "org.opencontainers.image.source": "https://github.com/projectcontour/contour/archive/v1.2.0-91-g7696eb2.tar.gz",
                "org.opencontainers.image.title": "Contour",
                "org.opencontainers.image.url": "https://projectcontour.io/",
                "org.opencontainers.image.vendor": "Project Contour",
                "org.opencontainers.image.version": "v1.2.0-91-g7696eb2"
            }
...

@jpeach jpeach added this to the 1.4.0 milestone Mar 30, 2020
@poidag-zz
Copy link
Contributor

LGTM

@codecov
Copy link

codecov bot commented Mar 30, 2020

Codecov Report

Merging #2400 into master will decrease coverage by 0.03%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #2400      +/-   ##
==========================================
- Coverage   77.46%   77.42%   -0.04%     
==========================================
  Files          66       66              
  Lines        5423     5423              
==========================================
- Hits         4201     4199       -2     
- Misses       1132     1133       +1     
- Partials       90       91       +1     
Impacted Files Coverage Δ
internal/dag/cache.go 95.34% <0.00%> (-0.72%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4864061...542f43e. Read the comment docs.

Copy link
Member

@youngnick youngnick left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@stevesloka stevesloka left a comment

Choose a reason for hiding this comment

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

Overall looks pretty cool! One thing I noticed is the image url points to projectcontour.io. Should that be something like docker.io/projectcontour/contour?

"org.opencontainers.image.url": "https://projectcontour.io/",

@jpeach
Copy link
Contributor Author

jpeach commented Apr 1, 2020

Overall looks pretty cool! One thing I noticed is the image url points to projectcontour.io. Should that be something like docker.io/projectcontour/contour?

"org.opencontainers.image.url": "https://projectcontour.io/",

The OCI spec documents this field as "URL to find more information on the image". When I read this, I thought it meant more information about the software that ships in the image, but I can see that it can also be read as more information about the image that the software ships in.

If it's the image, then we could go with https://hub.docker.com/r/projectcontour/contour.

The original label-schema definition of this field is:

URL of website with more information about the product or service provided by the container.

This is a lot clearer and would support the first interpretation.

opencontainers/image-spec#802

@youngnick
Copy link
Member

It probably doesn't matter too much, but tend to agree that just the projectcontour page sounds like the info it's intended for.

@jpeach
Copy link
Contributor Author

jpeach commented Apr 3, 2020

@stevesloka WDYT?

@jpeach jpeach added the release-note Denotes a PR that will be considered when it comes time to generate release notes. label Apr 3, 2020
Copy link
Member

@stevesloka stevesloka left a comment

Choose a reason for hiding this comment

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

/lgtm

@stevesloka stevesloka merged commit 5e86b01 into projectcontour:master Apr 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-note Denotes a PR that will be considered when it comes time to generate release notes.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add release metadata to the released Docker images
4 participants