docker_compose_config.yaml 5.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198
  1. command: docker compose config
  2. short: Parse, resolve and render compose file in canonical format
  3. long: |-
  4. `docker compose config` renders the actual data model to be applied on the Docker Engine.
  5. It merges the Compose files set by `-f` flags, resolves variables in the Compose file, and expands short-notation into
  6. the canonical format.
  7. usage: docker compose config [OPTIONS] [SERVICE...]
  8. pname: docker compose
  9. plink: docker_compose.yaml
  10. options:
  11. - option: environment
  12. value_type: bool
  13. default_value: "false"
  14. description: Print environment used for interpolation.
  15. deprecated: false
  16. hidden: false
  17. experimental: false
  18. experimentalcli: false
  19. kubernetes: false
  20. swarm: false
  21. - option: format
  22. value_type: string
  23. description: 'Format the output. Values: [yaml | json]'
  24. deprecated: false
  25. hidden: false
  26. experimental: false
  27. experimentalcli: false
  28. kubernetes: false
  29. swarm: false
  30. - option: hash
  31. value_type: string
  32. description: Print the service config hash, one per line.
  33. deprecated: false
  34. hidden: false
  35. experimental: false
  36. experimentalcli: false
  37. kubernetes: false
  38. swarm: false
  39. - option: images
  40. value_type: bool
  41. default_value: "false"
  42. description: Print the image names, one per line.
  43. deprecated: false
  44. hidden: false
  45. experimental: false
  46. experimentalcli: false
  47. kubernetes: false
  48. swarm: false
  49. - option: lock-image-digests
  50. value_type: bool
  51. default_value: "false"
  52. description: Produces an override file with image digests
  53. deprecated: false
  54. hidden: false
  55. experimental: false
  56. experimentalcli: false
  57. kubernetes: false
  58. swarm: false
  59. - option: no-consistency
  60. value_type: bool
  61. default_value: "false"
  62. description: |
  63. Don't check model consistency - warning: may produce invalid Compose output
  64. deprecated: false
  65. hidden: false
  66. experimental: false
  67. experimentalcli: false
  68. kubernetes: false
  69. swarm: false
  70. - option: no-env-resolution
  71. value_type: bool
  72. default_value: "false"
  73. description: Don't resolve service env files
  74. deprecated: false
  75. hidden: false
  76. experimental: false
  77. experimentalcli: false
  78. kubernetes: false
  79. swarm: false
  80. - option: no-interpolate
  81. value_type: bool
  82. default_value: "false"
  83. description: Don't interpolate environment variables
  84. deprecated: false
  85. hidden: false
  86. experimental: false
  87. experimentalcli: false
  88. kubernetes: false
  89. swarm: false
  90. - option: no-normalize
  91. value_type: bool
  92. default_value: "false"
  93. description: Don't normalize compose model
  94. deprecated: false
  95. hidden: false
  96. experimental: false
  97. experimentalcli: false
  98. kubernetes: false
  99. swarm: false
  100. - option: no-path-resolution
  101. value_type: bool
  102. default_value: "false"
  103. description: Don't resolve file paths
  104. deprecated: false
  105. hidden: false
  106. experimental: false
  107. experimentalcli: false
  108. kubernetes: false
  109. swarm: false
  110. - option: output
  111. shorthand: o
  112. value_type: string
  113. description: Save to file (default to stdout)
  114. deprecated: false
  115. hidden: false
  116. experimental: false
  117. experimentalcli: false
  118. kubernetes: false
  119. swarm: false
  120. - option: profiles
  121. value_type: bool
  122. default_value: "false"
  123. description: Print the profile names, one per line.
  124. deprecated: false
  125. hidden: false
  126. experimental: false
  127. experimentalcli: false
  128. kubernetes: false
  129. swarm: false
  130. - option: quiet
  131. shorthand: q
  132. value_type: bool
  133. default_value: "false"
  134. description: Only validate the configuration, don't print anything
  135. deprecated: false
  136. hidden: false
  137. experimental: false
  138. experimentalcli: false
  139. kubernetes: false
  140. swarm: false
  141. - option: resolve-image-digests
  142. value_type: bool
  143. default_value: "false"
  144. description: Pin image tags to digests
  145. deprecated: false
  146. hidden: false
  147. experimental: false
  148. experimentalcli: false
  149. kubernetes: false
  150. swarm: false
  151. - option: services
  152. value_type: bool
  153. default_value: "false"
  154. description: Print the service names, one per line.
  155. deprecated: false
  156. hidden: false
  157. experimental: false
  158. experimentalcli: false
  159. kubernetes: false
  160. swarm: false
  161. - option: variables
  162. value_type: bool
  163. default_value: "false"
  164. description: Print model variables and default values.
  165. deprecated: false
  166. hidden: false
  167. experimental: false
  168. experimentalcli: false
  169. kubernetes: false
  170. swarm: false
  171. - option: volumes
  172. value_type: bool
  173. default_value: "false"
  174. description: Print the volume names, one per line.
  175. deprecated: false
  176. hidden: false
  177. experimental: false
  178. experimentalcli: false
  179. kubernetes: false
  180. swarm: false
  181. inherited_options:
  182. - option: dry-run
  183. value_type: bool
  184. default_value: "false"
  185. description: Execute command in dry run mode
  186. deprecated: false
  187. hidden: false
  188. experimental: false
  189. experimentalcli: false
  190. kubernetes: false
  191. swarm: false
  192. deprecated: false
  193. hidden: false
  194. experimental: false
  195. experimentalcli: false
  196. kubernetes: false
  197. swarm: false