diff --git a/Dockerfile b/Dockerfile index 8e36dfecac3..1c681bb028e 100644 --- a/Dockerfile +++ b/Dockerfile @@ -23,8 +23,7 @@ ENV DISTRIBUTION_BRANCH="release/2.5" # The statements below pull reference docs from upstream locations, # then build the whole site to static HTML using Jekyll -RUN svn co https://github.com/docker/docker/branches/$ENGINE_BRANCH/docs/reference allv/engine/reference \ - && svn co https://github.com/docker/docker/branches/$ENGINE_BRANCH/docs/extend allv/engine/extend \ +RUN svn co https://github.com/docker/docker/branches/$ENGINE_BRANCH/docs/extend allv/engine/extend \ && wget -O allv/engine/deprecated.md https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/docs/deprecated.md \ && svn co https://github.com/docker/distribution/branches/$DISTRIBUTION_BRANCH/docs/spec allv/registry/spec \ && wget -O allv/registry/configuration.md https://raw.githubusercontent.com/docker/distribution/$DISTRIBUTION_BRANCH/docs/configuration.md \ diff --git a/_data/dockerd-cli/dockerd.yaml b/_data/dockerd-cli/dockerd.yaml new file mode 100644 index 00000000000..85e6078640d --- /dev/null +++ b/_data/dockerd-cli/dockerd.yaml @@ -0,0 +1,1372 @@ +command: dockerd +short: A self-sufficient runtime for containers. +long: | + Options with [] may be specified multiple times. + + dockerd is the persistent process that manages containers. Docker + uses different binaries for the daemon and client. To run the daemon you + type `dockerd`. + + To run the daemon with debug output, use `dockerd -D`. + + ## Daemon socket option + + The Docker daemon can listen for [Docker Remote API](../api/docker_remote_api.md) + requests via three different types of Socket: `unix`, `tcp`, and `fd`. + + By default, a `unix` domain socket (or IPC socket) is created at + `/var/run/docker.sock`, requiring either `root` permission, or `docker` group + membership. + + If you need to access the Docker daemon remotely, you need to enable the `tcp` + Socket. Beware that the default setup provides un-encrypted and + un-authenticated direct access to the Docker daemon - and should be secured + either using the [built in HTTPS encrypted socket](../../security/https.md), or by + putting a secure web proxy in front of it. You can listen on port `2375` on all + network interfaces with `-H tcp://0.0.0.0:2375`, or on a particular network + interface using its IP address: `-H tcp://192.168.59.103:2375`. It is + conventional to use port `2375` for un-encrypted, and port `2376` for encrypted + communication with the daemon. + + > **Note:** + > If you're using an HTTPS encrypted socket, keep in mind that only + > TLS1.0 and greater are supported. Protocols SSLv3 and under are not + > supported anymore for security reasons. + + On Systemd based systems, you can communicate with the daemon via + [Systemd socket activation](http://0pointer.de/blog/projects/socket-activation.html), + use `dockerd -H fd://`. Using `fd://` will work perfectly for most setups but + you can also specify individual sockets: `dockerd -H fd://3`. If the + specified socket activated files aren't found, then Docker will exit. You can + find examples of using Systemd socket activation with Docker and Systemd in the + [Docker source tree](https://github.com/docker/docker/tree/master/contrib/init/systemd/). + + You can configure the Docker daemon to listen to multiple sockets at the same + time using multiple `-H` options: + + ```bash + # listen using the default unix socket, and on 2 specific IP addresses on this host. + $ sudo dockerd -H unix:///var/run/docker.sock -H tcp://192.168.59.106 -H tcp://10.10.10.2 + ``` + + The Docker client will honor the `DOCKER_HOST` environment variable to set the + `-H` flag for the client. + + ```bash + $ docker -H tcp://0.0.0.0:2375 ps + # or + $ export DOCKER_HOST="tcp://0.0.0.0:2375" + $ docker ps + # both are equal + ``` + + Setting the `DOCKER_TLS_VERIFY` environment variable to any value other than + the empty string is equivalent to setting the `--tlsverify` flag. The following + are equivalent: + + ```bash + $ docker --tlsverify ps + # or + $ export DOCKER_TLS_VERIFY=1 + $ docker ps + ``` + + The Docker client will honor the `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` + environment variables (or the lowercase versions thereof). `HTTPS_PROXY` takes + precedence over `HTTP_PROXY`. + + ### Bind Docker to another host/port or a Unix socket + + > **Warning**: + > Changing the default `docker` daemon binding to a + > TCP port or Unix *docker* user group will increase your security risks + > by allowing non-root users to gain *root* access on the host. Make sure + > you control access to `docker`. If you are binding + > to a TCP port, anyone with access to that port has full Docker access; + > so it is not advisable on an open network. + + With `-H` it is possible to make the Docker daemon to listen on a + specific IP and port. By default, it will listen on + `unix:///var/run/docker.sock` to allow only local connections by the + *root* user. You *could* set it to `0.0.0.0:2375` or a specific host IP + to give access to everybody, but that is **not recommended** because + then it is trivial for someone to gain root access to the host where the + daemon is running. + + Similarly, the Docker client can use `-H` to connect to a custom port. + The Docker client will default to connecting to `unix:///var/run/docker.sock` + on Linux, and `tcp://127.0.0.1:2376` on Windows. + + `-H` accepts host and port assignment in the following format: + + tcp://[host]:[port][path] or unix://path + + For example: + + - `tcp://` -> TCP connection to `127.0.0.1` on either port `2376` when TLS encryption + is on, or port `2375` when communication is in plain text. + - `tcp://host:2375` -> TCP connection on + host:2375 + - `tcp://host:2375/path` -> TCP connection on + host:2375 and prepend path to all requests + - `unix://path/to/socket` -> Unix socket located + at `path/to/socket` + + `-H`, when empty, will default to the same value as + when no `-H` was passed in. + + `-H` also accepts short form for TCP bindings: `host:` or `host:port` or `:port` + + Run Docker in daemon mode: + + ```bash + $ sudo /dockerd -H 0.0.0.0:5555 & + ``` + + Download an `ubuntu` image: + + ```bash + $ docker -H :5555 pull ubuntu + ``` + + You can use multiple `-H`, for example, if you want to listen on both + TCP and a Unix socket + + ```bash + # Run docker in daemon mode + $ sudo /dockerd -H tcp://127.0.0.1:2375 -H unix:///var/run/docker.sock & + # Download an ubuntu image, use default Unix socket + $ docker pull ubuntu + # OR use the TCP port + $ docker -H tcp://127.0.0.1:2375 pull ubuntu + ``` + + ### Daemon storage-driver option + + The Docker daemon has support for several different image layer storage + drivers: `aufs`, `devicemapper`, `btrfs`, `zfs`, `overlay` and `overlay2`. + + The `aufs` driver is the oldest, but is based on a Linux kernel patch-set that + is unlikely to be merged into the main kernel. These are also known to cause + some serious kernel crashes. However, `aufs` allows containers to share + executable and shared library memory, so is a useful choice when running + thousands of containers with the same program or libraries. + + The `devicemapper` driver uses thin provisioning and Copy on Write (CoW) + snapshots. For each devicemapper graph location – typically + `/var/lib/docker/devicemapper` – a thin pool is created based on two block + devices, one for data and one for metadata. By default, these block devices + are created automatically by using loopback mounts of automatically created + sparse files. Refer to [Storage driver options](dockerd.md#storage-driver-options) below + for a way how to customize this setup. + [~jpetazzo/Resizing Docker containers with the Device Mapper plugin](http://jpetazzo.github.io/2014/01/29/docker-device-mapper-resize/) + article explains how to tune your existing setup without the use of options. + + The `btrfs` driver is very fast for `docker build` - but like `devicemapper` + does not share executable memory between devices. Use + `dockerd -s btrfs -g /mnt/btrfs_partition`. + + The `zfs` driver is probably not as fast as `btrfs` but has a longer track record + on stability. Thanks to `Single Copy ARC` shared blocks between clones will be + cached only once. Use `dockerd -s zfs`. To select a different zfs filesystem + set `zfs.fsname` option as described in [Storage driver options](dockerd.md#storage-driver-options). + + The `overlay` is a very fast union filesystem. It is now merged in the main + Linux kernel as of [3.18.0](https://lkml.org/lkml/2014/10/26/137). `overlay` + also supports page cache sharing, this means multiple containers accessing + the same file can share a single page cache entry (or entries), it makes + `overlay` as efficient with memory as `aufs` driver. Call + `dockerd -s overlay` to use it. + + > **Note:** + > As promising as `overlay` is, the feature is still quite young and should not + > be used in production. Most notably, using `overlay` can cause excessive + > inode consumption (especially as the number of images grows), as well as + > being incompatible with the use of RPMs. + + The `overlay2` uses the same fast union filesystem but takes advantage of + [additional features](https://lkml.org/lkml/2015/2/11/106) added in Linux + kernel 4.0 to avoid excessive inode consumption. Call `dockerd -s overlay2` + to use it. + + > **Note:** + > Both `overlay` and `overlay2` are currently unsupported on `btrfs` or any + > Copy on Write filesystem and should only be used over `ext4` partitions. + + ### Storage driver options + + Particular storage-driver can be configured with options specified with + `--storage-opt` flags. Options for `devicemapper` are prefixed with `dm`, + options for `zfs` start with `zfs` and options for `btrfs` start with `btrfs`. + + #### Devicemapper options + + * `dm.thinpooldev` + + Specifies a custom block storage device to use for the thin pool. + + If using a block device for device mapper storage, it is best to use `lvm` + to create and manage the thin-pool volume. This volume is then handed to Docker + to exclusively create snapshot volumes needed for images and containers. + + Managing the thin-pool outside of Engine makes for the most feature-rich + method of having Docker utilize device mapper thin provisioning as the + backing storage for Docker containers. The highlights of the lvm-based + thin-pool management feature include: automatic or interactive thin-pool + resize support, dynamically changing thin-pool features, automatic thinp + metadata checking when lvm activates the thin-pool, etc. + + As a fallback if no thin pool is provided, loopback files are + created. Loopback is very slow, but can be used without any + pre-configuration of storage. It is strongly recommended that you do + not use loopback in production. Ensure your Engine daemon has a + `--storage-opt dm.thinpooldev` argument provided. + + Example use: + + ```bash + $ sudo dockerd --storage-opt dm.thinpooldev=/dev/mapper/thin-pool + ``` + + * `dm.basesize` + + Specifies the size to use when creating the base device, which limits the + size of images and containers. The default value is 10G. Note, thin devices + are inherently "sparse", so a 10G device which is mostly empty doesn't use + 10 GB of space on the pool. However, the filesystem will use more space for + the empty case the larger the device is. + + The base device size can be increased at daemon restart which will allow + all future images and containers (based on those new images) to be of the + new base device size. + + Example use: + + ```bash + $ sudo dockerd --storage-opt dm.basesize=50G + ``` + + This will increase the base device size to 50G. The Docker daemon will throw an + error if existing base device size is larger than 50G. A user can use + this option to expand the base device size however shrinking is not permitted. + + This value affects the system-wide "base" empty filesystem + that may already be initialized and inherited by pulled images. Typically, + a change to this value requires additional steps to take effect: + + ```bash + $ sudo service docker stop + $ sudo rm -rf /var/lib/docker + $ sudo service docker start + ``` + + Example use: + + ```bash + $ sudo dockerd --storage-opt dm.basesize=20G + ``` + + * `dm.loopdatasize` + + > **Note**: + > This option configures devicemapper loopback, which should not + > be used in production. + + Specifies the size to use when creating the loopback file for the + "data" device which is used for the thin pool. The default size is + 100G. The file is sparse, so it will not initially take up this + much space. + + Example use: + + ```bash + $ sudo dockerd --storage-opt dm.loopdatasize=200G + ``` + + * `dm.loopmetadatasize` + + > **Note**: + > This option configures devicemapper loopback, which should not + > be used in production. + + Specifies the size to use when creating the loopback file for the + "metadata" device which is used for the thin pool. The default size + is 2G. The file is sparse, so it will not initially take up + this much space. + + Example use: + + ```bash + $ sudo dockerd --storage-opt dm.loopmetadatasize=4G + ``` + + * `dm.fs` + + Specifies the filesystem type to use for the base device. The supported + options are "ext4" and "xfs". The default is "xfs" + + Example use: + + ```bash + $ sudo dockerd --storage-opt dm.fs=ext4 + ``` + + * `dm.mkfsarg` + + Specifies extra mkfs arguments to be used when creating the base device. + + Example use: + + ```bash + $ sudo dockerd --storage-opt "dm.mkfsarg=-O ^has_journal" + ``` + + * `dm.mountopt` + + Specifies extra mount options used when mounting the thin devices. + + Example use: + + ```bash + $ sudo dockerd --storage-opt dm.mountopt=nodiscard + ``` + + * `dm.datadev` + + (Deprecated, use `dm.thinpooldev`) + + Specifies a custom blockdevice to use for data for the thin pool. + + If using a block device for device mapper storage, ideally both datadev and + metadatadev should be specified to completely avoid using the loopback + device. + + Example use: + + ```bash + $ sudo dockerd \ + --storage-opt dm.datadev=/dev/sdb1 \ + --storage-opt dm.metadatadev=/dev/sdc1 + ``` + + * `dm.metadatadev` + + (Deprecated, use `dm.thinpooldev`) + + Specifies a custom blockdevice to use for metadata for the thin pool. + + For best performance the metadata should be on a different spindle than the + data, or even better on an SSD. + + If setting up a new metadata pool it is required to be valid. This can be + achieved by zeroing the first 4k to indicate empty metadata, like this: + + ```bash + $ dd if=/dev/zero of=$metadata_dev bs=4096 count=1 + ``` + + Example use: + + ```bash + $ sudo dockerd \ + --storage-opt dm.datadev=/dev/sdb1 \ + --storage-opt dm.metadatadev=/dev/sdc1 + ``` + + * `dm.blocksize` + + Specifies a custom blocksize to use for the thin pool. The default + blocksize is 64K. + + Example use: + + ```bash + $ sudo dockerd --storage-opt dm.blocksize=512K + ``` + + * `dm.blkdiscard` + + Enables or disables the use of blkdiscard when removing devicemapper + devices. This is enabled by default (only) if using loopback devices and is + required to resparsify the loopback file on image/container removal. + + Disabling this on loopback can lead to *much* faster container removal + times, but will make the space used in `/var/lib/docker` directory not be + returned to the system for other use when containers are removed. + + Example use: + + ```bash + $ sudo dockerd --storage-opt dm.blkdiscard=false + ``` + + * `dm.override_udev_sync_check` + + Overrides the `udev` synchronization checks between `devicemapper` and `udev`. + `udev` is the device manager for the Linux kernel. + + To view the `udev` sync support of a Docker daemon that is using the + `devicemapper` driver, run: + + ```bash + $ docker info + [...] + Udev Sync Supported: true + [...] + ``` + + When `udev` sync support is `true`, then `devicemapper` and udev can + coordinate the activation and deactivation of devices for containers. + + When `udev` sync support is `false`, a race condition occurs between + the`devicemapper` and `udev` during create and cleanup. The race condition + results in errors and failures. (For information on these failures, see + [docker#4036](https://github.com/docker/docker/issues/4036)) + + To allow the `docker` daemon to start, regardless of `udev` sync not being + supported, set `dm.override_udev_sync_check` to true: + + ```bash + $ sudo dockerd --storage-opt dm.override_udev_sync_check=true + ``` + + When this value is `true`, the `devicemapper` continues and simply warns + you the errors are happening. + + > **Note:** + > The ideal is to pursue a `docker` daemon and environment that does + > support synchronizing with `udev`. For further discussion on this + > topic, see [docker#4036](https://github.com/docker/docker/issues/4036). + > Otherwise, set this flag for migrating existing Docker daemons to + > a daemon with a supported environment. + + * `dm.use_deferred_removal` + + Enables use of deferred device removal if `libdm` and the kernel driver + support the mechanism. + + Deferred device removal means that if device is busy when devices are + being removed/deactivated, then a deferred removal is scheduled on + device. And devices automatically go away when last user of the device + exits. + + For example, when a container exits, its associated thin device is removed. + If that device has leaked into some other mount namespace and can't be + removed, the container exit still succeeds and this option causes the + system to schedule the device for deferred removal. It does not wait in a + loop trying to remove a busy device. + + Example use: + + ```bash + $ sudo dockerd --storage-opt dm.use_deferred_removal=true + ``` + + * `dm.use_deferred_deletion` + + Enables use of deferred device deletion for thin pool devices. By default, + thin pool device deletion is synchronous. Before a container is deleted, + the Docker daemon removes any associated devices. If the storage driver + can not remove a device, the container deletion fails and daemon returns. + + Error deleting container: Error response from daemon: Cannot destroy container + + To avoid this failure, enable both deferred device deletion and deferred + device removal on the daemon. + + ```bash + $ sudo dockerd \ + --storage-opt dm.use_deferred_deletion=true \ + --storage-opt dm.use_deferred_removal=true + ``` + + With these two options enabled, if a device is busy when the driver is + deleting a container, the driver marks the device as deleted. Later, when + the device isn't in use, the driver deletes it. + + In general it should be safe to enable this option by default. It will help + when unintentional leaking of mount point happens across multiple mount + namespaces. + + * `dm.min_free_space` + + Specifies the min free space percent in a thin pool require for new device + creation to succeed. This check applies to both free data space as well + as free metadata space. Valid values are from 0% - 99%. Value 0% disables + free space checking logic. If user does not specify a value for this option, + the Engine uses a default value of 10%. + + Whenever a new a thin pool device is created (during `docker pull` or during + container creation), the Engine checks if the minimum free space is + available. If sufficient space is unavailable, then device creation fails + and any relevant `docker` operation fails. + + To recover from this error, you must create more free space in the thin pool + to recover from the error. You can create free space by deleting some images + and containers from the thin pool. You can also add more storage to the thin + pool. + + To add more space to a LVM (logical volume management) thin pool, just add + more storage to the volume group container thin pool; this should automatically + resolve any errors. If your configuration uses loop devices, then stop the + Engine daemon, grow the size of loop files and restart the daemon to resolve + the issue. + + Example use: + + ```bash + $ sudo dockerd --storage-opt dm.min_free_space=10% + ``` + + #### ZFS options + + * `zfs.fsname` + + Set zfs filesystem under which docker will create its own datasets. + By default docker will pick up the zfs filesystem where docker graph + (`/var/lib/docker`) is located. + + Example use: + + ```bash + $ sudo dockerd -s zfs --storage-opt zfs.fsname=zroot/docker + ``` + + #### Btrfs options + + * `btrfs.min_space` + + Specifies the minimum size to use when creating the subvolume which is used + for containers. If user uses disk quota for btrfs when creating or running + a container with **--storage-opt size** option, docker should ensure the + **size** cannot be smaller than **btrfs.min_space**. + + Example use: + + ```bash + $ sudo dockerd -s btrfs --storage-opt btrfs.min_space=10G + ``` + + #### Overlay2 options + + * `overlay2.override_kernel_check` + + Overrides the Linux kernel version check allowing overlay2. Support for + specifying multiple lower directories needed by overlay2 was added to the + Linux kernel in 4.0.0. However some older kernel versions may be patched + to add multiple lower directory support for OverlayFS. This option should + only be used after verifying this support exists in the kernel. Applying + this option on a kernel without this support will cause failures on mount. + + ## Docker runtime execution options + + The Docker daemon relies on a + [OCI](https://github.com/opencontainers/specs) compliant runtime + (invoked via the `containerd` daemon) as its interface to the Linux + kernel `namespaces`, `cgroups`, and `SELinux`. + + By default, the Docker daemon automatically starts `containerd`. If you want to + control `containerd` startup, manually start `containerd` and pass the path to + the `containerd` socket using the `--containerd` flag. For example: + + ```bash + $ sudo dockerd --containerd /var/run/dev/docker-containerd.sock + ``` + + Runtimes can be registered with the daemon either via the + configuration file or using the `--add-runtime` command line argument. + + The following is an example adding 2 runtimes via the configuration: + + ```json + "default-runtime": "runc", + "runtimes": { + "runc": { + "path": "runc" + }, + "custom": { + "path": "/usr/local/bin/my-runc-replacement", + "runtimeArgs": [ + "--debug" + ] + } + } + ``` + + This is the same example via the command line: + + ```bash + $ sudo dockerd --add-runtime runc=runc --add-runtime custom=/usr/local/bin/my-runc-replacement + ``` + + > **Note**: defining runtime arguments via the command line is not supported. + + ## Options for the runtime + + You can configure the runtime using options specified + with the `--exec-opt` flag. All the flag's options have the `native` prefix. A + single `native.cgroupdriver` option is available. + + The `native.cgroupdriver` option specifies the management of the container's + cgroups. You can specify only specify `cgroupfs` or `systemd`. If you specify + `systemd` and it is not available, the system errors out. If you omit the + `native.cgroupdriver` option,` cgroupfs` is used. + + This example sets the `cgroupdriver` to `systemd`: + + ```bash + $ sudo dockerd --exec-opt native.cgroupdriver=systemd + ``` + + Setting this option applies to all containers the daemon launches. + + Also Windows Container makes use of `--exec-opt` for special purpose. Docker user + can specify default container isolation technology with this, for example: + + ```bash + $ sudo dockerd --exec-opt isolation=hyperv + ``` + + Will make `hyperv` the default isolation technology on Windows. If no isolation + value is specified on daemon start, on Windows client, the default is + `hyperv`, and on Windows server, the default is `process`. + + ## Daemon DNS options + + To set the DNS server for all Docker containers, use: + + ```bash + $ sudo dockerd --dns 8.8.8.8 + ``` + + + To set the DNS search domain for all Docker containers, use: + + ```bash + $ sudo dockerd --dns-search example.com + ``` + + + ## Insecure registries + + Docker considers a private registry either secure or insecure. In the rest of + this section, *registry* is used for *private registry*, and `myregistry:5000` + is a placeholder example for a private registry. + + A secure registry uses TLS and a copy of its CA certificate is placed on the + Docker host at `/etc/docker/certs.d/myregistry:5000/ca.crt`. An insecure + registry is either not using TLS (i.e., listening on plain text HTTP), or is + using TLS with a CA certificate not known by the Docker daemon. The latter can + happen when the certificate was not found under + `/etc/docker/certs.d/myregistry:5000/`, or if the certificate verification + failed (i.e., wrong CA). + + By default, Docker assumes all, but local (see local registries below), + registries are secure. Communicating with an insecure registry is not possible + if Docker assumes that registry is secure. In order to communicate with an + insecure registry, the Docker daemon requires `--insecure-registry` in one of + the following two forms: + + * `--insecure-registry myregistry:5000` tells the Docker daemon that + myregistry:5000 should be considered insecure. + * `--insecure-registry 10.1.0.0/16` tells the Docker daemon that all registries + whose domain resolve to an IP address is part of the subnet described by the + CIDR syntax, should be considered insecure. + + The flag can be used multiple times to allow multiple registries to be marked + as insecure. + + If an insecure registry is not marked as insecure, `docker pull`, + `docker push`, and `docker search` will result in an error message prompting + the user to either secure or pass the `--insecure-registry` flag to the Docker + daemon as described above. + + Local registries, whose IP address falls in the 127.0.0.0/8 range, are + automatically marked as insecure as of Docker 1.3.2. It is not recommended to + rely on this, as it may change in the future. + + Enabling `--insecure-registry`, i.e., allowing un-encrypted and/or untrusted + communication, can be useful when running a local registry. However, + because its use creates security vulnerabilities it should ONLY be enabled for + testing purposes. For increased security, users should add their CA to their + system's list of trusted CAs instead of enabling `--insecure-registry`. + + ## Legacy Registries + + Enabling `--disable-legacy-registry` forces a docker daemon to only interact with registries which support the V2 protocol. Specifically, the daemon will not attempt `push`, `pull` and `login` to v1 registries. The exception to this is `search` which can still be performed on v1 registries. + + ## Running a Docker daemon behind an HTTPS_PROXY + + When running inside a LAN that uses an `HTTPS` proxy, the Docker Hub + certificates will be replaced by the proxy's certificates. These certificates + need to be added to your Docker host's configuration: + + 1. Install the `ca-certificates` package for your distribution + 2. Ask your network admin for the proxy's CA certificate and append them to + `/etc/pki/tls/certs/ca-bundle.crt` + 3. Then start your Docker daemon with `HTTPS_PROXY=http://username:password@proxy:port/ dockerd`. + The `username:` and `password@` are optional - and are only needed if your + proxy is set up to require authentication. + + This will only add the proxy and authentication to the Docker daemon's requests - + your `docker build`s and running containers will need extra configuration to + use the proxy + + ## Default Ulimits + + `--default-ulimit` allows you to set the default `ulimit` options to use for + all containers. It takes the same options as `--ulimit` for `docker run`. If + these defaults are not set, `ulimit` settings will be inherited, if not set on + `docker run`, from the Docker daemon. Any `--ulimit` options passed to + `docker run` will overwrite these defaults. + + Be careful setting `nproc` with the `ulimit` flag as `nproc` is designed by Linux to + set the maximum number of processes available to a user, not to a container. For details + please check the [run](run.md) reference. + + ## Nodes discovery + + The `--cluster-advertise` option specifies the `host:port` or `interface:port` + combination that this particular daemon instance should use when advertising + itself to the cluster. The daemon is reached by remote hosts through this value. + If you specify an interface, make sure it includes the IP address of the actual + Docker host. For Engine installation created through `docker-machine`, the + interface is typically `eth1`. + + The daemon uses [libkv](https://github.com/docker/libkv/) to advertise + the node within the cluster. Some key-value backends support mutual + TLS. To configure the client TLS settings used by the daemon can be configured + using the `--cluster-store-opt` flag, specifying the paths to PEM encoded + files. For example: + + ```bash + $ sudo dockerd \ + --cluster-advertise 192.168.1.2:2376 \ + --cluster-store etcd://192.168.1.2:2379 \ + --cluster-store-opt kv.cacertfile=/path/to/ca.pem \ + --cluster-store-opt kv.certfile=/path/to/cert.pem \ + --cluster-store-opt kv.keyfile=/path/to/key.pem + ``` + + The currently supported cluster store options are: + + * `discovery.heartbeat` + + Specifies the heartbeat timer in seconds which is used by the daemon as a + keepalive mechanism to make sure discovery module treats the node as alive + in the cluster. If not configured, the default value is 20 seconds. + + * `discovery.ttl` + + Specifies the ttl (time-to-live) in seconds which is used by the discovery + module to timeout a node if a valid heartbeat is not received within the + configured ttl value. If not configured, the default value is 60 seconds. + + * `kv.cacertfile` + + Specifies the path to a local file with PEM encoded CA certificates to trust + + * `kv.certfile` + + Specifies the path to a local file with a PEM encoded certificate. This + certificate is used as the client cert for communication with the + Key/Value store. + + * `kv.keyfile` + + Specifies the path to a local file with a PEM encoded private key. This + private key is used as the client key for communication with the + Key/Value store. + + * `kv.path` + + Specifies the path in the Key/Value store. If not configured, the default value is 'docker/nodes'. + + ## Access authorization + + Docker's access authorization can be extended by authorization plugins that your + organization can purchase or build themselves. You can install one or more + authorization plugins when you start the Docker `daemon` using the + `--authorization-plugin=PLUGIN_ID` option. + + ```bash + $ sudo dockerd --authorization-plugin=plugin1 --authorization-plugin=plugin2,... + ``` + + The `PLUGIN_ID` value is either the plugin's name or a path to its specification + file. The plugin's implementation determines whether you can specify a name or + path. Consult with your Docker administrator to get information about the + plugins available to you. + + Once a plugin is installed, requests made to the `daemon` through the command + line or Docker's remote API are allowed or denied by the plugin. If you have + multiple plugins installed, at least one must allow the request for it to + complete. + + For information about how to create an authorization plugin, see [authorization + plugin](../../extend/plugins_authorization.md) section in the Docker extend section of this documentation. + + + ## Daemon user namespace options + + The Linux kernel [user namespace support](http://man7.org/linux/man-pages/man7/user_namespaces.7.html) provides additional security by enabling + a process, and therefore a container, to have a unique range of user and + group IDs which are outside the traditional user and group range utilized by + the host system. Potentially the most important security improvement is that, + by default, container processes running as the `root` user will have expected + administrative privilege (with some restrictions) inside the container but will + effectively be mapped to an unprivileged `uid` on the host. + + When user namespace support is enabled, Docker creates a single daemon-wide mapping + for all containers running on the same engine instance. The mappings will + utilize the existing subordinate user and group ID feature available on all modern + Linux distributions. + The [`/etc/subuid`](http://man7.org/linux/man-pages/man5/subuid.5.html) and + [`/etc/subgid`](http://man7.org/linux/man-pages/man5/subgid.5.html) files will be + read for the user, and optional group, specified to the `--userns-remap` + parameter. If you do not wish to specify your own user and/or group, you can + provide `default` as the value to this flag, and a user will be created on your behalf + and provided subordinate uid and gid ranges. This default user will be named + `dockremap`, and entries will be created for it in `/etc/passwd` and + `/etc/group` using your distro's standard user and group creation tools. + + > **Note**: The single mapping per-daemon restriction is in place for now + > because Docker shares image layers from its local cache across all + > containers running on the engine instance. Since file ownership must be + > the same for all containers sharing the same layer content, the decision + > was made to map the file ownership on `docker pull` to the daemon's user and + > group mappings so that there is no delay for running containers once the + > content is downloaded. This design preserves the same performance for `docker + > pull`, `docker push`, and container startup as users expect with + > user namespaces disabled. + + ### Starting the daemon with user namespaces enabled + + To enable user namespace support, start the daemon with the + `--userns-remap` flag, which accepts values in the following formats: + + - uid + - uid:gid + - username + - username:groupname + + If numeric IDs are provided, translation back to valid user or group names + will occur so that the subordinate uid and gid information can be read, given + these resources are name-based, not id-based. If the numeric ID information + provided does not exist as entries in `/etc/passwd` or `/etc/group`, daemon + startup will fail with an error message. + + > **Note:** On Fedora 22, you have to `touch` the `/etc/subuid` and `/etc/subgid` + > files to have ranges assigned when users are created. This must be done + > *before* the `--userns-remap` option is enabled. Once these files exist, the + > daemon can be (re)started and range assignment on user creation works properly. + + **Example: starting with default Docker user management:** + + ```bash + $ sudo dockerd --userns-remap=default + ``` + + When `default` is provided, Docker will create - or find the existing - user and group + named `dockremap`. If the user is created, and the Linux distribution has + appropriate support, the `/etc/subuid` and `/etc/subgid` files will be populated + with a contiguous 65536 length range of subordinate user and group IDs, starting + at an offset based on prior entries in those files. For example, Ubuntu will + create the following range, based on an existing user named `user1` already owning + the first 65536 range: + + ```bash + $ cat /etc/subuid + user1:100000:65536 + dockremap:165536:65536 + ``` + + If you have a preferred/self-managed user with subordinate ID mappings already + configured, you can provide that username or uid to the `--userns-remap` flag. + If you have a group that doesn't match the username, you may provide the `gid` + or group name as well; otherwise the username will be used as the group name + when querying the system for the subordinate group ID range. + + ### Detailed information on `subuid`/`subgid` ranges + + Given potential advanced use of the subordinate ID ranges by power users, the + following paragraphs define how the Docker daemon currently uses the range entries + found within the subordinate range files. + + The simplest case is that only one contiguous range is defined for the + provided user or group. In this case, Docker will use that entire contiguous + range for the mapping of host uids and gids to the container process. This + means that the first ID in the range will be the remapped root user, and the + IDs above that initial ID will map host ID 1 through the end of the range. + + From the example `/etc/subuid` content shown above, the remapped root + user would be uid 165536. + + If the system administrator has set up multiple ranges for a single user or + group, the Docker daemon will read all the available ranges and use the + following algorithm to create the mapping ranges: + + 1. The range segments found for the particular user will be sorted by *start ID* ascending. + 2. Map segments will be created from each range in increasing value with a length matching the length of each segment. Therefore the range segment with the lowest numeric starting value will be equal to the remapped root, and continue up through host uid/gid equal to the range segment length. As an example, if the lowest segment starts at ID 1000 and has a length of 100, then a map of 1000 -> 0 (the remapped root) up through 1100 -> 100 will be created from this segment. If the next segment starts at ID 10000, then the next map will start with mapping 10000 -> 101 up to the length of this second segment. This will continue until no more segments are found in the subordinate files for this user. + 3. If more than five range segments exist for a single user, only the first five will be utilized, matching the kernel's limitation of only five entries in `/proc/self/uid_map` and `proc/self/gid_map`. + + ### Disable user namespace for a container + + If you enable user namespaces on the daemon, all containers are started + with user namespaces enabled. In some situations you might want to disable + this feature for a container, for example, to start a privileged container (see + [user namespace known restrictions](dockerd.md#user-namespace-known-restrictions)). + To enable those advanced features for a specific container use `--userns=host` + in the `run/exec/create` command. + This option will completely disable user namespace mapping for the container's user. + + ### User namespace known restrictions + + The following standard Docker features are currently incompatible when + running a Docker daemon with user namespaces enabled: + + - sharing PID or NET namespaces with the host (`--pid=host` or `--network=host`) + - A `--read-only` container filesystem (this is a Linux kernel restriction against remounting with modified flags of a currently mounted filesystem when inside a user namespace) + - external (volume or graph) drivers which are unaware/incapable of using daemon user mappings + - Using `--privileged` mode flag on `docker run` (unless also specifying `--userns=host`) + + In general, user namespaces are an advanced feature and will require + coordination with other capabilities. For example, if volumes are mounted from + the host, file ownership will have to be pre-arranged if the user or + administrator wishes the containers to have expected access to the volume + contents. + + Finally, while the `root` user inside a user namespaced container process has + many of the expected admin privileges that go along with being the superuser, the + Linux kernel has restrictions based on internal knowledge that this is a user namespaced + process. The most notable restriction that we are aware of at this time is the + inability to use `mknod`. Permission will be denied for device creation even as + container `root` inside a user namespace. + + ## Miscellaneous options + + IP masquerading uses address translation to allow containers without a public + IP to talk to other machines on the Internet. This may interfere with some + network topologies and can be disabled with `--ip-masq=false`. + + Docker supports softlinks for the Docker data directory (`/var/lib/docker`) and + for `/var/lib/docker/tmp`. The `DOCKER_TMPDIR` and the data directory can be + set like this: + + DOCKER_TMPDIR=/mnt/disk2/tmp /usr/local/bin/dockerd -D -g /var/lib/docker -H unix:// > /var/lib/docker-machine/docker.log 2>&1 + # or + export DOCKER_TMPDIR=/mnt/disk2/tmp + /usr/local/bin/dockerd -D -g /var/lib/docker -H unix:// > /var/lib/docker-machine/docker.log 2>&1 + + ## Default cgroup parent + + The `--cgroup-parent` option allows you to set the default cgroup parent + to use for containers. If this option is not set, it defaults to `/docker` for + fs cgroup driver and `system.slice` for systemd cgroup driver. + + If the cgroup has a leading forward slash (`/`), the cgroup is created + under the root cgroup, otherwise the cgroup is created under the daemon + cgroup. + + Assuming the daemon is running in cgroup `daemoncgroup`, + `--cgroup-parent=/foobar` creates a cgroup in + `/sys/fs/cgroup/memory/foobar`, whereas using `--cgroup-parent=foobar` + creates the cgroup in `/sys/fs/cgroup/memory/daemoncgroup/foobar` + + The systemd cgroup driver has different rules for `--cgroup-parent`. Systemd + represents hierarchy by slice and the name of the slice encodes the location in + the tree. So `--cgroup-parent` for systemd cgroups should be a slice name. A + name can consist of a dash-separated series of names, which describes the path + to the slice from the root slice. For example, `--cgroup-parent=user-a-b.slice` + means the memory cgroup for the container is created in + `/sys/fs/cgroup/memory/user.slice/user-a.slice/user-a-b.slice/docker-.scope`. + + This setting can also be set per container, using the `--cgroup-parent` + option on `docker create` and `docker run`, and takes precedence over + the `--cgroup-parent` option on the daemon. + + ## Daemon configuration file + + The `--config-file` option allows you to set any configuration option + for the daemon in a JSON format. This file uses the same flag names as keys, + except for flags that allow several entries, where it uses the plural + of the flag name, e.g., `labels` for the `label` flag. + + The options set in the configuration file must not conflict with options set + via flags. The docker daemon fails to start if an option is duplicated between + the file and the flags, regardless their value. We do this to avoid + silently ignore changes introduced in configuration reloads. + For example, the daemon fails to start if you set daemon labels + in the configuration file and also set daemon labels via the `--label` flag. + Options that are not present in the file are ignored when the daemon starts. + + ### Linux configuration file + + The default location of the configuration file on Linux is + `/etc/docker/daemon.json`. The `--config-file` flag can be used to specify a + non-default location. + + This is a full example of the allowed configuration options on Linux: + + ```json + { + "api-cors-header": "", + "authorization-plugins": [], + "bip": "", + "bridge": "", + "cgroup-parent": "", + "cluster-store": "", + "cluster-store-opts": {}, + "cluster-advertise": "", + "debug": true, + "default-gateway": "", + "default-gateway-v6": "", + "default-runtime": "runc", + "default-ulimits": {}, + "disable-legacy-registry": false, + "dns": [], + "dns-opts": [], + "dns-search": [], + "exec-opts": [], + "exec-root": "", + "fixed-cidr": "", + "fixed-cidr-v6": "", + "graph": "", + "group": "", + "hosts": [], + "icc": false, + "insecure-registries": [], + "ip": "0.0.0.0", + "iptables": false, + "ipv6": false, + "ip-forward": false, + "ip-masq": false, + "labels": [], + "live-restore": true, + "log-driver": "", + "log-level": "", + "log-opts": {}, + "max-concurrent-downloads": 3, + "max-concurrent-uploads": 5, + "mtu": 0, + "oom-score-adjust": -500, + "pidfile": "", + "raw-logs": false, + "registry-mirrors": [], + "runtimes": { + "runc": { + "path": "runc" + }, + "custom": { + "path": "/usr/local/bin/my-runc-replacement", + "runtimeArgs": [ + "--debug" + ] + } + }, + "selinux-enabled": false, + "storage-driver": "", + "storage-opts": [], + "swarm-default-advertise-addr": "", + "tls": true, + "tlscacert": "", + "tlscert": "", + "tlskey": "", + "tlsverify": true, + "userland-proxy": false, + "userns-remap": "" + } + ``` + + ### Windows configuration file + + The default location of the configuration file on Windows is + `%programdata%\docker\config\daemon.json`. The `--config-file` flag can be + used to specify a non-default location. + + This is a full example of the allowed configuration options on Windows: + + ```json + { + "authorization-plugins": [], + "bridge": "", + "cluster-advertise": "", + "cluster-store": "", + "debug": true, + "default-ulimits": {}, + "disable-legacy-registry": false, + "dns": [], + "dns-opts": [], + "dns-search": [], + "exec-opts": [], + "fixed-cidr": "", + "graph": "", + "group": "", + "hosts": [], + "insecure-registries": [], + "labels": [], + "live-restore": true, + "log-driver": "", + "log-level": "", + "mtu": 0, + "pidfile": "", + "raw-logs": false, + "registry-mirrors": [], + "storage-driver": "", + "storage-opts": [], + "swarm-default-advertise-addr": "", + "tlscacert": "", + "tlscert": "", + "tlskey": "", + "tlsverify": true + } + ``` + + ### Configuration reloading + + Some options can be reconfigured when the daemon is running without requiring + to restart the process. We use the `SIGHUP` signal in Linux to reload, and a global event + in Windows with the key `Global\docker-daemon-config-$PID`. The options can + be modified in the configuration file but still will check for conflicts with + the provided flags. The daemon fails to reconfigure itself + if there are conflicts, but it won't stop execution. + + The list of currently supported options that can be reconfigured is this: + + - `debug`: it changes the daemon to debug mode when set to true. + - `cluster-store`: it reloads the discovery store with the new address. + - `cluster-store-opts`: it uses the new options to reload the discovery store. + - `cluster-advertise`: it modifies the address advertised after reloading. + - `labels`: it replaces the daemon labels with a new set of labels. + - `live-restore`: Enables [keeping containers alive during daemon downtime](../../admin/live-restore.md). + - `max-concurrent-downloads`: it updates the max concurrent downloads for each pull. + - `max-concurrent-uploads`: it updates the max concurrent uploads for each push. + - `default-runtime`: it updates the runtime to be used if not is + specified at container creation. It defaults to "default" which is + the runtime shipped with the official docker packages. + - `runtimes`: it updates the list of available OCI runtimes that can + be used to run containers + + Updating and reloading the cluster configurations such as `--cluster-store`, + `--cluster-advertise` and `--cluster-store-opts` will take effect only if + these configurations were not previously configured. If `--cluster-store` + has been provided in flags and `cluster-advertise` not, `cluster-advertise` + can be added in the configuration file without accompanied by `--cluster-store` + Configuration reload will log a warning message if it detects a change in + previously configured cluster configurations. + + + ## Running multiple daemons + + > **Note:** Running multiple daemons on a single host is considered as "experimental". The user should be aware of + > unsolved problems. This solution may not work properly in some cases. Solutions are currently under development + > and will be delivered in the near future. + + This section describes how to run multiple Docker daemons on a single host. To + run multiple daemons, you must configure each daemon so that it does not + conflict with other daemons on the same host. You can set these options either + by providing them as flags, or by using a [daemon configuration file](dockerd.md#daemon-configuration-file). + + The following daemon options must be configured for each daemon: + + ```bash + -b, --bridge= Attach containers to a network bridge + --exec-root=/var/run/docker Root of the Docker execdriver + -g, --graph=/var/lib/docker Root of the Docker runtime + -p, --pidfile=/var/run/docker.pid Path to use for daemon PID file + -H, --host=[] Daemon socket(s) to connect to + --iptables=true Enable addition of iptables rules + --config-file=/etc/docker/daemon.json Daemon configuration file + --tlscacert="~/.docker/ca.pem" Trust certs signed only by this CA + --tlscert="~/.docker/cert.pem" Path to TLS certificate file + --tlskey="~/.docker/key.pem" Path to TLS key file + ``` + + When your daemons use different values for these flags, you can run them on the same host without any problems. + It is very important to properly understand the meaning of those options and to use them correctly. + + - The `-b, --bridge=` flag is set to `docker0` as default bridge network. It is created automatically when you install Docker. + If you are not using the default, you must create and configure the bridge manually or just set it to 'none': `--bridge=none` + - `--exec-root` is the path where the container state is stored. The default value is `/var/run/docker`. Specify the path for + your running daemon here. + - `--graph` is the path where images are stored. The default value is `/var/lib/docker`. To avoid any conflict with other daemons + set this parameter separately for each daemon. + - `-p, --pidfile=/var/run/docker.pid` is the path where the process ID of the daemon is stored. Specify the path for your + pid file here. + - `--host=[]` specifies where the Docker daemon will listen for client connections. If unspecified, it defaults to `/var/run/docker.sock`. + - `--iptables=false` prevents the Docker daemon from adding iptables rules. If + multiple daemons manage iptables rules, they may overwrite rules set by another + daemon. Be aware that disabling this option requires you to manually add + iptables rules to expose container ports. If you prevent Docker from adding + iptables rules, Docker will also not add IP masquerading rules, even if you set + `--ip-masq` to `true`. Without IP masquerading rules, Docker containers will not be + able to connect to external hosts or the internet when using network other than + default bridge. + - `--config-file=/etc/docker/daemon.json` is the path where configuration file is stored. You can use it instead of + daemon flags. Specify the path for each daemon. + - `--tls*` Docker daemon supports `--tlsverify` mode that enforces encrypted and authenticated remote connections. + The `--tls*` options enable use of specific certificates for individual daemons. + + Example script for a separate “bootstrap” instance of the Docker daemon without network: + + ```bash + $ sudo dockerd \ + -H unix:///var/run/docker-bootstrap.sock \ + -p /var/run/docker-bootstrap.pid \ + --iptables=false \ + --ip-masq=false \ + --bridge=none \ + --graph=/var/lib/docker-bootstrap \ + --exec-root=/var/run/docker-bootstrap + ``` +usage: dockerd [OPTIONS] +pname: dockerd +plink: dockerd.yaml +options: +- option: add-runtime + description: Register an additional OCI compatible runtime +- option: api-cors-header + description: Set CORS headers in the remote API +- option: authorization-plugin + description: Authorization plugins to load +- option: bridge + shorthand: b + description: Attach containers to a network bridge +- option: bip + description: Specify network bridge IP +- option: cgroup-parent + description: Set parent cgroup for all containers +- option: cluster-advertise + description: Address or interface name to advertise +- option: cluster-store + default_value: map[] + description: Set cluster store options +- option: config-file + default_value: /etc/docker/daemon.json + description: Daemon configuration file +- option: containerd + description: Path to containerd socket +- option: debug + shorthand: D + description: Enable debug mode +- option: default-gateway + description: Container default gateway IPv4 address +- option: default-gateway-v6 + description: Container default gateway IPv6 address +- option: default-runtime + default_value: runc + description: Default OCI runtime for containers +- option: default-ulimit + description: Default ulimits for containers +- option: disable-legacy-registry + description: Disable contacting legacy registries +- option: dns + description: DNS server to use +- option: dns-opt + description: DNS options to use +- option: dns-search + description: DNS search domains to use +- option: exec-opt + description: Runtime execution options +- option: exec-root + default_value: /var/run/docker + description: Root directory for execution state files +- option: fixed-cidr + description: IPv4 subnet for fixed IPs +- option: fixed-cidr-v6 + description: IPv6 subnet for fixed IPs +- option: group + shorthand: G + default_value: docker + description: Group for the unix socket +- option: graph + shorthand: g + default_value: /var/lib/docker + description: Root of the Docker runtime +- option: host + shorthand: H + description: Daemon socket(s) to connect to +- option: help + description: Print usage +- option: icc + default_value: true + description: Enable inter-container communication +- option: insecure-registry + description: Enable insecure registry communication +- option: ip + default_value: 0.0.0.0 + description: Default IP when binding container ports +- option: ip-forward + default_value: true + description: Enable net.ipv4.ip_forward +- option: ip-masq + default_value: true + description: Enable IP masquerading +- option: iptables + default_value: true + description: Enable addition of iptables rules +- option: ipv6 + description: Enable IPv6 networking +- option: log-level + shorthand: l + default_value: info + description: Set the logging level +- option: label + description: Set key=value labels to the daemon +- option: live-restore + description: Enables keeping containers alive during daemon downtime +- option: log-driver + default_value: json-file + description: Default driver for container logs +- option: log-opt + default_value: map[] + description: Default log driver options for containers +- option: max-concurrent-downloads + default_value: 3 + description: Set the max concurrent downloads for each pull +- option: max-concurrent-uploads + default_value: 5 + description: Set the max concurrent uploads for each push +- option: mtu + description: Set the containers network MTU +- option: oom-score-adjust + default_value: -500 + description: Set the oom_score_adj for the daemon +- option: pidfile + shorthand: p + default_value: /var/run/docker.pid + description: Path to use for daemon PID file +- option: raw-logs + description: Full timestamps without ANSI coloring +- option: registry-mirror + description: Preferred Docker registry mirror +- option: storage-driver + shorthand: s + description: Storage driver to use +- option: selinux-enabled + description: Enable selinux support +- option: storage-opt + description: Storage driver options +- option: swarm-default-advertise-addr + description: Set default address or interface for swarm advertised address +- option: tls + description: Use TLS; implied by --tlsverify +- option: tlscacert + default_value: ~/.docker/ca.pem + description: Trust certs signed only by this CA +- option: tlscert + default_value: ~/.docker/cert.pem + description: Path to TLS certificate file +- option: tlskey + default_value: ~/.docker/key.pem + description: Path to TLS key file +- option: tlsverify + description: Use TLS and verify the remote +- option: userland-proxy + default_value: true + description: Use userland proxy for loopback traffic +- option: userns-remap + description: User/Group setting for user namespaces +- option: version + shorthand: v + description: Print version information and quit diff --git a/_data/toc.yaml b/_data/toc.yaml index 284726c47a7..11282e7b8f7 100644 --- a/_data/toc.yaml +++ b/_data/toc.yaml @@ -355,180 +355,326 @@ toc: title: Dockerizing an SSH service - path: /engine/examples/apt-cacher-ng/ title: Dockerizing an apt-cacher-ng service - - sectiontitle: Engine reference + - path: /engine/reference/builder/ + title: Dockerfile reference + - path: /engine/reference/run/ + title: Docker run reference + - path: /engine/reference/commandline/cli/ + title: Use the Docker command line + - path: /engine/reference/commandline/dockerd/ + title: Daemon CLI reference + - sectiontitle: Engine CLI reference section: - - path: /engine/reference/builder/ - title: Dockerfile reference - - path: /engine/reference/run/ - title: Docker run reference - - sectiontitle: Command line reference + - path: /engine/reference/commandline/docker/ + title: docker (base command) + - path: /engine/reference/commandline/attach/ + title: docker attach + - path: /engine/reference/commandline/build/ + title: docker build + - path: /engine/reference/commandline/commit/ + title: docker commit + - sectiontitle: container * section: - - path: /engine/reference/commandline/ - title: Docker commands - - path: /engine/reference/commandline/cli/ - title: Use the Docker command line - - path: /engine/reference/commandline/dockerd/ - title: dockerd - - path: /engine/reference/commandline/attach/ - title: attach - - path: /engine/reference/commandline/build/ - title: build - - path: /engine/reference/commandline/commit/ - title: commit - - path: /engine/reference/commandline/cp/ - title: cp - - path: /engine/reference/commandline/create/ - title: create - - path: /engine/reference/commandline/deploy/ - title: deploy - - path: /engine/reference/commandline/diff/ - title: diff - - path: /engine/reference/commandline/events/ - title: events - - path: /engine/reference/commandline/exec/ - title: exec - - path: /engine/reference/commandline/export/ - title: export - - path: /engine/reference/commandline/history/ - title: history - - path: /engine/reference/commandline/images/ - title: images - - path: /engine/reference/commandline/import/ - title: import - - path: /engine/reference/commandline/info/ - title: info - - path: /engine/reference/commandline/inspect/ - title: inspect - - path: /engine/reference/commandline/kill/ - title: kill - - path: /engine/reference/commandline/load/ - title: load - - path: /engine/reference/commandline/login/ - title: login - - path: /engine/reference/commandline/logout/ - title: logout - - path: /engine/reference/commandline/logs/ - title: logs + - path: /engine/reference/commandline/container/ + title: docker container + - path: /engine/reference/commandline/container_attach/ + title: docker container attach + - path: /engine/reference/commandline/container_commit/ + title: docker container commit + - path: /engine/reference/commandline/container_cp/ + title: docker container cp + - path: /engine/reference/commandline/container_create/ + title: docker container create + - path: /engine/reference/commandline/container_diff/ + title: docker container diff + - path: /engine/reference/commandline/container_exec/ + title: docker container exec + - path: /engine/reference/commandline/container_export/ + title: docker container export + - path: /engine/reference/commandline/container_inspect/ + title: docker container inspect + - path: /engine/reference/commandline/container_kill/ + title: docker container kill + - path: /engine/reference/commandline/container_logs/ + title: docker container logs + - path: /engine/reference/commandline/container_ls/ + title: docker container ls + - path: /engine/reference/commandline/container_pause/ + title: docker container pause + - path: /engine/reference/commandline/container_port/ + title: docker container port + - path: /engine/reference/commandline/container_prune/ + title: docker container prune + - path: /engine/reference/commandline/container_rename/ + title: docker container rename + - path: /engine/reference/commandline/container_restart/ + title: docker container restart + - path: /engine/reference/commandline/container_rm/ + title: docker container rm + - path: /engine/reference/commandline/container_run/ + title: docker container run + - path: /engine/reference/commandline/container_start/ + title: docker container start + - path: /engine/reference/commandline/container_stats/ + title: docker container stats + - path: /engine/reference/commandline/container_stop/ + title: docker container stop + - path: /engine/reference/commandline/container_top/ + title: docker container top + - path: /engine/reference/commandline/container_unpause/ + title: docker container unpause + - path: /engine/reference/commandline/container_update/ + title: docker container update + - path: /engine/reference/commandline/container_wait/ + title: docker container wait + - path: /engine/reference/commandline/cp/ + title: docker cp + - path: /engine/reference/commandline/create/ + title: docker create + - path: /engine/reference/commandline/deploy/ + title: docker deploy + - path: /engine/reference/commandline/diff/ + title: docker diff + - path: /engine/reference/commandline/events/ + title: docker events + - path: /engine/reference/commandline/exec/ + title: docker exec + - path: /engine/reference/commandline/export/ + title: docker export + - path: /engine/reference/commandline/history/ + title: docker history + - sectiontitle: docker image * + section: + - path: /engine/reference/commandline/image/ + title: docker image + - path: /engine/reference/commandline/image_build/ + title: docker image build + - path: /engine/reference/commandline/image_history/ + title: docker image history + - path: /engine/reference/commandline/image_import/ + title: docker image import + - path: /engine/reference/commandline/image_inspect/ + title: docker image inspect + - path: /engine/reference/commandline/image_load/ + title: docker image load + - path: /engine/reference/commandline/image_ls/ + title: docker image ls + - path: /engine/reference/commandline/image_prune/ + title: docker image prune + - path: /engine/reference/commandline/image_pull/ + title: docker image pull + - path: /engine/reference/commandline/image_push/ + title: docker image push + - path: /engine/reference/commandline/image_rm/ + title: docker image rm + - path: /engine/reference/commandline/image_save/ + title: docker image save + - path: /engine/reference/commandline/image_tag/ + title: docker image tag + - path: /engine/reference/commandline/images/ + title: docker images + - path: /engine/reference/commandline/import/ + title: docker import + - path: /engine/reference/commandline/info/ + title: docker info + - path: /engine/reference/commandline/inspect/ + title: docker inspect + - path: /engine/reference/commandline/kill/ + title: docker kill + - path: /engine/reference/commandline/load/ + title: docker load + - path: /engine/reference/commandline/login/ + title: docker login + - path: /engine/reference/commandline/logout/ + title: docker logout + - path: /engine/reference/commandline/logs/ + title: docker logs + - sectiontitle: network * + section: + - path: /engine/reference/commandline/network/ + title: docker network - path: /engine/reference/commandline/network_connect/ - title: network connect + title: docker network connect - path: /engine/reference/commandline/network_create/ - title: network create + title: docker network create - path: /engine/reference/commandline/network_disconnect/ - title: network disconnect + title: docker network disconnect - path: /engine/reference/commandline/network_inspect/ - title: network inspect + title: docker network inspect - path: /engine/reference/commandline/network_ls/ - title: network ls + title: docker network ls + - path: /engine/reference/commandline/network_prune/ + title: docker network prune - path: /engine/reference/commandline/network_rm/ - title: network rm + title: docker network rm + - sectiontitle: docker node * + section: + - path: /engine/reference/commandline/node/ + title: docker node - path: /engine/reference/commandline/node_demote/ - title: node demote + title: docker node demote - path: /engine/reference/commandline/node_inspect/ - title: node inspect + title: docker node inspect - path: /engine/reference/commandline/node_ls/ - title: node ls + title: docker node ls - path: /engine/reference/commandline/node_promote/ - title: node promote + title: docker node promote - path: /engine/reference/commandline/node_ps/ - title: node ps + title: docker node ps - path: /engine/reference/commandline/node_rm/ - title: node rm + title: docker node rm - path: /engine/reference/commandline/node_update/ - title: node update - - path: /engine/reference/commandline/pause/ - title: pause + title: docker node update + - path: /engine/reference/commandline/pause/ + title: docker pause + - sectiontitle: docker plugin * + section: + - path: /engine/reference/commandline/plugin/ + title: docker plugin + - path: /engine/reference/commandline/plugin_create/ + title: docker plugin disable - path: /engine/reference/commandline/plugin_disable/ - title: plugin disable + title: docker plugin disable - path: /engine/reference/commandline/plugin_enable/ - title: plugin enable + title: docker plugin enable - path: /engine/reference/commandline/plugin_inspect/ - title: plugin inspect + title: docker plugin inspect - path: /engine/reference/commandline/plugin_install/ - title: plugin install + title: docker plugin install - path: /engine/reference/commandline/plugin_ls/ - title: plugin ls + title: docker plugin ls - path: /engine/reference/commandline/plugin_rm/ - title: plugin rm - - path: /engine/reference/commandline/port/ - title: port - - path: /engine/reference/commandline/ps/ - title: ps - - path: /engine/reference/commandline/pull/ - title: pull - - path: /engine/reference/commandline/push/ - title: push - - path: /engine/reference/commandline/rename/ - title: rename - - path: /engine/reference/commandline/restart/ - title: restart - - path: /engine/reference/commandline/rm/ - title: rm - - path: /engine/reference/commandline/rmi/ - title: rmi - - path: /engine/reference/commandline/run/ - title: run - - path: /engine/reference/commandline/save/ - title: save - - path: /engine/reference/commandline/search/ - title: search + title: docker plugin rm + - path: /engine/reference/commandline/plugin_set/ + title: docker plugin set + - path: /engine/reference/commandline/port/ + title: docker port + - path: /engine/reference/commandline/ps/ + title: docker ps + - path: /engine/reference/commandline/pull/ + title: docker pull + - path: /engine/reference/commandline/push/ + title: docker push + - path: /engine/reference/commandline/rename/ + title: docker rename + - path: /engine/reference/commandline/restart/ + title: docker restart + - path: /engine/reference/commandline/rm/ + title: docker rm + - path: /engine/reference/commandline/rmi/ + title: docker rmi + - path: /engine/reference/commandline/run/ + title: docker run + - path: /engine/reference/commandline/save/ + title: docker save + - path: /engine/reference/commandline/search/ + title: docker search + - sectiontitle: docker secret * + section: + - path: /engine/reference/commandline/secret/ + title: docker secret + - path: /engine/reference/commandline/secret_create/ + title: docker secret create + - path: /engine/reference/commandline/secret_inspect/ + title: docker secret inspect + - path: /engine/reference/commandline/secret_ls/ + title: docker secret ls + - path: /engine/reference/commandline/secret_rm/ + title: docker secret rm + - sectiontitle: docker service * + section: + - path: /engine/reference/commandline/service/ + title: docker service - path: /engine/reference/commandline/service_create/ - title: service create + title: docker service create - path: /engine/reference/commandline/service_inspect/ - title: service inspect + title: docker service inspect + - path: /engine/reference/commandline/service_logs/ + title: docker service logs - path: /engine/reference/commandline/service_ls/ - title: service ls + title: docker service ls - path: /engine/reference/commandline/service_ps/ - title: service ps + title: docker service ps - path: /engine/reference/commandline/service_rm/ - title: service rm + title: docker service rm - path: /engine/reference/commandline/service_scale/ - title: service scale + title: docker service scale - path: /engine/reference/commandline/service_update/ - title: service update + title: docker service update + - sectiontitle: docker stack * + section: + - path: /engine/reference/commandline/stack/ + title: docker stack - path: /engine/reference/commandline/stack_config/ - title: stack config + title: docker stack config - path: /engine/reference/commandline/stack_deploy/ - title: stack deploy + title: docker stack deploy - path: /engine/reference/commandline/stack_rm/ - title: stack rm + title: docker stack rm - path: /engine/reference/commandline/stack_services/ - title: stack services - - path: /engine/reference/commandline/start/ - title: start - - path: /engine/reference/commandline/stats/ - title: stats - - path: /engine/reference/commandline/stop/ - title: stop + title: docker stack services + - path: /engine/reference/commandline/stack_tasks/ + title: docker stack tasks + - path: /engine/reference/commandline/start/ + title: docker start + - path: /engine/reference/commandline/stats/ + title: docker stats + - path: /engine/reference/commandline/stop/ + title: docker stop + - sectiontitle: docker swarm * + setcion: + - path: /engine/reference/commandline/swarm/ + title: docker swarm - path: /engine/reference/commandline/swarm_init/ - title: swarm init + title: docker swarm init + - path: /engine/reference/commandline/swarm_join-token/ + title: docker swarm join-token - path: /engine/reference/commandline/swarm_join/ - title: swarm join - - path: /engine/reference/commandline/swarm_join_token/ - title: swarm join-token + title: docker swarm join - path: /engine/reference/commandline/swarm_leave/ - title: swarm leave + title: docker swarm leave + - path: /engine/reference/commandline/swarm_unlock-key/ + title: docker swarm unlock-key + - path: /engine/reference/commandline/swarm_unlock/ + title: docker swarm unlock - path: /engine/reference/commandline/swarm_update/ - title: swarm update - - path: /engine/reference/commandline/tag/ - title: tag - - path: /engine/reference/commandline/top/ - title: top - - path: /engine/reference/commandline/unpause/ - title: unpause - - path: /engine/reference/commandline/update/ - title: update - - path: /engine/reference/commandline/version/ - title: version + title: docker swarm update + - sectiontitle: docker system * + section: + - path: /engine/reference/commandline/system/ + title: docker system + - path: /engine/reference/commandline/system_df/ + title: docker system df + - path: /engine/reference/commandline/system_events/ + title: docker system events + - path: /engine/reference/commandline/system_info/ + title: docker system info + - path: /engine/reference/commandline/system_prune/ + title: docker system prune + - path: /engine/reference/commandline/tag/ + title: docker tag + - path: /engine/reference/commandline/top/ + title: docker top + - path: /engine/reference/commandline/unpause/ + title: docker unpause + - path: /engine/reference/commandline/update/ + title: docker update + - path: /engine/reference/commandline/version/ + title: docker version + - sectiontitle: docker volume * + section: - path: /engine/reference/commandline/volume_create/ - title: volume create + title: docker volume create - path: /engine/reference/commandline/volume_inspect/ - title: volume inspect + title: docker volume inspect - path: /engine/reference/commandline/volume_ls/ - title: volume ls + title: docker volume ls + - path: /engine/reference/commandline/volume_prune/ + title: docker volume ls - path: /engine/reference/commandline/volume_rm/ - title: volume rm - - path: /engine/reference/commandline/wait/ - title: wait + title: docker volume rm + - path: /engine/reference/commandline/wait/ + title: docker wait - sectiontitle: Engine API section: - path: /engine/api/ @@ -557,14 +703,14 @@ toc: title: v1.19 reference - path: /engine/api/v1.18/ title: v1.18 reference - - path: /engine/migration/ - title: Migrate to Engine 1.10 - - path: /engine/breaking_changes/ - title: Breaking changes - - path: /engine/deprecated/ - title: Deprecated Engine Features - - path: /engine/faq/ - title: FAQ + - path: /engine/migration/ + title: Migrate to Engine 1.10 + - path: /engine/breaking_changes/ + title: Breaking changes + - path: /engine/deprecated/ + title: Deprecated Engine Features + - path: /engine/faq/ + title: FAQ - sectiontitle: Docker Compose section: - path: /compose/overview/ diff --git a/_includes/cli.md b/_includes/cli.md new file mode 100644 index 00000000000..4ffe339c5cc --- /dev/null +++ b/_includes/cli.md @@ -0,0 +1,69 @@ +{% capture tabChar %} {% endcapture %} +{% capture dockerBaseDesc %}The base command for the Docker CLI.{% endcapture %} +{% if page.datafolder and page.datafile %} + +## Description + +{% if page.datafile=="docker" %} +{{ dockerBaseDesc }} +{% else %} +{{ site.data[page.datafolder][page.datafile].short }} +{% endif %} + +{% if site.data[page.datafolder][page.datafile].usage %} + +## Usage + +```shell +{{ site.data[page.datafolder][page.datafile].usage | replace: tabChar,"" | strip }}{% if site.data[page.datafolder][page.datafile].cname %} COMMAND{% endif %} +``` + +{% endif %} +{% if site.data[page.datafolder][page.datafile].options %} + +## Options + +| Name, shorthand | Default | Description | +| ---- | ------- | ----------- |{% for option in site.data[page.datafolder][page.datafile].options %} +| `--{{ option.option }}{% if option.shorthand %}, -{{ option.shorthand }}{% endif %}` | {% if option.default_value and option.default_value != "[]" %}`{{ option.default_value }}`{% endif %} | {{ option.description | replace: "|","|" | strip }} | {% endfor %} + +{% endif %} + +{% if site.data[page.datafolder][page.datafile].cname %} + +## Child commands + +| Command | Description | +| ------- | ----------- |{% for command in site.data[page.datafolder][page.datafile].cname %}{% capture dataFileName %}{{ command | strip | replace: " ","_" }}{% endcapture %} +| [{{ command }}]({{ dataFileName | replace: "docker_","" }}/) | {{ site.data[page.datafolder][dataFileName].short }} |{% endfor %} + +{% endif %} + +{% if site.data[page.datafolder][page.datafile].pname and site.data[page.datafolder][page.datafile].pname != page.datafile %} + +## Parent command + +{% capture parentfile %}{{ site.data[page.datafolder][page.datafile].plink | replace: ".yaml", "" | replace: "docker_","" }}{% endcapture %} +{% capture parentdatafile %}{{ site.data[page.datafolder][page.datafile].plink | replace: ".yaml", "" }}{% endcapture %} + +{% if site.data[page.datafolder][page.datafile].pname == "docker" %} +{% capture parentDesc %}{{ dockerBaseDesc }}{% endcapture %} +{% else %} +{% capture parentDesc %}{{ site.data[page.datafolder][parentdatafile].short }}{% endcapture %} +{% endif %} + +| Command | Description | +| ------- | ----------- | +| [{{ site.data[page.datafolder][page.datafile].pname }}]({{ parentfile }}) | {{ parentDesc }}| + +{% endif %} + +{% if site.data[page.datafolder][page.datafile].long != site.data[page.datafolder][page.datafile].short %} + +## Extended description + +{{ site.data[page.datafolder][page.datafile].long }} + +{% endif %} + +{% endif %} diff --git a/engine/reference/commandline/attach.md b/engine/reference/commandline/attach.md new file mode 100644 index 00000000000..b4928706ffc --- /dev/null +++ b/engine/reference/commandline/attach.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_attach +title: docker attach +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/build.md b/engine/reference/commandline/build.md new file mode 100644 index 00000000000..dca7df8efb7 --- /dev/null +++ b/engine/reference/commandline/build.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_build +title: docker build +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/commit.md b/engine/reference/commandline/commit.md new file mode 100644 index 00000000000..8ff35ff7cd1 --- /dev/null +++ b/engine/reference/commandline/commit.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_commit +title: docker commit +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/container.md b/engine/reference/commandline/container.md new file mode 100644 index 00000000000..078cea1ad7c --- /dev/null +++ b/engine/reference/commandline/container.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_container +title: docker container +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/container_attach.md b/engine/reference/commandline/container_attach.md new file mode 100644 index 00000000000..64fb43a9808 --- /dev/null +++ b/engine/reference/commandline/container_attach.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_container_attach +title: docker container attach +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/container_commit.md b/engine/reference/commandline/container_commit.md new file mode 100644 index 00000000000..afe4930216d --- /dev/null +++ b/engine/reference/commandline/container_commit.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_container_commit +title: docker container commit +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/container_cp.md b/engine/reference/commandline/container_cp.md new file mode 100644 index 00000000000..6e911bf4110 --- /dev/null +++ b/engine/reference/commandline/container_cp.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_container_cp +title: docker container cp +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/container_create.md b/engine/reference/commandline/container_create.md new file mode 100644 index 00000000000..237599bcc8b --- /dev/null +++ b/engine/reference/commandline/container_create.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_container_create +title: docker container create +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/container_diff.md b/engine/reference/commandline/container_diff.md new file mode 100644 index 00000000000..afa1956e3b0 --- /dev/null +++ b/engine/reference/commandline/container_diff.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_container_diff +title: docker container diff +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/container_exec.md b/engine/reference/commandline/container_exec.md new file mode 100644 index 00000000000..01d30649bfd --- /dev/null +++ b/engine/reference/commandline/container_exec.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_container_exec +title: docker container exec +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/container_export.md b/engine/reference/commandline/container_export.md new file mode 100644 index 00000000000..67d383d8866 --- /dev/null +++ b/engine/reference/commandline/container_export.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_container_export +title: docker container export +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/container_inspect.md b/engine/reference/commandline/container_inspect.md new file mode 100644 index 00000000000..ac2110e2390 --- /dev/null +++ b/engine/reference/commandline/container_inspect.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_container_inspect +title: docker container inspect +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/container_kill.md b/engine/reference/commandline/container_kill.md new file mode 100644 index 00000000000..d9bcd8c7a2b --- /dev/null +++ b/engine/reference/commandline/container_kill.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_container_kill +title: docker container kill +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/container_logs.md b/engine/reference/commandline/container_logs.md new file mode 100644 index 00000000000..55e92f39491 --- /dev/null +++ b/engine/reference/commandline/container_logs.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_container_logs +title: docker container logs +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/container_ls.md b/engine/reference/commandline/container_ls.md new file mode 100644 index 00000000000..e7ae7a5d708 --- /dev/null +++ b/engine/reference/commandline/container_ls.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_container_ls +title: docker container ls +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/container_pause.md b/engine/reference/commandline/container_pause.md new file mode 100644 index 00000000000..6d8c7fc652e --- /dev/null +++ b/engine/reference/commandline/container_pause.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_container_pause +title: docker container pause +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/container_port.md b/engine/reference/commandline/container_port.md new file mode 100644 index 00000000000..5a00bed24a1 --- /dev/null +++ b/engine/reference/commandline/container_port.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_container_port +title: docker container port +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/container_prune.md b/engine/reference/commandline/container_prune.md index 2301353afa2..8005e0a5c0c 100644 --- a/engine/reference/commandline/container_prune.md +++ b/engine/reference/commandline/container_prune.md @@ -1,41 +1,15 @@ - +--- +datafolder: engine-cli +datafile: docker_container_prune +title: docker container prune +--- -# container prune + -Remove all stopped containers - -Options: - -f, --force Do not prompt for confirmation - --help Print usage -``` - -## Examples - -```bash -$ docker container prune -WARNING! This will remove all stopped containers. -Are you sure you want to continue? [y/N] y -Deleted Containers: -4a7f7eebae0f63178aff7eb0aa39cd3f0627a203ab2df258c1a00b456cf20063 -f98f9c2aa1eaf727e4ec9c0283bc7d4aa4762fbdba7f26191f26c97f64090360 - -Total reclaimed space: 212 B -``` - -## Related information - -* [system df](system_df.md) -* [volume prune](volume_prune.md) -* [image prune](image_prune.md) -* [system prune](system_prune.md) +{% include cli.md %} diff --git a/engine/reference/commandline/container_rename.md b/engine/reference/commandline/container_rename.md new file mode 100644 index 00000000000..629b10fa301 --- /dev/null +++ b/engine/reference/commandline/container_rename.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_container_rename +title: docker container rename +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/container_restart.md b/engine/reference/commandline/container_restart.md new file mode 100644 index 00000000000..d6fa3947134 --- /dev/null +++ b/engine/reference/commandline/container_restart.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_container_restart +title: docker container restart +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/container_rm.md b/engine/reference/commandline/container_rm.md new file mode 100644 index 00000000000..b17168450a8 --- /dev/null +++ b/engine/reference/commandline/container_rm.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_container_rm +title: docker container rm +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/container_run.md b/engine/reference/commandline/container_run.md new file mode 100644 index 00000000000..78344e8285f --- /dev/null +++ b/engine/reference/commandline/container_run.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_container_run +title: docker container run +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/container_start.md b/engine/reference/commandline/container_start.md new file mode 100644 index 00000000000..ddcc2cec1fd --- /dev/null +++ b/engine/reference/commandline/container_start.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_container_start +title: docker container start +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/container_stats.md b/engine/reference/commandline/container_stats.md new file mode 100644 index 00000000000..26bf990bdcd --- /dev/null +++ b/engine/reference/commandline/container_stats.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_container_stats +title: docker container stats +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/container_stop.md b/engine/reference/commandline/container_stop.md new file mode 100644 index 00000000000..79a187fd5bf --- /dev/null +++ b/engine/reference/commandline/container_stop.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_container_stop +title: docker container stop +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/container_top.md b/engine/reference/commandline/container_top.md new file mode 100644 index 00000000000..42fc4ceb162 --- /dev/null +++ b/engine/reference/commandline/container_top.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_container_top +title: docker container top +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/container_unpause.md b/engine/reference/commandline/container_unpause.md new file mode 100644 index 00000000000..4d2a33dc0a4 --- /dev/null +++ b/engine/reference/commandline/container_unpause.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_container_unpause +title: docker container unpause +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/container_update.md b/engine/reference/commandline/container_update.md new file mode 100644 index 00000000000..eb1ee8ea8b0 --- /dev/null +++ b/engine/reference/commandline/container_update.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_container_update +title: docker container update +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/container_wait.md b/engine/reference/commandline/container_wait.md new file mode 100644 index 00000000000..4ec54625921 --- /dev/null +++ b/engine/reference/commandline/container_wait.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_container_wait +title: docker container wait +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/cp.md b/engine/reference/commandline/cp.md new file mode 100644 index 00000000000..8a984d9e994 --- /dev/null +++ b/engine/reference/commandline/cp.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_cp +title: docker cp +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/create.md b/engine/reference/commandline/create.md new file mode 100644 index 00000000000..d5c2cfd5ab0 --- /dev/null +++ b/engine/reference/commandline/create.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_create +title: docker create +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/deploy.md b/engine/reference/commandline/deploy.md new file mode 100644 index 00000000000..f371a91a62a --- /dev/null +++ b/engine/reference/commandline/deploy.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_deploy +title: docker deploy +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/diff.md b/engine/reference/commandline/diff.md new file mode 100644 index 00000000000..186b5b791f9 --- /dev/null +++ b/engine/reference/commandline/diff.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_diff +title: docker diff +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/docker.md b/engine/reference/commandline/docker.md new file mode 100644 index 00000000000..f22799439d9 --- /dev/null +++ b/engine/reference/commandline/docker.md @@ -0,0 +1,17 @@ +--- +datafolder: engine-cli +datafile: docker +title: docker +redirect_from: +- /engine/reference/commandline/ +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/dockerd.md b/engine/reference/commandline/dockerd.md new file mode 100644 index 00000000000..258c90f669b --- /dev/null +++ b/engine/reference/commandline/dockerd.md @@ -0,0 +1,22 @@ +--- +redirect_from: +- /reference/commandline/dockerd/ +- /reference/commandline/daemon/ +- /engine/reference/commandline/daemon/ +description: The daemon command description and usage +keywords: +- container, daemon, runtime +title: dockerd +datafolder: dockerd-cli +datafile: dockerd +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/events.md b/engine/reference/commandline/events.md new file mode 100644 index 00000000000..40cd17ff1a5 --- /dev/null +++ b/engine/reference/commandline/events.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_events +title: docker events +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/exec.md b/engine/reference/commandline/exec.md new file mode 100644 index 00000000000..397ee9aeed8 --- /dev/null +++ b/engine/reference/commandline/exec.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_exec +title: docker exec +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/export.md b/engine/reference/commandline/export.md new file mode 100644 index 00000000000..6fb2f79ee26 --- /dev/null +++ b/engine/reference/commandline/export.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_export +title: docker export +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/history.md b/engine/reference/commandline/history.md new file mode 100644 index 00000000000..c5491c4b276 --- /dev/null +++ b/engine/reference/commandline/history.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_history +title: docker history +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/image.md b/engine/reference/commandline/image.md new file mode 100644 index 00000000000..02136fb3b7d --- /dev/null +++ b/engine/reference/commandline/image.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_image +title: docker image +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/image_build.md b/engine/reference/commandline/image_build.md new file mode 100644 index 00000000000..0b2eb54c841 --- /dev/null +++ b/engine/reference/commandline/image_build.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_image_build +title: docker image build +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/image_history.md b/engine/reference/commandline/image_history.md new file mode 100644 index 00000000000..8a4b7063dcb --- /dev/null +++ b/engine/reference/commandline/image_history.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_image_history +title: docker image history +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/image_import.md b/engine/reference/commandline/image_import.md new file mode 100644 index 00000000000..bbd0abe245b --- /dev/null +++ b/engine/reference/commandline/image_import.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_image_import +title: docker image import +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/image_inspect.md b/engine/reference/commandline/image_inspect.md new file mode 100644 index 00000000000..9fab2e9b951 --- /dev/null +++ b/engine/reference/commandline/image_inspect.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_image_inspect +title: docker image inspect +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/image_load.md b/engine/reference/commandline/image_load.md new file mode 100644 index 00000000000..d48334568cf --- /dev/null +++ b/engine/reference/commandline/image_load.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_image_load +title: docker image load +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/image_ls.md b/engine/reference/commandline/image_ls.md new file mode 100644 index 00000000000..14bc5947e8b --- /dev/null +++ b/engine/reference/commandline/image_ls.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_image_ls +title: docker image ls +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/image_prune.md b/engine/reference/commandline/image_prune.md index 85bd8ce1a66..651ed413f5a 100644 --- a/engine/reference/commandline/image_prune.md +++ b/engine/reference/commandline/image_prune.md @@ -1,65 +1,15 @@ - +--- +datafolder: engine-cli +datafile: docker_image_prune +title: docker image prune +--- -# image prune + -Remove unused images - -Options: - -a, --all Remove all unused images, not just dangling ones - -f, --force Do not prompt for confirmation - --help Print usage -``` - -Remove all dangling images. If `-a` is specified, will also remove all images not referenced by any container. - -Example output: - -```bash -$ docker image prune -a -WARNING! This will remove all images without at least one container associated to them. -Are you sure you want to continue? [y/N] y -Deleted Images: -untagged: alpine:latest -untagged: alpine@sha256:3dcdb92d7432d56604d4545cbd324b14e647b313626d99b889d0626de158f73a -deleted: sha256:4e38e38c8ce0b8d9041a9c4fefe786631d1416225e13b0bfe8cfa2321aec4bba -deleted: sha256:4fe15f8d0ae69e169824f25f1d4da3015a48feeeeebb265cd2e328e15c6a869f -untagged: alpine:3.3 -untagged: alpine@sha256:4fa633f4feff6a8f02acfc7424efd5cb3e76686ed3218abf4ca0fa4a2a358423 -untagged: my-jq:latest -deleted: sha256:ae67841be6d008a374eff7c2a974cde3934ffe9536a7dc7ce589585eddd83aff -deleted: sha256:34f6f1261650bc341eb122313372adc4512b4fceddc2a7ecbb84f0958ce5ad65 -deleted: sha256:cf4194e8d8db1cb2d117df33f2c75c0369c3a26d96725efb978cc69e046b87e7 -untagged: my-curl:latest -deleted: sha256:b2789dd875bf427de7f9f6ae001940073b3201409b14aba7e5db71f408b8569e -deleted: sha256:96daac0cb203226438989926fc34dd024f365a9a8616b93e168d303cfe4cb5e9 -deleted: sha256:5cbd97a14241c9cd83250d6b6fc0649833c4a3e84099b968dd4ba403e609945e -deleted: sha256:a0971c4015c1e898c60bf95781c6730a05b5d8a2ae6827f53837e6c9d38efdec -deleted: sha256:d8359ca3b681cc5396a4e790088441673ed3ce90ebc04de388bfcd31a0716b06 -deleted: sha256:83fc9ba8fb70e1da31dfcc3c88d093831dbd4be38b34af998df37e8ac538260c -deleted: sha256:ae7041a4cc625a9c8e6955452f7afe602b401f662671cea3613f08f3d9343b35 -deleted: sha256:35e0f43a37755b832f0bbea91a2360b025ee351d7309dae0d9737bc96b6d0809 -deleted: sha256:0af941dd29f00e4510195dd00b19671bc591e29d1495630e7e0f7c44c1e6a8c0 -deleted: sha256:9fc896fc2013da84f84e45b3096053eb084417b42e6b35ea0cce5a3529705eac -deleted: sha256:47cf20d8c26c46fff71be614d9f54997edacfe8d46d51769706e5aba94b16f2b -deleted: sha256:2c675ee9ed53425e31a13e3390bf3f539bf8637000e4bcfbb85ee03ef4d910a1 - -Total reclaimed space: 16.43 MB -``` - -## Related information - -* [system df](system_df.md) -* [container prune](container_prune.md) -* [volume prune](volume_prune.md) -* [system prune](system_prune.md) +{% include cli.md %} diff --git a/engine/reference/commandline/image_pull.md b/engine/reference/commandline/image_pull.md new file mode 100644 index 00000000000..3a2cad8f4b9 --- /dev/null +++ b/engine/reference/commandline/image_pull.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_image_pull +title: docker image pull +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/image_push.md b/engine/reference/commandline/image_push.md new file mode 100644 index 00000000000..b948a186ac2 --- /dev/null +++ b/engine/reference/commandline/image_push.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_image_push +title: docker image push +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/image_rm.md b/engine/reference/commandline/image_rm.md new file mode 100644 index 00000000000..642a31a2796 --- /dev/null +++ b/engine/reference/commandline/image_rm.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_image_rm +title: docker image rm +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/image_save.md b/engine/reference/commandline/image_save.md new file mode 100644 index 00000000000..c1b4d330816 --- /dev/null +++ b/engine/reference/commandline/image_save.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_image_save +title: docker image save +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/image_tag.md b/engine/reference/commandline/image_tag.md new file mode 100644 index 00000000000..2b58ab66010 --- /dev/null +++ b/engine/reference/commandline/image_tag.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_image_tag +title: docker image tag +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/images.md b/engine/reference/commandline/images.md new file mode 100644 index 00000000000..d05c07a83d1 --- /dev/null +++ b/engine/reference/commandline/images.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_images +title: docker images +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/import.md b/engine/reference/commandline/import.md new file mode 100644 index 00000000000..f111f1d955a --- /dev/null +++ b/engine/reference/commandline/import.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_import +title: docker import +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/info.md b/engine/reference/commandline/info.md new file mode 100644 index 00000000000..c8d8a018f93 --- /dev/null +++ b/engine/reference/commandline/info.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_info +title: docker info +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/inspect.md b/engine/reference/commandline/inspect.md new file mode 100644 index 00000000000..bf668cedfb7 --- /dev/null +++ b/engine/reference/commandline/inspect.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_inspect +title: docker inspect +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/kill.md b/engine/reference/commandline/kill.md new file mode 100644 index 00000000000..cef10a2f426 --- /dev/null +++ b/engine/reference/commandline/kill.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_kill +title: docker kill +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/load.md b/engine/reference/commandline/load.md new file mode 100644 index 00000000000..c617b1ad513 --- /dev/null +++ b/engine/reference/commandline/load.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_load +title: docker load +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/login.md b/engine/reference/commandline/login.md new file mode 100644 index 00000000000..628aa486444 --- /dev/null +++ b/engine/reference/commandline/login.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_login +title: docker login +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/logout.md b/engine/reference/commandline/logout.md new file mode 100644 index 00000000000..6c85bb4688d --- /dev/null +++ b/engine/reference/commandline/logout.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_logout +title: docker logout +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/logs.md b/engine/reference/commandline/logs.md new file mode 100644 index 00000000000..0940c22b330 --- /dev/null +++ b/engine/reference/commandline/logs.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_logs +title: docker logs +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/network.md b/engine/reference/commandline/network.md new file mode 100644 index 00000000000..c3fe473a8b6 --- /dev/null +++ b/engine/reference/commandline/network.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_network +title: docker network +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/network_connect.md b/engine/reference/commandline/network_connect.md new file mode 100644 index 00000000000..ac389c151e6 --- /dev/null +++ b/engine/reference/commandline/network_connect.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_network_connect +title: docker network connect +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/network_create.md b/engine/reference/commandline/network_create.md new file mode 100644 index 00000000000..794fe5d731a --- /dev/null +++ b/engine/reference/commandline/network_create.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_network_create +title: docker network create +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/network_disconnect.md b/engine/reference/commandline/network_disconnect.md new file mode 100644 index 00000000000..39c7b4e8989 --- /dev/null +++ b/engine/reference/commandline/network_disconnect.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_network_disconnect +title: docker network disconnect +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/network_inspect.md b/engine/reference/commandline/network_inspect.md new file mode 100644 index 00000000000..0a3e2aaf6b2 --- /dev/null +++ b/engine/reference/commandline/network_inspect.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_network_inspect +title: docker network inspect +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/network_ls.md b/engine/reference/commandline/network_ls.md new file mode 100644 index 00000000000..08ff5222f76 --- /dev/null +++ b/engine/reference/commandline/network_ls.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_network_ls +title: docker network ls +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/network_prune.md b/engine/reference/commandline/network_prune.md new file mode 100644 index 00000000000..a0a88a5bbec --- /dev/null +++ b/engine/reference/commandline/network_prune.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_network_prune +title: docker network prune +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/network_rm.md b/engine/reference/commandline/network_rm.md new file mode 100644 index 00000000000..0245a9495a5 --- /dev/null +++ b/engine/reference/commandline/network_rm.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_network_rm +title: docker network rm +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/node.md b/engine/reference/commandline/node.md new file mode 100644 index 00000000000..39a63b330fd --- /dev/null +++ b/engine/reference/commandline/node.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_node +title: docker node +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/node_demote.md b/engine/reference/commandline/node_demote.md new file mode 100644 index 00000000000..13f024b8678 --- /dev/null +++ b/engine/reference/commandline/node_demote.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_node_demote +title: docker node demote +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/node_inspect.md b/engine/reference/commandline/node_inspect.md new file mode 100644 index 00000000000..1335ea40a3d --- /dev/null +++ b/engine/reference/commandline/node_inspect.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_node_inspect +title: docker node inspect +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/node_ls.md b/engine/reference/commandline/node_ls.md new file mode 100644 index 00000000000..eb55fdd3ea1 --- /dev/null +++ b/engine/reference/commandline/node_ls.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_node_ls +title: docker node ls +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/node_promote.md b/engine/reference/commandline/node_promote.md new file mode 100644 index 00000000000..bbabeb81bcb --- /dev/null +++ b/engine/reference/commandline/node_promote.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_node_promote +title: docker node promote +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/node_ps.md b/engine/reference/commandline/node_ps.md new file mode 100644 index 00000000000..3e73e29f0a3 --- /dev/null +++ b/engine/reference/commandline/node_ps.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_node_ps +title: docker node ps +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/node_rm.md b/engine/reference/commandline/node_rm.md new file mode 100644 index 00000000000..a710b3813a5 --- /dev/null +++ b/engine/reference/commandline/node_rm.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_node_rm +title: docker node rm +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/node_update.md b/engine/reference/commandline/node_update.md new file mode 100644 index 00000000000..cc2b60b1058 --- /dev/null +++ b/engine/reference/commandline/node_update.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_node_update +title: docker node update +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/pause.md b/engine/reference/commandline/pause.md new file mode 100644 index 00000000000..cb9513becc4 --- /dev/null +++ b/engine/reference/commandline/pause.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_pause +title: docker pause +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/plugin.md b/engine/reference/commandline/plugin.md new file mode 100644 index 00000000000..4bac6e71be9 --- /dev/null +++ b/engine/reference/commandline/plugin.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_plugin +title: docker plugin +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/plugin_create.md b/engine/reference/commandline/plugin_create.md new file mode 100644 index 00000000000..befd581c53b --- /dev/null +++ b/engine/reference/commandline/plugin_create.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_plugin_create +title: docker plugin create +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/plugin_disable.md b/engine/reference/commandline/plugin_disable.md new file mode 100644 index 00000000000..c9a55617971 --- /dev/null +++ b/engine/reference/commandline/plugin_disable.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_plugin_disable +title: docker plugin disable +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/plugin_enable.md b/engine/reference/commandline/plugin_enable.md new file mode 100644 index 00000000000..79944722ed9 --- /dev/null +++ b/engine/reference/commandline/plugin_enable.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_plugin_enable +title: docker plugin enable +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/plugin_inspect.md b/engine/reference/commandline/plugin_inspect.md new file mode 100644 index 00000000000..891fe02bb78 --- /dev/null +++ b/engine/reference/commandline/plugin_inspect.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_plugin_inspect +title: docker plugin inspect +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/plugin_install.md b/engine/reference/commandline/plugin_install.md new file mode 100644 index 00000000000..fc8babfbb39 --- /dev/null +++ b/engine/reference/commandline/plugin_install.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_plugin_install +title: docker plugin install +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/plugin_ls.md b/engine/reference/commandline/plugin_ls.md new file mode 100644 index 00000000000..d4bc115e887 --- /dev/null +++ b/engine/reference/commandline/plugin_ls.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_plugin_ls +title: docker plugin ls +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/plugin_push.md b/engine/reference/commandline/plugin_push.md new file mode 100644 index 00000000000..87fb890bc13 --- /dev/null +++ b/engine/reference/commandline/plugin_push.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_plugin_push +title: docker plugin push +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/plugin_rm.md b/engine/reference/commandline/plugin_rm.md new file mode 100644 index 00000000000..72bf8c7a27d --- /dev/null +++ b/engine/reference/commandline/plugin_rm.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_plugin_rm +title: docker plugin rm +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/plugin_set.md b/engine/reference/commandline/plugin_set.md new file mode 100644 index 00000000000..b1ed6a964a5 --- /dev/null +++ b/engine/reference/commandline/plugin_set.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_plugin_set +title: docker plugin set +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/port.md b/engine/reference/commandline/port.md new file mode 100644 index 00000000000..48edce05fc7 --- /dev/null +++ b/engine/reference/commandline/port.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_port +title: docker port +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/ps.md b/engine/reference/commandline/ps.md new file mode 100644 index 00000000000..907ceeb7e32 --- /dev/null +++ b/engine/reference/commandline/ps.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_ps +title: docker ps +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/pull.md b/engine/reference/commandline/pull.md new file mode 100644 index 00000000000..c46c2eee0e5 --- /dev/null +++ b/engine/reference/commandline/pull.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_pull +title: docker pull +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/push.md b/engine/reference/commandline/push.md new file mode 100644 index 00000000000..8d043a853e5 --- /dev/null +++ b/engine/reference/commandline/push.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_push +title: docker push +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/rename.md b/engine/reference/commandline/rename.md new file mode 100644 index 00000000000..391344d8029 --- /dev/null +++ b/engine/reference/commandline/rename.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_rename +title: docker rename +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/restart.md b/engine/reference/commandline/restart.md new file mode 100644 index 00000000000..1337fc656de --- /dev/null +++ b/engine/reference/commandline/restart.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_restart +title: docker restart +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/rm.md b/engine/reference/commandline/rm.md new file mode 100644 index 00000000000..7003242c542 --- /dev/null +++ b/engine/reference/commandline/rm.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_rm +title: docker rm +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/rmi.md b/engine/reference/commandline/rmi.md new file mode 100644 index 00000000000..21948589355 --- /dev/null +++ b/engine/reference/commandline/rmi.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_rmi +title: docker rmi +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/run.md b/engine/reference/commandline/run.md new file mode 100644 index 00000000000..71c486399cf --- /dev/null +++ b/engine/reference/commandline/run.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_run +title: docker run +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/save.md b/engine/reference/commandline/save.md new file mode 100644 index 00000000000..1542271585f --- /dev/null +++ b/engine/reference/commandline/save.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_save +title: docker save +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/search.md b/engine/reference/commandline/search.md new file mode 100644 index 00000000000..6f3b6aeda08 --- /dev/null +++ b/engine/reference/commandline/search.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_search +title: docker search +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/secret.md b/engine/reference/commandline/secret.md new file mode 100644 index 00000000000..67ca42b5bdd --- /dev/null +++ b/engine/reference/commandline/secret.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_secret +title: docker secret +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/secret_create.md b/engine/reference/commandline/secret_create.md new file mode 100644 index 00000000000..d50a69fc740 --- /dev/null +++ b/engine/reference/commandline/secret_create.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_secret_create +title: docker secret create +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/secret_inspect.md b/engine/reference/commandline/secret_inspect.md new file mode 100644 index 00000000000..8ec9c9f7e78 --- /dev/null +++ b/engine/reference/commandline/secret_inspect.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_secret_inspect +title: docker secret inspect +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/secret_ls.md b/engine/reference/commandline/secret_ls.md new file mode 100644 index 00000000000..fd7d2575a99 --- /dev/null +++ b/engine/reference/commandline/secret_ls.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_secret_ls +title: docker secret ls +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/secret_rm.md b/engine/reference/commandline/secret_rm.md new file mode 100644 index 00000000000..eccc9f2f79a --- /dev/null +++ b/engine/reference/commandline/secret_rm.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_secret_rm +title: docker secret rm +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/service.md b/engine/reference/commandline/service.md new file mode 100644 index 00000000000..902f62f92d9 --- /dev/null +++ b/engine/reference/commandline/service.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_service +title: docker service +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/service_create.md b/engine/reference/commandline/service_create.md new file mode 100644 index 00000000000..0d543360992 --- /dev/null +++ b/engine/reference/commandline/service_create.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_service_create +title: docker service create +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/service_inspect.md b/engine/reference/commandline/service_inspect.md new file mode 100644 index 00000000000..aef31b7a9cf --- /dev/null +++ b/engine/reference/commandline/service_inspect.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_service_inspect +title: docker service inspect +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/service_logs.md b/engine/reference/commandline/service_logs.md new file mode 100644 index 00000000000..81fc499a3ab --- /dev/null +++ b/engine/reference/commandline/service_logs.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_service_logs +title: docker service logs +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/service_ls.md b/engine/reference/commandline/service_ls.md new file mode 100644 index 00000000000..c7addac01db --- /dev/null +++ b/engine/reference/commandline/service_ls.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_service_ls +title: docker service ls +--- + +{% include cli.md %} diff --git a/engine/reference/commandline/service_ps.md b/engine/reference/commandline/service_ps.md new file mode 100644 index 00000000000..818e6530242 --- /dev/null +++ b/engine/reference/commandline/service_ps.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_service_ps +title: docker service ps +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/service_rm.md b/engine/reference/commandline/service_rm.md new file mode 100644 index 00000000000..96fc51d7f76 --- /dev/null +++ b/engine/reference/commandline/service_rm.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_service_rm +title: docker service rm +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/service_scale.md b/engine/reference/commandline/service_scale.md new file mode 100644 index 00000000000..c57e7236f9f --- /dev/null +++ b/engine/reference/commandline/service_scale.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_service_scale +title: docker service scale +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/service_update.md b/engine/reference/commandline/service_update.md new file mode 100644 index 00000000000..39a0dede996 --- /dev/null +++ b/engine/reference/commandline/service_update.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_service_update +title: docker service update +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/stack.md b/engine/reference/commandline/stack.md new file mode 100644 index 00000000000..769c917d4d4 --- /dev/null +++ b/engine/reference/commandline/stack.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_stack +title: docker stack +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/stack_deploy.md b/engine/reference/commandline/stack_deploy.md new file mode 100644 index 00000000000..97070078a4e --- /dev/null +++ b/engine/reference/commandline/stack_deploy.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_stack_deploy +title: docker stack deploy +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/stack_ls.md b/engine/reference/commandline/stack_ls.md index 11abc347272..d1ee2f00c29 100644 --- a/engine/reference/commandline/stack_ls.md +++ b/engine/reference/commandline/stack_ls.md @@ -1,37 +1,15 @@ - +--- +datafolder: engine-cli +datafile: docker_stack_ls +title: docker stack ls +--- -# stack ls (experimental) + -List stacks -``` - -Lists the stacks. - -For example, the following command shows all stacks and some additional information: - -```bash -$ docker stack ls - -ID SERVICES -vossibility-stack 6 -myapp 2 -``` - -## Related information - -* [stack config](stack_config.md) -* [stack deploy](stack_deploy.md) -* [stack rm](stack_rm.md) -* [stack tasks](stack_tasks.md) +{% include cli.md %} diff --git a/engine/reference/commandline/stack_ps.md b/engine/reference/commandline/stack_ps.md new file mode 100644 index 00000000000..55be606d4a0 --- /dev/null +++ b/engine/reference/commandline/stack_ps.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_stack_ps +title: docker stack ps +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/stack_rm.md b/engine/reference/commandline/stack_rm.md new file mode 100644 index 00000000000..cad70891529 --- /dev/null +++ b/engine/reference/commandline/stack_rm.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_stack_rm +title: docker stack rm +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/stack_services.md b/engine/reference/commandline/stack_services.md new file mode 100644 index 00000000000..5ef1d3f5f76 --- /dev/null +++ b/engine/reference/commandline/stack_services.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_stack_services +title: docker stack services +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/start.md b/engine/reference/commandline/start.md new file mode 100644 index 00000000000..99d2fa83551 --- /dev/null +++ b/engine/reference/commandline/start.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_start +title: docker start +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/stats.md b/engine/reference/commandline/stats.md new file mode 100644 index 00000000000..f6bd6234fdf --- /dev/null +++ b/engine/reference/commandline/stats.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_stats +title: docker stats +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/stop.md b/engine/reference/commandline/stop.md new file mode 100644 index 00000000000..18930aa4829 --- /dev/null +++ b/engine/reference/commandline/stop.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_stop +title: docker stop +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/swarm.md b/engine/reference/commandline/swarm.md new file mode 100644 index 00000000000..c011a37f838 --- /dev/null +++ b/engine/reference/commandline/swarm.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_swarm +title: docker swarm +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/swarm_init.md b/engine/reference/commandline/swarm_init.md new file mode 100644 index 00000000000..581fb44b4fb --- /dev/null +++ b/engine/reference/commandline/swarm_init.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_swarm_init +title: docker swarm init +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/swarm_join-token.md b/engine/reference/commandline/swarm_join-token.md new file mode 100644 index 00000000000..3cefaff2b6a --- /dev/null +++ b/engine/reference/commandline/swarm_join-token.md @@ -0,0 +1,17 @@ +--- +datafolder: engine-cli +datafile: docker_swarm_join-token +title: docker swarm join-token +redirect_from: +- /engine/reference/commandline/swarm_join_token/ +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/swarm_join.md b/engine/reference/commandline/swarm_join.md new file mode 100644 index 00000000000..23f189f751c --- /dev/null +++ b/engine/reference/commandline/swarm_join.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_swarm_join +title: docker swarm join +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/swarm_leave.md b/engine/reference/commandline/swarm_leave.md new file mode 100644 index 00000000000..2af6b1864de --- /dev/null +++ b/engine/reference/commandline/swarm_leave.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_swarm_leave +title: docker swarm leave +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/swarm_unlock-key.md b/engine/reference/commandline/swarm_unlock-key.md new file mode 100644 index 00000000000..3ebbcba89c7 --- /dev/null +++ b/engine/reference/commandline/swarm_unlock-key.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_swarm_unlock-key +title: docker swarm unlock-key +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/swarm_unlock.md b/engine/reference/commandline/swarm_unlock.md new file mode 100644 index 00000000000..7aba9c40fee --- /dev/null +++ b/engine/reference/commandline/swarm_unlock.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_swarm_unlock +title: docker swarm unlock +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/swarm_update.md b/engine/reference/commandline/swarm_update.md new file mode 100644 index 00000000000..239815838b8 --- /dev/null +++ b/engine/reference/commandline/swarm_update.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_swarm_update +title: docker swarm update +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/system.md b/engine/reference/commandline/system.md new file mode 100644 index 00000000000..10fc80614dd --- /dev/null +++ b/engine/reference/commandline/system.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_system +title: docker system +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/system_df.md b/engine/reference/commandline/system_df.md index 9f03dc8250b..4de1cdd5557 100644 --- a/engine/reference/commandline/system_df.md +++ b/engine/reference/commandline/system_df.md @@ -1,68 +1,15 @@ - +--- +datafolder: engine-cli +datafile: docker_system_df +title: docker system df +--- -# system df + -Show docker filesystem usage - -Options: - --help Print usage - -v, --verbose Show detailed information on space usage -``` - -The `docker system df` command displays information regarding the -amount of disk space used by the docker daemon. - -By default the command will just show a summary of the data used: -```bash -$ docker system df -TYPE TOTAL ACTIVE SIZE RECLAIMABLE -Images 5 2 16.43 MB 11.63 MB (70%) -Containers 2 0 212 B 212 B (100%) -Local Volumes 2 1 36 B 0 B (0%) -``` - -A more detailed view can be requested using the `-v, --verbose` flag: -```bash -$ docker system df -v -Images space usage: - -REPOSITORY TAG IMAGE ID CREATED SIZE SHARED SIZE UNIQUE SIZE CONTAINERS -my-curl latest b2789dd875bf 6 minutes ago 11 MB 11 MB 5 B 0 -my-jq latest ae67841be6d0 6 minutes ago 9.623 MB 8.991 MB 632.1 kB 0 - a0971c4015c1 6 minutes ago 11 MB 11 MB 0 B 0 -alpine latest 4e38e38c8ce0 9 weeks ago 4.799 MB 0 B 4.799 MB 1 -alpine 3.3 47cf20d8c26c 9 weeks ago 4.797 MB 4.797 MB 0 B 1 - -Containers space usage: - -CONTAINER ID IMAGE COMMAND LOCAL VOLUMES SIZE CREATED STATUS NAMES -4a7f7eebae0f alpine:latest "sh" 1 0 B 16 minutes ago Exited (0) 5 minutes ago hopeful_yalow -f98f9c2aa1ea alpine:3.3 "sh" 1 212 B 16 minutes ago Exited (0) 48 seconds ago anon-vol - -Local Volumes space usage: - -NAME LINKS SIZE -07c7bdf3e34ab76d921894c2b834f073721fccfbbcba792aa7648e3a7a664c2e 2 36 B -my-named-vol 0 0 B -``` - -* `SHARED SIZE` is the amount of space that an image shares with another one (i.e. their common data) -* `UNIQUE SIZE` is the amount of space that is only used by a given image -* `SIZE` is the virtual size of the image, it is the sum of `SHARED SIZE` and `UNIQUE SIZE` - -## Related Information -* [system prune](system_prune.md) -* [container prune](container_prune.md) -* [volume prune](volume_prune.md) -* [image prune](image_prune.md) +{% include cli.md %} diff --git a/engine/reference/commandline/system_events.md b/engine/reference/commandline/system_events.md new file mode 100644 index 00000000000..1d43a8c2e9a --- /dev/null +++ b/engine/reference/commandline/system_events.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_system_events +title: docker system events +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/system_info.md b/engine/reference/commandline/system_info.md new file mode 100644 index 00000000000..b23d898b457 --- /dev/null +++ b/engine/reference/commandline/system_info.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_system_info +title: docker system info +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/system_prune.md b/engine/reference/commandline/system_prune.md index 3ba73ee8182..c4af2476d6d 100644 --- a/engine/reference/commandline/system_prune.md +++ b/engine/reference/commandline/system_prune.md @@ -1,70 +1,15 @@ - +--- +datafolder: engine-cli +datafile: docker_system_prune +title: docker system prune +--- -# system prune + -Delete unused data - -Options: - -a, --all Remove all unused images not just dangling ones - -f, --force Do not prompt for confirmation - --help Print usage -``` - -Remove all unused containers, volumes and images (both dangling and unreferenced). - -Example output: - -```bash -$ docker system prune -a -WARNING! This will remove: - - all stopped containers - - all volumes not used by at least one container - - all images without at least one container associated to them -Are you sure you want to continue? [y/N] y -Deleted Containers:0998aa37185a1a7036b0e12cf1ac1b6442dcfa30a5c9650a42ed5010046f195b -73958bfb884fa81fa4cc6baf61055667e940ea2357b4036acbbe25a60f442a4d - -Deleted Volumes: -named-vol - -Deleted Images: -untagged: my-curl:latest -deleted: sha256:7d88582121f2a29031d92017754d62a0d1a215c97e8f0106c586546e7404447d -deleted: sha256:dd14a93d83593d4024152f85d7c63f76aaa4e73e228377ba1d130ef5149f4d8b -untagged: alpine:3.3 -deleted: sha256:695f3d04125db3266d4ab7bbb3c6b23aa4293923e762aa2562c54f49a28f009f -untagged: alpine:latest -deleted: sha256:ee4603260daafe1a8c2f3b78fd760922918ab2441cbb2853ed5c439e59c52f96 -deleted: sha256:9007f5987db353ec398a223bc5a135c5a9601798ba20a1abba537ea2f8ac765f -deleted: sha256:71fa90c8f04769c9721459d5aa0936db640b92c8c91c9b589b54abd412d120ab -deleted: sha256:bb1c3357b3c30ece26e6604aea7d2ec0ace4166ff34c3616701279c22444c0f3 -untagged: my-jq:latest -deleted: sha256:6e66d724542af9bc4c4abf4a909791d7260b6d0110d8e220708b09e4ee1322e1 -deleted: sha256:07b3fa89d4b17009eb3988dfc592c7d30ab3ba52d2007832dffcf6d40e3eda7f -deleted: sha256:3a88a5c81eb5c283e72db2dbc6d65cbfd8e80b6c89bb6e714cfaaa0eed99c548 - -Total reclaimed space: 13.5 MB -``` - -## Related information - -* [volume create](volume_create.md) -* [volume ls](volume_ls.md) -* [volume inspect](volume_inspect.md) -* [volume rm](volume_rm.md) -* [Understand Data Volumes](../../tutorials/dockervolumes.md) -* [system df](system_df.md) -* [container prune](container_prune.md) -* [image prune](image_prune.md) -* [system prune](system_prune.md) +{% include cli.md %} diff --git a/engine/reference/commandline/tag.md b/engine/reference/commandline/tag.md new file mode 100644 index 00000000000..cea0ad21a9c --- /dev/null +++ b/engine/reference/commandline/tag.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_tag +title: docker tag +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/top.md b/engine/reference/commandline/top.md new file mode 100644 index 00000000000..bcffc1b351d --- /dev/null +++ b/engine/reference/commandline/top.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_top +title: docker top +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/unpause.md b/engine/reference/commandline/unpause.md new file mode 100644 index 00000000000..dcdd7b6b3a6 --- /dev/null +++ b/engine/reference/commandline/unpause.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_unpause +title: docker unpause +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/update.md b/engine/reference/commandline/update.md new file mode 100644 index 00000000000..37d5b41f812 --- /dev/null +++ b/engine/reference/commandline/update.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_update +title: docker update +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/version.md b/engine/reference/commandline/version.md new file mode 100644 index 00000000000..992d4b63628 --- /dev/null +++ b/engine/reference/commandline/version.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_version +title: docker version +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/volume.md b/engine/reference/commandline/volume.md new file mode 100644 index 00000000000..1175ff19f47 --- /dev/null +++ b/engine/reference/commandline/volume.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_volume +title: docker volume +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/volume_create.md b/engine/reference/commandline/volume_create.md new file mode 100644 index 00000000000..1fac4851ddc --- /dev/null +++ b/engine/reference/commandline/volume_create.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_volume_create +title: docker volume create +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/volume_inspect.md b/engine/reference/commandline/volume_inspect.md new file mode 100644 index 00000000000..792249589cc --- /dev/null +++ b/engine/reference/commandline/volume_inspect.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_volume_inspect +title: docker volume inspect +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/volume_ls.md b/engine/reference/commandline/volume_ls.md new file mode 100644 index 00000000000..9cb0a60f530 --- /dev/null +++ b/engine/reference/commandline/volume_ls.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_volume_ls +title: docker volume ls +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/volume_prune.md b/engine/reference/commandline/volume_prune.md index 4c6eab0d535..7a13344a90e 100644 --- a/engine/reference/commandline/volume_prune.md +++ b/engine/reference/commandline/volume_prune.md @@ -1,48 +1,15 @@ - +--- +datafolder: engine-cli +datafile: docker_volume_prune +title: docker volume prune +--- -# volume prune + -Remove all unused volumes - -Options: - -f, --force Do not prompt for confirmation - --help Print usage -``` - -Remove all unused volumes. Unused volumes are those which are not referenced by any containers - -Example output: - -```bash -$ docker volume prune -WARNING! This will remove all volumes not used by at least one container. -Are you sure you want to continue? [y/N] y -Deleted Volumes: -07c7bdf3e34ab76d921894c2b834f073721fccfbbcba792aa7648e3a7a664c2e -my-named-vol - -Total reclaimed space: 36 B -``` - -## Related information - -* [volume create](volume_create.md) -* [volume ls](volume_ls.md) -* [volume inspect](volume_inspect.md) -* [volume rm](volume_rm.md) -* [Understand Data Volumes](../../tutorials/dockervolumes.md) -* [system df](system_df.md) -* [container prune](container_prune.md) -* [image prune](image_prune.md) -* [system prune](system_prune.md) +{% include cli.md %} diff --git a/engine/reference/commandline/volume_rm.md b/engine/reference/commandline/volume_rm.md new file mode 100644 index 00000000000..aed0fe4fcd6 --- /dev/null +++ b/engine/reference/commandline/volume_rm.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_volume_rm +title: docker volume rm +--- + + + +{% include cli.md %} diff --git a/engine/reference/commandline/wait.md b/engine/reference/commandline/wait.md new file mode 100644 index 00000000000..81c1cbb4249 --- /dev/null +++ b/engine/reference/commandline/wait.md @@ -0,0 +1,15 @@ +--- +datafolder: engine-cli +datafile: docker_wait +title: docker wait +--- + + + +{% include cli.md %}