docker_compose_config.yaml 5.2 KB

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