docker_compose_convert.yaml 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
  1. command: docker compose convert
  2. aliases: docker compose convert, docker compose config
  3. short: Converts the compose file to platform's canonical format
  4. long: |-
  5. `docker compose convert` renders the actual data model to be applied on the target platform. When used with 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. To allow smooth migration from docker-compose, this subcommand declares alias `docker compose config`
  9. usage: docker compose convert [OPTIONS] [SERVICE...]
  10. pname: docker compose
  11. plink: docker_compose.yaml
  12. options:
  13. - option: format
  14. value_type: string
  15. default_value: yaml
  16. description: 'Format the output. Values: [yaml | json]'
  17. deprecated: false
  18. hidden: false
  19. experimental: false
  20. experimentalcli: false
  21. kubernetes: false
  22. swarm: false
  23. - option: hash
  24. value_type: string
  25. description: Print the service config hash, one per line.
  26. deprecated: false
  27. hidden: false
  28. experimental: false
  29. experimentalcli: false
  30. kubernetes: false
  31. swarm: false
  32. - option: images
  33. value_type: bool
  34. default_value: "false"
  35. description: Print the image names, one per line.
  36. deprecated: false
  37. hidden: false
  38. experimental: false
  39. experimentalcli: false
  40. kubernetes: false
  41. swarm: false
  42. - option: no-consistency
  43. value_type: bool
  44. default_value: "false"
  45. description: |
  46. Don't check model consistency - warning: may produce invalid Compose output
  47. deprecated: false
  48. hidden: false
  49. experimental: false
  50. experimentalcli: false
  51. kubernetes: false
  52. swarm: false
  53. - option: no-interpolate
  54. value_type: bool
  55. default_value: "false"
  56. description: Don't interpolate environment variables.
  57. deprecated: false
  58. hidden: false
  59. experimental: false
  60. experimentalcli: false
  61. kubernetes: false
  62. swarm: false
  63. - option: no-normalize
  64. value_type: bool
  65. default_value: "false"
  66. description: Don't normalize compose model.
  67. deprecated: false
  68. hidden: false
  69. experimental: false
  70. experimentalcli: false
  71. kubernetes: false
  72. swarm: false
  73. - option: output
  74. shorthand: o
  75. value_type: string
  76. description: Save to file (default to stdout)
  77. deprecated: false
  78. hidden: false
  79. experimental: false
  80. experimentalcli: false
  81. kubernetes: false
  82. swarm: false
  83. - option: profiles
  84. value_type: bool
  85. default_value: "false"
  86. description: Print the profile names, one per line.
  87. deprecated: false
  88. hidden: false
  89. experimental: false
  90. experimentalcli: false
  91. kubernetes: false
  92. swarm: false
  93. - option: quiet
  94. shorthand: q
  95. value_type: bool
  96. default_value: "false"
  97. description: Only validate the configuration, don't print anything.
  98. deprecated: false
  99. hidden: false
  100. experimental: false
  101. experimentalcli: false
  102. kubernetes: false
  103. swarm: false
  104. - option: resolve-image-digests
  105. value_type: bool
  106. default_value: "false"
  107. description: Pin image tags to digests.
  108. deprecated: false
  109. hidden: false
  110. experimental: false
  111. experimentalcli: false
  112. kubernetes: false
  113. swarm: false
  114. - option: services
  115. value_type: bool
  116. default_value: "false"
  117. description: Print the service names, one per line.
  118. deprecated: false
  119. hidden: false
  120. experimental: false
  121. experimentalcli: false
  122. kubernetes: false
  123. swarm: false
  124. - option: volumes
  125. value_type: bool
  126. default_value: "false"
  127. description: Print the volume names, one per line.
  128. deprecated: false
  129. hidden: false
  130. experimental: false
  131. experimentalcli: false
  132. kubernetes: false
  133. swarm: false
  134. deprecated: false
  135. experimental: false
  136. experimentalcli: false
  137. kubernetes: false
  138. swarm: false