Browse code

Add docs for `--exec-opt` and setting `native.cgroupdriver`.

update man pages.
update bash completion.

Docker-DCO-1.1-Signed-off-by: Jessica Frazelle <jess@docker.com> (github: jfrazelle)

Docker-DCO-1.1-Signed-off-by: Jessie Frazelle <jess@docker.com> (github: jfrazelle)

Jessica Frazelle authored on 2015/01/29 07:54:25
Showing 4 changed files
... ...
@@ -1151,6 +1151,7 @@ _docker() {
1151 1151
 		--dns
1152 1152
 		--dns-search
1153 1153
 		--exec-driver -e
1154
+		--exec-opt
1154 1155
 		--fixed-cidr
1155 1156
 		--fixed-cidr-v6
1156 1157
 		--graph -g
... ...
@@ -51,6 +51,7 @@ complete -c docker -f -n '__fish_docker_no_subcommand' -s d -l daemon -d 'Enable
51 51
 complete -c docker -f -n '__fish_docker_no_subcommand' -l dns -d 'Force Docker to use specific DNS servers'
52 52
 complete -c docker -f -n '__fish_docker_no_subcommand' -l dns-search -d 'Force Docker to use specific DNS search domains'
53 53
 complete -c docker -f -n '__fish_docker_no_subcommand' -s e -l exec-driver -d 'Force the Docker runtime to use a specific exec driver'
54
+complete -c docker -f -n '__fish_docker_no_subcommand' -l exec-opt -d 'Set exec driver options'
54 55
 complete -c docker -f -n '__fish_docker_no_subcommand' -l fixed-cidr -d 'IPv4 subnet for fixed IPs (e.g. 10.20.0.0/16)'
55 56
 complete -c docker -f -n '__fish_docker_no_subcommand' -l fixed-cidr-v6 -d 'IPv6 subnet for fixed IPs (e.g.: 2001:a02b/48)'
56 57
 complete -c docker -f -n '__fish_docker_no_subcommand' -s G -l group -d 'Group to assign the unix socket specified by -H when running in daemon mode'
... ...
@@ -124,6 +124,9 @@ unix://[/path/to/socket] to use.
124 124
 **-v**, **--version**=*true*|*false*
125 125
   Print version information and quit. Default is false.
126 126
 
127
+**--exec-opt**=[]
128
+  Set exec driver options. See EXEC DRIVER OPTIONS.
129
+
127 130
 **--selinux-enabled**=*true*|*false*
128 131
   Enable selinux support. Default is false. SELinux does not presently support the BTRFS storage driver.
129 132
 
... ...
@@ -319,6 +322,18 @@ for data and metadata:
319 319
       --storage-opt dm.metadatadev=/dev/vdc \
320 320
       --storage-opt dm.basesize=20G
321 321
 
322
+# EXEC DRIVER OPTIONS
323
+
324
+Options to the exec-driver can be specified with the **--exec-opt** flags. The
325
+only driver accepting options is the *native* (libcontainer) driver. Therefore
326
+use these flags with **-s=**native.
327
+
328
+The following is the only *native* option:
329
+
330
+#### native.cgroupdriver
331
+Specifies the management of the container's cgroups. As of now the only viable
332
+options are `cgroupfs` and `systemd`. The option will always fallback to `cgroupfs`.
333
+
322 334
 #### Client
323 335
 For specific client examples please see the man page for the specific Docker
324 336
 command. For example:
... ...
@@ -452,6 +452,27 @@ https://linuxcontainers.org/) via the `lxc` execution driver, however, this is
452 452
 not where the primary development of new functionality is taking place.
453 453
 Add `-e lxc` to the daemon flags to use the `lxc` execution driver.
454 454
 
455
+#### Exec driver options
456
+
457
+Particular exec-driver can be configured with options specified with
458
+`--exec-opt` flags. The only driver accepting options is `native`
459
+(libcontainer) as of now. All its options are prefixed with `native`.
460
+
461
+Currently supported options are:
462
+
463
+ *  `native.cgroupdriver`
464
+
465
+    Specifies the management of the container's cgroups. As of now the only
466
+    viable options are `cgroupfs` and `systemd`. The option will always
467
+    fallback to `cgroupfs`. By default, if no option is specified, the
468
+    execdriver will try `systemd` and fallback to `cgroupfs`. Same applies if
469
+    `systemd` is passed as the `cgroupdriver` but is not capable of being used.
470
+
471
+    Example use:
472
+
473
+        $ sudo docker -d --exec-opt native.cgroupdriver=cgroupfs
474
+
475
+
455 476
 
456 477
 ### Daemon DNS options
457 478