1. docker
  2. Commit 55d61e98baa9cfffa246b40f48b09b9865b585ca
Browse code

Updated docker-info output and documentation

- [x] Update man page description
- [x] Update man page sample output to something more current

Tested with: `TESTFLAGS='-check.f DockerSuite.TestInfoEnsureSucceeds*'
make test-integration-cli`

Signed-off-by: Lucas Chan <lucas-github@lucaschan.com>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

Lucas Chan authored on 2016/03/14 13:53:30
Showing 2 changed files
docs/reference/commandline/info.md
History View file @ 55d61e9
... ... 
@@ -17,7 +17,27 @@ parent = "smn_cli"
17 17
18 18 
       --help              Print usage
19 19
20 
-For example:
20 
+
21 
+This command displays system wide information regarding the Docker installation.
22 
+Information displayed includes the kernel version, number of containers and images.
23 
+The number of images shown is the number of unique images. The same image tagged
24 
+under different names is counted only once.
25 
+
26 
+Depending on the storage driver in use, additional information can be shown, such
27 
+as pool name, data file, metadata file, data space used, total data space, metadata
28 
+space used, and total metadata space.
29 
+
30 
+The data file is where the images are stored and the metadata file is where the
31 
+meta data regarding those images are stored. When run for the first time Docker
32 
+allocates a certain amount of data space and meta data space from the space
33 
+available on the volume where `/var/lib/docker` is mounted.
34 
+
35 
+# EXAMPLES
36 
+
37 
+## Display Docker system information
38 
+
39 
+Here is a sample output for a daemon running on Ubuntu, using the overlay
40 
+storage driver:
21 41
22 42 
     $ docker -D info
23 43 
     Containers: 14
... ... 
@@ -25,22 +45,18 @@ For example:
25 25 
      Paused: 1
26 26 
      Stopped: 10
27 27 
     Images: 52
28 
-    Server Version: 1.9.0
29 
-    Storage Driver: aufs
30 
-     Root Dir: /var/lib/docker/aufs
28 
+    Server Version: 1.11.1
29 
+    Storage Driver: overlay
31 30 
      Backing Filesystem: extfs
32 
-     Dirs: 545
33 
-     Dirperm1 Supported: true
34 
-    Execution Driver: native-0.2
35 31 
     Logging Driver: json-file
36 32 
     Cgroup Driver: cgroupfs
37 33 
     Plugins:
38 34 
      Volume: local
39 35 
      Network: bridge null host
40 
-    Kernel Version: 3.19.0-22-generic
36 
+    Kernel Version: 4.4.0-21-generic
37 
+    Operating System: Ubuntu 16.04 LTS
41 38 
     OSType: linux
42 39 
     Architecture: x86_64
43 
-    Operating System: Ubuntu 15.04
44 40 
     CPUs: 24
45 41 
     Total Memory: 62.86 GiB
46 42 
     Name: docker
... ... 
@@ -50,23 +66,72 @@ For example:
50 50 
     Debug mode (server): true
51 51 
      File Descriptors: 59
52 52 
      Goroutines: 159
53 
-     System Time: 2015-09-23T14:04:20.699842089+08:00
53 
+     System Time: 2016-04-26T10:04:06.14689342-04:00
54 54 
      EventsListeners: 0
55 
-     Init SHA1:
56 
-     Init Path: /usr/bin/docker
57 
-     Docker Root Dir: /var/lib/docker
58 
-     Http Proxy: http://test:test@localhost:8080
59 
-     Https Proxy: https://test:test@localhost:8080
60 
-    WARNING: No swap limit support
55 
+    Http Proxy: http://test:test@localhost:8080
56 
+    Https Proxy: https://test:test@localhost:8080
57 
+    No Proxy: localhost,127.0.0.1,docker-registry.somecorporation.com
61 58 
     Username: svendowideit
62 
-    Registry: [https://index.docker.io/v1/]
59 
+    Registry: https://index.docker.io/v1/
60 
+    WARNING: No swap limit support
63 61 
     Labels:
64 62 
      storage=ssd
63 
+     staging=true
65 64 
     Insecure registries:
66 65 
      myinsecurehost:5000
67 66 
      127.0.0.0/8
68 67
69 68 
 The global `-D` option tells all `docker` commands to output debug information.
70 69
71 
-When sending issue reports, please use `docker version` and `docker -D info` to
72 
-ensure we know how your setup is configured.
70 
+The example below shows the output for a daemon running on Red Hat Enterprise Linux,
71 
+using the devicemapper storage driver. As can be seen in the output, additional
72 
+information about the devicemapper storage driver is shown:
73 
+
74 
+    $ docker info
75 
+    Containers: 14
76 
+     Running: 3
77 
+     Paused: 1
78 
+     Stopped: 10
79 
+    Untagged Images: 52
80 
+    Server Version: 1.10.3
81 
+    Storage Driver: devicemapper
82 
+     Pool Name: docker-202:2-25583803-pool
83 
+     Pool Blocksize: 65.54 kB
84 
+     Base Device Size: 10.74 GB
85 
+     Backing Filesystem: xfs
86 
+     Data file: /dev/loop0
87 
+     Metadata file: /dev/loop1
88 
+     Data Space Used: 1.68 GB
89 
+     Data Space Total: 107.4 GB
90 
+     Data Space Available: 7.548 GB
91 
+     Metadata Space Used: 2.322 MB
92 
+     Metadata Space Total: 2.147 GB
93 
+     Metadata Space Available: 2.145 GB
94 
+     Udev Sync Supported: true
95 
+     Deferred Removal Enabled: false
96 
+     Deferred Deletion Enabled: false
97 
+     Deferred Deleted Device Count: 0
98 
+     Data loop file: /var/lib/docker/devicemapper/devicemapper/data
99 
+     Metadata loop file: /var/lib/docker/devicemapper/devicemapper/metadata
100 
+     Library Version: 1.02.107-RHEL7 (2015-12-01)
101 
+    Execution Driver: native-0.2
102 
+    Logging Driver: json-file
103 
+    Plugins:
104 
+     Volume: local
105 
+     Network: null host bridge
106 
+    Kernel Version: 3.10.0-327.el7.x86_64
107 
+    Operating System: Red Hat Enterprise Linux Server 7.2 (Maipo)
108 
+    OSType: linux
109 
+    Architecture: x86_64
110 
+    CPUs: 1
111 
+    Total Memory: 991.7 MiB
112 
+    Name: ip-172-30-0-91.ec2.internal
113 
+    ID: I54V:OLXT:HVMM:TPKO:JPHQ:CQCD:JNLC:O3BZ:4ZVJ:43XJ:PFHZ:6N2S
114 
+    Docker Root Dir: /var/lib/docker
115 
+    Debug mode (client): false
116 
+    Debug mode (server): false
117 
+    Username: xyz
118 
+    Registry: https://index.docker.io/v1/
119 
+    Insecure registries:
120 
+     myinsecurehost:5000
121 
+     127.0.0.0/8
man/docker-info.1.md
History View file @ 55d61e9
... ... 
@@ -11,9 +11,13 @@ docker-info - Display system-wide information
11 11
12 12 
 # DESCRIPTION
13 13 
 This command displays system wide information regarding the Docker installation.
14 
-Information displayed includes the number of containers and images, pool name,
15 
-data file, metadata file, data space used, total data space, metadata space used
16 
-, total metadata space, execution driver, and the kernel version.
14 
+Information displayed includes the kernel version, number of containers and images.
15 
+The number of images shown is the number of unique images. The same image tagged
16 
+under different names is counted only once.
17 
+
18 
+Depending on the storage driver in use, additional information can be shown, such
19 
+as pool name, data file, metadata file, data space used, total data space, metadata
20 
+space used, and total metadata space.
17 21
18 22 
 The data file is where the images are stored and the metadata file is where the
19 23 
 meta data regarding those images are stored. When run for the first time Docker
... ... 
@@ -28,33 +32,98 @@ available on the volume where `/var/lib/docker` is mounted.
28 28
29 29 
 ## Display Docker system information
30 30
31 
-Here is a sample output:
31 
+Here is a sample output for a daemon running on Ubuntu, using the overlay
32 
+storage driver:
32 33
33 
-    # docker info
34 
+    $ docker -D info
34 35 
     Containers: 14
35 36 
      Running: 3
36 37 
      Paused: 1
37 38 
      Stopped: 10
38 39 
     Images: 52
39 
-    Server Version: 1.9.0
40 
-    Storage Driver: aufs
41 
-     Root Dir: /var/lib/docker/aufs
42 
-     Dirs: 80
43 
-    Execution Driver: native-0.2
40 
+    Server Version: 1.11.1
41 
+    Storage Driver: overlay
42 
+     Backing Filesystem: extfs
44 43 
     Logging Driver: json-file
45 44 
     Cgroup Driver: cgroupfs
46 45 
     Plugins:
47 46 
      Volume: local
48 47 
      Network: bridge null host
49 
-    Kernel Version: 3.13.0-24-generic
50 
-    Operating System: Ubuntu 14.04 LTS
48 
+    Kernel Version: 4.4.0-21-generic
49 
+    Operating System: Ubuntu 16.04 LTS
51 50 
     OSType: linux
52 51 
     Architecture: x86_64
53 
-    CPUs: 1
54 
-    Total Memory: 2 GiB
52 
+    CPUs: 24
53 
+    Total Memory: 62.86 GiB
55 54 
     Name: docker
56 55 
     ID: I54V:OLXT:HVMM:TPKO:JPHQ:CQCD:JNLC:O3BZ:4ZVJ:43XJ:PFHZ:6N2S
57 56 
     Docker Root Dir: /var/lib/docker
57 
+    Debug mode (client): true
58 
+    Debug mode (server): true
59 
+     File Descriptors: 59
60 
+     Goroutines: 159
61 
+     System Time: 2016-04-26T10:04:06.14689342-04:00
62 
+     EventsListeners: 0
63 
+    Http Proxy: http://test:test@localhost:8080
64 
+    Https Proxy: https://test:test@localhost:8080
65 
+    No Proxy: localhost,127.0.0.1,docker-registry.somecorporation.com
66 
+    Username: svendowideit
67 
+    Registry: https://index.docker.io/v1/
68 
+    WARNING: No swap limit support
69 
+    Labels:
70 
+     storage=ssd
71 
+     staging=true
72 
+    Insecure registries:
73 
+     myinsecurehost:5000
74 
+     127.0.0.0/8
75 
+
76 
+The global `-D` option tells all `docker` commands to output debug information.
77 
+
78 
+The example below shows the output for a daemon running on Red Hat Enterprise Linux,
79 
+using the devicemapper storage driver. As can be seen in the output, additional
80 
+information about the devicemapper storage driver is shown:
81 
+
82 
+    $ docker info
83 
+    Containers: 14
84 
+     Running: 3
85 
+     Paused: 1
86 
+     Stopped: 10
87 
+    Untagged Images: 52
88 
+    Server Version: 1.10.3
89 
+    Storage Driver: devicemapper
90 
+     Pool Name: docker-202:2-25583803-pool
91 
+     Pool Blocksize: 65.54 kB
92 
+     Base Device Size: 10.74 GB
93 
+     Backing Filesystem: xfs
94 
+     Data file: /dev/loop0
95 
+     Metadata file: /dev/loop1
96 
+     Data Space Used: 1.68 GB
97 
+     Data Space Total: 107.4 GB
98 
+     Data Space Available: 7.548 GB
99 
+     Metadata Space Used: 2.322 MB
100 
+     Metadata Space Total: 2.147 GB
101 
+     Metadata Space Available: 2.145 GB
102 
+     Udev Sync Supported: true
103 
+     Deferred Removal Enabled: false
104 
+     Deferred Deletion Enabled: false
105 
+     Deferred Deleted Device Count: 0
106 
+     Data loop file: /var/lib/docker/devicemapper/devicemapper/data
107 
+     Metadata loop file: /var/lib/docker/devicemapper/devicemapper/metadata
108 
+     Library Version: 1.02.107-RHEL7 (2015-12-01)
109 
+    Execution Driver: native-0.2
110 
+    Logging Driver: json-file
111 
+    Plugins:
112 
+     Volume: local
113 
+     Network: null host bridge
114 
+    Kernel Version: 3.10.0-327.el7.x86_64
115 
+    Operating System: Red Hat Enterprise Linux Server 7.2 (Maipo)
116 
+    OSType: linux
117 
+    Architecture: x86_64
118 
+    CPUs: 1
119 
+    Total Memory: 991.7 MiB
120 
+    Name: ip-172-30-0-91.ec2.internal
121 
+    ID: I54V:OLXT:HVMM:TPKO:JPHQ:CQCD:JNLC:O3BZ:4ZVJ:43XJ:PFHZ:6N2S
122 
+    Docker Root Dir: /var/lib/docker
58 123 
     Debug mode (client): false
59 124 
     Debug mode (server): false
60 125 
     Username: xyz
... ... 
@@ -62,7 +131,7 @@ Here is a sample output:
62 62 
     Insecure registries:
63 63 
      myinsecurehost:5000
64 64 
      127.0.0.0/8
65 
-
65 
+
66 66 
 # HISTORY
67 67 
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
68 68 
 based on docker.com source material and internal work.