Skip to content

docs(oci): relax component version identification rules #147

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.

Sign up for GitHub

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

Open
piotrjanik wants to merge 2 commits into
base: main
Choose a base branch
from
+16 −2
Open

docs(oci): relax component version identification rules #147

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a6ad18c
docs(oci): relax component version identification rules
piotrjanik Jul 27, 2026
51885fc
docs(oci): prefer componentversion over legacy config media type
piotrjanik Jul 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions doc/04-extensions/03-storage-backends/oci.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -779,20 +779,25 @@ Examples:
| `1.2.3.build-ci.42` | `1.2.3+ci.42` |

Tags **SHOULD** reference a manifest or index (see [6](#6-component-version-storage-models)),
whose descriptor **MUST** include the (deprecated) annotation:
whose descriptor **MAY** include the (deprecated) annotation:

```text
software.ocm.componentversion: "<component>:<version>"
```

The descriptor **MAY** also be identified by component key annotations from [6.3 Asset Annotations](#63-asset-annotations)
as an alternative to the above annotation. Clients **MAY** use one of or both forms for verification:
as an alternative to the above annotation. Clients **SHOULD** use one of or both forms for verification:

```text
software.ocm.component.name: "<component>"
software.ocm.component.version: "<version>"
```

When neither annotation form is present, clients **SHOULD** identify a component version
by the manifest's config media type: the media type defined in
[6.1 Manifest Representation](#61-manifest-representation), or one of the legacy media
types listed in [13. Compatibility Requirements](#13-compatibility-requirements).

### 12.1 Version Aliasing

OCI tags such as `latest`, `stable`, or other user-defined symbolic names are not OCM versions.
Expand Down Expand Up @@ -899,6 +904,12 @@ callers to handle the capability gap gracefully.
* Descriptor formats (YAML, JSON, TAR) **SHOULD** be read; at least one **MUST** be written.
* Index-based representation **MUST NOT** deprecate manifest-based.
* Component Index semantics **MAY** rely on registry referrer support but MUST NOT require it.
* Readers **SHOULD** accept the legacy (pre-OCM Gardener/cnudie) config media types
Comment thread
matthiasbruns marked this conversation as resolved.
`application/vnd.gardener.cloud.cnudie.component.config.v1+json` and
`application/vnd.oci.gardener.cloud.cnudie.component-descriptor-metadata.config.v2+json`
as identifying a component version manifest (see
[12. Tag and Version Mapping Rules](#12-tag-and-version-mapping-rules)); writers
**MUST NOT** produce them.

## Examples (Informative)

Expand Down
Loading