Skip to content

Commit aef649d

Browse files
committed
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]: opencontainers/image-spec#333 (comment) Signed-off-by: W. Trevor King <[email protected]>
1 parent 15af793 commit aef649d

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

config.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Using a layer-based or union filesystem such as AUFS, or by computing the diff f
1818

1919
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.
2020
The JSON structure also references a cryptographic hash of each layer used by the image, and provides history information for those layers.
21-
This JSON is considered to be immutable, because changing it would change the computed ImageID.
21+
This JSON is considered to be immutable, because changing it would change the computed [ImageID](#imageid).
2222
Changing it means creating a new derived image, instead of changing the existing image.
2323

2424
### Layer DiffID
@@ -40,9 +40,9 @@ Otherwise the `ChainID` is given by the formula:
4040

4141
### ImageID
4242

43-
Each image's ID is given by the SHA256 hash of its configuration JSON.
43+
Each image's ID is given by the SHA256 hash of its [configuration JSON](#image-json).
4444
It is represented as a hexadecimal encoding of 256 bits, e.g., `sha256:a9561eb1b190625c9adb5a9513e72c4dedafc1cb2d4c5236c9a6957ec7dfd5a9`.
45-
Since the configuration JSON that gets hashed references hashes of each layer in the image, this formulation of the ImageID makes images content-addresable.
45+
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.
4646

4747
## Properties
4848

0 commit comments

Comments
 (0)