add CNAB_CLAIMS_VERSION and mount path for claim.json #300
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
Signed-off-by: Matt Butcher <[email protected]>
This was referenced Dec 11, 2019
vdice
approved these changes
Dec 11, 2019
400-claims.md
Outdated
|
|
||
| The invocation image may benefit from accessing the claim. Consequently, a claim MUST be attached to the invocation image when the invocation image is started. | ||
|
|
||
| The claim MUST be mounted at the path `/cnab/claim.json` inside of the bundle. The version of this claim that is to be mounted is the _version prior to this operation beginning_. In other words, when a bundle is installed, it creates the original installation claim. On the first upgrade, the claim describe the _installation_ is located at `/cnab/claim.json`. This allows the invocation image to inspect the former state and compare it to the desired new state. |
There was a problem hiding this comment.
Perhaps reword the claim describe to the claim describing or the claim that describes?
radu-matei
reviewed
Dec 12, 2019
400-claims.md
Outdated
|
|
||
| The claim MUST be mounted at the path `/cnab/claim.json` inside of the bundle. The version of this claim that is to be mounted is the _version prior to this operation beginning_. In other words, when a bundle is installed, it creates the original installation claim. On the first upgrade, the claim describe the _installation_ is located at `/cnab/claim.json`. This allows the invocation image to inspect the former state and compare it to the desired new state. | ||
|
|
||
| Note: Systems may be compliant to the core specification but not support the claims specification. If `$CNAB_CLAIMS_VERSION` is not present, a runtime SHOULD assume that the claims specification is not implemented. Bundle authors may therefore have to take care when relying upon `/cnab/claim.json`, accommodating the case where the runtime does not support claims. |
There was a problem hiding this comment.
nit: compliant with the core specification.
There was a problem hiding this comment.
Fixed per @radu-matei 's comment
7 tasks
Merged
3 tasks
Signed-off-by: Matt Butcher <[email protected]>
Co-Authored-By: Glyn Normington <[email protected]>
Signed-off-by: Matt Butcher <[email protected]>
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.
This adds two related features:
$CNAB_CLAIMS_VERSIONspecifies (within the CNAB invocation image) what version of the claims specification is supported/cnab/claim.jsonis the required path in the invocation image where the claim must be presented.Signed-off-by: Matt Butcher [email protected]