Skip to content

docs: replace asset annotations with OCI ownership referrer#142

Open
piotrjanik wants to merge 5 commits into
open-component-model:mainfrom
piotrjanik:referrer
Open

docs: replace asset annotations with OCI ownership referrer#142
piotrjanik wants to merge 5 commits into
open-component-model:mainfrom
piotrjanik:referrer

Conversation

@piotrjanik

Copy link
Copy Markdown

Updates §6.3 of the OCI storage backend spec to trace assets to their owning Component Version via a separate ownership referrer manifest (linked through the OCI subject field), instead of mutating the artifact with annotations. This matches ADR 0015 and keeps the artifact's digest and any existing OCI signatures intact.

  • Defines the referrer manifest (artifact type application/vnd.ocm.software.ownership.v1+json, empty config/layer, same repository as the artifact) and discovery via the OCI Referrers API with tag-schema fallback.
  • Rewrites integrity (§6.3.2) and verification (§6.3.3) around the referrer; drops the obsolete software.ocm.base.digest annotation and the ociArtifactDigest/v1 annotation-stripping normalization.
  • Requires referrers to travel with the artifact across registries and OCI Image Layouts.

Fixes: open-component-model/ocm-project#1031

What this PR does / why we need it

Which issue(s) this PR is related to

@piotrjanik piotrjanik changed the title docs: replace asset annotations with OCI ownership referrer docs: replace asset annotations with OCI ownership referrer (DONT MERGE) May 2, 2026
<!-- markdownlint-disable MD041 -->

Updates §6.3 of the OCI storage backend spec to trace assets to their
owning Component Version via a separate *ownership referrer* manifest
(linked through the OCI `subject` field), instead of mutating the
artifact with annotations. This matches ADR 0015 and keeps the
artifact's digest and any existing OCI signatures intact.

- Defines the referrer manifest (artifact type
  `application/vnd.ocm.software.ownership.v1+json`, empty config/layer,
  same repository as the artifact) and discovery via the OCI Referrers
  API with tag-schema fallback.
- Rewrites integrity (§6.3.2) and verification (§6.3.3) around the
  referrer; drops the obsolete `software.ocm.base.digest` annotation
  and the `ociArtifactDigest/v1` annotation-stripping normalization.
- Requires referrers to travel with the artifact across registries and
  OCI Image Layouts.

<!--
Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`.
-->

Fixes: open-component-model/ocm-project#1031
Signed-off-by: Piotr Janik <piotr.janik@sap.com>
@piotrjanik piotrjanik marked this pull request as ready for review June 3, 2026 08:22
@piotrjanik piotrjanik requested a review from a team as a code owner June 3, 2026 08:22
@piotrjanik

Copy link
Copy Markdown
Author

Approval needed from TSC

@piotrjanik piotrjanik changed the title docs: replace asset annotations with OCI ownership referrer (DONT MERGE) docs: replace asset annotations with OCI ownership referrer Jun 3, 2026
@jakobmoellerdev jakobmoellerdev requested a review from a team June 3, 2026 08:32
@Skarlso

Skarlso commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

/vote

Skarlso
Skarlso previously approved these changes Jun 8, 2026
@frewilhelm frewilhelm dismissed Skarlso’s stale review June 11, 2026 08:22

Before merging this PR we need to find out how the GC handles referrers

@piotrjanik

Copy link
Copy Markdown
Author

Regarding Garbage Collection:
open-component-model/ocm-project#1130 (comment)

@jakobmoellerdev

Copy link
Copy Markdown
Member

I think the garbage collection behavior should be part of the spec

Skarlso
Skarlso previously approved these changes Jun 16, 2026
@Skarlso

Skarlso commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Look okay, @piotrjanik can you please sign the commit? :)

Signed-off-by: Piotr Janik <piotr.janik@sap.com>
Comment thread doc/04-extensions/03-storage-backends/oci.md Outdated
Comment thread doc/04-extensions/03-storage-backends/oci.md
Comment thread doc/04-extensions/03-storage-backends/oci.md
@piotrjanik piotrjanik dismissed stale reviews from Skarlso and jakobmoellerdev via f69257a June 19, 2026 13:21
Signed-off-by: Piotr Janik <piotr.janik@sap.com>
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.

Update OCM Spec with Asset-to-Owner Referrer Approach

4 participants