spec: namespace annotations defined in image spec #606
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@opencontainers/image-spec-maintainers PTAL |
vbatts
reviewed
Mar 9, 2017
annotations.md
Outdated
| @@ -9,16 +9,16 @@ Annotations MUST be a key-value map where both the key and value MUST be strings | |||
| While the value MUST be present, it MAY be an empty string. | |||
| Keys MUST be unique within this map, and best practice is to namespace the keys. | |||
| Keys SHOULD be named using a reverse domain notation - e.g. `com.example.myKey`. | |||
| Keys using the `org.opencontainers` namespace are reserved and MUST NOT be used by other specifications and extensions. | |||
| Keys using the `org.opencontainers.image` namespace are reserved and MUST NOT be used by other specifications and extensions. | |||
There was a problem hiding this comment.
i'm not opposed, but wonder how to handle the reservation of org.opencontainers prefix as well?
There was a problem hiding this comment.
How about something like this:
org.opencontainersis reserved for keys defined in Open Container Initiative (OCI) specifications and MUST NOT be used by other specifications and extensions.
Keys using theorg.opencontainers.imagenamespace are reserved for use in the OCI Image Specification and MUST NOT be used by other specifications and extensions, including other OCI specifications.
|
Looks good overall, with +1 to vbatts comment and your suggested solution |
Signed-off-by: Stephen J Day <stephen.day@docker.com>
stevvooe
force-pushed
the
namespace-image-annotations
branch
from
3f18b36
to
8ec42b7
Compare
|
@vbatts @jonboulle Fixed. PTAL. |
|
LGTM, thanks! |
|
LGTM |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Stephen J Day stephen.day@docker.com
Closes #600