1. docker
  2. Commit 9fd27bf1a9a443de5f9f263d63af0ffbc2265dcb
Browse code

Update docs for experimental features

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

Misty Stanley-Jones authored on 2017/02/15 09:07:50
Showing 2 changed files
docs/reference/commandline/dockerd.md
History View file @ 9fd27bf
... ... 
@@ -17,33 +17,34 @@ keywords: "container, daemon, runtime"
17 17 
 # daemon
18 18
19 19 
 ```markdown
20 
-Usage: dockerd [OPTIONS]
20 
+Usage:	dockerd COMMAND
21 21
22 22 
 A self-sufficient runtime for containers.
23 23
24 24 
 Options:
25 
-      --add-runtime value                     Register an additional OCI compatible runtime (default [])
25 
+      --add-runtime runtime                   Register an additional OCI compatible runtime (default [])
26 26 
       --api-cors-header string                Set CORS headers in the Engine API
27 
-      --authorization-plugin value            Authorization plugins to load (default [])
27 
+      --authorization-plugin list             Authorization plugins to load (default [])
28 28 
       --bip string                            Specify network bridge IP
29 29 
   -b, --bridge string                         Attach containers to a network bridge
30 30 
       --cgroup-parent string                  Set parent cgroup for all containers
31 31 
       --cluster-advertise string              Address or interface name to advertise
32 32 
       --cluster-store string                  URL of the distributed storage backend
33 
-      --cluster-store-opt value               Set cluster store options (default map[])
33 
+      --cluster-store-opt map                 Set cluster store options (default map[])
34 34 
       --config-file string                    Daemon configuration file (default "/etc/docker/daemon.json")
35 35 
       --containerd string                     Path to containerd socket
36 
+      --cpu-rt-period int                     Limit the CPU real-time period in microseconds
37 
+      --cpu-rt-runtime int                    Limit the CPU real-time runtime in microseconds
36 38 
   -D, --debug                                 Enable debug mode
37 
-      --default-gateway value                 Container default gateway IPv4 address
38 
-      --default-gateway-v6 value              Container default gateway IPv6 address
39 
+      --default-gateway ip                    Container default gateway IPv4 address
40 
+      --default-gateway-v6 ip                 Container default gateway IPv6 address
39 41 
       --default-runtime string                Default OCI runtime for containers (default "runc")
40 
-      --default-shm-size bytes                Set the default shm size for containers (default 64 MiB)
41 
-      --default-ulimit value                  Default ulimits for containers (default [])
42 
+      --default-ulimit ulimit                 Default ulimits for containers (default [])
42 43 
       --disable-legacy-registry               Disable contacting legacy registries
43 
-      --dns value                             DNS server to use (default [])
44 
-      --dns-opt value                         DNS options to use (default [])
45 
-      --dns-search value                      DNS search domains to use (default [])
46 
-      --exec-opt value                        Runtime execution options (default [])
44 
+      --dns list                              DNS server to use (default [])
45 
+      --dns-opt list                          DNS options to use (default [])
46 
+      --dns-search list                       DNS search domains to use (default [])
47 
+      --exec-opt list                         Runtime execution options (default [])
47 48 
       --exec-root string                      Root directory for execution state files (default "/var/run/docker")
48 49 
       --experimental                          Enable experimental features
49 50 
       --fixed-cidr string                     IPv4 subnet for fixed IPs
... ... 
@@ -51,39 +52,39 @@ Options:
51 51 
   -g, --graph string                          Root of the Docker runtime (default "/var/lib/docker")
52 52 
   -G, --group string                          Group for the unix socket (default "docker")
53 53 
       --help                                  Print usage
54 
-  -H, --host value                            Daemon socket(s) to connect to (default [])
54 
+  -H, --host list                             Daemon socket(s) to connect to (default [])
55 55 
       --icc                                   Enable inter-container communication (default true)
56 56 
       --init                                  Run an init in the container to forward signals and reap processes
57 57 
       --init-path string                      Path to the docker-init binary
58 
-      --insecure-registry value               Enable insecure registry communication (default [])
59 
-      --ip value                              Default IP when binding container ports (default 0.0.0.0)
58 
+      --insecure-registry list                Enable insecure registry communication (default [])
59 
+      --ip ip                                 Default IP when binding container ports (default 0.0.0.0)
60 60 
       --ip-forward                            Enable net.ipv4.ip_forward (default true)
61 61 
       --ip-masq                               Enable IP masquerading (default true)
62 62 
       --iptables                              Enable addition of iptables rules (default true)
63 63 
       --ipv6                                  Enable IPv6 networking
64 
-      --label value                           Set key=value labels to the daemon (default [])
65 
-      --live-restore                          Enable live restore of docker when containers are still running (Linux only)
64 
+      --label list                            Set key=value labels to the daemon (default [])
65 
+      --live-restore                          Enable live restore of docker when containers are still running
66 66 
       --log-driver string                     Default driver for container logs (default "json-file")
67 
-  -l, --log-level string                      Set the logging level ("debug"|"info"|"warn"|"error"|"fatal") (default "info")
68 
-      --log-opt value                         Default log driver options for containers (default map[])
67 
+  -l, --log-level string                      Set the logging level ("debug", "info", "warn", "error", "fatal") (default "info")
68 
+      --log-opt map                           Default log driver options for containers (default map[])
69 69 
       --max-concurrent-downloads int          Set the max concurrent downloads for each pull (default 3)
70 70 
       --max-concurrent-uploads int            Set the max concurrent uploads for each push (default 5)
71 
-      --metrics-addr string                   Set address and port to serve the metrics api (default "")
71 
+      --metrics-addr string                   Set default address and port to serve the metrics api on
72 72 
       --mtu int                               Set the containers network MTU
73 73 
       --oom-score-adjust int                  Set the oom_score_adj for the daemon (default -500)
74 74 
   -p, --pidfile string                        Path to use for daemon PID file (default "/var/run/docker.pid")
75 75 
       --raw-logs                              Full timestamps without ANSI coloring
76 
-      --registry-mirror value                 Preferred Docker registry mirror (default [])
77 
-      --seccomp-profile value                 Path to seccomp profile
76 
+      --registry-mirror list                  Preferred Docker registry mirror (default [])
77 
+      --seccomp-profile string                Path to seccomp profile
78 78 
       --selinux-enabled                       Enable selinux support
79 
-      --shutdown-timeout=15                   Set the shutdown timeout value in seconds
79 
+      --shutdown-timeout int                  Set the default shutdown timeout (default 15)
80 80 
   -s, --storage-driver string                 Storage driver to use
81 
-      --storage-opt value                     Storage driver options (default [])
81 
+      --storage-opt list                      Storage driver options (default [])
82 82 
       --swarm-default-advertise-addr string   Set default address or interface for swarm advertised address
83 83 
       --tls                                   Use TLS; implied by --tlsverify
84 
-      --tlscacert string                      Trust certs signed only by this CA (default "/root/.docker/ca.pem")
85 
-      --tlscert string                        Path to TLS certificate file (default "/root/.docker/cert.pem")
86 
-      --tlskey string                         Path to TLS key file (default "/root/.docker/key.pem")
84 
+      --tlscacert string                      Trust certs signed only by this CA (default "~/.docker/ca.pem")
85 
+      --tlscert string                        Path to TLS certificate file (default "~/.docker/cert.pem")
86 
+      --tlskey string                         Path to TLS key file (default ~/.docker/key.pem")
87 87 
       --tlsverify                             Use TLS and verify the remote
88 88 
       --userland-proxy                        Use userland proxy for loopback traffic (default true)
89 89 
       --userland-proxy-path string            Path to the userland proxy binary
... ... 
@@ -99,7 +100,13 @@ Options with [] may be specified multiple times.
99 99 
 uses different binaries for the daemon and client. To run the daemon you
100 100 
 type `dockerd`.
101 101
102 
-To run the daemon with debug output, use `dockerd -D`.
102 
+To run the daemon with debug output, use `dockerd -D` or add `debug: true` to
103 
+the `daemon.json` file.
104 
+
105 
+> **Note**: In Docker 1.13 and higher, enable experimental features by starting
106 
+> `dockerd` with the `--experimental` flag or adding `experimental: true` to the
107 
+> `daemon.json` file. In earlier Docker versions, a different build was required
108 
+> to enable experimental features.
103 109
104 110 
 ## Examples
105 111
experimental/README.md
History View file @ 9fd27bf
... ... 
@@ -13,9 +13,9 @@ please feel free to provide any feedback on these features you wish.
13 13
14 14 
 Experimental features are now included in the standard Docker binaries as of
15 15 
 version 1.13.0.
16 
-For enabling experimental features, you need to start the Docker daemon with
17 
-`--experimental` flag.
18 
-You can also enable the daemon flag via `/etc/docker/daemon.json`. e.g.
16 
+To enable experimental features, start the Docker daemon with the
17 
+`--experimental` flag or enable the daemon flag in the
18 
+`/etc/docker/daemon.json` configuration file:
19 19
20 20 
 ```json
21 21 
 {
... ... 
@@ -23,7 +23,8 @@ You can also enable the daemon flag via `/etc/docker/daemon.json`. e.g.
23 23 
 }
24 24 
 ```
25 25
26 
-Then make sure the experimental flag is enabled:
26 
+You can check to see if experimental features are enabled on a running daemon
27 
+using the following command:
27 28
28 29 
 ```bash
29 30 
 $ docker version -f '{{.Server.Experimental}}'
... ... 
@@ -32,9 +33,18 @@ true
32 32
33 33 
 ## Current experimental features
34 34
35 
+Docker service logs command to view logs for a Docker service. This is needed in Swarm mode.
36 
+Option to squash image layers to the base image after successful builds.
37 
+Checkpoint and restore support for Containers.
38 
+Metrics (Prometheus) output for basic container, image, and daemon operations.
39 
+
40 
+ * The top-level [docker deploy](../../docs/reference/deploy.md) command. The
41 
+   `docker stack deploy` command is **not** experimental.
42 
+ * [`docker service logs` command](../docs/reference/commandline/service_logs.md)
43 
+ * [`--squash` option to `docker build` command](../docs/reference/commandline/build.md##squash-an-images-layers---squash-experimental-only)
35 44 
  * [External graphdriver plugins](../docs/extend/plugins_graphdriver.md)
36 45 
  * [Ipvlan Network Drivers](vlan-networks.md)
37 
- * [Docker Stacks and Distributed Application Bundles](docker-stacks-and-bundles.md)
46 
+ * [Distributed Application Bundles](docker-stacks-and-bundles.md)
38 47 
  * [Checkpoint & Restore](checkpoint-restore.md)
39 48
40 49 
 ## How to comment on an experimental feature