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

65 lines
1.9 KiB
Markdown
Raw Normal View History

Convert Markdown frontmatter to YAML Some frontmatter such as the weights, menu stuff, etc is no longer used 'draft=true' becomes 'published: false' Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-10-14 18:30:36 -04:00
---
title: "volume prune"
Clarify description of volume prune command volume prune command removes only local volumes not used by at least one container. Signed-off-by: Sungwon Han <sungwon.han@navercorp.com>
2018-02-08 00:57:41 -05:00
description: "Remove unused local volumes"
fix frontmatter keywords value type (string, instead of []string) in /docs/reference Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
2016-11-03 18:48:30 -04:00
keywords: "volume, prune, delete"
Convert Markdown frontmatter to YAML Some frontmatter such as the weights, menu stuff, etc is no longer used 'draft=true' becomes 'published: false' Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-10-14 18:30:36 -04:00
---
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
```markdown
update docs usage output to match new format Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-02 09:51:01 -04:00
Usage: docker volume prune [OPTIONS]
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
Clarify description of volume prune command volume prune command removes only local volumes not used by at least one container. Signed-off-by: Sungwon Han <sungwon.han@navercorp.com>
2018-02-08 00:57:41 -05:00
Remove all 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
Options:
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
--filter filter Provide filter values (e.g. 'label=<label>')
-f, --force Do not prompt for confirmation
--help Print usage
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
Clarify description of volume prune command volume prune command removes only local volumes not used by at least one container. Signed-off-by: Sungwon Han <sungwon.han@navercorp.com>
2018-02-08 00:57:41 -05:00
Remove all unused local volumes. Unused local volumes are those which are not referenced by any containers
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
Clarify description of volume prune command volume prune command removes only local volumes not used by at least one container. Signed-off-by: Sungwon Han <sungwon.han@navercorp.com>
2018-02-08 00:57:41 -05:00
WARNING! This will remove all 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
```
docs: add anchor-tags for flags This will generate "details_url" for options, so that the options table on the pages at docs.docker.com link to the section describing the option. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-03-30 09:05:29 -04: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)