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

docs/reference: info: update example output 

Update the example output to not use deprecated storage drivers or
Windows versions.

Also removes the section about `--debug`, because the `docker info` output
depends on the _daemon_ (not the client) to have debug mode enabled.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Sebastiaan van Stijn 2022-06-06 15:22:32 +02:00
parent 9ba371f665
commit cac78c237f
No known key found for this signature in database
GPG Key ID: 76698F39D527CE8C
2 changed files with 125 additions and 269 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -43,9 +43,9 @@ available on the volume where `/var/lib/docker` is mounted.
### Show output ### Show output
The example below shows the output for a daemon running on Red Hat Enterprise Linux, The example below shows the output for a daemon running on Ubuntu Linux,
using the `devicemapper` storage driver. As can be seen in the output, additional using the `overlay2` storage driver. As can be seen in the output, additional
information about the `devicemapper` storage driver is shown: information about the `overlay2` storage driver is shown:
```console ```console
$ docker info $ docker info
@ -53,6 +53,16 @@ $ docker info
Client: Client:
Context: default Context: default
Debug Mode: false Debug Mode: false
Plugins:
buildx: Docker Buildx (Docker Inc.)
Version: v0.8.2
Path: /usr/libexec/docker/cli-plugins/docker-buildx
compose: Docker Compose (Docker Inc.)
Version: v2.6.0
Path: /usr/libexec/docker/cli-plugins/docker-compose
scan: Docker Scan (Docker Inc.)
Version: v0.17.0
Path: /usr/libexec/docker/cli-plugins/docker-scan
Server: Server:
Containers: 14 Containers: 14
@ -60,141 +70,51 @@ Server:
Paused: 1 Paused: 1
Stopped: 10 Stopped: 10
Images: 52 Images: 52
Server Version: 1.10.3 Server Version: 22.06.0
Storage Driver: devicemapper Storage Driver: overlay2
Pool Name: docker-202:2-25583803-pool Backing Filesystem: extfs
Pool Blocksize: 65.54 kB Supports d_type: true
Base Device Size: 10.74 GB Using metacopy: false
Backing Filesystem: xfs Native Overlay Diff: true
Data file: /dev/loop0 userxattr: false
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 Logging Driver: json-file
Cgroup Driver: systemd
Cgroup Version: 2
Plugins: Plugins:
Volume: local Volume: local
Network: null host bridge Network: bridge host ipvlan macvlan null overlay
Kernel Version: 3.10.0-327.el7.x86_64 Log: awslogs fluentd gcplogs gelf journald json-file local logentries splunk syslog
Operating System: Red Hat Enterprise Linux Server 7.2 (Maipo) Swarm: inactive
Runtimes: io.containerd.runc.v2 io.containerd.runtime.v1.linux runc
Default Runtime: runc
Init Binary: docker-init
containerd version: 212e8b6fa2f44b9c21b2798135fc6fb7c53efc16
runc version: v1.1.1-0-g52de29d
init version: de40ad0
Security Options:
apparmor
seccomp
Profile: builtin
cgroupns
Kernel Version: 5.15.0-25-generic
Operating System: Ubuntu 22.04 LTS
OSType: linux OSType: linux
Architecture: x86_64 Architecture: x86_64
CPUs: 1 CPUs: 1
Total Memory: 991.7 MiB Total Memory: 991.7 MiB
Name: ip-172-30-0-91.ec2.internal Name: ip-172-30-0-91.ec2.internal
ID: I54V:OLXT:HVMM:TPKO:JPHQ:CQCD:JNLC:O3BZ:4ZVJ:43XJ:PFHZ:6N2S ID: 4cee4408-10d2-4e17-891c-a41736ac4536
Docker Root Dir: /var/lib/docker Docker Root Dir: /var/lib/docker
Debug Mode: false Debug Mode: false
Username: gordontheturtle Username: gordontheturtle
Registry: https://index.docker.io/v1/ Registry: https://index.docker.io/v1/
Experimental: false
Insecure registries: Insecure registries:
myinsecurehost:5000 myinsecurehost:5000
127.0.0.0/8 127.0.0.0/8
```
### <a name=debug></a> Show debugging output (--debug)
Here is a sample output for a daemon running on Ubuntu, using the overlay2
storage driver and a node that is part of a 2-node swarm:
```console
$ docker --debug info
Client:
Context: default
Debug Mode: true
Server:
Containers: 14
Running: 3
Paused: 1
Stopped: 10
Images: 52
Server Version: 1.13.0
Storage Driver: overlay2
Backing Filesystem: extfs
Supports d_type: true
Native Overlay Diff: false
Logging Driver: json-file
Cgroup Driver: cgroupfs
Plugins:
Volume: local
Network: bridge host macvlan null overlay
Swarm: active
NodeID: rdjq45w1op418waxlairloqbm
Is Manager: true
ClusterID: te8kdyw33n36fqiz74bfjeixd
Managers: 1
Nodes: 2
Orchestration:
Task History Retention Limit: 5
Raft:
Snapshot Interval: 10000
Number of Old Snapshots to Retain: 0
Heartbeat Tick: 1
Election Tick: 3
Dispatcher:
Heartbeat Period: 5 seconds
CA Configuration:
Expiry Duration: 3 months
Root Rotation In Progress: false
Node Address: 172.16.66.128 172.16.66.129
Manager Addresses:
172.16.66.128:2477
Runtimes: runc
Default Runtime: runc
Init Binary: docker-init
containerd version: 8517738ba4b82aff5662c97ca4627e7e4d03b531
runc version: ac031b5bf1cc92239461125f4c1ffb760522bbf2
init version: N/A (expected: v0.13.0)
Security Options:
apparmor
seccomp
Profile: default
Kernel Version: 4.4.0-31-generic
Operating System: Ubuntu 16.04.1 LTS
OSType: linux
Architecture: x86_64
CPUs: 2
Total Memory: 1.937 GiB
Name: ubuntu
ID: H52R:7ZR6:EIIA:76JG:ORIY:BVKF:GSFU:HNPG:B5MK:APSC:SZ3Q:N326
Docker Root Dir: /var/lib/docker
Debug Mode: true
File Descriptors: 30
Goroutines: 123
System Time: 2016-11-12T17:24:37.955404361-08:00
EventsListeners: 0
Http Proxy: http://test:test@proxy.example.com:8080
Https Proxy: https://test:test@proxy.example.com:8080
No Proxy: localhost,127.0.0.1,docker-registry.somecorporation.com
Registry: https://index.docker.io/v1/
WARNING: No swap limit support
Labels:
storage=ssd
staging=true
Experimental: false
Insecure Registries:
127.0.0.0/8
Registry Mirrors:
http://192.168.1.2/
http://registry-mirror.example.com:5000/
Live Restore Enabled: false Live Restore Enabled: false
``` ```
The global `-D` option causes all `docker` commands to output debug information.
### <a name=format></a> Format the output (--format) ### <a name=format></a> Format the output (--format)
You can also specify the output format: You can also specify the output format:
@ -207,13 +127,18 @@ $ docker info --format '{{json .}}'
### Run `docker info` on Windows ### Run `docker info` on Windows
Here is a sample output for a daemon running on Windows Server 2016: Here is a sample output for a daemon running on Windows Server:
```console ```console
E:\docker>docker info C:\> docker info
Client: Client:
Context: default Context: default
Debug Mode: false Debug Mode: false
Plugins:
buildx: Docker Buildx (Docker Inc., v0.8.2-docker)
compose: Docker Compose (Docker Inc., v2.6.0)
scan: Docker Scan (Docker Inc., v0.17.0)
Server: Server:
Containers: 1 Containers: 1
@ -221,27 +146,29 @@ Server:
Paused: 0 Paused: 0
Stopped: 1 Stopped: 1
Images: 17 Images: 17
Server Version: 1.13.0 Server Version: 20.10.16
Storage Driver: windowsfilter Storage Driver: windowsfilter
Windows:
Logging Driver: json-file Logging Driver: json-file
Plugins: Plugins:
Volume: local Volume: local
Network: nat null overlay Network: ics internal l2bridge l2tunnel nat null overlay private transparent
Log: awslogs etwlogs fluentd gcplogs gelf json-file local logentries splunk syslog
Swarm: inactive Swarm: inactive
Default Isolation: process Default Isolation: process
Kernel Version: 10.0 14393 (14393.206.amd64fre.rs1_release.160912-1937) Kernel Version: 10.0 20348 (20348.1.amd64fre.fe_release.210507-1500)
Operating System: Windows Server 2016 Datacenter Operating System: Microsoft Windows Server Version 21H2 (OS Build 20348.707)
OSType: windows OSType: windows
Architecture: x86_64 Architecture: x86_64
CPUs: 8 CPUs: 8
Total Memory: 3.999 GiB Total Memory: 3.999 GiB
Name: WIN-V0V70C0LU5P Name: WIN-V0V70C0LU5P
ID: NYMS:B5VK:UMSL:FVDZ:EWB5:FKVK:LPFL:FJMQ:H6FT:BZJ6:L2TD:XH62 ID: 2880d38d-464e-4d01-91bd-c76f33ba3981
Docker Root Dir: C:\control Docker Root Dir: C:\ProgramData\docker
Debug Mode: false Debug Mode: false
Registry: https://index.docker.io/v1/ Registry: https://index.docker.io/v1/
Experimental: true
Insecure Registries: Insecure Registries:
myregistry:5000
127.0.0.0/8 127.0.0.0/8
Registry Mirrors: Registry Mirrors:
http://192.168.1.2/ http://192.168.1.2/

209
man/src/system/info.md
View File

@ -20,150 +20,79 @@ available on the volume where `/var/lib/docker` is mounted.
## Display Docker system information ## Display Docker system information
Here is a sample output for a daemon running on Ubuntu, using the overlay2 The example below shows the output for a daemon running on Ubuntu Linux,
storage driver: using the `overlay2` storage driver. As can be seen in the output, additional
information about the `overlay2` storage driver is shown:
$ docker -D info ```console
Client: $ docker info
Debug Mode: true
Server: Client:
Containers: 14 Context: default
Running: 3 Debug Mode: false
Paused: 1 Plugins:
Stopped: 10 buildx: Docker Buildx (Docker Inc.)
Images: 52 Version: v0.8.2
Server Version: 1.13.0 Path: /usr/libexec/docker/cli-plugins/docker-buildx
Storage Driver: overlay2 compose: Docker Compose (Docker Inc.)
Backing Filesystem: extfs Version: v2.6.0
Supports d_type: true Path: /usr/libexec/docker/cli-plugins/docker-compose
Native Overlay Diff: false scan: Docker Scan (Docker Inc.)
Logging Driver: json-file Version: v0.17.0
Cgroup Driver: cgroupfs Path: /usr/libexec/docker/cli-plugins/docker-scan
Plugins:
Volume: local
Network: bridge host macvlan null overlay
Swarm: active
NodeID: rdjq45w1op418waxlairloqbm
Is Manager: true
ClusterID: te8kdyw33n36fqiz74bfjeixd
Managers: 1
Nodes: 2
Orchestration:
Task History Retention Limit: 5
Raft:
Snapshot Interval: 10000
Number of Old Snapshots to Retain: 0
Heartbeat Tick: 1
Election Tick: 3
Dispatcher:
Heartbeat Period: 5 seconds
CA Configuration:
Expiry Duration: 3 months
Node Address: 172.16.66.128 172.16.66.129
Manager Addresses:
172.16.66.128:2477
Runtimes: runc
Default Runtime: runc
Init Binary: docker-init
containerd version: 8517738ba4b82aff5662c97ca4627e7e4d03b531
runc version: ac031b5bf1cc92239461125f4c1ffb760522bbf2
init version: N/A (expected: v0.13.0)
Security Options:
apparmor
seccomp
Profile: default
Kernel Version: 4.4.0-31-generic
Operating System: Ubuntu 16.04.1 LTS
OSType: linux
Architecture: x86_64
CPUs: 2
Total Memory: 1.937 GiB
Name: ubuntu
ID: H52R:7ZR6:EIIA:76JG:ORIY:BVKF:GSFU:HNPG:B5MK:APSC:SZ3Q:N326
Docker Root Dir: /var/lib/docker
Debug Mode: true
File Descriptors: 30
Goroutines: 123
System Time: 2016-11-12T17:24:37.955404361-08:00
EventsListeners: 0
Http Proxy: http://test:test@proxy.example.com:8080
Https Proxy: https://test:test@proxy.example.com:8080
No Proxy: localhost,127.0.0.1,docker-registry.somecorporation.com
Registry: https://index.docker.io/v1/
WARNING: No swap limit support
Labels:
storage=ssd
staging=true
Experimental: false
Insecure Registries:
127.0.0.0/8
Registry Mirrors:
http://192.168.1.2/
http://registry-mirror.example.com:5000/
Live Restore Enabled: false
Server:
Containers: 14
The global `-D` option tells all `docker` commands to output debug information. Running: 3
Paused: 1
The example below shows the output for a daemon running on Red Hat Enterprise Linux, Stopped: 10
using the devicemapper storage driver. As can be seen in the output, additional Images: 52
information about the devicemapper storage driver is shown: Server Version: 22.06.0
Storage Driver: overlay2
$ docker info Backing Filesystem: extfs
Client: Supports d_type: true
Debug Mode: false Using metacopy: false
Native Overlay Diff: true
Server: userxattr: false
Containers: 14 Logging Driver: json-file
Running: 3 Cgroup Driver: systemd
Paused: 1 Cgroup Version: 2
Stopped: 10 Plugins:
Untagged Images: 52 Volume: local
Server Version: 1.10.3 Network: bridge host ipvlan macvlan null overlay
Storage Driver: devicemapper Log: awslogs fluentd gcplogs gelf journald json-file local logentries splunk syslog
Pool Name: docker-202:2-25583803-pool Swarm: inactive
Pool Blocksize: 65.54 kB Runtimes: io.containerd.runc.v2 io.containerd.runtime.v1.linux runc
Base Device Size: 10.74 GB Default Runtime: runc
Backing Filesystem: xfs Init Binary: docker-init
Data file: /dev/loop0 containerd version: 212e8b6fa2f44b9c21b2798135fc6fb7c53efc16
Metadata file: /dev/loop1 runc version: v1.1.1-0-g52de29d
Data Space Used: 1.68 GB init version: de40ad0
Data Space Total: 107.4 GB Security Options:
Data Space Available: 7.548 GB apparmor
Metadata Space Used: 2.322 MB seccomp
Metadata Space Total: 2.147 GB Profile: builtin
Metadata Space Available: 2.145 GB cgroupns
Udev Sync Supported: true Kernel Version: 5.15.0-25-generic
Deferred Removal Enabled: false Operating System: Ubuntu 22.04 LTS
Deferred Deletion Enabled: false OSType: linux
Deferred Deleted Device Count: 0 Architecture: x86_64
Data loop file: /var/lib/docker/devicemapper/devicemapper/data CPUs: 1
Metadata loop file: /var/lib/docker/devicemapper/devicemapper/metadata Total Memory: 991.7 MiB
Library Version: 1.02.107-RHEL7 (2015-12-01) Name: ip-172-30-0-91.ec2.internal
Execution Driver: native-0.2 ID: 4cee4408-10d2-4e17-891c-a41736ac4536
Logging Driver: json-file Docker Root Dir: /var/lib/docker
Plugins: Debug Mode: false
Volume: local Username: gordontheturtle
Network: null host bridge Registry: https://index.docker.io/v1/
Kernel Version: 3.10.0-327.el7.x86_64 Experimental: false
Operating System: Red Hat Enterprise Linux Server 7.2 (Maipo) Insecure registries:
OSType: linux myinsecurehost:5000
Architecture: x86_64 127.0.0.0/8
CPUs: 1 Live Restore Enabled: false
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: false
Username: gordontheturtle
Registry: https://index.docker.io/v1/
Insecure registries:
myinsecurehost:5000
127.0.0.0/8
You can also specify the output format: You can also specify the output format:
$ docker info --format '{{json .}}' $ docker info --format '{{json .}}'
{"ID":"I54V:OLXT:HVMM:TPKO:JPHQ:CQCD:JNLC:O3BZ:4ZVJ:43XJ:PFHZ:6N2S","Containers":14, ...} {"ID":"I54V:OLXT:HVMM:TPKO:JPHQ:CQCD:JNLC:O3BZ:4ZVJ:43XJ:PFHZ:6N2S","Containers":14, ...}