From 04fb1a49c20cbcf4c01cd5d8942e02b7cd88bb24 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Sat, 11 Apr 2026 03:12:03 +0000 Subject: [PATCH] cli: sync docs with docker/cli v29.4.0 --- data/cli/engine/docker_container_prune.yaml | 14 +++++++++++++- data/cli/engine/docker_image_prune.yaml | 14 +++++++++++++- data/cli/engine/docker_network_prune.yaml | 14 +++++++++++++- data/cli/engine/docker_swarm_init.yaml | 2 +- data/cli/engine/docker_swarm_join-token.yaml | 8 ++++---- data/cli/engine/docker_swarm_join.yaml | 4 ++-- data/cli/engine/docker_swarm_unlock-key.yaml | 6 +++--- data/cli/engine/docker_system_prune.yaml | 14 +++++++++++++- data/cli/engine/docker_volume_prune.yaml | 14 +++++++++++++- 9 files changed, 75 insertions(+), 15 deletions(-) diff --git a/data/cli/engine/docker_container_prune.yaml b/data/cli/engine/docker_container_prune.yaml index c595b3e6f867..469a7f72ddef 100644 --- a/data/cli/engine/docker_container_prune.yaml +++ b/data/cli/engine/docker_container_prune.yaml @@ -54,7 +54,19 @@ examples: |- ### Filtering (--filter) {#filter} The filtering flag (`--filter`) format is of "key=value". If there is more - than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`) + than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`). + + When multiple filters are provided, they are combined as follows: + + - Multiple filters with **different keys** are combined using AND logic. + A container must satisfy all filter conditions to be pruned. + - Multiple filters with the **same key** are combined using OR logic. + A container is pruned if it matches any of the values for that key. + + For example, `--filter "label=foo" --filter "until=24h"` prunes containers + that have the `foo` label **and** were created more than 24 hours ago. + Conversely, `--filter "label=foo" --filter "label=bar"` prunes containers + that have **either** the `foo` **or** `bar` label. The currently supported filters are: diff --git a/data/cli/engine/docker_image_prune.yaml b/data/cli/engine/docker_image_prune.yaml index 2cae8c59072c..524a318118ea 100644 --- a/data/cli/engine/docker_image_prune.yaml +++ b/data/cli/engine/docker_image_prune.yaml @@ -88,7 +88,19 @@ examples: |- ### Filtering (--filter) {#filter} The filtering flag (`--filter`) format is of "key=value". If there is more - than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`) + than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`). + + When multiple filters are provided, they are combined as follows: + + - Multiple filters with **different keys** are combined using AND logic. + An image must satisfy all filter conditions to be pruned. + - Multiple filters with the **same key** are combined using OR logic. + An image is pruned if it matches any of the values for that key. + + For example, `--filter "label=foo" --filter "until=24h"` prunes images + that have the `foo` label **and** were created more than 24 hours ago. + Conversely, `--filter "label=foo" --filter "label=bar"` prunes images + that have **either** the `foo` **or** `bar` label. The currently supported filters are: diff --git a/data/cli/engine/docker_network_prune.yaml b/data/cli/engine/docker_network_prune.yaml index 01b9e8ff9a5e..7010ff8e9f10 100644 --- a/data/cli/engine/docker_network_prune.yaml +++ b/data/cli/engine/docker_network_prune.yaml @@ -53,7 +53,19 @@ examples: |- ### Filtering (--filter) {#filter} The filtering flag (`--filter`) format is of "key=value". If there is more - than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`) + than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`). + + When multiple filters are provided, they are combined as follows: + + - Multiple filters with **different keys** are combined using AND logic. + A network must satisfy all filter conditions to be pruned. + - Multiple filters with the **same key** are combined using OR logic. + A network is pruned if it matches any of the values for that key. + + For example, `--filter "label=foo" --filter "until=24h"` prunes networks + that have the `foo` label **and** were created more than 24 hours ago. + Conversely, `--filter "label=foo" --filter "label=bar"` prunes networks + that have **either** the `foo` **or** `bar` label. The currently supported filters are: diff --git a/data/cli/engine/docker_swarm_init.yaml b/data/cli/engine/docker_swarm_init.yaml index 3344dd81ddc4..46fe99404668 100644 --- a/data/cli/engine/docker_swarm_init.yaml +++ b/data/cli/engine/docker_swarm_init.yaml @@ -194,7 +194,7 @@ examples: |- To add a worker to this swarm, run the following command: - docker swarm join --token SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-1awxwuwd3z9j1z3puu7rcgdbx 172.17.0.2:2377 + docker swarm join --token SWMTKN-1-aabbccdd00112233aabbccdd00112233aabbccdd00112233aa-aabbccdd00112233... 172.17.0.2:2377 To add a manager to this swarm, run 'docker swarm join-token manager' and follow the instructions. ``` diff --git a/data/cli/engine/docker_swarm_join-token.yaml b/data/cli/engine/docker_swarm_join-token.yaml index 69a69bb5cab2..3757d07ad1ed 100644 --- a/data/cli/engine/docker_swarm_join-token.yaml +++ b/data/cli/engine/docker_swarm_join-token.yaml @@ -63,7 +63,7 @@ examples: |- To add a worker to this swarm, run the following command: docker swarm join \ - --token SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-1awxwuwd3z9j1z3puu7rcgdbx \ + --token SWMTKN-1-aabbccdd00112233aabbccdd00112233aabbccdd00112233aa-aabbccdd00112233... \ 172.17.0.2:2377 $ docker swarm join-token manager @@ -71,7 +71,7 @@ examples: |- To add a manager to this swarm, run the following command: docker swarm join \ - --token SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2 \ + --token SWMTKN-1-aabbccdd00112233aabbccdd00112233aabbccdd00112233aa-aabbccdd00112233... \ 172.17.0.2:2377 ``` @@ -85,7 +85,7 @@ examples: |- To add a worker to this swarm, run the following command: docker swarm join \ - --token SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-b30ljddcqhef9b9v4rs7mel7t \ + --token SWMTKN-1-aabbccdd00112233aabbccdd00112233aabbccdd00112233aa-aabbccdd00112233... \ 172.17.0.2:2377 ``` @@ -96,7 +96,7 @@ examples: |- ```console $ docker swarm join-token -q worker - SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-b30ljddcqhef9b9v4rs7mel7t + SWMTKN-1-aabbccdd00112233aabbccdd00112233aabbccdd00112233aa-aabbccdd00112233... ``` ### `--rotate` {#rotate} diff --git a/data/cli/engine/docker_swarm_join.yaml b/data/cli/engine/docker_swarm_join.yaml index cab96ffe3db1..f1fa56196466 100644 --- a/data/cli/engine/docker_swarm_join.yaml +++ b/data/cli/engine/docker_swarm_join.yaml @@ -79,7 +79,7 @@ examples: |- The example below demonstrates joining a manager node using a manager token. ```console - $ docker swarm join --token SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2 192.168.99.121:2377 + $ docker swarm join --token SWMTKN-1-aabbccdd00112233aabbccdd00112233aabbccdd00112233aa-aabbccdd00112233... 192.168.99.121:2377 This node joined a swarm as a manager. $ docker node ls @@ -97,7 +97,7 @@ examples: |- The example below demonstrates joining a worker node using a worker token. ```console - $ docker swarm join --token SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-1awxwuwd3z9j1z3puu7rcgdbx 192.168.99.121:2377 + $ docker swarm join --token SWMTKN-1-aabbccdd00112233aabbccdd00112233aabbccdd00112233aa-aabbccdd00112233... 192.168.99.121:2377 This node joined a swarm as a worker. $ docker node ls diff --git a/data/cli/engine/docker_swarm_unlock-key.yaml b/data/cli/engine/docker_swarm_unlock-key.yaml index 93ab3496fa47..0d0708202c93 100644 --- a/data/cli/engine/docker_swarm_unlock-key.yaml +++ b/data/cli/engine/docker_swarm_unlock-key.yaml @@ -58,7 +58,7 @@ examples: |- To unlock a swarm manager after it restarts, run the `docker swarm unlock` command and provide the following key: - SWMKEY-1-fySn8TY4w5lKcWcJPIpKufejh9hxx5KYwx6XZigx3Q4 + SWMKEY-1-aabbccdd00112233aabbccdd00112233aabbccdd00112233aa-aabbccdd00112233... Remember to store this key in a password manager, since without it you will not be able to restart the manager. @@ -75,7 +75,7 @@ examples: |- To unlock a swarm manager after it restarts, run the `docker swarm unlock` command and provide the following key: - SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8 + SWMKEY-1-aabbccdd00112233aabbccdd00112233aabbccdd00112233aa-aabbccdd00112233... Remember to store this key in a password manager, since without it you will not be able to restart the manager. @@ -86,7 +86,7 @@ examples: |- ```console $ docker swarm unlock-key -q - SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8 + SWMKEY-1-aabbccdd00112233aabbccdd00112233aabbccdd00112233aa-aabbccdd00112233... ``` ### `--rotate` {#rotate} diff --git a/data/cli/engine/docker_system_prune.yaml b/data/cli/engine/docker_system_prune.yaml index 06776c5b9500..a3995b276f48 100644 --- a/data/cli/engine/docker_system_prune.yaml +++ b/data/cli/engine/docker_system_prune.yaml @@ -137,7 +137,19 @@ examples: |- ### Filtering (--filter) {#filter} The filtering flag (`--filter`) format is of "key=value". If there is more - than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`) + than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`). + + When multiple filters are provided, they are combined as follows: + + - Multiple filters with **different keys** are combined using AND logic. + An item must satisfy all filter conditions to be pruned. + - Multiple filters with the **same key** are combined using OR logic. + An item is pruned if it matches any of the values for that key. + + For example, `--filter "label=foo" --filter "until=24h"` prunes items + that have the `foo` label **and** were created more than 24 hours ago. + Conversely, `--filter "label=foo" --filter "label=bar"` prunes items + that have **either** the `foo` **or** `bar` label. The currently supported filters are: diff --git a/data/cli/engine/docker_volume_prune.yaml b/data/cli/engine/docker_volume_prune.yaml index 3c4b098a5d74..541c9fa266c9 100644 --- a/data/cli/engine/docker_volume_prune.yaml +++ b/data/cli/engine/docker_volume_prune.yaml @@ -71,7 +71,19 @@ examples: |- ### Filtering (--filter) {#filter} The filtering flag (`--filter`) format is of "key=value". If there is more - than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`) + than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`). + + When multiple filters are provided, they are combined as follows: + + - Multiple filters with **different keys** are combined using AND logic. + A volume must satisfy all filter conditions to be pruned. + - Multiple filters with the **same key** are combined using OR logic. + A volume is pruned if it matches any of the values for that key. + + For example, `--filter "label=foo" --filter "label=bar"` prunes volumes that + have **either** the `foo` **or** `bar` label, while + `--filter "label=foo" --filter "label!=bar"` prunes volumes that have the + `foo` label **and** do not have the `bar` label. The currently supported filters are: