From 652ec7c3070265f13d117fbffba1d1c4cedb1cd9 Mon Sep 17 00:00:00 2001 From: Tianon Gravi Date: Thu, 29 Feb 2024 10:23:30 -0800 Subject: [PATCH] Add note about `ImageID` to the `config` section of `manifest.md` 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 --- manifest.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/manifest.md b/manifest.md index ea046863..7430f515 100644 --- a/manifest.md +++ b/manifest.md @@ -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).