Use consistent formatting and sorted keys in all JSON examples for dockerd reference

To create this, I ran every JSON document through `jq -S` (which sorts the keys and consistently pretty-prints the result in a format which matches the majority of documents in this file).

Signed-off-by: Tianon Gravi <admwiggin@gmail.com>
This commit is contained in:
Tianon Gravi 2020-11-06 11:52:06 -08:00
parent d5f1c8ebd6
commit 184e5feb72
1 changed files with 105 additions and 93 deletions

View File

@ -969,14 +969,14 @@ The following is an example adding 2 runtimes via the configuration:
{ {
"default-runtime": "runc", "default-runtime": "runc",
"runtimes": { "runtimes": {
"runc": {
"path": "runc"
},
"custom": { "custom": {
"path": "/usr/local/bin/my-runc-replacement", "path": "/usr/local/bin/my-runc-replacement",
"runtimeArgs": [ "runtimeArgs": [
"--debug" "--debug"
] ]
},
"runc": {
"path": "runc"
} }
} }
} }
@ -1303,7 +1303,10 @@ the task to run.
Example of usage: Example of usage:
```json ```json
{ {
"node-generic-resources": ["NVIDIA-GPU=UUID1", "NVIDIA-GPU=UUID2"] "node-generic-resources": [
"NVIDIA-GPU=UUID1",
"NVIDIA-GPU=UUID2"
]
} }
``` ```
@ -1332,9 +1335,39 @@ This is a full example of the allowed configuration options on Linux:
```json ```json
{ {
"allow-nondistributable-artifacts": [],
"api-cors-header": "",
"authorization-plugins": [], "authorization-plugins": [],
"bip": "",
"bridge": "",
"cgroup-parent": "",
"cluster-advertise": "",
"cluster-store": "",
"cluster-store-opts": {},
"data-root": "", "data-root": "",
"debug": true,
"default-address-pools": [
{
"base": "172.80.0.0/16",
"size": 24
},
{
"base": "172.90.0.0/16",
"size": 24
}
],
"default-cgroupns-mode": "private", "default-cgroupns-mode": "private",
"default-gateway": "",
"default-gateway-v6": "",
"default-runtime": "runc",
"default-shm-size": "64M",
"default-ulimits": {
"nofile": {
"Hard": 64000,
"Name": "nofile",
"Soft": 64000
}
},
"dns": [], "dns": [],
"dns-opts": [], "dns-opts": [],
"dns-search": [], "dns-search": [],
@ -1342,73 +1375,42 @@ This is a full example of the allowed configuration options on Linux:
"exec-root": "", "exec-root": "",
"experimental": false, "experimental": false,
"features": {}, "features": {},
"storage-driver": "", "fixed-cidr": "",
"storage-opts": [], "fixed-cidr-v6": "",
"group": "",
"hosts": [],
"icc": false,
"init": false,
"init-path": "/usr/libexec/docker-init",
"insecure-registries": [],
"ip": "0.0.0.0",
"ip-forward": false,
"ip-masq": false,
"iptables": false,
"ipv6": false,
"labels": [], "labels": [],
"live-restore": true, "live-restore": true,
"log-driver": "json-file", "log-driver": "json-file",
"log-level": "",
"log-opts": { "log-opts": {
"max-size": "10m", "env": "os,customer",
"max-file":"5",
"labels": "somelabel", "labels": "somelabel",
"env": "os,customer" "max-file": "5",
"max-size": "10m"
}, },
"mtu": 0,
"pidfile": "",
"cluster-store": "",
"cluster-store-opts": {},
"cluster-advertise": "",
"max-concurrent-downloads": 3, "max-concurrent-downloads": 3,
"max-concurrent-uploads": 5, "max-concurrent-uploads": 5,
"max-download-attempts": 5, "max-download-attempts": 5,
"default-shm-size": "64M", "mtu": 0,
"shutdown-timeout": 15,
"debug": true,
"hosts": [],
"log-level": "",
"tls": true,
"tlsverify": true,
"tlscacert": "",
"tlscert": "",
"tlskey": "",
"swarm-default-advertise-addr": "",
"api-cors-header": "",
"selinux-enabled": false,
"userns-remap": "",
"group": "",
"cgroup-parent": "",
"default-ulimits": {
"nofile": {
"Name": "nofile",
"Hard": 64000,
"Soft": 64000
}
},
"init": false,
"init-path": "/usr/libexec/docker-init",
"ipv6": false,
"iptables": false,
"ip-forward": false,
"ip-masq": false,
"userland-proxy": false,
"userland-proxy-path": "/usr/libexec/docker-proxy",
"ip": "0.0.0.0",
"bridge": "",
"bip": "",
"fixed-cidr": "",
"fixed-cidr-v6": "",
"default-gateway": "",
"default-gateway-v6": "",
"icc": false,
"raw-logs": false,
"allow-nondistributable-artifacts": [],
"registry-mirrors": [],
"seccomp-profile": "",
"insecure-registries": [],
"no-new-privileges": false, "no-new-privileges": false,
"default-runtime": "runc", "node-generic-resources": [
"NVIDIA-GPU=UUID1",
"NVIDIA-GPU=UUID2"
],
"oom-score-adjust": -500, "oom-score-adjust": -500,
"node-generic-resources": ["NVIDIA-GPU=UUID1", "NVIDIA-GPU=UUID2"], "pidfile": "",
"raw-logs": false,
"registry-mirrors": [],
"runtimes": { "runtimes": {
"cc-runtime": { "cc-runtime": {
"path": "/usr/bin/cc-runtime" "path": "/usr/bin/cc-runtime"
@ -1420,10 +1422,20 @@ This is a full example of the allowed configuration options on Linux:
] ]
} }
}, },
"default-address-pools":[ "seccomp-profile": "",
{"base":"172.80.0.0/16","size":24}, "selinux-enabled": false,
{"base":"172.90.0.0/16","size":24} "shutdown-timeout": 15,
] "storage-driver": "",
"storage-opts": [],
"swarm-default-advertise-addr": "",
"tls": true,
"tlscacert": "",
"tlscert": "",
"tlskey": "",
"tlsverify": true,
"userland-proxy": false,
"userland-proxy-path": "/usr/libexec/docker-proxy",
"userns-remap": ""
} }
``` ```
@ -1446,42 +1458,42 @@ This is a full example of the allowed configuration options on Windows:
```json ```json
{ {
"allow-nondistributable-artifacts": [],
"authorization-plugins": [], "authorization-plugins": [],
"bridge": "",
"cluster-advertise": "",
"cluster-store": "",
"data-root": "", "data-root": "",
"debug": true,
"default-ulimits": {},
"dns": [], "dns": [],
"dns-opts": [], "dns-opts": [],
"dns-search": [], "dns-search": [],
"exec-opts": [], "exec-opts": [],
"experimental": false, "experimental": false,
"features":{}, "features": {},
"storage-driver": "", "fixed-cidr": "",
"storage-opts": [], "group": "",
"hosts": [],
"insecure-registries": [],
"labels": [], "labels": [],
"log-driver": "", "log-driver": "",
"mtu": 0, "log-level": "",
"pidfile": "",
"cluster-store": "",
"cluster-advertise": "",
"max-concurrent-downloads": 3, "max-concurrent-downloads": 3,
"max-concurrent-uploads": 5, "max-concurrent-uploads": 5,
"max-download-attempts": 5, "max-download-attempts": 5,
"mtu": 0,
"pidfile": "",
"raw-logs": false,
"registry-mirrors": [],
"shutdown-timeout": 15, "shutdown-timeout": 15,
"debug": true, "storage-driver": "",
"hosts": [], "storage-opts": [],
"log-level": "", "swarm-default-advertise-addr": "",
"tlsverify": true,
"tlscacert": "", "tlscacert": "",
"tlscert": "", "tlscert": "",
"tlskey": "", "tlskey": "",
"swarm-default-advertise-addr": "", "tlsverify": true
"group": "",
"default-ulimits": {},
"bridge": "",
"fixed-cidr": "",
"raw-logs": false,
"allow-nondistributable-artifacts": [],
"registry-mirrors": [],
"insecure-registries": []
} }
``` ```