Skip to content

Commit

Permalink
Add note about ImageID to the config section of manifest.md
Browse files Browse the repository at this point in the history
The `config` digest is used by a number of popular runtimes/orchestrators as an identifier for an image with an amount of assumed uniqueness.

Signed-off-by: Tianon Gravi <admwiggin@gmail.com>
  • Loading branch information
tianon committed Feb 29, 2024
1 parent f5f8701 commit 652ec7c
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@ Unlike the [image index](image-index.md), which contains information about a set

To set an effectively null or empty config and maintain portability see the [guidance for an empty descriptor](#guidance-for-an-empty-descriptor) below, and `DescriptorEmptyJSON` of the reference code.

If this image manifest will be "runnable" by a runtime of some kind, it is strongly recommended to ensure it includes enough data to be unique (such as the `rootfs` and `diff_ids` included in `application/vnd.oci.image.config.v1+json`) so that it has a unique [`ImageID`](config.md#imageid).

- **`layers`** *array of objects*

Each item in the array MUST be a [descriptor](descriptor.md).
Expand Down

0 comments on commit 652ec7c

Please sign in to comment.