/cli

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

Allow `x-*` extension on 3rd level objects #1097

Merged
merged 1 commit into from Jun 1, 2018

Conversation

Reviewers

@thaJeztah thaJeztah

@silvin-lubecki silvin-lubecki

@dnephin dnephin

@shin- shin-

Assignees
No one assigned
Labels
area/stack impact/changelog impact/compose-file impact/documentation status/2-code-review
Projects
None yet
Milestone
  18.06.0
4 participants
@vdemeester @silvin-lubecki @thaJeztah @GordonTheTurtle
@vdemeester
Member

vdemeester commented May 31, 2018 •
edited

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
x-top:
  foo: bar

It concerns services, volumes, networks, configs and secrets.

Signed-off-by: Vincent Demeester vincent@sbr.pm
@vdemeester
Allow `x-*` extension on 3rd level objects 
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>
Verified
This commit was signed with a verified signature.
@vdemeester vdemeester Vincent Demeester
GPG key ID: 083CC6FD6EB699A3 Learn about signing commits
Loading status checks…
6bcfa88

@vdemeester vdemeester added the status/1-design-review label May 31, 2018

@vdemeester vdemeester requested review from dnephin, shin-, thaJeztah and silvin-lubecki May 31, 2018

@GordonTheTurtle GordonTheTurtle added the status/0-triage label May 31, 2018

@vdemeester vdemeester removed the status/0-triage label May 31, 2018

@thaJeztah

thaJeztah approved these changes May 31, 2018
View changes

SGTM 👍

This was referenced May 31, 2018

Merged
Open
@silvin-lubecki

This comment has been minimized.

Sign in to view
Contributor

silvin-lubecki commented May 31, 2018

Does docker-compose need this feature too?
@vdemeester

This comment has been minimized.

Sign in to view
Member

vdemeester commented May 31, 2018

@silvin-lubecki yes, there is already a PR in docker/compose for it docker/compose#5995
@silvin-lubecki

silvin-lubecki approved these changes May 31, 2018
View changes

LGTM

@thaJeztah thaJeztah added impact/changelog impact/documentation area/stack impact/compose-file status/2-code-review and removed status/1-design-review labels Jun 1, 2018

@thaJeztah

This comment has been minimized.

Sign in to view
Member

thaJeztah commented Jun 1, 2018

Okay, let's merge!

@thaJeztah thaJeztah merged commit eb54d3e into docker:master Jun 1, 2018
7 checks passed

7 checks passed

ci/circleci: cross Your tests passed on CircleCI!
Details
ci/circleci: lint Your tests passed on CircleCI!
Details
ci/circleci: shellcheck Your tests passed on CircleCI!
Details
ci/circleci: test Your tests passed on CircleCI!
Details
ci/circleci: validate Your tests passed on CircleCI!
Details
continuous-integration/jenkins/pr-head This commit looks good
Details
dco-signed All commits are signed

@GordonTheTurtle GordonTheTurtle added this to the 18.06.0 milestone Jun 1, 2018

@vdemeester vdemeester deleted the vdemeester:x-objects branch Jun 1, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment