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/system_prune.md

136 lines
5.4 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
# system 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 system prune docs for --volumes flag The `--volumes` flag was added in 37fd6128dc268b885f070b6d89a72e73d2eacec8, but the documentation was not updated. This patch updates the documentation. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2017-09-12 11:21:47 -04:00
Remove unused data
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
| Name | Type | Default | Description |
|:----------------------|:---------|:--------|:---------------------------------------------------|
| `-a`, `--all` | | | Remove all unused images not just dangling ones |
| [`--filter`](#filter) | `filter` | | Provide filter values (e.g. `label=<key>=<value>`) |
| `-f`, `--force` | | | Do not prompt for confirmation |
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
| `--volumes` | | | Prune anonymous volumes |
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
Update system prune docs for --volumes flag The `--volumes` flag was added in 37fd6128dc268b885f070b6d89a72e73d2eacec8, but the documentation was not updated. This patch updates the documentation. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2017-09-12 11:21:47 -04:00
Remove all unused containers, networks, images (both dangling and unreferenced),
and optionally, 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
Update system prune docs for --volumes flag The `--volumes` flag was added in 37fd6128dc268b885f070b6d89a72e73d2eacec8, but the documentation was not updated. This patch updates the documentation. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2017-09-12 11:21:47 -04:00
$ docker system 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
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
WARNING! This will remove:
Update system prune docs for --volumes flag The `--volumes` flag was added in 37fd6128dc268b885f070b6d89a72e73d2eacec8, but the documentation was not updated. This patch updates the documentation. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2017-09-12 11:21:47 -04:00
- all stopped containers
- all networks not used by at least one container
- all dangling images
prune: fix build cache prune warning Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-11-28 05:53:13 -05:00
- unused build cache
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
Update system prune docs for --volumes flag The `--volumes` flag was added in 37fd6128dc268b885f070b6d89a72e73d2eacec8, but the documentation was not updated. This patch updates the documentation. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2017-09-12 11:21:47 -04:00
Deleted Containers:
f44f9b81948b3919590d5f79a680d8378f1139b41952e219830a33027c80c867
792776e68ac9d75bce4092bc1b5cc17b779bc926ab04f4185aec9bf1c0d4641f
Deleted Networks:
network1
network2
Deleted Images:
untagged: hello-world@sha256:f3b3b28a45160805bb16542c9531888519430e9e6d6ffc09d72261b0d26ff74f
deleted: sha256:1815c82652c03bfd8644afda26fb184f2ed891d921b20a0703b46768f9755c57
deleted: sha256:45761469c965421a92a69cc50e92c01e0cfa94fe026cdd1233445ea00e96289a
Total reclaimed space: 1.84kB
```
By default, volumes are not removed to prevent important data from being
deleted if there is currently no container using the volume. Use the `--volumes`
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
flag when running the command to prune anonymous volumes as well:
Update system prune docs for --volumes flag The `--volumes` flag was added in 37fd6128dc268b885f070b6d89a72e73d2eacec8, but the documentation was not updated. This patch updates the documentation. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2017-09-12 11:21:47 -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
Update system prune docs for --volumes flag The `--volumes` flag was added in 37fd6128dc268b885f070b6d89a72e73d2eacec8, but the documentation was not updated. This patch updates the documentation. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2017-09-12 11:21:47 -04:00
$ docker system prune -a --volumes
WARNING! This will remove:
- all stopped containers
- all networks not used by at least one container
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
- all anonymous volumes not used by at least one container
Update system prune docs for --volumes flag The `--volumes` flag was added in 37fd6128dc268b885f070b6d89a72e73d2eacec8, but the documentation was not updated. This patch updates the documentation. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2017-09-12 11:21:47 -04:00
- all images without at least one container associated to them
- all build cache
Are you sure you want to continue? [y/N] y
wrap line in deleted containers when pruning Signed-off-by: allencloud <allen.sun@daocloud.io>
2016-10-18 02:20:12 -04:00
Deleted Containers:
0998aa37185a1a7036b0e12cf1ac1b6442dcfa30a5c9650a42ed5010046f195b
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
73958bfb884fa81fa4cc6baf61055667e940ea2357b4036acbbe25a60f442a4d
Update system prune docs for --volumes flag The `--volumes` flag was added in 37fd6128dc268b885f070b6d89a72e73d2eacec8, but the documentation was not updated. This patch updates the documentation. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2017-09-12 11:21:47 -04:00
Deleted Networks:
my-network-a
my-network-b
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
Deleted Volumes:
named-vol
Deleted Images:
untagged: my-curl:latest
deleted: sha256:7d88582121f2a29031d92017754d62a0d1a215c97e8f0106c586546e7404447d
deleted: sha256:dd14a93d83593d4024152f85d7c63f76aaa4e73e228377ba1d130ef5149f4d8b
untagged: alpine:3.3
deleted: sha256:695f3d04125db3266d4ab7bbb3c6b23aa4293923e762aa2562c54f49a28f009f
untagged: alpine:latest
deleted: sha256:ee4603260daafe1a8c2f3b78fd760922918ab2441cbb2853ed5c439e59c52f96
deleted: sha256:9007f5987db353ec398a223bc5a135c5a9601798ba20a1abba537ea2f8ac765f
deleted: sha256:71fa90c8f04769c9721459d5aa0936db640b92c8c91c9b589b54abd412d120ab
deleted: sha256:bb1c3357b3c30ece26e6604aea7d2ec0ace4166ff34c3616701279c22444c0f3
untagged: my-jq:latest
deleted: sha256:6e66d724542af9bc4c4abf4a909791d7260b6d0110d8e220708b09e4ee1322e1
deleted: sha256:07b3fa89d4b17009eb3988dfc592c7d30ab3ba52d2007832dffcf6d40e3eda7f
deleted: sha256:3a88a5c81eb5c283e72db2dbc6d65cbfd8e80b6c89bb6e714cfaaa0eed99c548
Total reclaimed space: 13.5 MB
```
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)
Add `--filter until=<timestamp>` for `docker container/image prune` This fix is a follow up for comment https://github.com/docker/docker/pull/28535#issuecomment-263215225 This fix provides `--filter until=<timestamp>` for `docker container/image prune`. This fix adds `--filter until=<timestamp>` to `docker container/image prune` so that it is possible to specify a timestamp and prune those containers/images that are earlier than the timestamp. Related docs has been updated Several integration tests have been added to cover changes. This fix fixes #28497. This fix is related to #28535. Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
2016-12-07 17:02:13 -05:00
For system prune, -f is not an alias for --filter Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2017-10-20 13:51:17 -04:00
The filtering flag (`--filter`) format is of "key=value". If there is more
Add `--filter until=<timestamp>` for `docker container/image prune` This fix is a follow up for comment https://github.com/docker/docker/pull/28535#issuecomment-263215225 This fix provides `--filter until=<timestamp>` for `docker container/image prune`. This fix adds `--filter until=<timestamp>` to `docker container/image prune` so that it is possible to specify a timestamp and prune those containers/images that are earlier than the timestamp. Related docs has been updated Several integration tests have been added to cover changes. This fix fixes #28497. This fix is related to #28535. Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
2016-12-07 17:02:13 -05:00
than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`)
The currently supported filters are:
* until (`<timestamp>`) - only remove containers, images, and networks created before given timestamp
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
* label (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or `label!=<key>=<value>`) - only remove containers, images, networks, and volumes with (or without, in case `label!=...` is used) the specified labels.
Add `--filter until=<timestamp>` for `docker container/image prune` This fix is a follow up for comment https://github.com/docker/docker/pull/28535#issuecomment-263215225 This fix provides `--filter until=<timestamp>` for `docker container/image prune`. This fix adds `--filter until=<timestamp>` to `docker container/image prune` so that it is possible to specify a timestamp and prune those containers/images that are earlier than the timestamp. Related docs has been updated Several integration tests have been added to cover changes. This fix fixes #28497. This fix is related to #28535. Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
2016-12-07 17:02:13 -05:00
The `until` filter can be Unix timestamps, date formatted
timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed
relative to the daemon machine’s time. Supported formats for date
formatted time stamps include RFC3339Nano, RFC3339, `2006-01-02T15:04:05`,
`2006-01-02T15:04:05.999999999`, `2006-01-02Z07:00`, and `2006-01-02`. The local
timezone on the daemon will be used if you do not provide either a `Z` or a
`+-00:00` timezone offset at the end of the timestamp. When providing Unix
timestamps enter seconds[.nanoseconds], where seconds is the number of seconds
that have elapsed since January 1, 1970 (midnight UTC/GMT), not counting leap
seconds (aka Unix epoch or Unix time), and the optional .nanoseconds field is a
fraction of a second no more than nine digits long.
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
The `label` filter accepts two formats. One is the `label=...` (`label=<key>` or `label=<key>=<value>`),
which removes containers, images, networks, and volumes with the specified labels. The other
format is the `label!=...` (`label!=<key>` or `label!=<key>=<value>`), which removes
containers, images, networks, and 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)
Fix typs from go to Go Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn>
2016-10-18 06:50:11 -04:00
* [volume prune](volume_prune.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)