search

opencontainers / image-spec

OCI Image Format
https://www.opencontainers.org/
Apache License 2.0
3.34k stars 624 forks source link

The problem about index: REQUIRED or OPTIONAL? #1176

Open Zheaoli opened 4 months ago

Zheaoli commented 4 months ago

I have noticed that we describe the index as an optional in here

https://github.com/opencontainers/image-spec/blob/f5f87016de46439ccf91b5381cf76faaae2bc28f/spec.md?plain=1#L5

But we describe that the index.json is REQUIRED in here

https://github.com/opencontainers/image-spec/blob/f5f87016de46439ccf91b5381cf76faaae2bc28f/image-layout.md?plain=1#L28

Is there a conflict description?

FYI I have noticed that the OPTIONAL is added in this PR https://github.com/opencontainers/image-spec/pull/455/files

cc @coolljt0725

michaelb990 commented 4 months ago

The image-layout.md describes the way to organize an image as a directory structure. The index.json file described in the Image Layout spec is specific to the on-disk representation of an image and isn't the same as an "image index" described in the image-index.md file. Perhaps it's worth disambiguating the index.json file in the image-layout.md specification.

sudo-bmitch commented 4 months ago

I believe this is a duplicate of #1175. I'm curious if there's something outside of OCI happening that is causing the sudden attention on this?