Skip to content

Clarify what "ignore" means for a registry#902

Closed
sudo-bmitch wants to merge 1 commit intoopencontainers:mainfrom
sudo-bmitch:pr-extensibility
Closed

Clarify what "ignore" means for a registry#902
sudo-bmitch wants to merge 1 commit intoopencontainers:mainfrom
sudo-bmitch:pr-extensibility

Conversation

@sudo-bmitch
Copy link
Copy Markdown
Contributor

Signed-off-by: Brandon Mitchell git@bmitch.net

In various discussions the question has been raised if "ignore unknown properties" means the fields should be removed by a registry server. This clarifies that a registry shall not modify data being stored/returned in a content addressable store.

@tianon
Copy link
Copy Markdown
Member

tianon commented Mar 31, 2022

Clarrify

👀

(both in the commit message and the title)

Signed-off-by: Brandon Mitchell <git@bmitch.net>
@sudo-bmitch sudo-bmitch changed the title Clarrify what "ignore" means for a registry Clarify what "ignore" means for a registry Mar 31, 2022
@sudo-bmitch
Copy link
Copy Markdown
Contributor Author

Pinging @opencontainers/image-spec-maintainers since this question is getting asked again.


Implementations that are reading/processing [manifests](manifest.md) or [image indexes](image-index.md) MUST NOT generate an error if they encounter an unknown property.
Instead they MUST ignore unknown properties.
Implementations that are storing/returning manifests and blobs in a content addressable store SHALL NOT modify that content, even when encountering unknown properties.
Copy link
Copy Markdown
Member

@sajayantony sajayantony Dec 1, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there any reason this is not a MUST?
--update
This comment it moot -
SHALL NOT is equivalent to must as per - https://www.rfc-editor.org/rfc/rfc2119
in https://github.com/opencontainers/image-spec/blob/4df8887994e871a59f9e30e8dd811d060f6a39ef/spec.md

@sudo-bmitch
Copy link
Copy Markdown
Contributor Author

Closing this this has been resolved in other PRs.

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

Successfully merging this pull request may close these issues.

3 participants