From 3bbbf5e111a48840fb3820c77225a911dae34040 Mon Sep 17 00:00:00 2001 From: docker-tools-robot <40391885+docker-tools-robot@users.noreply.github.com> Date: Tue, 11 Jul 2023 16:25:36 +0200 Subject: [PATCH] Update Compose reference API to v2.20.0 (#17718) Signed-off-by: GitHub Co-authored-by: glours --- _config.yml | 2 +- _data/compose-cli/docker_compose.yaml | 3 ++ _data/compose-cli/docker_compose_alpha.yaml | 1 + .../compose-cli/docker_compose_alpha_viz.yaml | 1 + .../docker_compose_alpha_watch.yaml | 1 + _data/compose-cli/docker_compose_build.yaml | 10 ++++++ _data/compose-cli/docker_compose_config.yaml | 1 + _data/compose-cli/docker_compose_cp.yaml | 6 ++-- _data/compose-cli/docker_compose_create.yaml | 1 + _data/compose-cli/docker_compose_down.yaml | 1 + _data/compose-cli/docker_compose_events.yaml | 1 + _data/compose-cli/docker_compose_exec.yaml | 6 ++-- _data/compose-cli/docker_compose_images.yaml | 1 + _data/compose-cli/docker_compose_kill.yaml | 1 + _data/compose-cli/docker_compose_logs.yaml | 1 + _data/compose-cli/docker_compose_ls.yaml | 1 + _data/compose-cli/docker_compose_pause.yaml | 1 + _data/compose-cli/docker_compose_port.yaml | 3 +- _data/compose-cli/docker_compose_ps.yaml | 1 + _data/compose-cli/docker_compose_pull.yaml | 1 + _data/compose-cli/docker_compose_push.yaml | 1 + _data/compose-cli/docker_compose_restart.yaml | 1 + _data/compose-cli/docker_compose_rm.yaml | 1 + _data/compose-cli/docker_compose_run.yaml | 1 + _data/compose-cli/docker_compose_start.yaml | 1 + _data/compose-cli/docker_compose_stop.yaml | 1 + _data/compose-cli/docker_compose_top.yaml | 1 + _data/compose-cli/docker_compose_unpause.yaml | 1 + _data/compose-cli/docker_compose_up.yaml | 1 + _data/compose-cli/docker_compose_version.yaml | 1 + _data/compose-cli/docker_compose_wait.yaml | 35 +++++++++++++++++++ 31 files changed, 81 insertions(+), 8 deletions(-) create mode 100644 _data/compose-cli/docker_compose_wait.yaml diff --git a/_config.yml b/_config.yml index bba63c229c..14326a20af 100644 --- a/_config.yml +++ b/_config.yml @@ -45,7 +45,7 @@ exclude: latest_engine_api_version: "1.43" docker_ce_version: "24.0.0" compose_v1_version: "1.29.2" -compose_version: "v2.19.1" +compose_version: "v2.20.0" compose_file_v3: "3.8" compose_file_v2: "2.4" machine_version: "0.16.0" diff --git a/_data/compose-cli/docker_compose.yaml b/_data/compose-cli/docker_compose.yaml index 1f3a49ebd8..4f74166765 100644 --- a/_data/compose-cli/docker_compose.yaml +++ b/_data/compose-cli/docker_compose.yaml @@ -171,6 +171,7 @@ cname: - docker compose unpause - docker compose up - docker compose version + - docker compose wait clink: - docker_compose_build.yaml - docker_compose_config.yaml @@ -197,6 +198,7 @@ clink: - docker_compose_unpause.yaml - docker_compose_up.yaml - docker_compose_version.yaml + - docker_compose_wait.yaml options: - option: ansi value_type: string @@ -345,6 +347,7 @@ options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/_data/compose-cli/docker_compose_alpha.yaml b/_data/compose-cli/docker_compose_alpha.yaml index 5921d94364..2598c0e881 100644 --- a/_data/compose-cli/docker_compose_alpha.yaml +++ b/_data/compose-cli/docker_compose_alpha.yaml @@ -21,6 +21,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: true experimental: false experimentalcli: true kubernetes: false diff --git a/_data/compose-cli/docker_compose_alpha_viz.yaml b/_data/compose-cli/docker_compose_alpha_viz.yaml index 6f4a7f4ca7..b179d648ef 100644 --- a/_data/compose-cli/docker_compose_alpha_viz.yaml +++ b/_data/compose-cli/docker_compose_alpha_viz.yaml @@ -69,6 +69,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: true kubernetes: false diff --git a/_data/compose-cli/docker_compose_alpha_watch.yaml b/_data/compose-cli/docker_compose_alpha_watch.yaml index 7a98477e40..6a3f5d52e3 100644 --- a/_data/compose-cli/docker_compose_alpha_watch.yaml +++ b/_data/compose-cli/docker_compose_alpha_watch.yaml @@ -29,6 +29,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: true kubernetes: false diff --git a/_data/compose-cli/docker_compose_build.yaml b/_data/compose-cli/docker_compose_build.yaml index efab6c055f..af758d4fb7 100644 --- a/_data/compose-cli/docker_compose_build.yaml +++ b/_data/compose-cli/docker_compose_build.yaml @@ -24,6 +24,15 @@ options: experimentalcli: false kubernetes: false swarm: false + - option: builder + value_type: string + description: Set builder to use. + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: compress value_type: bool default_value: "true" @@ -150,6 +159,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/_data/compose-cli/docker_compose_config.yaml b/_data/compose-cli/docker_compose_config.yaml index 53078ee779..d19a786c63 100644 --- a/_data/compose-cli/docker_compose_config.yaml +++ b/_data/compose-cli/docker_compose_config.yaml @@ -152,6 +152,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/_data/compose-cli/docker_compose_cp.yaml b/_data/compose-cli/docker_compose_cp.yaml index 18e4f9be8e..4551c13c64 100644 --- a/_data/compose-cli/docker_compose_cp.yaml +++ b/_data/compose-cli/docker_compose_cp.yaml @@ -10,7 +10,7 @@ options: - option: all value_type: bool default_value: "false" - description: Copy to all the containers of the service. + description: copy to all the containers of the service. deprecated: true hidden: true experimental: false @@ -42,8 +42,7 @@ options: - option: index value_type: int default_value: "0" - description: | - Index of the container if there are multiple instances of a service . + description: index of the container if service has multiple replicas deprecated: false hidden: false experimental: false @@ -62,6 +61,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/_data/compose-cli/docker_compose_create.yaml b/_data/compose-cli/docker_compose_create.yaml index 030b72d3be..0e3e77d6e4 100644 --- a/_data/compose-cli/docker_compose_create.yaml +++ b/_data/compose-cli/docker_compose_create.yaml @@ -90,6 +90,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/_data/compose-cli/docker_compose_down.yaml b/_data/compose-cli/docker_compose_down.yaml index 69b802f0fc..8d6388129c 100644 --- a/_data/compose-cli/docker_compose_down.yaml +++ b/_data/compose-cli/docker_compose_down.yaml @@ -73,6 +73,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/_data/compose-cli/docker_compose_events.yaml b/_data/compose-cli/docker_compose_events.yaml index 99e226e93b..ce7af72cc4 100644 --- a/_data/compose-cli/docker_compose_events.yaml +++ b/_data/compose-cli/docker_compose_events.yaml @@ -46,6 +46,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/_data/compose-cli/docker_compose_exec.yaml b/_data/compose-cli/docker_compose_exec.yaml index 96466bee03..ce6faeda6d 100644 --- a/_data/compose-cli/docker_compose_exec.yaml +++ b/_data/compose-cli/docker_compose_exec.yaml @@ -33,9 +33,8 @@ options: swarm: false - option: index value_type: int - default_value: "1" - description: | - index of the container if there are multiple instances of a service [default: 1]. + default_value: "0" + description: index of the container if service has multiple replicas deprecated: false hidden: false experimental: false @@ -118,6 +117,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/_data/compose-cli/docker_compose_images.yaml b/_data/compose-cli/docker_compose_images.yaml index 7afa355d26..4719590af5 100644 --- a/_data/compose-cli/docker_compose_images.yaml +++ b/_data/compose-cli/docker_compose_images.yaml @@ -38,6 +38,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/_data/compose-cli/docker_compose_kill.yaml b/_data/compose-cli/docker_compose_kill.yaml index 61360c526e..2134227641 100644 --- a/_data/compose-cli/docker_compose_kill.yaml +++ b/_data/compose-cli/docker_compose_kill.yaml @@ -43,6 +43,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/_data/compose-cli/docker_compose_logs.yaml b/_data/compose-cli/docker_compose_logs.yaml index f1b7bad31d..3a13cb2930 100644 --- a/_data/compose-cli/docker_compose_logs.yaml +++ b/_data/compose-cli/docker_compose_logs.yaml @@ -91,6 +91,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/_data/compose-cli/docker_compose_ls.yaml b/_data/compose-cli/docker_compose_ls.yaml index 68d5f1fcbb..c4b6d5f7c1 100644 --- a/_data/compose-cli/docker_compose_ls.yaml +++ b/_data/compose-cli/docker_compose_ls.yaml @@ -58,6 +58,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/_data/compose-cli/docker_compose_pause.yaml b/_data/compose-cli/docker_compose_pause.yaml index 24da45fda0..2ae1c40279 100644 --- a/_data/compose-cli/docker_compose_pause.yaml +++ b/_data/compose-cli/docker_compose_pause.yaml @@ -17,6 +17,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/_data/compose-cli/docker_compose_port.yaml b/_data/compose-cli/docker_compose_port.yaml index 6ffe8065a3..7c8dee90ce 100644 --- a/_data/compose-cli/docker_compose_port.yaml +++ b/_data/compose-cli/docker_compose_port.yaml @@ -7,7 +7,7 @@ plink: docker_compose.yaml options: - option: index value_type: int - default_value: "1" + default_value: "0" description: index of the container if service has multiple replicas deprecated: false hidden: false @@ -37,6 +37,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/_data/compose-cli/docker_compose_ps.yaml b/_data/compose-cli/docker_compose_ps.yaml index f7e8f52794..a8c76c3ca3 100644 --- a/_data/compose-cli/docker_compose_ps.yaml +++ b/_data/compose-cli/docker_compose_ps.yaml @@ -180,6 +180,7 @@ examples: |- The `docker compose ps` command currently only supports the `--filter status=` option, but additional filter options may be added in the future. deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/_data/compose-cli/docker_compose_pull.yaml b/_data/compose-cli/docker_compose_pull.yaml index d7f475dd65..757f31be6f 100644 --- a/_data/compose-cli/docker_compose_pull.yaml +++ b/_data/compose-cli/docker_compose_pull.yaml @@ -124,6 +124,7 @@ examples: |- `docker compose pull` will try to pull image for services with a build section. If pull fails, it will let user know this service image MUST be built. You can skip this by setting `--ignore-buildable` flag deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/_data/compose-cli/docker_compose_push.yaml b/_data/compose-cli/docker_compose_push.yaml index 82a9435c31..be7c116065 100644 --- a/_data/compose-cli/docker_compose_push.yaml +++ b/_data/compose-cli/docker_compose_push.yaml @@ -66,6 +66,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/_data/compose-cli/docker_compose_restart.yaml b/_data/compose-cli/docker_compose_restart.yaml index 055daedd13..bc907aacc0 100644 --- a/_data/compose-cli/docker_compose_restart.yaml +++ b/_data/compose-cli/docker_compose_restart.yaml @@ -48,6 +48,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/_data/compose-cli/docker_compose_rm.yaml b/_data/compose-cli/docker_compose_rm.yaml index 7d8828b6a8..7ddafae480 100644 --- a/_data/compose-cli/docker_compose_rm.yaml +++ b/_data/compose-cli/docker_compose_rm.yaml @@ -76,6 +76,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/_data/compose-cli/docker_compose_run.yaml b/_data/compose-cli/docker_compose_run.yaml index 2cf41ad99e..d827dc339f 100644 --- a/_data/compose-cli/docker_compose_run.yaml +++ b/_data/compose-cli/docker_compose_run.yaml @@ -286,6 +286,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/_data/compose-cli/docker_compose_start.yaml b/_data/compose-cli/docker_compose_start.yaml index 5f3d601a58..9a7fa379be 100644 --- a/_data/compose-cli/docker_compose_start.yaml +++ b/_data/compose-cli/docker_compose_start.yaml @@ -16,6 +16,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/_data/compose-cli/docker_compose_stop.yaml b/_data/compose-cli/docker_compose_stop.yaml index f7870be4f3..f2ec34ccb3 100644 --- a/_data/compose-cli/docker_compose_stop.yaml +++ b/_data/compose-cli/docker_compose_stop.yaml @@ -29,6 +29,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/_data/compose-cli/docker_compose_top.yaml b/_data/compose-cli/docker_compose_top.yaml index 67beeb8bb4..7d87f7ccab 100644 --- a/_data/compose-cli/docker_compose_top.yaml +++ b/_data/compose-cli/docker_compose_top.yaml @@ -23,6 +23,7 @@ examples: |- root 142353 142331 2 15:33 ? 00:00:00 ping localhost -c 5 ``` deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/_data/compose-cli/docker_compose_unpause.yaml b/_data/compose-cli/docker_compose_unpause.yaml index 5229598489..2679f53f69 100644 --- a/_data/compose-cli/docker_compose_unpause.yaml +++ b/_data/compose-cli/docker_compose_unpause.yaml @@ -16,6 +16,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/_data/compose-cli/docker_compose_up.yaml b/_data/compose-cli/docker_compose_up.yaml index b59af84967..042e2b4914 100644 --- a/_data/compose-cli/docker_compose_up.yaml +++ b/_data/compose-cli/docker_compose_up.yaml @@ -285,6 +285,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/_data/compose-cli/docker_compose_version.yaml b/_data/compose-cli/docker_compose_version.yaml index 2b11da2ed3..b06c4b1508 100644 --- a/_data/compose-cli/docker_compose_version.yaml +++ b/_data/compose-cli/docker_compose_version.yaml @@ -37,6 +37,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/_data/compose-cli/docker_compose_wait.yaml b/_data/compose-cli/docker_compose_wait.yaml new file mode 100644 index 0000000000..87f69059ce --- /dev/null +++ b/_data/compose-cli/docker_compose_wait.yaml @@ -0,0 +1,35 @@ +command: docker compose wait +short: Block until the first service container stops +long: Block until the first service container stops +usage: docker compose wait SERVICE [SERVICE...] [OPTIONS] +pname: docker compose +plink: docker_compose.yaml +options: + - option: down-project + value_type: bool + default_value: "false" + description: Drops project when the first container stops + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +inherited_options: + - option: dry-run + value_type: bool + default_value: "false" + description: Execute command in dry run mode + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +deprecated: false +hidden: false +experimental: false +experimentalcli: false +kubernetes: false +swarm: false +