compose_yml 0.0.59

Parse, manipulate and serialize docker-compose.yml in a strongly-typed fashion
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "id": "config_schema_v2.2.json",
    "type": "object",
  
    "properties": {
      "version": {
        "type": "string"
      },
  
      "services": {
        "id": "#/properties/services",
        "type": "object",
        "patternProperties": {
          "^[a-zA-Z0-9._-]+$": {
            "$ref": "#/definitions/service"
          }
        },
        "additionalProperties": false
      },
  
      "networks": {
        "id": "#/properties/networks",
        "type": "object",
        "patternProperties": {
          "^[a-zA-Z0-9._-]+$": {
            "$ref": "#/definitions/network"
          }
        }
      },
  
      "volumes": {
        "id": "#/properties/volumes",
        "type": "object",
        "patternProperties": {
          "^[a-zA-Z0-9._-]+$": {
            "$ref": "#/definitions/volume"
          }
        },
        "additionalProperties": false
      }
    },
  
    "patternProperties": {"^x-": {}},
    "additionalProperties": false,
  
    "definitions": {
  
      "service": {
        "id": "#/definitions/service",
        "type": "object",
  
        "properties": {
          "blkio_config": {
            "type": "object",
            "properties": {
              "device_read_bps": {
                "type": "array",
                "items": {"$ref": "#/definitions/blkio_limit"}
              },
              "device_read_iops": {
                "type": "array",
                "items": {"$ref": "#/definitions/blkio_limit"}
              },
              "device_write_bps": {
                "type": "array",
                "items": {"$ref": "#/definitions/blkio_limit"}
              },
              "device_write_iops": {
                "type": "array",
                "items": {"$ref": "#/definitions/blkio_limit"}
              },
              "weight": {"type": "integer"},
              "weight_device": {
                "type": "array",
                "items": {"$ref": "#/definitions/blkio_weight"}
              }
            },
            "additionalProperties": false
          },
  
          "build": {
            "oneOf": [
              {"type": "string"},
              {
                "type": "object",
                "properties": {
                  "context": {"type": "string"},
                  "dockerfile": {"type": "string"},
                  "args": {"$ref": "#/definitions/list_or_dict"},
                  "labels": {"$ref": "#/definitions/labels"},
                  "cache_from": {"$ref": "#/definitions/list_of_strings"},
                  "network": {"type": "string"},
                  "isolation": {"type": "string"}
                },
                "additionalProperties": false
              }
            ]
          },
          "cap_add": {"type": "array", "items": {"type": "string"}, "uniqueItems": true},
          "cap_drop": {"type": "array", "items": {"type": "string"}, "uniqueItems": true},
          "cgroup_parent": {"type": "string"},
          "command": {
            "oneOf": [
              {"type": "string"},
              {"type": "array", "items": {"type": "string"}}
            ]
          },
          "container_name": {"type": "string"},
          "cpu_count": {"type": "integer", "minimum": 0},
          "cpu_percent": {"type": "integer", "minimum": 0, "maximum": 100},
          "cpu_shares": {"type": ["number", "string"]},
          "cpu_quota": {"type": ["number", "string"]},
          "cpu_period": {"type": ["number", "string"]},
          "cpu_rt_period": {"type": ["number", "string"]},
          "cpu_rt_runtime": {"type": ["number", "string"]},
          "cpus": {"type": "number", "minimum": 0},
          "cpuset": {"type": "string"},
          "depends_on": {
            "oneOf": [
              {"$ref": "#/definitions/list_of_strings"},
              {
                "type": "object",
                "additionalProperties": false,
                "patternProperties": {
                  "^[a-zA-Z0-9._-]+$": {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                      "condition": {
                        "type": "string",
                        "enum": ["service_started", "service_healthy"]
                      }
                    },
                    "required": ["condition"]
                  }
                }
              }
            ]
          },
          "devices": {"type": "array", "items": {"type": "string"}, "uniqueItems": true},
          "dns_opt": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "uniqueItems": true
          },
          "dns": {"$ref": "#/definitions/string_or_list"},
          "dns_search": {"$ref": "#/definitions/string_or_list"},
          "domainname": {"type": "string"},
          "entrypoint": {
            "oneOf": [
              {"type": "string"},
              {"type": "array", "items": {"type": "string"}}
            ]
          },
          "env_file": {"$ref": "#/definitions/string_or_list"},
          "environment": {"$ref": "#/definitions/list_or_dict"},
  
          "expose": {
            "type": "array",
            "items": {
              "type": ["string", "number"],
              "format": "expose"
            },
            "uniqueItems": true
          },
  
          "extends": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "object",
  
                "properties": {
                  "service": {"type": "string"},
                  "file": {"type": "string"}
                },
                "required": ["service"],
                "additionalProperties": false
              }
            ]
          },
  
          "external_links": {"type": "array", "items": {"type": "string"}, "uniqueItems": true},
          "extra_hosts": {"$ref": "#/definitions/list_or_dict"},
          "healthcheck": {"$ref": "#/definitions/healthcheck"},
          "hostname": {"type": "string"},
          "image": {"type": "string"},
          "init": {"type": ["boolean", "string"]},
          "ipc": {"type": "string"},
          "isolation": {"type": "string"},
          "labels": {"$ref": "#/definitions/labels"},
          "links": {"type": "array", "items": {"type": "string"}, "uniqueItems": true},
  
          "logging": {
              "type": "object",
  
              "properties": {
                  "driver": {"type": "string"},
                  "options": {"type": "object"}
              },
              "additionalProperties": false
          },
  
          "mac_address": {"type": "string"},
          "mem_limit": {"type": ["number", "string"]},
          "mem_reservation": {"type": ["string", "integer"]},
          "mem_swappiness": {"type": "integer"},
          "memswap_limit": {"type": ["number", "string"]},
          "network_mode": {"type": "string"},
  
          "networks": {
            "oneOf": [
              {"$ref": "#/definitions/list_of_strings"},
              {
                "type": "object",
                "patternProperties": {
                  "^[a-zA-Z0-9._-]+$": {
                    "oneOf": [
                      {
                        "type": "object",
                        "properties": {
                          "aliases": {"$ref": "#/definitions/list_of_strings"},
                          "ipv4_address": {"type": "string"},
                          "ipv6_address": {"type": "string"},
                          "link_local_ips": {"$ref": "#/definitions/list_of_strings"},
                          "priority": {"type": "number"}
                        },
                        "additionalProperties": false
                      },
                      {"type": "null"}
                    ]
                  }
                },
                "additionalProperties": false
              }
            ]
          },
          "oom_kill_disable": {"type": "boolean"},
          "oom_score_adj": {"type": "integer", "minimum": -1000, "maximum": 1000},
          "group_add": {
              "type": "array",
              "items": {
                  "type": ["string", "number"]
              },
              "uniqueItems": true
          },
          "pid": {"type": ["string", "null"]},
  
          "ports": {
            "type": "array",
            "items": {
              "type": ["string", "number"],
              "format": "ports"
            },
            "uniqueItems": true
          },
  
          "privileged": {"type": "boolean"},
          "read_only": {"type": "boolean"},
          "restart": {"type": "string"},
          "scale": {"type": "integer"},
          "security_opt": {"type": "array", "items": {"type": "string"}, "uniqueItems": true},
          "shm_size": {"type": ["number", "string"]},
          "sysctls": {"$ref": "#/definitions/list_or_dict"},
          "pids_limit": {"type": ["number", "string"]},
          "stdin_open": {"type": "boolean"},
          "stop_grace_period": {"type": "string", "format": "duration"},
          "stop_signal": {"type": "string"},
          "storage_opt": {"type": "object"},
          "tmpfs": {"$ref": "#/definitions/string_or_list"},
          "tty": {"type": "boolean"},
          "ulimits": {
            "type": "object",
            "patternProperties": {
              "^[a-z]+$": {
                "oneOf": [
                  {"type": "integer"},
                  {
                    "type":"object",
                    "properties": {
                      "hard": {"type": "integer"},
                      "soft": {"type": "integer"}
                    },
                    "required": ["soft", "hard"],
                    "additionalProperties": false
                  }
                ]
              }
            }
          },
          "user": {"type": "string"},
          "userns_mode": {"type": "string"},
          "volumes": {"type": "array", "items": {"type": "string"}, "uniqueItems": true},
          "volume_driver": {"type": "string"},
          "volumes_from": {"type": "array", "items": {"type": "string"}, "uniqueItems": true},
          "working_dir": {"type": "string"}
        },
  
        "dependencies": {
          "memswap_limit": ["mem_limit"]
        },
        "additionalProperties": false
      },
  
      "healthcheck": {
        "id": "#/definitions/healthcheck",
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "disable": {"type": "boolean"},
          "interval": {"type": "string"},
          "retries": {"type": "number"},
          "test": {
            "oneOf": [
              {"type": "string"},
              {"type": "array", "items": {"type": "string"}}
            ]
          },
          "timeout": {"type": "string"}
        }
      },
  
      "network": {
        "id": "#/definitions/network",
        "type": "object",
        "properties": {
          "driver": {"type": "string"},
          "driver_opts": {
            "type": "object",
            "patternProperties": {
              "^.+$": {"type": ["string", "number"]}
            }
          },
          "ipam": {
              "type": "object",
              "properties": {
                  "driver": {"type": "string"},
                  "config": {
                      "type": "array",
                      "items": {"$ref": "#/definitions/ipam_config"}
                  },
                  "options": {
                    "type": "object",
                    "patternProperties": {
                      "^.+$": {"type": "string"}
                    },
                    "additionalProperties": false
                  }
              },
              "additionalProperties": false
          },
          "external": {
            "type": ["boolean", "object"],
            "properties": {
              "name": {"type": "string"}
            },
            "additionalProperties": false
          },
          "internal": {"type": "boolean"},
          "enable_ipv6": {"type": "boolean"},
          "labels": {"$ref": "#/definitions/labels"},
          "name": {"type": "string"}
        },
        "additionalProperties": false
      },
  
      "ipam_config": {
        "id": "#/definitions/ipam_config",
        "type": "object",
        "properties": {
          "subnet": {"type": "string"},
          "ip_range": {"type": "string"},
          "gateway": {"type": "string"},
          "aux_addresses": {
            "type": "object",
            "patternProperties": {
              "^.+$": {"type": "string"}
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
  
      "volume": {
        "id": "#/definitions/volume",
        "type": ["object", "null"],
        "properties": {
          "driver": {"type": "string"},
          "driver_opts": {
            "type": "object",
            "patternProperties": {
              "^.+$": {"type": ["string", "number"]}
            }
          },
          "external": {
            "type": ["boolean", "object"],
            "properties": {
              "name": {"type": "string"}
            },
            "additionalProperties": false
          },
          "labels": {"$ref": "#/definitions/labels"},
          "name": {"type": "string"}
        },
        "additionalProperties": false
      },
  
      "string_or_list": {
        "oneOf": [
          {"type": "string"},
          {"$ref": "#/definitions/list_of_strings"}
        ]
      },
  
      "list_of_strings": {
        "type": "array",
        "items": {"type": "string"},
        "uniqueItems": true
      },
  
      "list_or_dict": {
        "oneOf": [
          {
            "type": "object",
            "patternProperties": {
              ".+": {
                "type": ["string", "number", "null"]
              }
            },
            "additionalProperties": false
          },
          {"type": "array", "items": {"type": "string"}, "uniqueItems": true}
        ]
      },
  
      "labels": {
        "oneOf": [
          {
            "type": "object",
            "patternProperties": {
              ".+": {
                "type": "string"
              }
            },
            "additionalProperties": false
          },
          {"type": "array", "items": {"type": "string"}, "uniqueItems": true}
        ]
      },
  
      "blkio_limit": {
        "type": "object",
        "properties": {
          "path": {"type": "string"},
          "rate": {"type": ["integer", "string"]}
        },
        "additionalProperties": false
      },
      "blkio_weight": {
        "type": "object",
        "properties": {
          "path": {"type": "string"},
          "weight": {"type": "integer"}
        },
        "additionalProperties": false
      },
  
      "constraints": {
        "service": {
          "id": "#/definitions/constraints/service",
          "anyOf": [
            {"required": ["build"]},
            {"required": ["image"]}
          ],
          "properties": {
            "build": {
              "required": ["context"]
            }
          }
        }
      }
    }
  }