Browse code

Update docs to use the new `docker daemon` command

Signed-off-by: Tibor Vass <tibor@docker.com>

Tibor Vass authored on 2015/07/23 04:37:17
Showing 14 changed files
... ...
@@ -103,7 +103,7 @@ when no `-H` was passed in.
103 103
 
104 104
 Run Docker in daemon mode:
105 105
 
106
-    $ sudo <path to>/docker -H 0.0.0.0:5555 -d &
106
+    $ sudo <path to>/docker daemon -H 0.0.0.0:5555 &
107 107
 
108 108
 Download an `ubuntu` image:
109 109
 
... ...
@@ -113,7 +113,7 @@ You can use multiple `-H`, for example, if you want to listen on both
113 113
 TCP and a Unix socket
114 114
 
115 115
     # Run docker in daemon mode
116
-    $ sudo <path to>/docker -H tcp://127.0.0.1:2375 -H unix:///var/run/docker.sock -d &
116
+    $ sudo <path to>/docker daemon -H tcp://127.0.0.1:2375 -H unix:///var/run/docker.sock &
117 117
     # Download an ubuntu image, use default Unix socket
118 118
     $ docker pull ubuntu
119 119
     # OR use the TCP port
... ...
@@ -24,7 +24,7 @@ or `systemd` to manage the `docker` daemon's start and stop.
24 24
 The `docker` daemon can be run directly using the `-d` option. By default it listens on
25 25
 the Unix socket `unix:///var/run/docker.sock`
26 26
 
27
-    $ docker -d
27
+    $ docker daemon
28 28
 
29 29
     INFO[0000] +job init_networkdriver()
30 30
     INFO[0000] +job serveapi(unix:///var/run/docker.sock)
... ...
@@ -34,10 +34,9 @@ the Unix socket `unix:///var/run/docker.sock`
34 34
 
35 35
 ### Configuring the docker daemon directly
36 36
 
37
-If you're running the `docker` daemon directly by running `docker -d` instead
37
+If you're running the `docker` daemon directly by running `docker daemon` instead
38 38
 of using a process manager, you can append the configuration options to the `docker` run
39
-command directly. Just like the `-d` option, other options can be passed to the `docker`
40
-daemon to configure it.
39
+command directly. Other options can be passed to the `docker` daemon to configure it.
41 40
 
42 41
 Some of the daemon's options are:
43 42
 
... ...
@@ -50,7 +49,7 @@ Some of the daemon's options are:
50 50
 
51 51
 Here is a an example of running the `docker` daemon with configuration options:
52 52
 
53
-    $ docker -d -D --tls=true --tlscert=/var/docker/server.pem --tlskey=/var/docker/serverkey.pem -H tcp://192.168.59.3:2376
53
+    $ docker daemon -D --tls=true --tlscert=/var/docker/server.pem --tlskey=/var/docker/serverkey.pem -H tcp://192.168.59.3:2376
54 54
 
55 55
 These options :
56 56
 
... ...
@@ -136,7 +136,7 @@ prevent accidental damage:
136 136
 Now you can make the Docker daemon only accept connections from clients
137 137
 providing a certificate trusted by our CA:
138 138
 
139
-    $ docker -d --tlsverify --tlscacert=ca.pem --tlscert=server-cert.pem --tlskey=server-key.pem \
139
+    $ docker daemon --tlsverify --tlscacert=ca.pem --tlscert=server-cert.pem --tlskey=server-key.pem \
140 140
       -H=0.0.0.0:2376
141 141
 
142 142
 To be able to connect to Docker and validate its certificate, you now
... ...
@@ -503,7 +503,7 @@ To assign globally routable IPv6 addresses to your containers you have to
503 503
 specify an IPv6 subnet to pick the addresses from. Set the IPv6 subnet via the
504 504
 `--fixed-cidr-v6` parameter when starting Docker daemon:
505 505
 
506
-    docker -d --ipv6 --fixed-cidr-v6="2001:db8:1::/64"
506
+    docker daemon --ipv6 --fixed-cidr-v6="2001:db8:1::/64"
507 507
 
508 508
 The subnet for Docker containers should at least have a size of `/80`. This way
509 509
 an IPv6 address can end with the container's MAC address and you prevent NDP
... ...
@@ -589,7 +589,7 @@ Let's split up the configurable address range into two subnets
589 589
 `2001:db8::c000/125` and `2001:db8::c008/125`. The first one can be used by the
590 590
 host itself, the latter by Docker:
591 591
 
592
-    docker -d --ipv6 --fixed-cidr-v6 2001:db8::c008/125
592
+    docker daemon --ipv6 --fixed-cidr-v6 2001:db8::c008/125
593 593
 
594 594
 You notice the Docker subnet is within the subnet managed by your router that
595 595
 is connected to `eth0`. This means all devices (containers) with the addresses
... ...
@@ -36,11 +36,11 @@ There are two steps to set up and use a local registry mirror.
36 36
 You will need to pass the `--registry-mirror` option to your Docker daemon on
37 37
 startup:
38 38
 
39
-    docker --registry-mirror=http://<my-docker-mirror-host> -d
39
+    docker daemon --registry-mirror=http://<my-docker-mirror-host>
40 40
 
41 41
 For example, if your mirror is serving on `http://10.0.0.2:5000`, you would run:
42 42
 
43
-    docker --registry-mirror=http://10.0.0.2:5000 -d
43
+    docker daemon --registry-mirror=http://10.0.0.2:5000
44 44
 
45 45
 **NOTE:**
46 46
 Depending on your local host setup, you may be able to add the
... ...
@@ -70,7 +70,7 @@ In this example, we'll assume that your `docker.service` file looks something li
70 70
     [Service]
71 71
     Type=notify
72 72
     EnvironmentFile=-/etc/sysconfig/docker
73
-    ExecStart=/usr/bin/docker -d -H fd:// $OPTIONS
73
+    ExecStart=/usr/bin/docker daemon -H fd:// $OPTIONS
74 74
     LimitNOFILE=1048576
75 75
     LimitNPROC=1048576
76 76
 
... ...
@@ -174,7 +174,7 @@ For example:
174 174
 ## Run the Docker daemon
175 175
 
176 176
     # start the docker in daemon mode from the directory you unpacked
177
-    $ sudo ./docker -d &
177
+    $ sudo ./docker daemon &
178 178
 
179 179
 ## Giving non-root access
180 180
 
... ...
@@ -185,7 +185,7 @@ To create the `docker` group and add your user:
185 185
 
186 186
 	If this fails with a message similar to this:
187 187
 
188
-		Cannot connect to the Docker daemon. Is 'docker -d' running on this host?
188
+		Cannot connect to the Docker daemon. Is 'docker daemon' running on this host?
189 189
 
190 190
 	Check that the `DOCKER_HOST` environment variable is not set for your shell.
191 191
 	If it is, unset it.
... ...
@@ -285,7 +285,7 @@ with the `make.sh` script.
285 285
 
286 286
 8. Start a `docker` daemon running inside your container.
287 287
 
288
-        root@5f8630b873fe:/go/src/github.com/docker/docker#  docker -dD
288
+        root@5f8630b873fe:/go/src/github.com/docker/docker#  docker daemon -D
289 289
 
290 290
     The `-dD` flag starts the daemon in debug mode. You'll find this useful
291 291
     when debugging your code.
... ...
@@ -411,7 +411,7 @@ onto the `/go` directory inside the container.
411 411
 
412 412
     * copy the binary inside the development container using
413 413
       `cp bundles/1.5.0-dev/binary/docker /usr/bin`
414
-    * start `docker -dD` to launch the Docker daemon inside the container
414
+    * start `docker daemon -D` to launch the Docker daemon inside the container
415 415
     * run `docker ps` on local host to get the development container's name
416 416
     * connect to your running container `docker exec -it container_name bash`
417 417
     * use the `docker run hello-world` command to create and run a container 
... ...
@@ -120,7 +120,7 @@ Run the entire test suite on your current repository:
120 120
         PASS
121 121
         coverage: 70.8% of statements
122 122
         ---> Making bundle: test-docker-py (in bundles/1.5.0-dev/test-docker-py)
123
-        +++ exec docker --daemon --debug --host unix:///go/src/github.com/docker/docker/bundles/1.5.0-dev/test-docker-py/docker.sock --storage-driver vfs --exec-driver native --pidfile /go/src/github.com/docker/docker/bundles/1.5.0-dev/test-docker-py/docker.pid
123
+        +++ exec docker daemon --debug --host unix:///go/src/github.com/docker/docker/bundles/1.5.0-dev/test-docker-py/docker.sock --storage-driver vfs --exec-driver native --pidfile /go/src/github.com/docker/docker/bundles/1.5.0-dev/test-docker-py/docker.pid
124 124
         .................................................................
125 125
         ----------------------------------------------------------------------
126 126
         Ran 65 tests in 89.266s
... ...
@@ -2269,4 +2269,4 @@ To set cross origin requests to the remote api please give values to
2269 2269
 `--api-cors-header` when running Docker in daemon mode. Set * (asterisk) allows all,
2270 2270
 default or blank means CORS disabled
2271 2271
 
2272
-    $ docker -d -H="192.168.1.9:2375" --api-cors-header="http://foo.bar"
2272
+    $ docker daemon -H="192.168.1.9:2375" --api-cors-header="http://foo.bar"
... ...
@@ -19,6 +19,9 @@ or execute `docker help`:
19 19
 
20 20
     $ docker
21 21
       Usage: docker [OPTIONS] COMMAND [arg...]
22
+             docker daemon [ --help | ... ]
23
+             docker [ -h | --help | -v | --version ]
24
+
22 25
         -H, --host=[]: The socket(s) to bind to in daemon mode, specified using one or more tcp://host:port, unix:///path/to/socket, fd://* or fd://socketfd.
23 26
 
24 27
       A self-sufficient runtime for Linux containers.
... ...
@@ -10,7 +10,7 @@ parent = "smn_cli"
10 10
 
11 11
 # daemon
12 12
 
13
-    Usage: docker [OPTIONS] COMMAND [arg...]
13
+    Usage: docker daemon [OPTIONS]
14 14
 
15 15
     A self-sufficient runtime for linux containers.
16 16
 
... ...
@@ -18,9 +18,7 @@ parent = "smn_cli"
18 18
       --api-cors-header=""                   Set CORS headers in the remote API
19 19
       -b, --bridge=""                        Attach containers to a network bridge
20 20
       --bip=""                               Specify network bridge IP
21
-      --config=~/.docker                     Location of client config files
22 21
       -D, --debug=false                      Enable debug mode
23
-      -d, --daemon=false                     Enable daemon mode
24 22
       --default-gateway=""                   Container default gateway IPv4 address
25 23
       --default-gateway-v6=""                Container default gateway IPv6 address
26 24
       --dns=[]                               DNS server to use
... ...
@@ -58,15 +56,14 @@ parent = "smn_cli"
58 58
       --tlskey="~/.docker/key.pem"           Path to TLS key file
59 59
       --tlsverify=false                      Use TLS and verify the remote
60 60
       --userland-proxy=true                  Use userland proxy for loopback traffic
61
-      -v, --version=false                    Print version information and quit
62 61
 
63 62
 Options with [] may be specified multiple times.
64 63
 
65 64
 The Docker daemon is the persistent process that manages containers. Docker
66 65
 uses the same binary for both the daemon and client. To run the daemon you
67
-provide the `-d` flag.
66
+type `docker daemon`.
68 67
 
69
-To run the daemon with debug output, use `docker -d -D`.
68
+To run the daemon with debug output, use `docker daemon -D`.
70 69
 
71 70
 ## Daemon socket option
72 71
 
... ...
@@ -94,8 +91,8 @@ communication with the daemon.
94 94
 
95 95
 On Systemd based systems, you can communicate with the daemon via
96 96
 [Systemd socket activation](http://0pointer.de/blog/projects/socket-activation.html),
97
-use `docker -d -H fd://`. Using `fd://` will work perfectly for most setups but
98
-you can also specify individual sockets: `docker -d -H fd://3`. If the
97
+use `docker daemon -H fd://`. Using `fd://` will work perfectly for most setups but
98
+you can also specify individual sockets: `docker daemon -H fd://3`. If the
99 99
 specified socket activated files aren't found, then Docker will exit. You can
100 100
 find examples of using Systemd socket activation with Docker and Systemd in the
101 101
 [Docker source tree](https://github.com/docker/docker/tree/master/contrib/init/systemd/).
... ...
@@ -104,7 +101,7 @@ You can configure the Docker daemon to listen to multiple sockets at the same
104 104
 time using multiple `-H` options:
105 105
 
106 106
     # listen using the default unix socket, and on 2 specific IP addresses on this host.
107
-    docker -d -H unix:///var/run/docker.sock -H tcp://192.168.59.106 -H tcp://10.10.10.2
107
+    docker daemon -H unix:///var/run/docker.sock -H tcp://192.168.59.106 -H tcp://10.10.10.2
108 108
 
109 109
 The Docker client will honor the `DOCKER_HOST` environment variable to set the
110 110
 `-H` flag for the client.
... ...
@@ -152,16 +149,16 @@ article explains how to tune your existing setup without the use of options.
152 152
 
153 153
 The `btrfs` driver is very fast for `docker build` - but like `devicemapper`
154 154
 does not share executable memory between devices. Use
155
-`docker -d -s btrfs -g /mnt/btrfs_partition`.
155
+`docker daemon -s btrfs -g /mnt/btrfs_partition`.
156 156
 
157 157
 The `zfs` driver is probably not fast as `btrfs` but has a longer track record
158 158
 on stability. Thanks to `Single Copy ARC` shared blocks between clones will be
159
-cached only once. Use `docker -d -s zfs`. To select a different zfs filesystem
159
+cached only once. Use `docker daemon -s zfs`. To select a different zfs filesystem
160 160
 set `zfs.fsname` option as described in [Storage driver options](#storage-driver-options).
161 161
 
162 162
 The `overlay` is a very fast union filesystem. It is now merged in the main
163 163
 Linux kernel as of [3.18.0](https://lkml.org/lkml/2014/10/26/137). Call
164
-`docker -d -s overlay` to use it.
164
+`docker daemon -s overlay` to use it.
165 165
 
166 166
 > **Note:**
167 167
 > As promising as `overlay` is, the feature is still quite young and should not
... ...
@@ -196,7 +193,7 @@ options for `zfs` start with `zfs`.
196 196
 
197 197
      Example use:
198 198
 
199
-        docker -d --storage-opt dm.thinpooldev=/dev/mapper/thin-pool
199
+        docker daemon --storage-opt dm.thinpooldev=/dev/mapper/thin-pool
200 200
 
201 201
  *  `dm.basesize`
202 202
 
... ...
@@ -216,7 +213,7 @@ options for `zfs` start with `zfs`.
216 216
 
217 217
     Example use:
218 218
 
219
-        $ docker -d --storage-opt dm.basesize=20G
219
+        $ docker daemon --storage-opt dm.basesize=20G
220 220
 
221 221
  *  `dm.loopdatasize`
222 222
 
... ...
@@ -229,7 +226,7 @@ options for `zfs` start with `zfs`.
229 229
 
230 230
     Example use:
231 231
 
232
-        $ docker -d --storage-opt dm.loopdatasize=200G
232
+        $ docker daemon --storage-opt dm.loopdatasize=200G
233 233
 
234 234
  *  `dm.loopmetadatasize`
235 235
 
... ...
@@ -242,7 +239,7 @@ options for `zfs` start with `zfs`.
242 242
 
243 243
     Example use:
244 244
 
245
-        $ docker -d --storage-opt dm.loopmetadatasize=4G
245
+        $ docker daemon --storage-opt dm.loopmetadatasize=4G
246 246
 
247 247
  *  `dm.fs`
248 248
 
... ...
@@ -251,7 +248,7 @@ options for `zfs` start with `zfs`.
251 251
 
252 252
     Example use:
253 253
 
254
-        $ docker -d --storage-opt dm.fs=xfs
254
+        $ docker daemon --storage-opt dm.fs=xfs
255 255
 
256 256
  *  `dm.mkfsarg`
257 257
 
... ...
@@ -259,7 +256,7 @@ options for `zfs` start with `zfs`.
259 259
 
260 260
     Example use:
261 261
 
262
-        $ docker -d --storage-opt "dm.mkfsarg=-O ^has_journal"
262
+        $ docker daemon --storage-opt "dm.mkfsarg=-O ^has_journal"
263 263
 
264 264
  *  `dm.mountopt`
265 265
 
... ...
@@ -267,7 +264,7 @@ options for `zfs` start with `zfs`.
267 267
 
268 268
     Example use:
269 269
 
270
-        $ docker -d --storage-opt dm.mountopt=nodiscard
270
+        $ docker daemon --storage-opt dm.mountopt=nodiscard
271 271
 
272 272
  *  `dm.datadev`
273 273
 
... ...
@@ -281,7 +278,7 @@ options for `zfs` start with `zfs`.
281 281
 
282 282
     Example use:
283 283
 
284
-        $ docker -d --storage-opt dm.datadev=/dev/sdb1 --storage-opt dm.metadatadev=/dev/sdc1
284
+        $ docker daemon --storage-opt dm.datadev=/dev/sdb1 --storage-opt dm.metadatadev=/dev/sdc1
285 285
 
286 286
  *  `dm.metadatadev`
287 287
 
... ...
@@ -299,7 +296,7 @@ options for `zfs` start with `zfs`.
299 299
 
300 300
     Example use:
301 301
 
302
-        $ docker -d --storage-opt dm.datadev=/dev/sdb1 --storage-opt dm.metadatadev=/dev/sdc1
302
+        $ docker daemon --storage-opt dm.datadev=/dev/sdb1 --storage-opt dm.metadatadev=/dev/sdc1
303 303
 
304 304
  *  `dm.blocksize`
305 305
 
... ...
@@ -308,7 +305,7 @@ options for `zfs` start with `zfs`.
308 308
 
309 309
     Example use:
310 310
 
311
-        $ docker -d --storage-opt dm.blocksize=512K
311
+        $ docker daemon --storage-opt dm.blocksize=512K
312 312
 
313 313
  *  `dm.blkdiscard`
314 314
 
... ...
@@ -322,7 +319,7 @@ options for `zfs` start with `zfs`.
322 322
 
323 323
     Example use:
324 324
 
325
-        $ docker -d --storage-opt dm.blkdiscard=false
325
+        $ docker daemon --storage-opt dm.blkdiscard=false
326 326
 
327 327
  *  `dm.override_udev_sync_check`
328 328
 
... ...
@@ -348,7 +345,7 @@ options for `zfs` start with `zfs`.
348 348
     To allow the `docker` daemon to start, regardless of `udev` sync not being
349 349
     supported, set `dm.override_udev_sync_check` to true:
350 350
 
351
-        $ docker -d --storage-opt dm.override_udev_sync_check=true
351
+        $ docker daemon --storage-opt dm.override_udev_sync_check=true
352 352
 
353 353
     When this value is `true`, the  `devicemapper` continues and simply warns
354 354
     you the errors are happening.
... ...
@@ -373,7 +370,7 @@ Currently supported options of `zfs`:
373 373
 
374 374
     Example use:
375 375
 
376
-        $ docker -d -s zfs --storage-opt zfs.fsname=zroot/docker
376
+        $ docker daemon -s zfs --storage-opt zfs.fsname=zroot/docker
377 377
 
378 378
 ## Docker execdriver option
379 379
 
... ...
@@ -397,17 +394,17 @@ it is not available, the system uses `cgroupfs`. By default, if no option is
397 397
 specified, the execdriver first tries `systemd` and falls back to `cgroupfs`.
398 398
 This example sets the execdriver to `cgroupfs`:
399 399
 
400
-    $ sudo docker -d --exec-opt native.cgroupdriver=cgroupfs
400
+    $ sudo docker daemon --exec-opt native.cgroupdriver=cgroupfs
401 401
 
402 402
 Setting this option applies to all containers the daemon launches.
403 403
 
404 404
 ## Daemon DNS options
405 405
 
406 406
 To set the DNS server for all Docker containers, use
407
-`docker -d --dns 8.8.8.8`.
407
+`docker daemon --dns 8.8.8.8`.
408 408
 
409 409
 To set the DNS search domain for all Docker containers, use
410
-`docker -d --dns-search example.com`.
410
+`docker daemon --dns-search example.com`.
411 411
 
412 412
 ## Insecure registries
413 413
 
... ...
@@ -456,7 +453,7 @@ need to be added to your Docker host's configuration:
456 456
 1. Install the `ca-certificates` package for your distribution
457 457
 2. Ask your network admin for the proxy's CA certificate and append them to
458 458
    `/etc/pki/tls/certs/ca-bundle.crt`
459
-3. Then start your Docker daemon with `HTTPS_PROXY=http://username:password@proxy:port/ docker -d`.
459
+3. Then start your Docker daemon with `HTTPS_PROXY=http://username:password@proxy:port/ docker daemon`.
460 460
    The `username:` and `password@` are optional - and are only needed if your
461 461
    proxy is set up to require authentication.
462 462
 
... ...
@@ -486,9 +483,9 @@ Docker supports softlinks for the Docker data directory (`/var/lib/docker`) and
486 486
 for `/var/lib/docker/tmp`. The `DOCKER_TMPDIR` and the data directory can be
487 487
 set like this:
488 488
 
489
-    DOCKER_TMPDIR=/mnt/disk2/tmp /usr/local/bin/docker -d -D -g /var/lib/docker -H unix:// > /var/lib/boot2docker/docker.log 2>&1
489
+    DOCKER_TMPDIR=/mnt/disk2/tmp /usr/local/bin/docker daemon -D -g /var/lib/docker -H unix:// > /var/lib/boot2docker/docker.log 2>&1
490 490
     # or
491 491
     export DOCKER_TMPDIR=/mnt/disk2/tmp
492
-    /usr/local/bin/docker -d -D -g /var/lib/docker -H unix:// > /var/lib/boot2docker/docker.log 2>&1
492
+    /usr/local/bin/docker daemon -D -g /var/lib/docker -H unix:// > /var/lib/boot2docker/docker.log 2>&1
493 493
 
494 494
 
... ...
@@ -164,7 +164,7 @@ List all images with `vendor` `ACME`:
164 164
 ## Daemon labels
165 165
 
166 166
 
167
-    docker -d \
167
+    docker daemon \
168 168
       --dns 8.8.8.8 \
169 169
       --dns 8.8.4.4 \
170 170
       -H unix:///var/run/docker.sock \