Skip to content

Commit 0d33472

Browse files
authored
Merge pull request #1200 from sudo-bmitch/pr-deprecate-nondistributable
Add deprecation notices to nondistributable layers
2 parents e72ae99 + 7327da4 commit 0d33472

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

layer.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@ This section defines the `application/vnd.oci.image.layer.v1.tar`, `application/
99
## `+gzip` Media Types
1010

1111
- The media type `application/vnd.oci.image.layer.v1.tar+gzip` represents an `application/vnd.oci.image.layer.v1.tar` payload which has been compressed with [gzip][rfc1952_2].
12-
- The media type `application/vnd.oci.image.layer.nondistributable.v1.tar+gzip` represents an `application/vnd.oci.image.layer.nondistributable.v1.tar` payload which has been compressed with [gzip][rfc1952_2].
12+
- The media type `application/vnd.oci.image.layer.nondistributable.v1.tar+gzip` represents an `application/vnd.oci.image.layer.nondistributable.v1.tar` payload ([deprecation notice](#non-distributable-layers)) which has been compressed with [gzip][rfc1952_2].
1313

1414
## `+zstd` Media Types
1515

1616
- The media type `application/vnd.oci.image.layer.v1.tar+zstd` represents an `application/vnd.oci.image.layer.v1.tar` payload which has been compressed with [zstd][rfc8478].
17-
- The media type `application/vnd.oci.image.layer.nondistributable.v1.tar+zstd` represents an `application/vnd.oci.image.layer.nondistributable.v1.tar` payload which has been compressed with [zstd][rfc8478].
17+
- The media type `application/vnd.oci.image.layer.nondistributable.v1.tar+zstd` represents an `application/vnd.oci.image.layer.nondistributable.v1.tar` payload ([deprecation notice](#non-distributable-layers)) which has been compressed with [zstd][rfc8478].
1818

1919
## Distributable Format
2020

@@ -328,11 +328,12 @@ Any given image is likely to be composed of several of these Image Filesystem Ch
328328

329329
> **NOTE**: Non-distributable layers are deprecated, and not recommended for future use.
330330
> Implementations SHOULD NOT produce new non-distributable layers.
331+
> Implementations are expected to support preexisting images with non-distributable layers.
331332
332333
Due to legal requirements, certain layers may not be regularly distributable.
333334
Such "non-distributable" layers are typically downloaded directly from a distributor but never uploaded.
334335

335-
Non-distributable layers SHOULD be tagged with an alternative mediatype of `application/vnd.oci.image.layer.nondistributable.v1.tar`.
336+
Non-distributable layers SHOULD be tagged with an alternative mediatype of `application/vnd.oci.image.layer.nondistributable.v1.tar`, `application/vnd.oci.image.layer.nondistributable.v1.tar+gzip`, or `application/vnd.oci.image.layer.nondistributable.v1.tar+zstd`.
336337
Implementations SHOULD NOT upload layers tagged with this media type; however, such a media type SHOULD NOT affect whether an implementation downloads the layer.
337338

338339
[Descriptors](descriptor.md) referencing non-distributable layers MAY include `urls` for downloading these layers directly; however, the presence of the `urls` field SHOULD NOT be used to determine whether or not a layer is non-distributable.

manifest.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,8 @@ Unlike the [image index](image-index.md), which contains information about a set
8181

8282
- [`application/vnd.oci.image.layer.v1.tar`](layer.md)
8383
- [`application/vnd.oci.image.layer.v1.tar+gzip`](layer.md#gzip-media-types)
84-
- [`application/vnd.oci.image.layer.nondistributable.v1.tar`](layer.md#non-distributable-layers)
85-
- [`application/vnd.oci.image.layer.nondistributable.v1.tar+gzip`](layer.md#gzip-media-types)
84+
- [`application/vnd.oci.image.layer.nondistributable.v1.tar`](layer.md#non-distributable-layers) ([deprecation notice](./layer.md#non-distributable-layers))
85+
- [`application/vnd.oci.image.layer.nondistributable.v1.tar+gzip`](layer.md#gzip-media-types) ([deprecation notice](./layer.md#non-distributable-layers))
8686

8787
Manifests concerned with portability SHOULD use one of the above media types.
8888
Implementations storing or copying image manifests MUST NOT error on encountering a `mediaType` that is unknown to the implementation.

0 commit comments

Comments
 (0)