Browse Source

Add documentation for container, volume, image and system prune subcommands

Signed-off-by: Kenfe-Mickael Laventure <mickael.laventure@gmail.com>
Kenfe-Mickael Laventure 8 years ago
parent
commit
913e5cb77b

+ 93 - 93
docs/reference/api/docker_remote_api_v1.25.md

@@ -1565,11 +1565,11 @@ Upload a tar archive to be extracted to a path in the filesystem of container
 - **500** – server error
 - **500** – server error
 
 
 
 
-### Prune unused containers
+### Prune stopped containers
 
 
 `POST /containers/prune`
 `POST /containers/prune`
 
 
-Delete unused containers
+Delete stopped containers
 
 
 **Example request**:
 **Example request**:
 
 
@@ -1584,12 +1584,12 @@ Delete unused containers
     HTTP/1.1 200 OK
     HTTP/1.1 200 OK
     Content-Type: application/json
     Content-Type: application/json
 
 
-	{
-	    "ContainersDeleted": [
-	        "e575172ed11dc01bfce087fb27bee502db149e1a0fad7c296ad300bbff178148"
-	    ],
-	    "SpaceReclaimed": 109
-	}
+    {
+        "ContainersDeleted": [
+            "e575172ed11dc01bfce087fb27bee502db149e1a0fad7c296ad300bbff178148"
+        ],
+        "SpaceReclaimed": 109
+    }
 
 
 **Status codes**:
 **Status codes**:
 
 
@@ -2235,7 +2235,7 @@ Delete unused images
     Content-Type: application/json
     Content-Type: application/json
 
 
     {
     {
-        "DanglingOnly": false,
+        "DanglingOnly": false
     }
     }
 
 
 **Example response**:
 **Example response**:
@@ -2243,27 +2243,27 @@ Delete unused images
     HTTP/1.1 200 OK
     HTTP/1.1 200 OK
     Content-Type: application/json
     Content-Type: application/json
 
 
-	{
-	    "ImagesDeleted": [
-	        {
-	            "Untagged": "busybox:latest"
-	        },
-	        {
-	            "Untagged": "busybox@sha256:a59906e33509d14c036c8678d687bd4eec81ed7c4b8ce907b888c607f6a1e0e6"
-	        },
-	        {
-	            "Deleted": "sha256:2b8fd9751c4c0f5dd266fcae00707e67a2545ef34f9a29354585f93dac906749"
-	        },
-	        {
-	            "Deleted": "sha256:8ac8bfaff55af948c796026ee867448c5b5b5d9dd3549f4006d9759b25d4a893"
-	        }
-	    ],
-	    "SpaceReclaimed": 1092588
-	}
+    {
+        "ImagesDeleted": [
+            {
+                "Untagged": "busybox:latest"
+            },
+            {
+                "Untagged": "busybox@sha256:a59906e33509d14c036c8678d687bd4eec81ed7c4b8ce907b888c607f6a1e0e6"
+            },
+            {
+                "Deleted": "sha256:2b8fd9751c4c0f5dd266fcae00707e67a2545ef34f9a29354585f93dac906749"
+            },
+            {
+                "Deleted": "sha256:8ac8bfaff55af948c796026ee867448c5b5b5d9dd3549f4006d9759b25d4a893"
+            }
+        ],
+        "SpaceReclaimed": 1092588
+    }
 
 
 **JSON parameters**:
 **JSON parameters**:
 
 
-- **DanglingOnly**: if true only delete unused AND untagged images
+- **DanglingOnly**: if `true` only delete unused *and* untagged images. Default to `false` if omitted
 
 
 **Status codes**:
 **Status codes**:
 
 
@@ -2514,65 +2514,65 @@ Return docker data usage information
 
 
 **Example response**:
 **Example response**:
 
 
-	{
-	    "LayersSize": 1092588,
-	    "Images": [
-	        {
-	            "Id": "sha256:2b8fd9751c4c0f5dd266fcae00707e67a2545ef34f9a29354585f93dac906749",
-	            "ParentId": "",
-	            "RepoTags": [
-	                "busybox:latest"
-	            ],
-	            "RepoDigests": [
-	                "busybox@sha256:a59906e33509d14c036c8678d687bd4eec81ed7c4b8ce907b888c607f6a1e0e6"
-	            ],
-	            "Created": 1466724217,
-	            "Size": 1092588,
-	            "SharedSize": 0,
-	            "VirtualSize": 1092588,
-	            "Labels": {},
-	            "Containers": 1
-	        }
-	    ],
-	    "Containers": [
-	        {
-	            "Id": "e575172ed11dc01bfce087fb27bee502db149e1a0fad7c296ad300bbff178148",
-	            "Names": [
-	                "/top"
-	            ],
-	            "Image": "busybox",
-	            "ImageID": "sha256:2b8fd9751c4c0f5dd266fcae00707e67a2545ef34f9a29354585f93dac906749",
-	            "Command": "top",
-	            "Created": 1472592424,
-	            "Ports": [],
-	            "SizeRootFs": 1092588,
-	            "Labels": {},
-	            "State": "exited",
-	            "Status": "Exited (0) 56 minutes ago",
-	            "HostConfig": {
-	                "NetworkMode": "default"
-	            },
-	            "NetworkSettings": {
-	                "Networks": {
-	                    "bridge": {
-	                        "IPAMConfig": null,
-	                        "Links": null,
-	                        "Aliases": null,
-	                        "NetworkID": "d687bc59335f0e5c9ee8193e5612e8aee000c8c62ea170cfb99c098f95899d92",
-	                        "EndpointID": "8ed5115aeaad9abb174f68dcf135b49f11daf597678315231a32ca28441dec6a",
-	                        "Gateway": "172.18.0.1",
-	                        "IPAddress": "172.18.0.2",
-	                        "IPPrefixLen": 16,
-	                        "IPv6Gateway": "",
-	                        "GlobalIPv6Address": "",
-	                        "GlobalIPv6PrefixLen": 0,
-	                        "MacAddress": "02:42:ac:12:00:02"
-	                    }
-	                }
-	            },
-	            "Mounts": []
-	        }
-	    ],
+    {
+        "LayersSize": 1092588,
+        "Images": [
+            {
+                "Id": "sha256:2b8fd9751c4c0f5dd266fcae00707e67a2545ef34f9a29354585f93dac906749",
+                "ParentId": "",
+                "RepoTags": [
+                    "busybox:latest"
+                ],
+                "RepoDigests": [
+                    "busybox@sha256:a59906e33509d14c036c8678d687bd4eec81ed7c4b8ce907b888c607f6a1e0e6"
+                ],
+                "Created": 1466724217,
+                "Size": 1092588,
+                "SharedSize": 0,
+                "VirtualSize": 1092588,
+                "Labels": {},
+                "Containers": 1
+            }
+        ],
+        "Containers": [
+            {
+                "Id": "e575172ed11dc01bfce087fb27bee502db149e1a0fad7c296ad300bbff178148",
+                "Names": [
+                    "/top"
+                ],
+                "Image": "busybox",
+                "ImageID": "sha256:2b8fd9751c4c0f5dd266fcae00707e67a2545ef34f9a29354585f93dac906749",
+                "Command": "top",
+                "Created": 1472592424,
+                "Ports": [],
+                "SizeRootFs": 1092588,
+                "Labels": {},
+                "State": "exited",
+                "Status": "Exited (0) 56 minutes ago",
+                "HostConfig": {
+                    "NetworkMode": "default"
+                },
+                "NetworkSettings": {
+                    "Networks": {
+                        "bridge": {
+                            "IPAMConfig": null,
+                            "Links": null,
+                            "Aliases": null,
+                            "NetworkID": "d687bc59335f0e5c9ee8193e5612e8aee000c8c62ea170cfb99c098f95899d92",
+                            "EndpointID": "8ed5115aeaad9abb174f68dcf135b49f11daf597678315231a32ca28441dec6a",
+                            "Gateway": "172.18.0.1",
+                            "IPAddress": "172.18.0.2",
+                            "IPPrefixLen": 16,
+                            "IPv6Gateway": "",
+                            "GlobalIPv6Address": "",
+                            "GlobalIPv6PrefixLen": 0,
+                            "MacAddress": "02:42:ac:12:00:02"
+                        }
+                    }
+                },
+                "Mounts": []
+            }
+        ],
         "Volumes": [
         "Volumes": [
                 {
                 {
                     "Name": "my-volume",
                     "Name": "my-volume",
@@ -2584,7 +2584,7 @@ Return docker data usage information
                     "RefCount": 0
                     "RefCount": 0
                 }
                 }
         ]
         ]
-	}
+    }
 
 
 **Status codes**:
 **Status codes**:
 
 
@@ -3412,12 +3412,12 @@ Delete unused volumes
     HTTP/1.1 200 OK
     HTTP/1.1 200 OK
     Content-Type: application/json
     Content-Type: application/json
 
 
-	{
-	    "VolumesDeleted": [
-	        "my-volume"
-	    ],
-	    "SpaceReclaimed": 42
-	}
+    {
+        "VolumesDeleted": [
+            "my-volume"
+        ],
+        "SpaceReclaimed": 42
+    }
 
 
 **Status codes**:
 **Status codes**:
 
 

+ 41 - 0
docs/reference/commandline/container_prune.md

@@ -0,0 +1,41 @@
+<!--[metadata]>
++++
+title = "container prune"
+description = "Remove all stopped containers"
+keywords = [container, prune, delete, remove]
+[menu.main]
+parent = "smn_cli"
++++
+<![end-metadata]-->
+
+# container prune
+
+```markdown
+Usage:	docker container prune
+
+Remove all stopped containers
+
+Options:
+  -f, --force   Do not prompt for confirmation
+      --help    Print usage
+```
+
+Example output:
+
+```bash
+$ docker container prune
+WARNING! This will remove all stopped containers.
+Are you sure you want to continue? [y/N] y
+Deleted Containers:
+4a7f7eebae0f63178aff7eb0aa39cd3f0627a203ab2df258c1a00b456cf20063
+f98f9c2aa1eaf727e4ec9c0283bc7d4aa4762fbdba7f26191f26c97f64090360
+
+Total reclaimed space: 212 B
+```
+
+## Related information
+
+* [system df](system_df.md)
+* [volume prune](container_prune.md)
+* [image prune](container_prune.md)
+* [system prune](system_prune.md)

+ 65 - 0
docs/reference/commandline/image_prune.md

@@ -0,0 +1,65 @@
+<!--[metadata]>
++++
+title = "image prune"
+description = "Remove all stopped images"
+keywords = [image, prune, delete, remove]
+[menu.main]
+parent = "smn_cli"
++++
+<![end-metadata]-->
+
+# image prune
+
+```markdown
+Usage:	docker image prune
+
+Remove unused images
+
+Options:
+  -a, --all     Remove all unused images, not just dangling ones
+  -f, --force   Do not prompt for confirmation
+      --help    Print usage
+```
+
+Remove all dangling images. If `-a` is specified, will also remove all images not referenced by any container.
+
+Example output:
+
+```bash
+$ docker image prune -a
+WARNING! This will remove all images without at least one container associated to them.
+Are you sure you want to continue? [y/N] y
+Deleted Images:
+untagged: alpine:latest
+untagged: alpine@sha256:3dcdb92d7432d56604d4545cbd324b14e647b313626d99b889d0626de158f73a
+deleted: sha256:4e38e38c8ce0b8d9041a9c4fefe786631d1416225e13b0bfe8cfa2321aec4bba
+deleted: sha256:4fe15f8d0ae69e169824f25f1d4da3015a48feeeeebb265cd2e328e15c6a869f
+untagged: alpine:3.3
+untagged: alpine@sha256:4fa633f4feff6a8f02acfc7424efd5cb3e76686ed3218abf4ca0fa4a2a358423
+untagged: my-jq:latest
+deleted: sha256:ae67841be6d008a374eff7c2a974cde3934ffe9536a7dc7ce589585eddd83aff
+deleted: sha256:34f6f1261650bc341eb122313372adc4512b4fceddc2a7ecbb84f0958ce5ad65
+deleted: sha256:cf4194e8d8db1cb2d117df33f2c75c0369c3a26d96725efb978cc69e046b87e7
+untagged: my-curl:latest
+deleted: sha256:b2789dd875bf427de7f9f6ae001940073b3201409b14aba7e5db71f408b8569e
+deleted: sha256:96daac0cb203226438989926fc34dd024f365a9a8616b93e168d303cfe4cb5e9
+deleted: sha256:5cbd97a14241c9cd83250d6b6fc0649833c4a3e84099b968dd4ba403e609945e
+deleted: sha256:a0971c4015c1e898c60bf95781c6730a05b5d8a2ae6827f53837e6c9d38efdec
+deleted: sha256:d8359ca3b681cc5396a4e790088441673ed3ce90ebc04de388bfcd31a0716b06
+deleted: sha256:83fc9ba8fb70e1da31dfcc3c88d093831dbd4be38b34af998df37e8ac538260c
+deleted: sha256:ae7041a4cc625a9c8e6955452f7afe602b401f662671cea3613f08f3d9343b35
+deleted: sha256:35e0f43a37755b832f0bbea91a2360b025ee351d7309dae0d9737bc96b6d0809
+deleted: sha256:0af941dd29f00e4510195dd00b19671bc591e29d1495630e7e0f7c44c1e6a8c0
+deleted: sha256:9fc896fc2013da84f84e45b3096053eb084417b42e6b35ea0cce5a3529705eac
+deleted: sha256:47cf20d8c26c46fff71be614d9f54997edacfe8d46d51769706e5aba94b16f2b
+deleted: sha256:2c675ee9ed53425e31a13e3390bf3f539bf8637000e4bcfbb85ee03ef4d910a1
+
+Total reclaimed space: 16.43 MB
+```
+
+## Related information
+
+* [system df](system_df.md)
+* [container prune](container_prune.md)
+* [volume prune](container_prune.md)
+* [system prune](system_prune.md)

+ 68 - 0
docs/reference/commandline/system_df.md

@@ -0,0 +1,68 @@
+<!--[metadata]>
++++
+title = "system df"
+description = "The system df command description and usage"
+keywords = [system, data, usage, disk]
+[menu.main]
+parent = "smn_cli"
++++
+<![end-metadata]-->
+
+# system df
+
+```markdown
+Usage:	docker system df [OPTIONS]
+
+Show docker filesystem usage
+
+Options:
+      --help      Print usage
+  -v, --verbose   Show detailed information on space usage
+```
+
+The `docker system df` command displays information regarding the
+amount of disk space used by the docker daemon.
+
+By default the command will just show a summary of the data used:
+```bash
+$ docker system df
+TYPE                TOTAL               ACTIVE              SIZE                RECLAIMABLE
+Images              5                   2                   16.43 MB            11.63 MB (70%)
+Containers          2                   0                   212 B               212 B (100%)
+Local Volumes       2                   1                   36 B                0 B (0%)
+```
+
+A more detailed view can be requested using the `-v, --verbose` flag:
+```bash
+$ docker system df -v
+Images space usage:
+
+REPOSITORY          TAG                 IMAGE ID            CREATED             SIZE                SHARED SIZE         UNIQUE SIZE         CONTAINERS
+my-curl             latest              b2789dd875bf        6 minutes ago       11 MB               11 MB               5 B                 0
+my-jq               latest              ae67841be6d0        6 minutes ago       9.623 MB            8.991 MB            632.1 kB            0
+<none>              <none>              a0971c4015c1        6 minutes ago       11 MB               11 MB               0 B                 0
+alpine              latest              4e38e38c8ce0        9 weeks ago         4.799 MB            0 B                 4.799 MB            1
+alpine              3.3                 47cf20d8c26c        9 weeks ago         4.797 MB            4.797 MB            0 B                 1
+
+Containers space usage:
+
+CONTAINER ID        IMAGE               COMMAND             LOCAL VOLUMES       SIZE                CREATED             STATUS                      NAMES
+4a7f7eebae0f        alpine:latest       "sh"                1                   0 B                 16 minutes ago      Exited (0) 5 minutes ago    hopeful_yalow
+f98f9c2aa1ea        alpine:3.3          "sh"                1                   212 B               16 minutes ago      Exited (0) 48 seconds ago   anon-vol
+
+Local Volumes space usage:
+
+NAME                                                               LINKS               SIZE
+07c7bdf3e34ab76d921894c2b834f073721fccfbbcba792aa7648e3a7a664c2e   2                   36 B
+my-named-vol                                                       0                   0 B
+```
+
+* `SHARED SIZE` is the amount of space that an image shares with another one (i.e. their common data)
+* `UNIQUE SIZE` is the amount of space that is only used by a given image
+* `SIZE` is the virtual size of the image, it is the sum of `SHARED SIZE` and `UNIQUE SIZE`
+
+## Related Information
+* [system prune](system_prune.md)
+* [container prune](container_prune.md)
+* [volume prune](volume_prune.md)
+* [image prune](image_prune.md)

+ 70 - 0
docs/reference/commandline/system_prune.md

@@ -0,0 +1,70 @@
+<!--[metadata]>
++++
+title = "system prune"
+description = "Remove unused data"
+keywords = [system, prune, delete, remove]
+[menu.main]
+parent = "smn_cli"
++++
+<![end-metadata]-->
+
+# system prune
+
+```markdown
+Usage:	docker system prune COMMAND
+
+Delete unused data
+
+Options:
+  -a, --all     Remove all unused images not just dangling ones
+  -f, --force   Do not prompt for confirmation
+      --help    Print usage
+```
+
+Remove all unused containers, volumes and images (both dangling and unreferenced).
+
+Example output:
+
+```bash
+$ docker system prune -a
+WARNING! This will remove:
+	- all stopped containers
+	- all volumes not used by at least one container
+	- all images without at least one container associated to them
+Are you sure you want to continue? [y/N] y
+Deleted Containers:0998aa37185a1a7036b0e12cf1ac1b6442dcfa30a5c9650a42ed5010046f195b
+73958bfb884fa81fa4cc6baf61055667e940ea2357b4036acbbe25a60f442a4d
+
+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
+```
+
+## Related information
+
+* [volume create](volume_create.md)
+* [volume ls](volume_ls.md)
+* [volume inspect](volume_inspect.md)
+* [volume rm](volume_rm.md)
+* [Understand Data Volumes](../../tutorials/dockervolumes.md)
+* [system df](system_df.md)
+* [container prune](container_prune.md)
+* [image prune](container_prune.md)
+* [system prune](system_prune.md)

+ 48 - 0
docs/reference/commandline/volume_prune.md

@@ -0,0 +1,48 @@
+<!--[metadata]>
++++
+title = "volume prune"
+description = "Remove unused volumes"
+keywords = [volume, prune, delete]
+[menu.main]
+parent = "smn_cli"
++++
+<![end-metadata]-->
+
+# volume prune
+
+```markdown
+Usage:	docker volume prune
+
+Remove all unused volumes
+
+Options:
+  -f, --force   Do not prompt for confirmation
+      --help    Print usage
+```
+
+Remove all unused volumes. Unused volumes are those which are not referenced by any containers
+
+Example output:
+
+```bash
+$ docker volume prune
+WARNING! This will remove all volumes not used by at least one container.
+Are you sure you want to continue? [y/N] y
+Deleted Volumes:
+07c7bdf3e34ab76d921894c2b834f073721fccfbbcba792aa7648e3a7a664c2e
+my-named-vol
+
+Total reclaimed space: 36 B
+```
+
+## Related information
+
+* [volume create](volume_create.md)
+* [volume ls](volume_ls.md)
+* [volume inspect](volume_inspect.md)
+* [volume rm](volume_rm.md)
+* [Understand Data Volumes](../../tutorials/dockervolumes.md)
+* [system df](system_df.md)
+* [container prune](container_prune.md)
+* [image prune](container_prune.md)
+* [system prune](system_prune.md)