docker_compose_convert.yaml 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129
  1. command: docker compose convert
  2. aliases: config
  3. short: Converts the compose file to platform's canonical format
  4. long: |-
  5. `docker compose convert` render the actual data model to be applied on target platform. When used with Docker engine,
  6. it merges the Compose files set by `-f` flags, resolves variables in Compose file, and expands short-notation into
  7. fully defined Compose model.
  8. To allow smooth migration from docker-compose, this subcommand declares alias `docker compose config`
  9. usage: docker compose convert SERVICES
  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-interpolate
  43. value_type: bool
  44. default_value: "false"
  45. description: Don't interpolate environment variables.
  46. deprecated: false
  47. hidden: false
  48. experimental: false
  49. experimentalcli: false
  50. kubernetes: false
  51. swarm: false
  52. - option: no-normalize
  53. value_type: bool
  54. default_value: "false"
  55. description: Don't normalize compose model.
  56. deprecated: false
  57. hidden: false
  58. experimental: false
  59. experimentalcli: false
  60. kubernetes: false
  61. swarm: false
  62. - option: output
  63. shorthand: o
  64. value_type: string
  65. description: Save to file (default to stdout)
  66. deprecated: false
  67. hidden: false
  68. experimental: false
  69. experimentalcli: false
  70. kubernetes: false
  71. swarm: false
  72. - option: profiles
  73. value_type: bool
  74. default_value: "false"
  75. description: Print the profile names, one per line.
  76. deprecated: false
  77. hidden: false
  78. experimental: false
  79. experimentalcli: false
  80. kubernetes: false
  81. swarm: false
  82. - option: quiet
  83. shorthand: q
  84. value_type: bool
  85. default_value: "false"
  86. description: Only validate the configuration, don't print anything.
  87. deprecated: false
  88. hidden: false
  89. experimental: false
  90. experimentalcli: false
  91. kubernetes: false
  92. swarm: false
  93. - option: resolve-image-digests
  94. value_type: bool
  95. default_value: "false"
  96. description: Pin image tags to digests.
  97. deprecated: false
  98. hidden: false
  99. experimental: false
  100. experimentalcli: false
  101. kubernetes: false
  102. swarm: false
  103. - option: services
  104. value_type: bool
  105. default_value: "false"
  106. description: Print the service names, one per line.
  107. deprecated: false
  108. hidden: false
  109. experimental: false
  110. experimentalcli: false
  111. kubernetes: false
  112. swarm: false
  113. - option: volumes
  114. value_type: bool
  115. default_value: "false"
  116. description: Print the volume names, one per line.
  117. deprecated: false
  118. hidden: false
  119. experimental: false
  120. experimentalcli: false
  121. kubernetes: false
  122. swarm: false
  123. deprecated: false
  124. experimental: false
  125. experimentalcli: false
  126. kubernetes: false
  127. swarm: false