From 6b640411cec9c4623bac3df14d87d3a1d57c9895 Mon Sep 17 00:00:00 2001 From: Valentin Viennot Date: Mon, 4 Apr 2022 11:04:49 +0200 Subject: [PATCH 1/2] Add support annotations Signed-off-by: Valentin Viennot --- annotations.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/annotations.md b/annotations.md index 907220796..288970342 100644 --- a/annotations.md +++ b/annotations.md @@ -27,6 +27,21 @@ This specification defines the following annotation keys, intended for but not l * version MAY be [Semantic versioning-compatible](http://semver.org/) * **org.opencontainers.image.revision** Source control revision identifier for the packaged software. * **org.opencontainers.image.vendor** Name of the distributing entity, organization or individual. +* **org.opencontainers.image.support.end-of-life** Date after which the software won’t receive new features/updates from the publisher. Users should stop using this OCI image and move to a newer version. Publishers may or may not continue to ship security updates. On this day, the OCI image is deprecated. + * This MAY be specified (optional field) + * This SHOULD be specified for maintained software with predictable end of life + * If not empty, + * this MUST be a valid ISO 8601 (YYYY-MM-DD) date format [2] + * `org.opencontainers.image.vendor` MUST provide contact information to the entity responsible for support + * `org.opencontainers.image.support.info` SHOULD provide necessary information for the end user to access the support services +* **org.opencontainers.image.support.end-of-support** Date after which the software won’t receive service, support, or security updates from the publisher. Users must stop using this OCI image. On this day, the OCI image is considered outdated, dangerous to use, and might become unavailable. + * This MAY be specified (optional field) + * This SHOULD be specified only when `support.end-of-life` is also specified + * If not empty, + * this MUST be a valid ISO 8601 (YYYY-MM-DD) date format [2] +* **org.opencontainers.image.support.info** URL or text to provide more information about vendor support and upgrade options. + * This MAY be specified (optional field) + * This SHOULD be displayed by tooling advertising the deprecation status * **org.opencontainers.image.licenses** License(s) under which contained software is distributed as an [SPDX License Expression][spdx-license-expression]. * **org.opencontainers.image.ref.name** Name of the reference for a target (string). * SHOULD only be considered valid when on descriptors on `index.json` within [image layout](image-layout.md). From e35596ff54bdafe5cdda0c5d54f0120ea9b828dc Mon Sep 17 00:00:00 2001 From: Valentin Viennot Date: Mon, 4 Apr 2022 11:11:54 +0200 Subject: [PATCH 2/2] Date formats and language updates Aligning with the verbosity of other annotations as per @sudo-bmitch's feedback - Date formats aligned on rfc3339 - Less verbosity - Less strict Signed-off-by: Valentin Viennot --- annotations.md | 19 +++++-------------- 1 file changed, 5 insertions(+), 14 deletions(-) diff --git a/annotations.md b/annotations.md index 288970342..4892cfe36 100644 --- a/annotations.md +++ b/annotations.md @@ -27,21 +27,12 @@ This specification defines the following annotation keys, intended for but not l * version MAY be [Semantic versioning-compatible](http://semver.org/) * **org.opencontainers.image.revision** Source control revision identifier for the packaged software. * **org.opencontainers.image.vendor** Name of the distributing entity, organization or individual. -* **org.opencontainers.image.support.end-of-life** Date after which the software won’t receive new features/updates from the publisher. Users should stop using this OCI image and move to a newer version. Publishers may or may not continue to ship security updates. On this day, the OCI image is deprecated. - * This MAY be specified (optional field) - * This SHOULD be specified for maintained software with predictable end of life - * If not empty, - * this MUST be a valid ISO 8601 (YYYY-MM-DD) date format [2] - * `org.opencontainers.image.vendor` MUST provide contact information to the entity responsible for support - * `org.opencontainers.image.support.info` SHOULD provide necessary information for the end user to access the support services -* **org.opencontainers.image.support.end-of-support** Date after which the software won’t receive service, support, or security updates from the publisher. Users must stop using this OCI image. On this day, the OCI image is considered outdated, dangerous to use, and might become unavailable. - * This MAY be specified (optional field) - * This SHOULD be specified only when `support.end-of-life` is also specified - * If not empty, - * this MUST be a valid ISO 8601 (YYYY-MM-DD) date format [2] +* **org.opencontainers.image.support.end-of-life** Date and time when the image stops receiving new features and bug fixes (security updates may continue). (Date-time as defined by [RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6).) + * `image.vendor` and `image.support.info` SHOULD also be defined +* **org.opencontainers.image.support.end-of-support** Date and time when the image stops receiving support, including new features, bug fixes, and security updates. (Date-time as defined by [RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6).) + * `image.support.end-of-life` SHOULD also be defined * **org.opencontainers.image.support.info** URL or text to provide more information about vendor support and upgrade options. - * This MAY be specified (optional field) - * This SHOULD be displayed by tooling advertising the deprecation status + * This MAY be displayed by tooling advertising the deprecation status * **org.opencontainers.image.licenses** License(s) under which contained software is distributed as an [SPDX License Expression][spdx-license-expression]. * **org.opencontainers.image.ref.name** Name of the reference for a target (string). * SHOULD only be considered valid when on descriptors on `index.json` within [image layout](image-layout.md).