config_schema_v2.1.json 8.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321
  1. {
  2. "$schema": "http://json-schema.org/draft-04/schema#",
  3. "id": "config_schema_v2.1.json",
  4. "type": "object",
  5. "properties": {
  6. "version": {
  7. "type": "string"
  8. },
  9. "services": {
  10. "id": "#/properties/services",
  11. "type": "object",
  12. "patternProperties": {
  13. "^[a-zA-Z0-9._-]+$": {
  14. "$ref": "#/definitions/service"
  15. }
  16. },
  17. "additionalProperties": false
  18. },
  19. "networks": {
  20. "id": "#/properties/networks",
  21. "type": "object",
  22. "patternProperties": {
  23. "^[a-zA-Z0-9._-]+$": {
  24. "$ref": "#/definitions/network"
  25. }
  26. }
  27. },
  28. "volumes": {
  29. "id": "#/properties/volumes",
  30. "type": "object",
  31. "patternProperties": {
  32. "^[a-zA-Z0-9._-]+$": {
  33. "$ref": "#/definitions/volume"
  34. }
  35. },
  36. "additionalProperties": false
  37. }
  38. },
  39. "additionalProperties": false,
  40. "definitions": {
  41. "service": {
  42. "id": "#/definitions/service",
  43. "type": "object",
  44. "properties": {
  45. "build": {
  46. "oneOf": [
  47. {"type": "string"},
  48. {
  49. "type": "object",
  50. "properties": {
  51. "context": {"type": "string"},
  52. "dockerfile": {"type": "string"},
  53. "args": {"$ref": "#/definitions/list_or_dict"}
  54. },
  55. "additionalProperties": false
  56. }
  57. ]
  58. },
  59. "cap_add": {"type": "array", "items": {"type": "string"}, "uniqueItems": true},
  60. "cap_drop": {"type": "array", "items": {"type": "string"}, "uniqueItems": true},
  61. "cgroup_parent": {"type": "string"},
  62. "command": {
  63. "oneOf": [
  64. {"type": "string"},
  65. {"type": "array", "items": {"type": "string"}}
  66. ]
  67. },
  68. "container_name": {"type": "string"},
  69. "cpu_shares": {"type": ["number", "string"]},
  70. "cpu_quota": {"type": ["number", "string"]},
  71. "cpuset": {"type": "string"},
  72. "depends_on": {"$ref": "#/definitions/list_of_strings"},
  73. "devices": {"type": "array", "items": {"type": "string"}, "uniqueItems": true},
  74. "dns": {"$ref": "#/definitions/string_or_list"},
  75. "dns_search": {"$ref": "#/definitions/string_or_list"},
  76. "domainname": {"type": "string"},
  77. "entrypoint": {
  78. "oneOf": [
  79. {"type": "string"},
  80. {"type": "array", "items": {"type": "string"}}
  81. ]
  82. },
  83. "env_file": {"$ref": "#/definitions/string_or_list"},
  84. "environment": {"$ref": "#/definitions/list_or_dict"},
  85. "expose": {
  86. "type": "array",
  87. "items": {
  88. "type": ["string", "number"],
  89. "format": "expose"
  90. },
  91. "uniqueItems": true
  92. },
  93. "extends": {
  94. "oneOf": [
  95. {
  96. "type": "string"
  97. },
  98. {
  99. "type": "object",
  100. "properties": {
  101. "service": {"type": "string"},
  102. "file": {"type": "string"}
  103. },
  104. "required": ["service"],
  105. "additionalProperties": false
  106. }
  107. ]
  108. },
  109. "external_links": {"type": "array", "items": {"type": "string"}, "uniqueItems": true},
  110. "extra_hosts": {"$ref": "#/definitions/list_or_dict"},
  111. "hostname": {"type": "string"},
  112. "image": {"type": "string"},
  113. "ipc": {"type": "string"},
  114. "isolation": {"type": "string"},
  115. "labels": {"$ref": "#/definitions/list_or_dict"},
  116. "links": {"type": "array", "items": {"type": "string"}, "uniqueItems": true},
  117. "logging": {
  118. "type": "object",
  119. "properties": {
  120. "driver": {"type": "string"},
  121. "options": {"type": "object"}
  122. },
  123. "additionalProperties": false
  124. },
  125. "mac_address": {"type": "string"},
  126. "mem_limit": {"type": ["number", "string"]},
  127. "memswap_limit": {"type": ["number", "string"]},
  128. "network_mode": {"type": "string"},
  129. "networks": {
  130. "oneOf": [
  131. {"$ref": "#/definitions/list_of_strings"},
  132. {
  133. "type": "object",
  134. "patternProperties": {
  135. "^[a-zA-Z0-9._-]+$": {
  136. "oneOf": [
  137. {
  138. "type": "object",
  139. "properties": {
  140. "aliases": {"$ref": "#/definitions/list_of_strings"},
  141. "ipv4_address": {"type": "string"},
  142. "ipv6_address": {"type": "string"},
  143. "link_local_ips": {"$ref": "#/definitions/list_of_strings"}
  144. },
  145. "additionalProperties": false
  146. },
  147. {"type": "null"}
  148. ]
  149. }
  150. },
  151. "additionalProperties": false
  152. }
  153. ]
  154. },
  155. "pid": {"type": ["string", "null"]},
  156. "ports": {
  157. "type": "array",
  158. "items": {
  159. "type": ["string", "number"],
  160. "format": "ports"
  161. },
  162. "uniqueItems": true
  163. },
  164. "privileged": {"type": "boolean"},
  165. "read_only": {"type": "boolean"},
  166. "restart": {"type": "string"},
  167. "security_opt": {"type": "array", "items": {"type": "string"}, "uniqueItems": true},
  168. "shm_size": {"type": ["number", "string"]},
  169. "stdin_open": {"type": "boolean"},
  170. "stop_signal": {"type": "string"},
  171. "tmpfs": {"$ref": "#/definitions/string_or_list"},
  172. "tty": {"type": "boolean"},
  173. "ulimits": {
  174. "type": "object",
  175. "patternProperties": {
  176. "^[a-z]+$": {
  177. "oneOf": [
  178. {"type": "integer"},
  179. {
  180. "type":"object",
  181. "properties": {
  182. "hard": {"type": "integer"},
  183. "soft": {"type": "integer"}
  184. },
  185. "required": ["soft", "hard"],
  186. "additionalProperties": false
  187. }
  188. ]
  189. }
  190. }
  191. },
  192. "user": {"type": "string"},
  193. "volumes": {"type": "array", "items": {"type": "string"}, "uniqueItems": true},
  194. "volume_driver": {"type": "string"},
  195. "volumes_from": {"type": "array", "items": {"type": "string"}, "uniqueItems": true},
  196. "working_dir": {"type": "string"}
  197. },
  198. "dependencies": {
  199. "memswap_limit": ["mem_limit"]
  200. },
  201. "additionalProperties": false
  202. },
  203. "network": {
  204. "id": "#/definitions/network",
  205. "type": "object",
  206. "properties": {
  207. "driver": {"type": "string"},
  208. "driver_opts": {
  209. "type": "object",
  210. "patternProperties": {
  211. "^.+$": {"type": ["string", "number"]}
  212. }
  213. },
  214. "ipam": {
  215. "type": "object",
  216. "properties": {
  217. "driver": {"type": "string"},
  218. "config": {
  219. "type": "array"
  220. }
  221. },
  222. "additionalProperties": false
  223. },
  224. "external": {
  225. "type": ["boolean", "object"],
  226. "properties": {
  227. "name": {"type": "string"}
  228. },
  229. "additionalProperties": false
  230. },
  231. "enable_ipv6": {"type": "boolean"}
  232. },
  233. "additionalProperties": false
  234. },
  235. "volume": {
  236. "id": "#/definitions/volume",
  237. "type": ["object", "null"],
  238. "properties": {
  239. "driver": {"type": "string"},
  240. "driver_opts": {
  241. "type": "object",
  242. "patternProperties": {
  243. "^.+$": {"type": ["string", "number"]}
  244. }
  245. },
  246. "external": {
  247. "type": ["boolean", "object"],
  248. "properties": {
  249. "name": {"type": "string"}
  250. }
  251. },
  252. "additionalProperties": false
  253. },
  254. "additionalProperties": false
  255. },
  256. "string_or_list": {
  257. "oneOf": [
  258. {"type": "string"},
  259. {"$ref": "#/definitions/list_of_strings"}
  260. ]
  261. },
  262. "list_of_strings": {
  263. "type": "array",
  264. "items": {"type": "string"},
  265. "uniqueItems": true
  266. },
  267. "list_or_dict": {
  268. "oneOf": [
  269. {
  270. "type": "object",
  271. "patternProperties": {
  272. ".+": {
  273. "type": ["string", "number", "null"]
  274. }
  275. },
  276. "additionalProperties": false
  277. },
  278. {"type": "array", "items": {"type": "string"}, "uniqueItems": true}
  279. ]
  280. },
  281. "constraints": {
  282. "service": {
  283. "id": "#/definitions/constraints/service",
  284. "anyOf": [
  285. {"required": ["build"]},
  286. {"required": ["image"]}
  287. ],
  288. "properties": {
  289. "build": {
  290. "required": ["context"]
  291. }
  292. }
  293. }
  294. }
  295. }
  296. }