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

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>
This commit is contained in:
Lucas Chan 2016-03-14 15:53:30 +11:00 committed by Tibor Vass
parent bdfe7963f2
commit 0b4a6c36b7
2 changed files with 168 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

103
docs/reference/commandline/info.md
View File

@ -17,7 +17,27 @@ parent = "smn_cli"
--help Print usage --help Print usage
For example:
This command displays system wide information regarding the Docker installation.
Information displayed includes the kernel version, number of containers and images.
The number of images shown is the number of unique images. The same image tagged
under different names is counted only once.
Depending on the storage driver in use, additional information can be shown, such
as pool name, data file, metadata file, data space used, total data space, metadata
space used, and total metadata space.
The data file is where the images are stored and the metadata file is where the
meta data regarding those images are stored. When run for the first time Docker
allocates a certain amount of data space and meta data space from the space
available on the volume where `/var/lib/docker` is mounted.
# EXAMPLES
## Display Docker system information
Here is a sample output for a daemon running on Ubuntu, using the overlay
storage driver:
$ docker -D info $ docker -D info
Containers: 14 Containers: 14
@ -25,22 +45,18 @@ For example:
Paused: 1 Paused: 1
Stopped: 10 Stopped: 10
Images: 52 Images: 52
Server Version: 1.9.0 Server Version: 1.11.1
Storage Driver: aufs Storage Driver: overlay
Root Dir: /var/lib/docker/aufs
Backing Filesystem: extfs Backing Filesystem: extfs
Dirs: 545
Dirperm1 Supported: true
Execution Driver: native-0.2
Logging Driver: json-file Logging Driver: json-file
Cgroup Driver: cgroupfs Cgroup Driver: cgroupfs
Plugins: Plugins:
Volume: local Volume: local
Network: bridge null host Network: bridge null host
Kernel Version: 3.19.0-22-generic Kernel Version: 4.4.0-21-generic
Operating System: Ubuntu 16.04 LTS
OSType: linux OSType: linux
Architecture: x86_64 Architecture: x86_64
Operating System: Ubuntu 15.04
CPUs: 24 CPUs: 24
Total Memory: 62.86 GiB Total Memory: 62.86 GiB
Name: docker Name: docker
@ -50,23 +66,72 @@ For example:
Debug mode (server): true Debug mode (server): true
File Descriptors: 59 File Descriptors: 59
Goroutines: 159 Goroutines: 159
System Time: 2015-09-23T14:04:20.699842089+08:00 System Time: 2016-04-26T10:04:06.14689342-04:00
EventsListeners: 0 EventsListeners: 0
Init SHA1: Http Proxy: http://test:test@localhost:8080
Init Path: /usr/bin/docker Https Proxy: https://test:test@localhost:8080
Docker Root Dir: /var/lib/docker No Proxy: localhost,127.0.0.1,docker-registry.somecorporation.com
Http Proxy: http://test:test@localhost:8080
Https Proxy: https://test:test@localhost:8080
WARNING: No swap limit support
Username: svendowideit Username: svendowideit
Registry: [https://index.docker.io/v1/] Registry: https://index.docker.io/v1/
WARNING: No swap limit support
Labels: Labels:
storage=ssd storage=ssd
staging=true
Insecure registries: Insecure registries:
myinsecurehost:5000 myinsecurehost:5000
127.0.0.0/8 127.0.0.0/8
The global `-D` option tells all `docker` commands to output debug information. The global `-D` option tells all `docker` commands to output debug information.
When sending issue reports, please use `docker version` and `docker -D info` to The example below shows the output for a daemon running on Red Hat Enterprise Linux,
ensure we know how your setup is configured. using the devicemapper storage driver. As can be seen in the output, additional
information about the devicemapper storage driver is shown:
$ docker info
Containers: 14
Running: 3
Paused: 1
Stopped: 10
Untagged Images: 52
Server Version: 1.10.3
Storage Driver: devicemapper
Pool Name: docker-202:2-25583803-pool
Pool Blocksize: 65.54 kB
Base Device Size: 10.74 GB
Backing Filesystem: xfs
Data file: /dev/loop0
Metadata file: /dev/loop1
Data Space Used: 1.68 GB
Data Space Total: 107.4 GB
Data Space Available: 7.548 GB
Metadata Space Used: 2.322 MB
Metadata Space Total: 2.147 GB
Metadata Space Available: 2.145 GB
Udev Sync Supported: true
Deferred Removal Enabled: false
Deferred Deletion Enabled: false
Deferred Deleted Device Count: 0
Data loop file: /var/lib/docker/devicemapper/devicemapper/data
Metadata loop file: /var/lib/docker/devicemapper/devicemapper/metadata
Library Version: 1.02.107-RHEL7 (2015-12-01)
Execution Driver: native-0.2
Logging Driver: json-file
Plugins:
Volume: local
Network: null host bridge
Kernel Version: 3.10.0-327.el7.x86_64
Operating System: Red Hat Enterprise Linux Server 7.2 (Maipo)
OSType: linux
Architecture: x86_64
CPUs: 1
Total Memory: 991.7 MiB
Name: ip-172-30-0-91.ec2.internal
ID: I54V:OLXT:HVMM:TPKO:JPHQ:CQCD:JNLC:O3BZ:4ZVJ:43XJ:PFHZ:6N2S
Docker Root Dir: /var/lib/docker
Debug mode (client): false
Debug mode (server): false
Username: xyz
Registry: https://index.docker.io/v1/
Insecure registries:
myinsecurehost:5000
127.0.0.0/8

99
man/docker-info.1.md
View File

@ -11,9 +11,13 @@ docker-info - Display system-wide information
# DESCRIPTION # DESCRIPTION
This command displays system wide information regarding the Docker installation. This command displays system wide information regarding the Docker installation.
Information displayed includes the number of containers and images, pool name, Information displayed includes the kernel version, number of containers and images.
data file, metadata file, data space used, total data space, metadata space used The number of images shown is the number of unique images. The same image tagged
, total metadata space, execution driver, and the kernel version. under different names is counted only once.
Depending on the storage driver in use, additional information can be shown, such
as pool name, data file, metadata file, data space used, total data space, metadata
space used, and total metadata space.
The data file is where the images are stored and the metadata file is where the The data file is where the images are stored and the metadata file is where the
meta data regarding those images are stored. When run for the first time Docker meta data regarding those images are stored. When run for the first time Docker
@ -28,31 +32,96 @@ available on the volume where `/var/lib/docker` is mounted.
## Display Docker system information ## Display Docker system information
Here is a sample output: Here is a sample output for a daemon running on Ubuntu, using the overlay
storage driver:
# docker info $ docker -D info
Containers: 14 Containers: 14
Running: 3 Running: 3
Paused: 1 Paused: 1
Stopped: 10 Stopped: 10
Images: 52 Images: 52
Server Version: 1.9.0 Server Version: 1.11.1
Storage Driver: aufs Storage Driver: overlay
Root Dir: /var/lib/docker/aufs Backing Filesystem: extfs
Dirs: 80
Execution Driver: native-0.2
Logging Driver: json-file Logging Driver: json-file
Cgroup Driver: cgroupfs Cgroup Driver: cgroupfs
Plugins: Plugins:
Volume: local Volume: local
Network: bridge null host Network: bridge null host
Kernel Version: 3.13.0-24-generic Kernel Version: 4.4.0-21-generic
Operating System: Ubuntu 14.04 LTS Operating System: Ubuntu 16.04 LTS
OSType: linux
Architecture: x86_64
CPUs: 24
Total Memory: 62.86 GiB
Name: docker
ID: I54V:OLXT:HVMM:TPKO:JPHQ:CQCD:JNLC:O3BZ:4ZVJ:43XJ:PFHZ:6N2S
Docker Root Dir: /var/lib/docker
Debug mode (client): true
Debug mode (server): true
File Descriptors: 59
Goroutines: 159
System Time: 2016-04-26T10:04:06.14689342-04:00
EventsListeners: 0
Http Proxy: http://test:test@localhost:8080
Https Proxy: https://test:test@localhost:8080
No Proxy: localhost,127.0.0.1,docker-registry.somecorporation.com
Username: svendowideit
Registry: https://index.docker.io/v1/
WARNING: No swap limit support
Labels:
storage=ssd
staging=true
Insecure registries:
myinsecurehost:5000
127.0.0.0/8
The global `-D` option tells all `docker` commands to output debug information.
The example below shows the output for a daemon running on Red Hat Enterprise Linux,
using the devicemapper storage driver. As can be seen in the output, additional
information about the devicemapper storage driver is shown:
$ docker info
Containers: 14
Running: 3
Paused: 1
Stopped: 10
Untagged Images: 52
Server Version: 1.10.3
Storage Driver: devicemapper
Pool Name: docker-202:2-25583803-pool
Pool Blocksize: 65.54 kB
Base Device Size: 10.74 GB
Backing Filesystem: xfs
Data file: /dev/loop0
Metadata file: /dev/loop1
Data Space Used: 1.68 GB
Data Space Total: 107.4 GB
Data Space Available: 7.548 GB
Metadata Space Used: 2.322 MB
Metadata Space Total: 2.147 GB
Metadata Space Available: 2.145 GB
Udev Sync Supported: true
Deferred Removal Enabled: false
Deferred Deletion Enabled: false
Deferred Deleted Device Count: 0
Data loop file: /var/lib/docker/devicemapper/devicemapper/data
Metadata loop file: /var/lib/docker/devicemapper/devicemapper/metadata
Library Version: 1.02.107-RHEL7 (2015-12-01)
Execution Driver: native-0.2
Logging Driver: json-file
Plugins:
Volume: local
Network: null host bridge
Kernel Version: 3.10.0-327.el7.x86_64
Operating System: Red Hat Enterprise Linux Server 7.2 (Maipo)
OSType: linux OSType: linux
Architecture: x86_64 Architecture: x86_64
CPUs: 1 CPUs: 1
Total Memory: 2 GiB Total Memory: 991.7 MiB
Name: docker Name: ip-172-30-0-91.ec2.internal
ID: I54V:OLXT:HVMM:TPKO:JPHQ:CQCD:JNLC:O3BZ:4ZVJ:43XJ:PFHZ:6N2S ID: I54V:OLXT:HVMM:TPKO:JPHQ:CQCD:JNLC:O3BZ:4ZVJ:43XJ:PFHZ:6N2S
Docker Root Dir: /var/lib/docker Docker Root Dir: /var/lib/docker
Debug mode (client): false Debug mode (client): false
@ -62,7 +131,7 @@ Here is a sample output:
Insecure registries: Insecure registries:
myinsecurehost:5000 myinsecurehost:5000
127.0.0.0/8 127.0.0.0/8
# HISTORY # HISTORY
April 2014, Originally compiled by William Henry (whenry at redhat dot com) April 2014, Originally compiled by William Henry (whenry at redhat dot com)
based on docker.com source material and internal work. based on docker.com source material and internal work.