Bug 2151849 - Please add org.opencontainers.image.* labels
Summary: Please add org.opencontainers.image.* labels
Keywords:
Status: ASSIGNED
Alias: None
Product: Fedora Container Images
Classification: Fedora
Component: base
Version: 39
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
Assignee: Clement Verna
QA Contact:
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2022-12-08 10:05 UTC by Jan Pazdziora (Red Hat)
Modified: 2025-02-24 08:23 UTC (History)
3 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2024-11-27 21:03:26 UTC
Type: Bug
Embargoed:


Attachments (Terms of Use)

Description Jan Pazdziora (Red Hat) 2022-12-08 10:05:54 UTC
Description of problem:

While trying to quickly figure out the reason for bug 2151844, I came across the problem that by looking at the image and without extensive knowledge of the build process and systems, it is not clear where the Fedora base image came from. We should make it easier for our users to find the sources.

Please consider adding org.opencontainers.image.* labels per https://github.com/opencontainers/image-spec/blob/main/annotations.md to point at the source of the Fedora container images. At minimum, org.opencontainers.image.source and org.opencontainers.image.revision would be useful.

Version-Release number of selected component (if applicable):

registry.fedoraproject.org/fedora:37

How reproducible:

Deterministic.

Steps to Reproduce:
1. $ skopeo inspect docker://registry.fedoraproject.org/fedora:37 | jq '.Labels'

Actual results:

{
  "license": "MIT",
  "name": "fedora",
  "vendor": "Fedora Project",
  "version": "37"
}

Expected results:

{
  "license": "MIT",
  "name": "fedora",
  "org.opencontainers.image.revision": "1234567890abcdef1234567890abcdef12345678",
  "org.opencontainers.image.source": "https://some.host/some.source.kickstart.or.link.to.a.build.process",
  "vendor": "Fedora Project",
  "version": "37"
}

Additional info:

This is how we use the org.opencontainers.image.* labels for the quay.io/freeipa/freeipa-server images:

$ skopeo inspect docker://quay.io/freeipa/freeipa-server:fedora-37 | jq '.Labels'
{
  "license": "MIT",
  "name": "FreeIPA server",
  "org.opencontainers.image.authors": "FreeIPA Developers <freeipa-devel.org>",
  "org.opencontainers.image.base.digest": "sha256:0f65bee641e821f8118acafb44c2f8fe30c2fc6b9a2b3729c0660376391aa117",
  "org.opencontainers.image.base.name": "registry.fedoraproject.org/fedora:37",
  "org.opencontainers.image.created": "2022-12-05 04:36:58+00:00",
  "org.opencontainers.image.revision": "3d66a1253834c855d3baceadf6305590ca6563ee",
  "org.opencontainers.image.source": "https://github.com/freeipa/freeipa-container/actions/runs/3616965644",
  "org.opencontainers.image.title": "FreeIPA server",
  "org.opencontainers.image.version": "4.10.1-rpms-502ca9e268d2e2a8106418d6b1ef6a69e3bce3300a0ac7d7d3f5f80bd45c46ce-gittree-c6a948ec5a29c97fa8d4e62e665d6f2717b8b8d2",
  "vendor": "Fedora Project",
  "version": "4.10.1"
}

Comment 1 Aoife Moloney 2023-11-23 00:43:29 UTC
This message is a reminder that Fedora Linux 37 is nearing its end of life.
Fedora will stop maintaining and issuing updates for Fedora Linux 37 on 2023-12-05.
It is Fedora's policy to close all bug reports from releases that are no longer
maintained. At that time this bug will be closed as EOL if it remains open with a
'version' of '37'.

Package Maintainer: If you wish for this bug to remain open because you
plan to fix it in a currently maintained version, change the 'version' 
to a later Fedora Linux version. Note that the version field may be hidden.
Click the "Show advanced fields" button if you do not see it.

Thank you for reporting this issue and we are sorry that we were not 
able to fix it before Fedora Linux 37 is end of life. If you would still like 
to see this bug fixed and are able to reproduce it against a later version 
of Fedora Linux, you are encouraged to change the 'version' to a later version
prior to this bug being closed.

Comment 2 Jan Pazdziora (Red Hat) 2023-11-23 09:13:28 UTC
The issue is still present with Fedora 39 images:

$ skopeo inspect docker://registry.fedoraproject.org/fedora:39 | jq '.Labels'
{
  "license": "MIT",
  "name": "fedora",
  "vendor": "Fedora Project",
  "version": "39"
}

Comment 3 Aoife Moloney 2024-11-08 10:45:30 UTC
This message is a reminder that Fedora Linux 39 is nearing its end of life.
Fedora will stop maintaining and issuing updates for Fedora Linux 39 on 2024-11-26.
It is Fedora's policy to close all bug reports from releases that are no longer
maintained. At that time this bug will be closed as EOL if it remains open with a
'version' of '39'.

Package Maintainer: If you wish for this bug to remain open because you
plan to fix it in a currently maintained version, change the 'version' 
to a later Fedora Linux version. Note that the version field may be hidden.
Click the "Show advanced fields" button if you do not see it.

Thank you for reporting this issue and we are sorry that we were not 
able to fix it before Fedora Linux 39 is end of life. If you would still like 
to see this bug fixed and are able to reproduce it against a later version 
of Fedora Linux, you are encouraged to change the 'version' to a later version
prior to this bug being closed.

Comment 4 Aoife Moloney 2024-11-27 21:03:26 UTC
Fedora Linux 39 entered end-of-life (EOL) status on 2024-11-26.

Fedora Linux 39 is no longer maintained, which means that it
will not receive any further security or bug fix updates. As a result we
are closing this bug.

If you can reproduce this bug against a currently maintained version of Fedora Linux
please feel free to reopen this bug against that version. Note that the version
field may be hidden. Click the "Show advanced fields" button if you do not see
the version field.

If you are unable to reopen this bug, please file a new report against an
active release.

Thank you for reporting this bug and we are sorry it could not be fixed.

Comment 5 Jan Pazdziora 2025-02-14 19:06:11 UTC
Let me reopen.

The topic of where a Fedora image came from was recently surfaced in bug 2344322.

I can see that compared to Fedora 39 images, the latest Fedora images started to adopt the org.opencontainers.image.* labels:

$ skopeo inspect docker://registry.fedoraproject.org/fedora:39 | jq '.Labels'
{
  "license": "MIT",
  "name": "fedora",
  "vendor": "Fedora Project",
  "version": "39"
}
$ skopeo inspect docker://registry.fedoraproject.org/fedora:42 | jq '.Labels'
{
  "io.buildah.version": "1.39.0",
  "license": "MIT",
  "name": "fedora",
  "org.opencontainers.image.license": "MIT",
  "org.opencontainers.image.name": "fedora",
  "org.opencontainers.image.url": "https://fedoraproject.org/",
  "org.opencontainers.image.vendor": "Fedora Project",
  "org.opencontainers.image.version": "42",
  "vendor": "Fedora Project",
  "version": "42"
}

What is however still missing and useful to folks who happen to observe some behaviour of some Fedora image and wonder where it came from, are labels like

  "org.opencontainers.image.revision": "1234567890abcdef1234567890abcdef12345678",
  "org.opencontainers.image.source": "https://some.host/some.source.kickstart.or.link.to.a.build.process",

dynamically populated for each image.

Whether they should be pointing to under https://pagure.io/fedora-kiwi-descriptions, or link to job that built the specific image, or some completely different information, is to be fleshed out.


Note You need to log in before you can comment on or make changes to this bug.