docker_compose_config.yaml 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180
  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. default_value: yaml
  25. description: 'Format the output. Values: [yaml | json]'
  26. deprecated: false
  27. hidden: false
  28. experimental: false
  29. experimentalcli: false
  30. kubernetes: false
  31. swarm: false
  32. - option: hash
  33. value_type: string
  34. description: Print the service config hash, one per line.
  35. deprecated: false
  36. hidden: false
  37. experimental: false
  38. experimentalcli: false
  39. kubernetes: false
  40. swarm: false
  41. - option: images
  42. value_type: bool
  43. default_value: "false"
  44. description: Print the image names, one per line.
  45. deprecated: false
  46. hidden: false
  47. experimental: false
  48. experimentalcli: false
  49. kubernetes: false
  50. swarm: false
  51. - option: no-consistency
  52. value_type: bool
  53. default_value: "false"
  54. description: |
  55. Don't check model consistency - warning: may produce invalid Compose output
  56. deprecated: false
  57. hidden: false
  58. experimental: false
  59. experimentalcli: false
  60. kubernetes: false
  61. swarm: false
  62. - option: no-interpolate
  63. value_type: bool
  64. default_value: "false"
  65. description: Don't interpolate environment variables
  66. deprecated: false
  67. hidden: false
  68. experimental: false
  69. experimentalcli: false
  70. kubernetes: false
  71. swarm: false
  72. - option: no-normalize
  73. value_type: bool
  74. default_value: "false"
  75. description: Don't normalize compose model
  76. deprecated: false
  77. hidden: false
  78. experimental: false
  79. experimentalcli: false
  80. kubernetes: false
  81. swarm: false
  82. - option: no-path-resolution
  83. value_type: bool
  84. default_value: "false"
  85. description: Don't resolve file paths
  86. deprecated: false
  87. hidden: false
  88. experimental: false
  89. experimentalcli: false
  90. kubernetes: false
  91. swarm: false
  92. - option: output
  93. shorthand: o
  94. value_type: string
  95. description: Save to file (default to stdout)
  96. deprecated: false
  97. hidden: false
  98. experimental: false
  99. experimentalcli: false
  100. kubernetes: false
  101. swarm: false
  102. - option: profiles
  103. value_type: bool
  104. default_value: "false"
  105. description: Print the profile names, one per line.
  106. deprecated: false
  107. hidden: false
  108. experimental: false
  109. experimentalcli: false
  110. kubernetes: false
  111. swarm: false
  112. - option: quiet
  113. shorthand: q
  114. value_type: bool
  115. default_value: "false"
  116. description: Only validate the configuration, don't print anything
  117. deprecated: false
  118. hidden: false
  119. experimental: false
  120. experimentalcli: false
  121. kubernetes: false
  122. swarm: false
  123. - option: resolve-image-digests
  124. value_type: bool
  125. default_value: "false"
  126. description: Pin image tags to digests
  127. deprecated: false
  128. hidden: false
  129. experimental: false
  130. experimentalcli: false
  131. kubernetes: false
  132. swarm: false
  133. - option: services
  134. value_type: bool
  135. default_value: "false"
  136. description: Print the service names, one per line.
  137. deprecated: false
  138. hidden: false
  139. experimental: false
  140. experimentalcli: false
  141. kubernetes: false
  142. swarm: false
  143. - option: variables
  144. value_type: bool
  145. default_value: "false"
  146. description: Print model variables and default values.
  147. deprecated: false
  148. hidden: false
  149. experimental: false
  150. experimentalcli: false
  151. kubernetes: false
  152. swarm: false
  153. - option: volumes
  154. value_type: bool
  155. default_value: "false"
  156. description: Print the volume names, one per line.
  157. deprecated: false
  158. hidden: false
  159. experimental: false
  160. experimentalcli: false
  161. kubernetes: false
  162. swarm: false
  163. inherited_options:
  164. - option: dry-run
  165. value_type: bool
  166. default_value: "false"
  167. description: Execute command in dry run mode
  168. deprecated: false
  169. hidden: false
  170. experimental: false
  171. experimentalcli: false
  172. kubernetes: false
  173. swarm: false
  174. deprecated: false
  175. hidden: false
  176. experimental: false
  177. experimentalcli: false
  178. kubernetes: false
  179. swarm: false