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

Update docs for experimental features 

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Misty Stanley-Jones 2017-02-14 16:07:50 -08:00 committed by Tibor Vass
parent 5840993e1c
commit 2e9e71f59a
2 changed files with 50 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
docs/reference/commandline/dockerd.md
View File

@ -17,33 +17,34 @@ keywords: "container, daemon, runtime"
# daemon # daemon
```markdown ```markdown
Usage: dockerd [OPTIONS] Usage: dockerd COMMAND
A self-sufficient runtime for containers. A self-sufficient runtime for containers.
Options: Options:
--add-runtime value Register an additional OCI compatible runtime (default []) --add-runtime runtime Register an additional OCI compatible runtime (default [])
--api-cors-header string Set CORS headers in the Engine API --api-cors-header string Set CORS headers in the Engine API
--authorization-plugin value Authorization plugins to load (default []) --authorization-plugin list Authorization plugins to load (default [])
--bip string Specify network bridge IP --bip string Specify network bridge IP
-b, --bridge string Attach containers to a network bridge -b, --bridge string Attach containers to a network bridge
--cgroup-parent string Set parent cgroup for all containers --cgroup-parent string Set parent cgroup for all containers
--cluster-advertise string Address or interface name to advertise --cluster-advertise string Address or interface name to advertise
--cluster-store string URL of the distributed storage backend --cluster-store string URL of the distributed storage backend
--cluster-store-opt value Set cluster store options (default map[]) --cluster-store-opt map Set cluster store options (default map[])
--config-file string Daemon configuration file (default "/etc/docker/daemon.json") --config-file string Daemon configuration file (default "/etc/docker/daemon.json")
--containerd string Path to containerd socket --containerd string Path to containerd socket
--cpu-rt-period int Limit the CPU real-time period in microseconds
--cpu-rt-runtime int Limit the CPU real-time runtime in microseconds
-D, --debug Enable debug mode -D, --debug Enable debug mode
--default-gateway value Container default gateway IPv4 address --default-gateway ip Container default gateway IPv4 address
--default-gateway-v6 value Container default gateway IPv6 address --default-gateway-v6 ip Container default gateway IPv6 address
--default-runtime string Default OCI runtime for containers (default "runc") --default-runtime string Default OCI runtime for containers (default "runc")
--default-shm-size bytes Set the default shm size for containers (default 64 MiB) --default-ulimit ulimit Default ulimits for containers (default [])
--default-ulimit value Default ulimits for containers (default [])
--disable-legacy-registry Disable contacting legacy registries --disable-legacy-registry Disable contacting legacy registries
--dns value DNS server to use (default []) --dns list DNS server to use (default [])
--dns-opt value DNS options to use (default []) --dns-opt list DNS options to use (default [])
--dns-search value DNS search domains to use (default []) --dns-search list DNS search domains to use (default [])
--exec-opt value Runtime execution options (default []) --exec-opt list Runtime execution options (default [])
--exec-root string Root directory for execution state files (default "/var/run/docker") --exec-root string Root directory for execution state files (default "/var/run/docker")
--experimental Enable experimental features --experimental Enable experimental features
--fixed-cidr string IPv4 subnet for fixed IPs --fixed-cidr string IPv4 subnet for fixed IPs
@ -51,39 +52,39 @@ Options:
-g, --graph string Root of the Docker runtime (default "/var/lib/docker") -g, --graph string Root of the Docker runtime (default "/var/lib/docker")
-G, --group string Group for the unix socket (default "docker") -G, --group string Group for the unix socket (default "docker")
--help Print usage --help Print usage
-H, --host value Daemon socket(s) to connect to (default []) -H, --host list Daemon socket(s) to connect to (default [])
--icc Enable inter-container communication (default true) --icc Enable inter-container communication (default true)
--init Run an init in the container to forward signals and reap processes --init Run an init in the container to forward signals and reap processes
--init-path string Path to the docker-init binary --init-path string Path to the docker-init binary
--insecure-registry value Enable insecure registry communication (default []) --insecure-registry list Enable insecure registry communication (default [])
--ip value Default IP when binding container ports (default 0.0.0.0) --ip ip Default IP when binding container ports (default 0.0.0.0)
--ip-forward Enable net.ipv4.ip_forward (default true) --ip-forward Enable net.ipv4.ip_forward (default true)
--ip-masq Enable IP masquerading (default true) --ip-masq Enable IP masquerading (default true)
--iptables Enable addition of iptables rules (default true) --iptables Enable addition of iptables rules (default true)
--ipv6 Enable IPv6 networking --ipv6 Enable IPv6 networking
--label value Set key=value labels to the daemon (default []) --label list Set key=value labels to the daemon (default [])
--live-restore Enable live restore of docker when containers are still running (Linux only) --live-restore Enable live restore of docker when containers are still running
--log-driver string Default driver for container logs (default "json-file") --log-driver string Default driver for container logs (default "json-file")
-l, --log-level string Set the logging level ("debug"|"info"|"warn"|"error"|"fatal") (default "info") -l, --log-level string Set the logging level ("debug", "info", "warn", "error", "fatal") (default "info")
--log-opt value Default log driver options for containers (default map[]) --log-opt map Default log driver options for containers (default map[])
--max-concurrent-downloads int Set the max concurrent downloads for each pull (default 3) --max-concurrent-downloads int Set the max concurrent downloads for each pull (default 3)
--max-concurrent-uploads int Set the max concurrent uploads for each push (default 5) --max-concurrent-uploads int Set the max concurrent uploads for each push (default 5)
--metrics-addr string Set address and port to serve the metrics api (default "") --metrics-addr string Set default address and port to serve the metrics api on
--mtu int Set the containers network MTU --mtu int Set the containers network MTU
--oom-score-adjust int Set the oom_score_adj for the daemon (default -500) --oom-score-adjust int Set the oom_score_adj for the daemon (default -500)
-p, --pidfile string Path to use for daemon PID file (default "/var/run/docker.pid") -p, --pidfile string Path to use for daemon PID file (default "/var/run/docker.pid")
--raw-logs Full timestamps without ANSI coloring --raw-logs Full timestamps without ANSI coloring
--registry-mirror value Preferred Docker registry mirror (default []) --registry-mirror list Preferred Docker registry mirror (default [])
--seccomp-profile value Path to seccomp profile --seccomp-profile string Path to seccomp profile
--selinux-enabled Enable selinux support --selinux-enabled Enable selinux support
--shutdown-timeout=15 Set the shutdown timeout value in seconds --shutdown-timeout int Set the default shutdown timeout (default 15)
-s, --storage-driver string Storage driver to use -s, --storage-driver string Storage driver to use
--storage-opt value Storage driver options (default []) --storage-opt list Storage driver options (default [])
--swarm-default-advertise-addr string Set default address or interface for swarm advertised address --swarm-default-advertise-addr string Set default address or interface for swarm advertised address
--tls Use TLS; implied by --tlsverify --tls Use TLS; implied by --tlsverify
--tlscacert string Trust certs signed only by this CA (default "/root/.docker/ca.pem") --tlscacert string Trust certs signed only by this CA (default "~/.docker/ca.pem")
--tlscert string Path to TLS certificate file (default "/root/.docker/cert.pem") --tlscert string Path to TLS certificate file (default "~/.docker/cert.pem")
--tlskey string Path to TLS key file (default "/root/.docker/key.pem") --tlskey string Path to TLS key file (default ~/.docker/key.pem")
--tlsverify Use TLS and verify the remote --tlsverify Use TLS and verify the remote
--userland-proxy Use userland proxy for loopback traffic (default true) --userland-proxy Use userland proxy for loopback traffic (default true)
--userland-proxy-path string Path to the userland proxy binary --userland-proxy-path string Path to the userland proxy binary
@ -99,7 +100,13 @@ Options with [] may be specified multiple times.
uses different binaries for the daemon and client. To run the daemon you uses different binaries for the daemon and client. To run the daemon you
type `dockerd`. type `dockerd`.
To run the daemon with debug output, use `dockerd -D`. To run the daemon with debug output, use `dockerd -D` or add `debug: true` to
the `daemon.json` file.
> **Note**: In Docker 1.13 and higher, enable experimental features by starting
> `dockerd` with the `--experimental` flag or adding `experimental: true` to the
> `daemon.json` file. In earlier Docker versions, a different build was required
> to enable experimental features.
## Examples ## Examples

20
experimental/README.md
View File

@ -13,9 +13,9 @@ please feel free to provide any feedback on these features you wish.
Experimental features are now included in the standard Docker binaries as of Experimental features are now included in the standard Docker binaries as of
version 1.13.0. version 1.13.0.
For enabling experimental features, you need to start the Docker daemon with To enable experimental features, start the Docker daemon with the
`--experimental` flag. `--experimental` flag or enable the daemon flag in the
You can also enable the daemon flag via `/etc/docker/daemon.json`. e.g. `/etc/docker/daemon.json` configuration file:
```json ```json
{ {
@ -23,7 +23,8 @@ You can also enable the daemon flag via `/etc/docker/daemon.json`. e.g.
} }
``` ```
Then make sure the experimental flag is enabled: You can check to see if experimental features are enabled on a running daemon
using the following command:
```bash ```bash
$ docker version -f '{{.Server.Experimental}}' $ docker version -f '{{.Server.Experimental}}'
@ -32,9 +33,18 @@ true
## Current experimental features ## Current experimental features
Docker service logs command to view logs for a Docker service. This is needed in Swarm mode.
Option to squash image layers to the base image after successful builds.
Checkpoint and restore support for Containers.
Metrics (Prometheus) output for basic container, image, and daemon operations.
* The top-level [docker deploy](../../docs/reference/deploy.md) command. The
`docker stack deploy` command is **not** experimental.
* [`docker service logs` command](../docs/reference/commandline/service_logs.md)
* [`--squash` option to `docker build` command](../docs/reference/commandline/build.md##squash-an-images-layers---squash-experimental-only)
* [External graphdriver plugins](../docs/extend/plugins_graphdriver.md) * [External graphdriver plugins](../docs/extend/plugins_graphdriver.md)
* [Ipvlan Network Drivers](vlan-networks.md) * [Ipvlan Network Drivers](vlan-networks.md)
* [Docker Stacks and Distributed Application Bundles](docker-stacks-and-bundles.md) * [Distributed Application Bundles](docker-stacks-and-bundles.md)
* [Checkpoint & Restore](checkpoint-restore.md) * [Checkpoint & Restore](checkpoint-restore.md)
* [Docker build with --squash argument](docker-build-with-squash.md) * [Docker build with --squash argument](docker-build-with-squash.md)