docker_compose_convert.yaml 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
  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. experimental: false
  19. experimentalcli: false
  20. kubernetes: false
  21. swarm: false
  22. - option: hash
  23. value_type: string
  24. description: Print the service config hash, one per line.
  25. deprecated: false
  26. experimental: false
  27. experimentalcli: false
  28. kubernetes: false
  29. swarm: false
  30. - option: no-interpolate
  31. value_type: bool
  32. default_value: "false"
  33. description: Don't interpolate environment variables.
  34. deprecated: false
  35. experimental: false
  36. experimentalcli: false
  37. kubernetes: false
  38. swarm: false
  39. - option: profiles
  40. value_type: bool
  41. default_value: "false"
  42. description: Print the profile names, one per line.
  43. deprecated: false
  44. experimental: false
  45. experimentalcli: false
  46. kubernetes: false
  47. swarm: false
  48. - option: quiet
  49. shorthand: q
  50. value_type: bool
  51. default_value: "false"
  52. description: Only validate the configuration, don't print anything.
  53. deprecated: false
  54. experimental: false
  55. experimentalcli: false
  56. kubernetes: false
  57. swarm: false
  58. - option: resolve-image-digests
  59. value_type: bool
  60. default_value: "false"
  61. description: Pin image tags to digests.
  62. deprecated: false
  63. experimental: false
  64. experimentalcli: false
  65. kubernetes: false
  66. swarm: false
  67. - option: services
  68. value_type: bool
  69. default_value: "false"
  70. description: Print the service names, one per line.
  71. deprecated: false
  72. experimental: false
  73. experimentalcli: false
  74. kubernetes: false
  75. swarm: false
  76. - option: volumes
  77. value_type: bool
  78. default_value: "false"
  79. description: Print the volume names, one per line.
  80. deprecated: false
  81. experimental: false
  82. experimentalcli: false
  83. kubernetes: false
  84. swarm: false
  85. deprecated: false
  86. experimental: false
  87. experimentalcli: false
  88. kubernetes: false
  89. swarm: false