Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The problem about index: REQUIRED or OPTIONAL? #1176

Open
Zheaoli opened this issue Mar 4, 2024 · 2 comments
Open

The problem about index: REQUIRED or OPTIONAL? #1176

Zheaoli opened this issue Mar 4, 2024 · 2 comments

Comments

@Zheaoli
Copy link

Zheaoli commented Mar 4, 2024

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

This specification defines an OCI Image, consisting of an [image manifest](manifest.md), an [image index](image-index.md) (optional), a set of [filesystem layers](layer.md), and a [configuration](config.md).

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

- It MUST exist

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
Copy link
Contributor

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
Copy link
Contributor

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants