tyler.durden/compose
1
0
Fork 0
mirror of https://github.com/docker/compose.git synced 2025-07-27 07:34:10 +02:00
Code Issues Packages Projects Releases Wiki Activity

Allow x-* extension on 3rd level objects

Browse Source 
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>
This commit is contained in:
Vincent Demeester 2018-05-31 14:12:10 +02:00
parent b9cccf2efc
commit 7a19b7548f
No known key found for this signature in database
GPG Key ID: 083CC6FD6EB699A3
2 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
compose/config/config_schema_v2.4.json
View File

@ -346,6 +346,7 @@
"dependencies": { "dependencies": {
"memswap_limit": ["mem_limit"] "memswap_limit": ["mem_limit"]
}, },
"patternProperties": {"^x-": {}},
"additionalProperties": false "additionalProperties": false
}, },
@ -409,6 +410,7 @@
"labels": {"$ref": "#/definitions/labels"}, "labels": {"$ref": "#/definitions/labels"},
"name": {"type": "string"} "name": {"type": "string"}
}, },
"patternProperties": {"^x-": {}},
"additionalProperties": false "additionalProperties": false
}, },
@ -451,6 +453,7 @@
"labels": {"$ref": "#/definitions/labels"}, "labels": {"$ref": "#/definitions/labels"},
"name": {"type": "string"} "name": {"type": "string"}
}, },
"patternProperties": {"^x-": {}},
"additionalProperties": false "additionalProperties": false
}, },

5
compose/config/config_schema_v3.7.json
View File

@ -319,6 +319,7 @@
}, },
"working_dir": {"type": "string"} "working_dir": {"type": "string"}
}, },
"patternProperties": {"^x-": {}},
"additionalProperties": false "additionalProperties": false
}, },
@ -489,6 +490,7 @@
"attachable": {"type": "boolean"}, "attachable": {"type": "boolean"},
"labels": {"$ref": "#/definitions/list_or_dict"} "labels": {"$ref": "#/definitions/list_or_dict"}
}, },
"patternProperties": {"^x-": {}},
"additionalProperties": false "additionalProperties": false
}, },
@ -513,6 +515,7 @@
}, },
"labels": {"$ref": "#/definitions/list_or_dict"} "labels": {"$ref": "#/definitions/list_or_dict"}
}, },
"patternProperties": {"^x-": {}},
"additionalProperties": false "additionalProperties": false
}, },
@ -530,6 +533,7 @@
}, },
"labels": {"$ref": "#/definitions/list_or_dict"} "labels": {"$ref": "#/definitions/list_or_dict"}
}, },
"patternProperties": {"^x-": {}},
"additionalProperties": false "additionalProperties": false
}, },
@ -547,6 +551,7 @@
}, },
"labels": {"$ref": "#/definitions/list_or_dict"} "labels": {"$ref": "#/definitions/list_or_dict"}
}, },
"patternProperties": {"^x-": {}},
"additionalProperties": false "additionalProperties": false
}, },