From 97c12437e3b04a20f0b133bb248d3a58559c6848 Mon Sep 17 00:00:00 2001 From: "W. Trevor King" Date: Tue, 27 Sep 2016 09:41:50 -0700 Subject: [PATCH] config: Cross-link ImageID and image JSON Originally proposed by Lei Jitang in 28743f6c (Add some links in config.md, 2016-09-18, #301) and not carried by #333 [1]. [1]: https://github.com/opencontainers/image-spec/pull/333#issuecomment-249770880 Signed-off-by: W. Trevor King --- config.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/config.md b/config.md index 7a40d8de3..79ee17362 100644 --- a/config.md +++ b/config.md @@ -18,7 +18,7 @@ Using a layer-based or union filesystem such as AUFS, or by computing the diff f Each image has an associated JSON structure which describes some basic information about the image such as date created, author, and the ID of its parent image as well as execution/runtime configuration like its entrypoint, default arguments, CPU/memory shares, networking, and volumes. The JSON structure also references a cryptographic hash of each layer used by the image, and provides history information for those layers. -This JSON is considered to be immutable, because changing it would change the computed ImageID. +This JSON is considered to be immutable, because changing it would change the computed [ImageID](#imageid). Changing it means creating a new derived image, instead of changing the existing image. ### Layer DiffID @@ -40,9 +40,9 @@ Otherwise the `ChainID` is given by the formula: ### ImageID -Each image's ID is given by the SHA256 hash of its configuration JSON. +Each image's ID is given by the SHA256 hash of its [configuration JSON](#image-json). It is represented as a hexadecimal encoding of 256 bits, e.g., `sha256:a9561eb1b190625c9adb5a9513e72c4dedafc1cb2d4c5236c9a6957ec7dfd5a9`. -Since the configuration JSON that gets hashed references hashes of each layer in the image, this formulation of the ImageID makes images content-addresable. +Since the [configuration JSON](#image-json) that gets hashed references hashes of each layer in the image, this formulation of the ImageID makes images content-addresable. ## Properties