Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
DockerCLI/docs/reference/commandline/volume_prune.md

66 lines
2.3 KiB
Markdown
Raw Normal View History

Add documentation for container, volume, image and system prune subcommands Signed-off-by: Kenfe-Mickael Laventure <mickael.laventure@gmail.com>
2016-08-31 12:57:32 -04:00
# volume prune
docs: generate markdown Keep frontmatter for docker, dockerd and index markdown files. Also needs to move cli.md > docker.md before generation and then move it back because cli.md is needed for yaml generation on docs website: https://github.com/docker/cli/pull/3924#discussion_r1059986605 Signed-off-by: Kevin Alvarez <crazy-max@users.noreply.github.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-01-06 13:04:05 -05:00
<!---MARKER_GEN_START-->
Update docs/command output for volume pruning In previous versions of the Docker API, `system prune --volumes` and `volume prune` would remove all dangling volumes. With API v1.42, this was changed so that only anonymous volumes would be removed unless the all filter was specified. Some of the docs were updated in #4218, however, there were a couple of places left that didn't make the anonymous vs named volumes distinction clear. This replaces #4079, which was bitrotted by #4218. See also #4028. Closes #4079. Signed-off-by: Ed Morley <501702+edmorley@users.noreply.github.com>
2023-08-12 09:19:17 -04:00
Remove unused local volumes
Add documentation for container, volume, image and system prune subcommands Signed-off-by: Kenfe-Mickael Laventure <mickael.laventure@gmail.com>
2016-08-31 12:57:32 -04:00
docs: generate markdown Keep frontmatter for docker, dockerd and index markdown files. Also needs to move cli.md > docker.md before generation and then move it back because cli.md is needed for yaml generation on docs website: https://github.com/docker/cli/pull/3924#discussion_r1059986605 Signed-off-by: Kevin Alvarez <crazy-max@users.noreply.github.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-01-06 13:04:05 -05:00
### Options
volumes: prune: add --all / -a option Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-04-20 06:54:56 -04:00
| Name | Type | Default | Description |
|:------------------------------|:---------|:--------|:---------------------------------------------------|
chore: regenerate docs Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-07-03 02:29:57 -04:00
| [`-a`](#all), [`--all`](#all) | `bool` | | Remove all unused volumes, not just anonymous ones |
volumes: prune: add --all / -a option Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-04-20 06:54:56 -04:00
| [`--filter`](#filter) | `filter` | | Provide filter values (e.g. `label=<label>`) |
chore: regenerate docs Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-07-03 02:29:57 -04:00
| `-f`, `--force` | `bool` | | Do not prompt for confirmation |
docs: generate markdown Keep frontmatter for docker, dockerd and index markdown files. Also needs to move cli.md > docker.md before generation and then move it back because cli.md is needed for yaml generation on docs website: https://github.com/docker/cli/pull/3924#discussion_r1059986605 Signed-off-by: Kevin Alvarez <crazy-max@users.noreply.github.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-01-06 13:04:05 -05:00
<!---MARKER_GEN_END-->
Add documentation for container, volume, image and system prune subcommands Signed-off-by: Kenfe-Mickael Laventure <mickael.laventure@gmail.com>
2016-08-31 12:57:32 -04:00
Standardized formatting of CLI reference commands Command name should be a H1 Only Description, Examples, and Related Commands should be H2 Changed 'Related information' heading to 'Related commands' since 99% it is only linking commands Added some examples where relevant Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2017-02-07 18:42:48 -05:00
## Description
volumes: prune: add --all / -a option Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-04-20 06:54:56 -04:00
Remove all unused local volumes. Unused local volumes are those which are not
referenced by any containers. By default, it only removes anonymous volumes.
Add documentation for container, volume, image and system prune subcommands Signed-off-by: Kenfe-Mickael Laventure <mickael.laventure@gmail.com>
2016-08-31 12:57:32 -04:00
Standardized formatting of CLI reference commands Command name should be a H1 Only Description, Examples, and Related Commands should be H2 Changed 'Related information' heading to 'Related commands' since 99% it is only linking commands Added some examples where relevant Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2017-02-07 18:42:48 -05:00
## Examples
Add documentation for container, volume, image and system prune subcommands Signed-off-by: Kenfe-Mickael Laventure <mickael.laventure@gmail.com>
2016-08-31 12:57:32 -04:00
docs: use "console" code-hint for shell examples This replaces the use of bash where suitable, to allow easier copy/pasting of shell examples without copying the prompt or process output. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-08-21 08:54:14 -04:00
```console
Add documentation for container, volume, image and system prune subcommands Signed-off-by: Kenfe-Mickael Laventure <mickael.laventure@gmail.com>
2016-08-31 12:57:32 -04:00
$ docker volume prune
Standardized formatting of CLI reference commands Command name should be a H1 Only Description, Examples, and Related Commands should be H2 Changed 'Related information' heading to 'Related commands' since 99% it is only linking commands Added some examples where relevant Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2017-02-07 18:42:48 -05:00
volumes: prune: add --all / -a option Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-04-20 06:54:56 -04:00
WARNING! This will remove anonymous local volumes not used by at least one container.
Add documentation for container, volume, image and system prune subcommands Signed-off-by: Kenfe-Mickael Laventure <mickael.laventure@gmail.com>
2016-08-31 12:57:32 -04:00
Are you sure you want to continue? [y/N] y
Deleted Volumes:
07c7bdf3e34ab76d921894c2b834f073721fccfbbcba792aa7648e3a7a664c2e
my-named-vol
Total reclaimed space: 36 B
```
volumes: prune: add --all / -a option Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-04-20 06:54:56 -04:00
### <a name="all"></a> Filtering (--all, -a)
Use the `--all` flag to prune both unused anonymous and named volumes.
docs: fix anchors Signed-off-by: Kevin Alvarez <crazy-max@users.noreply.github.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-01-06 13:28:29 -05:00
### <a name="filter"></a> Filtering (--filter)
Update docs of `label` filter for `docker system prune` This fix updates docs of `label` filter for `docker system prune`. This fix is related to #30740 and #29999, and specifically to comment https://github.com/docker/docker/pull/30740#issuecomment-293012957. Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
2017-04-10 14:08:40 -04:00
Fix description of filter flag in prune commands The "-f" flag is an alias for --force, not --filter (as correctly stated at the top of each documents). The system_prune.md didn't have this error. Signed-off-by: Mateusz Major <apkd@users.noreply.github.com>
2018-01-02 13:40:23 -05:00
The filtering flag (`--filter`) format is of "key=value". If there is more
Update docs of `label` filter for `docker system prune` This fix updates docs of `label` filter for `docker system prune`. This fix is related to #30740 and #29999, and specifically to comment https://github.com/docker/docker/pull/30740#issuecomment-293012957. Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
2017-04-10 14:08:40 -04:00
than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`)
The currently supported filters are:
* label (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or `label!=<key>=<value>`) - only remove volumes with (or without, in case `label!=...` is used) the specified labels.
The `label` filter accepts two formats. One is the `label=...` (`label=<key>` or `label=<key>=<value>`),
which removes volumes with the specified labels. The other
format is the `label!=...` (`label!=<key>` or `label!=<key>=<value>`), which removes
volumes without the specified labels.
Standardized formatting of CLI reference commands Command name should be a H1 Only Description, Examples, and Related Commands should be H2 Changed 'Related information' heading to 'Related commands' since 99% it is only linking commands Added some examples where relevant Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2017-02-07 18:42:48 -05:00
## Related commands
Add documentation for container, volume, image and system prune subcommands Signed-off-by: Kenfe-Mickael Laventure <mickael.laventure@gmail.com>
2016-08-31 12:57:32 -04:00
* [volume create](volume_create.md)
* [volume ls](volume_ls.md)
* [volume inspect](volume_inspect.md)
* [volume rm](volume_rm.md)
reference docs: fix broken links and markdown touch-ups - fix various broken links - fix incorrect anchors - updated links for content that moved, so that no redirect to the new location is needed. - touched-up Markdown; - re-format some JSON output - add blank line betweeen command and command output - format "note" blocks Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-19 09:43:08 -04:00
* [Understand Data Volumes](https://docs.docker.com/storage/volumes/)
Add documentation for container, volume, image and system prune subcommands Signed-off-by: Kenfe-Mickael Laventure <mickael.laventure@gmail.com>
2016-08-31 12:57:32 -04:00
* [system df](system_df.md)
* [container prune](container_prune.md)
Fix the incorrect links Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn>
2016-10-10 11:26:05 -04:00
* [image prune](image_prune.md)
add `docker network prune` `docker network prune` prunes unused networks, including overlay ones. `docker system prune` also prunes unused networks. Signed-off-by: Akihiro Suda <suda.akihiro@lab.ntt.co.jp>
2016-10-18 00:36:52 -04:00
* [network prune](network_prune.md)
Add documentation for container, volume, image and system prune subcommands Signed-off-by: Kenfe-Mickael Laventure <mickael.laventure@gmail.com>
2016-08-31 12:57:32 -04:00
* [system prune](system_prune.md)