Allow x-* extension on 3rd level objects
#1097
Merged
Conversation
Verified
This commit was signed with the committer’s verified signature.
vdemeester
Vincent Demeester
As for top-level key, any 3rd-level key which starts with `x-` will be ignored by compose. This allows for users to: * include additional metadata in their compose files * create YAML anchor objects that can be re-used in other parts of the config This matches a similar feature in the swagger spec definition: https://swagger.io/specification/#specificationExtensions This means a composefile like the following is valid ``` verison: "3.7" services: foo: image: foo/bar x-foo: bar network: bar: x-bar: baz ``` It concerns services, volumes, networks, configs and secrets. Signed-off-by: Vincent Demeester <vincent@sbr.pm>
|
SGTM |
This was referenced May 31, 2018
|
Does docker-compose need this feature too? |
|
@silvin-lubecki yes, there is already a PR in |
|
LGTM |
thaJeztah
added
impact/changelog
impact/documentation
area/stack
impact/compose-file
status/2-code-review
and removed
status/1-design-review
labels
|
Okay, let's merge! |
thaJeztah
merged commit eb54d3e
into
docker:master
7 checks passed
7 checks passed
dco-signed
All commits are signed
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.
As for top-level key, any 3rd-level key which starts with
x-will beignored by compose. This allows for users to:
This matches a similar feature in the swagger spec definition:
https://swagger.io/specification/#specificationExtensions
This means a composefile like the following is valid
It concerns services, volumes, networks, configs and secrets.
Signed-off-by: Vincent Demeester vincent@sbr.pm