mirror of
https://github.com/clearlinux/docker.git
synced 2026-09-06 21:51:33 +00:00
Enabled GitHub Flavored Markdown
GitHub flavored markdown is now supported for links and images. Also, ran LinkChecker and FileResolver. Yay! Fixes from Spider check Output for docker/docker now goes into engine directory Signed-off-by: Mary Anthony <mary@docker.com>
This commit is contained in:
@@ -11,5 +11,5 @@ weight = 99
|
||||
|
||||
# Docker Hub API
|
||||
|
||||
This API is deprecated as of 1.7. To view the old version, see the [Docker Hub API](https://docs.docker.com/v1.7/reference/api/docker-io_api/) in the 1.7 documentation.
|
||||
This API is deprecated as of 1.7. To view the old version, see the [Docker Hub API](docker-io_api.md) in the 1.7 documentation.
|
||||
|
||||
|
||||
@@ -56,7 +56,7 @@ wget --no-check-certificate --certificate=$DOCKER_CERT_PATH/cert.pem --private-k
|
||||
|
||||
The following diagram depicts the container states accessible through the API.
|
||||
|
||||

|
||||

|
||||
|
||||
Some container-related events are not affected by container state, so they are not included in this diagram. These events are:
|
||||
|
||||
@@ -74,7 +74,7 @@ This section lists each version from latest to oldest. Each listing includes a
|
||||
|
||||
### v1.21 API changes
|
||||
|
||||
[Docker Remote API v1.21](/reference/api/docker_remote_api_v1.21/) documentation
|
||||
[Docker Remote API v1.21](docker_remote_api_v1.21.md) documentation
|
||||
|
||||
* `GET /volumes` lists volumes from all volume drivers.
|
||||
* `POST /volumes` to create a volume.
|
||||
@@ -95,7 +95,7 @@ list of DNS options to be used in the container.
|
||||
|
||||
### v1.20 API changes
|
||||
|
||||
[Docker Remote API v1.20](/reference/api/docker_remote_api_v1.20/) documentation
|
||||
[Docker Remote API v1.20](docker_remote_api_v1.20/) documentation
|
||||
|
||||
* `GET /containers/(id)/archive` get an archive of filesystem content from a container.
|
||||
* `PUT /containers/(id)/archive` upload an archive of content to be extracted to
|
||||
@@ -107,7 +107,7 @@ list of additional groups that the container process will run as.
|
||||
|
||||
### v1.19 API changes
|
||||
|
||||
[Docker Remote API v1.19](/reference/api/docker_remote_api_v1.19/) documentation
|
||||
[Docker Remote API v1.19](docker_remote_api_v1.19.md) documentation
|
||||
|
||||
* When the daemon detects a version mismatch with the client, usually when
|
||||
the client is newer than the daemon, an HTTP 400 is now returned instead
|
||||
@@ -121,7 +121,7 @@ end point now returns the new boolean fields `CpuCfsPeriod`, `CpuCfsQuota`, and
|
||||
|
||||
### v1.18 API changes
|
||||
|
||||
[Docker Remote API v1.18](/reference/api/docker_remote_api_v1.18/) documentation
|
||||
[Docker Remote API v1.18](docker_remote_api_v1.18.md) documentation
|
||||
|
||||
* `GET /version` now returns `Os`, `Arch` and `KernelVersion`.
|
||||
* `POST /containers/create` and `POST /containers/(id)/start`allow you to set ulimit settings for use in the container.
|
||||
@@ -134,7 +134,7 @@ end point now returns the new boolean fields `CpuCfsPeriod`, `CpuCfsQuota`, and
|
||||
|
||||
### v1.17 API changes
|
||||
|
||||
[Docker Remote API v1.17](/reference/api/docker_remote_api_v1.17/) documentation
|
||||
[Docker Remote API v1.17](docker_remote_api_v1.17.md) documentation
|
||||
|
||||
* The build supports `LABEL` command. Use this to add metadata to an image. For
|
||||
example you could add data describing the content of an image. `LABEL
|
||||
@@ -156,7 +156,7 @@ read only.
|
||||
|
||||
### v1.16 API changes
|
||||
|
||||
[Docker Remote API v1.16](/reference/api/docker_remote_api_v1.16/)
|
||||
[Docker Remote API v1.16](docker_remote_api_v1.16.md)
|
||||
|
||||
* `GET /info` returns the number of CPUs available on the machine (`NCPU`),
|
||||
total memory available (`MemTotal`), a user-friendly name describing the running Docker daemon (`Name`), a unique ID identifying the daemon (`ID`), and
|
||||
@@ -167,14 +167,14 @@ a list of daemon labels (`Labels`).
|
||||
|
||||
### v1.15 API changes
|
||||
|
||||
[Docker Remote API v1.15](/reference/api/docker_remote_api_v1.15/) documentation
|
||||
[Docker Remote API v1.15](docker_remote_api_v1.15.md) documentation
|
||||
|
||||
`POST /containers/create` you can set a container's `HostConfig` when creating a
|
||||
container. Previously this was only available when starting a container.
|
||||
|
||||
### v1.14 API changes
|
||||
|
||||
[Docker Remote API v1.14](/reference/api/docker_remote_api_v1.14/) documentation
|
||||
[Docker Remote API v1.14](docker_remote_api_v1.14.md) documentation
|
||||
|
||||
* `DELETE /containers/(id)` when using `force`, the container will be immediately killed with SIGKILL.
|
||||
* `POST /containers/(id)/start` the `hostConfig` option accepts the field `CapAdd`, which specifies a list of capabilities
|
||||
|
||||
@@ -506,7 +506,7 @@ Status Codes:
|
||||
|
||||
When using the TTY setting is enabled in
|
||||
[`POST /containers/create`
|
||||
](/reference/api/docker_remote_api_v1.9/#create-a-container "POST /containers/create"),
|
||||
](docker_remote_api_v1.9.md#create-a-container),
|
||||
the stream is the raw data from the process PTY and client's stdin.
|
||||
When the TTY is disabled, then the stream is multiplexed to separate
|
||||
stdout and stderr.
|
||||
@@ -1040,7 +1040,7 @@ Build an image from Dockerfile via stdin
|
||||
The archive must include a file called `Dockerfile`
|
||||
at its root. It may include any number of other files,
|
||||
which will be accessible in the build context (See the [*ADD build
|
||||
command*](/reference/builder/#add)).
|
||||
command*](../../reference/builder.md#add)).
|
||||
|
||||
Query Parameters:
|
||||
|
||||
|
||||
@@ -541,7 +541,7 @@ Status Codes:
|
||||
|
||||
When using the TTY setting is enabled in
|
||||
[`POST /containers/create`
|
||||
](/reference/api/docker_remote_api_v1.9/#create-a-container "POST /containers/create"),
|
||||
](docker_remote_api_v1.9.md#create-a-container),
|
||||
the stream is the raw data from the process PTY and client's stdin.
|
||||
When the TTY is disabled, then the stream is multiplexed to separate
|
||||
stdout and stderr.
|
||||
@@ -1046,7 +1046,7 @@ Build an image from Dockerfile via stdin
|
||||
The archive must include a file called `Dockerfile`
|
||||
at its root. It may include any number of other files,
|
||||
which will be accessible in the build context (See the [*ADD build
|
||||
command*](/reference/builder/#dockerbuilder)).
|
||||
command*](../../reference/builder.md#dockerbuilder)).
|
||||
|
||||
Query Parameters:
|
||||
|
||||
|
||||
@@ -15,8 +15,7 @@ parent = "smn_remoteapi"
|
||||
|
||||
- The Remote API has replaced `rcli`.
|
||||
- The daemon listens on `unix:///var/run/docker.sock` but you can
|
||||
[Bind Docker to another host/port or a Unix socket](
|
||||
/articles/basics/#bind-docker-to-another-hostport-or-a-unix-socket).
|
||||
[Bind Docker to another host/port or a Unix socket](../../articles/basics.md#bind-docker-to-another-hostport-or-a-unix-socket).
|
||||
- The API tends to be REST, but for some complex commands, like `attach`
|
||||
or `pull`, the HTTP connection is hijacked to transport `STDOUT`,
|
||||
`STDIN` and `STDERR`.
|
||||
@@ -589,7 +588,7 @@ Status Codes:
|
||||
|
||||
When using the TTY setting is enabled in
|
||||
[`POST /containers/create`
|
||||
](/reference/api/docker_remote_api_v1.9/#create-a-container "POST /containers/create"),
|
||||
](docker_remote_api_v1.9.md#create-a-container),
|
||||
the stream is the raw data from the process PTY and client's stdin.
|
||||
When the TTY is disabled, then the stream is multiplexed to separate
|
||||
stdout and stderr.
|
||||
@@ -1108,7 +1107,7 @@ Build an image from Dockerfile via stdin
|
||||
The archive must include a file called `Dockerfile`
|
||||
at its root. It may include any number of other files,
|
||||
which will be accessible in the build context (See the [*ADD build
|
||||
command*](/reference/builder/#dockerbuilder)).
|
||||
command*](../../reference/builder.md#dockerbuilder)).
|
||||
|
||||
Query Parameters:
|
||||
|
||||
|
||||
@@ -15,8 +15,7 @@ parent = "smn_remoteapi"
|
||||
|
||||
- The Remote API has replaced `rcli`.
|
||||
- The daemon listens on `unix:///var/run/docker.sock` but you can
|
||||
[Bind Docker to another host/port or a Unix socket](
|
||||
/articles/basics/#bind-docker-to-another-hostport-or-a-unix-socket).
|
||||
[Bind Docker to another host/port or a Unix socket](../../articles/basics.md#bind-docker-to-another-hostport-or-a-unix-socket).
|
||||
- The API tends to be REST, but for some complex commands, like `attach`
|
||||
or `pull`, the HTTP connection is hijacked to transport `STDOUT`,
|
||||
`STDIN` and `STDERR`.
|
||||
@@ -582,7 +581,7 @@ Status Codes:
|
||||
|
||||
When using the TTY setting is enabled in
|
||||
[`POST /containers/create`
|
||||
](/reference/api/docker_remote_api_v1.9/#create-a-container "POST /containers/create"),
|
||||
](docker_remote_api_v1.9.md#create-a-container),
|
||||
the stream is the raw data from the process PTY and client's stdin.
|
||||
When the TTY is disabled, then the stream is multiplexed to separate
|
||||
stdout and stderr.
|
||||
@@ -1097,7 +1096,7 @@ Build an image from Dockerfile via stdin
|
||||
The archive must include a file called `Dockerfile`
|
||||
at its root. It may include any number of other files,
|
||||
which will be accessible in the build context (See the [*ADD build
|
||||
command*](/reference/builder/#dockerbuilder)).
|
||||
command*](../../reference/builder.md#dockerbuilder)).
|
||||
|
||||
Query Parameters:
|
||||
|
||||
|
||||
@@ -15,8 +15,7 @@ weight = 7
|
||||
|
||||
- The Remote API has replaced `rcli`.
|
||||
- The daemon listens on `unix:///var/run/docker.sock` but you can
|
||||
[Bind Docker to another host/port or a Unix socket](
|
||||
/articles/basics/#bind-docker-to-another-hostport-or-a-unix-socket).
|
||||
[Bind Docker to another host/port or a Unix socket](../../articles/basics.md#bind-docker-to-another-hostport-or-a-unix-socket).
|
||||
- The API tends to be REST, but for some complex commands, like `attach`
|
||||
or `pull`, the HTTP connection is hijacked to transport `STDOUT`,
|
||||
`STDIN` and `STDERR`.
|
||||
@@ -591,8 +590,7 @@ Status Codes:
|
||||
**Stream details**:
|
||||
|
||||
When using the TTY setting is enabled in
|
||||
[`POST /containers/create`
|
||||
](/reference/api/docker_remote_api_v1.9/#create-a-container "POST /containers/create"),
|
||||
[`POST /containers/create`](#create-a-container),
|
||||
the stream is the raw data from the process PTY and client's stdin.
|
||||
When the TTY is disabled, then the stream is multiplexed to separate
|
||||
stdout and stderr.
|
||||
@@ -1107,7 +1105,7 @@ Build an image from Dockerfile via stdin
|
||||
The archive must include a file called `Dockerfile`
|
||||
at its root. It may include any number of other files,
|
||||
which will be accessible in the build context (See the [*ADD build
|
||||
command*](/reference/builder/#dockerbuilder)).
|
||||
command*](../../reference/builder.md#dockerbuilder)).
|
||||
|
||||
Query Parameters:
|
||||
|
||||
|
||||
@@ -15,8 +15,7 @@ weight = 6
|
||||
|
||||
- The Remote API has replaced `rcli`.
|
||||
- The daemon listens on `unix:///var/run/docker.sock` but you can
|
||||
[Bind Docker to another host/port or a Unix socket](
|
||||
/articles/basics/#bind-docker-to-another-hostport-or-a-unix-socket).
|
||||
[Bind Docker to another host/port or a Unix socket](../../articles/basics.md#bind-docker-to-another-hostport-or-a-unix-socket).
|
||||
- The API tends to be REST, but for some complex commands, like `attach`
|
||||
or `pull`, the HTTP connection is hijacked to transport `STDOUT`,
|
||||
`STDIN` and `STDERR`.
|
||||
@@ -740,8 +739,7 @@ Status Codes:
|
||||
**Stream details**:
|
||||
|
||||
When using the TTY setting is enabled in
|
||||
[`POST /containers/create`
|
||||
](/reference/api/docker_remote_api_v1.9/#create-a-container "POST /containers/create"),
|
||||
[`POST /containers/create`](#create-a-container),
|
||||
the stream is the raw data from the process PTY and client's stdin.
|
||||
When the TTY is disabled, then the stream is multiplexed to separate
|
||||
stdout and stderr.
|
||||
@@ -1258,7 +1256,7 @@ Build an image from Dockerfile via stdin
|
||||
The archive must include a file called `Dockerfile`
|
||||
at its root. It may include any number of other files,
|
||||
which will be accessible in the build context (See the [*ADD build
|
||||
command*](/reference/builder/#dockerbuilder)).
|
||||
command*](../../reference/builder.md#dockerbuilder)).
|
||||
|
||||
Query Parameters:
|
||||
|
||||
|
||||
@@ -15,8 +15,7 @@ weight = 5
|
||||
|
||||
- The Remote API has replaced `rcli`.
|
||||
- The daemon listens on `unix:///var/run/docker.sock` but you can
|
||||
[Bind Docker to another host/port or a Unix socket](
|
||||
/articles/basics/#bind-docker-to-another-hostport-or-a-unix-socket).
|
||||
[Bind Docker to another host/port or a Unix socket](../../articles/basics.md#bind-docker-to-another-hostport-or-a-unix-socket).
|
||||
- The API tends to be REST, but for some complex commands, like `attach`
|
||||
or `pull`, the HTTP connection is hijacked to transport `STDOUT`,
|
||||
`STDIN` and `STDERR`.
|
||||
@@ -688,7 +687,7 @@ Status Codes:
|
||||
|
||||
When using the TTY setting is enabled in
|
||||
[`POST /containers/create`
|
||||
](/reference/api/docker_remote_api_v1.9/#create-a-container "POST /containers/create"),
|
||||
](#create-a-container),
|
||||
the stream is the raw data from the process PTY and client's stdin.
|
||||
When the TTY is disabled, then the stream is multiplexed to separate
|
||||
stdout and stderr.
|
||||
@@ -1205,7 +1204,7 @@ Build an image from Dockerfile via stdin
|
||||
The archive must include a file called `Dockerfile`
|
||||
at its root. It may include any number of other files,
|
||||
which will be accessible in the build context (See the [*ADD build
|
||||
command*](/reference/builder/#dockerbuilder)).
|
||||
command*](../../reference/builder.md#dockerbuilder)).
|
||||
|
||||
Query Parameters:
|
||||
|
||||
|
||||
@@ -15,8 +15,7 @@ weight = 4
|
||||
|
||||
- The Remote API has replaced `rcli`.
|
||||
- The daemon listens on `unix:///var/run/docker.sock` but you can
|
||||
[Bind Docker to another host/port or a Unix socket](
|
||||
/articles/basics/#bind-docker-to-another-hostport-or-a-unix-socket).
|
||||
[Bind Docker to another host/port or a Unix socket](../../articles/basics.md#bind-docker-to-another-hostport-or-a-unix-socket).
|
||||
- The API tends to be REST, but for some complex commands, like `attach`
|
||||
or `pull`, the HTTP connection is hijacked to transport `STDOUT`,
|
||||
`STDIN` and `STDERR`.
|
||||
@@ -846,7 +845,7 @@ Status Codes:
|
||||
|
||||
When using the TTY setting is enabled in
|
||||
[`POST /containers/create`
|
||||
](/reference/api/docker_remote_api_v1.9/#create-a-container "POST /containers/create"),
|
||||
](#create-a-container),
|
||||
the stream is the raw data from the process PTY and client's stdin.
|
||||
When the TTY is disabled, then the stream is multiplexed to separate
|
||||
stdout and stderr.
|
||||
@@ -1079,7 +1078,7 @@ the path to the alternate build instructions file to use.
|
||||
|
||||
The archive may include any number of other files,
|
||||
which will be accessible in the build context (See the [*ADD build
|
||||
command*](/reference/builder/#dockerbuilder)).
|
||||
command*](../../reference/builder.md#dockerbuilder)).
|
||||
|
||||
Query Parameters:
|
||||
|
||||
|
||||
@@ -15,8 +15,7 @@ weight = 3
|
||||
|
||||
- The Remote API has replaced `rcli`.
|
||||
- The daemon listens on `unix:///var/run/docker.sock` but you can
|
||||
[Bind Docker to another host/port or a Unix socket](
|
||||
/articles/basics/#bind-docker-to-another-hostport-or-a-unix-socket).
|
||||
[Bind Docker to another host/port or a Unix socket](../../articles/basics.md#bind-docker-to-another-hostport-or-a-unix-socket).
|
||||
- The API tends to be REST, but for some complex commands, like `attach`
|
||||
or `pull`, the HTTP connection is hijacked to transport `STDOUT`,
|
||||
`STDIN` and `STDERR`.
|
||||
@@ -895,7 +894,7 @@ Status Codes:
|
||||
|
||||
When using the TTY setting is enabled in
|
||||
[`POST /containers/create`
|
||||
](/reference/api/docker_remote_api_v1.9/#create-a-container "POST /containers/create"),
|
||||
](#create-a-container),
|
||||
the stream is the raw data from the process PTY and client's stdin.
|
||||
When the TTY is disabled, then the stream is multiplexed to separate
|
||||
stdout and stderr.
|
||||
@@ -1168,7 +1167,7 @@ the path to the alternate build instructions file to use.
|
||||
|
||||
The archive may include any number of other files,
|
||||
which will be accessible in the build context (See the [*ADD build
|
||||
command*](/reference/builder/#dockerbuilder)).
|
||||
command*](../../reference/builder.md#dockerbuilder)).
|
||||
|
||||
The build will also be canceled if the client drops the connection by quitting
|
||||
or being killed.
|
||||
|
||||
@@ -15,8 +15,7 @@ weight = 2
|
||||
|
||||
- The Remote API has replaced `rcli`.
|
||||
- The daemon listens on `unix:///var/run/docker.sock` but you can
|
||||
[Bind Docker to another host/port or a Unix socket](
|
||||
/articles/basics/#bind-docker-to-another-hostport-or-a-unix-socket).
|
||||
[Bind Docker to another host/port or a Unix socket](../../articles/basics.md#bind-docker-to-another-hostport-or-a-unix-socket).
|
||||
- The API tends to be REST. However, for some complex commands, like `attach`
|
||||
or `pull`, the HTTP connection is hijacked to transport `stdout`,
|
||||
`stdin` and `stderr`.
|
||||
@@ -914,7 +913,7 @@ Status Codes:
|
||||
|
||||
When using the TTY setting is enabled in
|
||||
[`POST /containers/create`
|
||||
](/reference/api/docker_remote_api_v1.9/#create-a-container "POST /containers/create"),
|
||||
](#create-a-container),
|
||||
the stream is the raw data from the process PTY and client's `stdin`.
|
||||
When the TTY is disabled, then the stream is multiplexed to separate
|
||||
`stdout` and `stderr`.
|
||||
@@ -1192,7 +1191,7 @@ the path to the alternate build instructions file to use.
|
||||
|
||||
The archive may include any number of other files,
|
||||
which are accessible in the build context (See the [*ADD build
|
||||
command*](/reference/builder/#dockerbuilder)).
|
||||
command*](../../reference/builder.md#dockerbuilder)).
|
||||
|
||||
The build is canceled if the client drops the connection by quitting
|
||||
or being killed.
|
||||
|
||||
@@ -15,8 +15,7 @@ weight = 1
|
||||
|
||||
- The Remote API has replaced `rcli`.
|
||||
- The daemon listens on `unix:///var/run/docker.sock` but you can
|
||||
[Bind Docker to another host/port or a Unix socket](
|
||||
/articles/basics/#bind-docker-to-another-hostport-or-a-unix-socket).
|
||||
[Bind Docker to another host/port or a Unix socket](../../articles/basics.md#bind-docker-to-another-hostport-or-a-unix-socket).
|
||||
- The API tends to be REST. However, for some complex commands, like `attach`
|
||||
or `pull`, the HTTP connection is hijacked to transport `stdout`,
|
||||
`stdin` and `stderr`.
|
||||
@@ -925,7 +924,7 @@ Status Codes:
|
||||
|
||||
When using the TTY setting is enabled in
|
||||
[`POST /containers/create`
|
||||
](/reference/api/docker_remote_api_v1.9/#create-a-container "POST /containers/create"),
|
||||
](#create-a-container),
|
||||
the stream is the raw data from the process PTY and client's `stdin`.
|
||||
When the TTY is disabled, then the stream is multiplexed to separate
|
||||
`stdout` and `stderr`.
|
||||
@@ -1319,7 +1318,7 @@ the path to the alternate build instructions file to use.
|
||||
|
||||
The archive may include any number of other files,
|
||||
which are accessible in the build context (See the [*ADD build
|
||||
command*](/reference/builder/#dockerbuilder)).
|
||||
command*](../../reference/builder.md#dockerbuilder)).
|
||||
|
||||
The build is canceled if the client drops the connection by quitting
|
||||
or being killed.
|
||||
|
||||
@@ -15,8 +15,7 @@ weight = 0
|
||||
|
||||
- The Remote API has replaced `rcli`.
|
||||
- The daemon listens on `unix:///var/run/docker.sock` but you can
|
||||
[Bind Docker to another host/port or a Unix socket](
|
||||
/articles/basics/#bind-docker-to-another-hostport-or-a-unix-socket).
|
||||
[Bind Docker to another host/port or a Unix socket](../../articles/basics.md#bind-docker-to-another-hostport-or-a-unix-socket).
|
||||
- The API tends to be REST. However, for some complex commands, like `attach`
|
||||
or `pull`, the HTTP connection is hijacked to transport `stdout`,
|
||||
`stdin` and `stderr`.
|
||||
@@ -962,7 +961,7 @@ Status Codes:
|
||||
|
||||
When using the TTY setting is enabled in
|
||||
[`POST /containers/create`
|
||||
](/reference/api/docker_remote_api_v1.9/#create-a-container "POST /containers/create"),
|
||||
](#create-a-container),
|
||||
the stream is the raw data from the process PTY and client's `stdin`.
|
||||
When the TTY is disabled, then the stream is multiplexed to separate
|
||||
`stdout` and `stderr`.
|
||||
@@ -1356,7 +1355,7 @@ the path to the alternate build instructions file to use.
|
||||
|
||||
The archive may include any number of other files,
|
||||
which are accessible in the build context (See the [*ADD build
|
||||
command*](/reference/builder/#dockerbuilder)).
|
||||
command*](../../reference/builder.md#dockerbuilder)).
|
||||
|
||||
The build is canceled if the client drops the connection by quitting
|
||||
or being killed.
|
||||
@@ -1383,7 +1382,7 @@ Query Parameters:
|
||||
these values at build-time. Docker uses the `buildargs` as the environment
|
||||
context for command(s) run via the Dockerfile's `RUN` instruction or for
|
||||
variable expansion in other Dockerfile instructions. This is not meant for
|
||||
passing secret values. [Read more about the buildargs instruction](/reference/builder/#arg)
|
||||
passing secret values. [Read more about the buildargs instruction](../../reference/builder.md#arg)
|
||||
|
||||
Request Headers:
|
||||
|
||||
|
||||
@@ -531,7 +531,7 @@ Status Codes:
|
||||
|
||||
When using the TTY setting is enabled in
|
||||
[`POST /containers/create`
|
||||
](/reference/api/docker_remote_api_v1.9/#create-a-container "POST /containers/create"),
|
||||
](docker_remote_api_v1.9.md#create-a-container),
|
||||
the stream is the raw data from the process PTY and client's stdin.
|
||||
When the TTY is disabled, then the stream is multiplexed to separate
|
||||
stdout and stderr.
|
||||
|
||||
@@ -476,7 +476,7 @@ Status Codes:
|
||||
|
||||
When using the TTY setting is enabled in
|
||||
[`POST /containers/create`
|
||||
](/reference/api/docker_remote_api_v1.7/#create-a-container),
|
||||
](docker_remote_api_v1.7.md#create-a-container),
|
||||
the stream is the raw data from the process PTY and client's stdin.
|
||||
When the TTY is disabled, then the stream is multiplexed to separate
|
||||
stdout and stderr.
|
||||
@@ -992,7 +992,7 @@ Build an image from Dockerfile via stdin
|
||||
The archive must include a file called `Dockerfile`
|
||||
at its root. It may include any number of other files,
|
||||
which will be accessible in the build context (See the [*ADD build
|
||||
command*](/builder/#dockerbuilder)).
|
||||
command*](../../reference/builder.md#dockerbuilder)).
|
||||
|
||||
Query Parameters:
|
||||
|
||||
|
||||
@@ -524,7 +524,7 @@ Status Codes:
|
||||
|
||||
When using the TTY setting is enabled in
|
||||
[`POST /containers/create`
|
||||
](/reference/api/docker_remote_api_v1.9/#create-a-container "POST /containers/create"),
|
||||
](docker_remote_api_v1.9.md#create-a-container),
|
||||
the stream is the raw data from the process PTY and client's stdin.
|
||||
When the TTY is disabled, then the stream is multiplexed to separate
|
||||
stdout and stderr.
|
||||
@@ -1042,7 +1042,7 @@ Build an image from Dockerfile via stdin
|
||||
The archive must include a file called `Dockerfile`
|
||||
at its root. It may include any number of other files,
|
||||
which will be accessible in the build context (See the [*ADD build
|
||||
command*](/reference/builder/#dockerbuilder)).
|
||||
command*](../../reference/builder.md#dockerbuilder)).
|
||||
|
||||
Query Parameters:
|
||||
|
||||
|
||||
@@ -1045,7 +1045,7 @@ Build an image from Dockerfile using a POST body.
|
||||
The archive must include a file called `Dockerfile`
|
||||
at its root. It may include any number of other files,
|
||||
which will be accessible in the build context (See the [*ADD build
|
||||
command*](/reference/builder/#add)).
|
||||
command*](../../reference/builder.md#add)).
|
||||
|
||||
Query Parameters:
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@ parent="smn_hub_ref"
|
||||
# The Docker Hub and the Registry v1
|
||||
|
||||
This API is deprecated as of 1.7. To view the old version, see the [go
|
||||
here](http://docs.docker.com/v1.7/reference/api/hub_registry_spec/) in
|
||||
here](hub_registry_spec.md) in
|
||||
the 1.7 documentation. If you want an overview of the current features in
|
||||
Docker Hub or other image management features see the [image management
|
||||
overview](/userguide/image_management/) in the current documentation set.
|
||||
overview](../../userguide/image_management.md) in the current documentation set.
|
||||
+15
-16
@@ -18,11 +18,11 @@ instructions in succession.
|
||||
|
||||
This page describes the commands you can use in a `Dockerfile`. When you are
|
||||
done reading this page, refer to the [`Dockerfile` Best
|
||||
Practices](/articles/dockerfile_best-practices) for a tip-oriented guide.
|
||||
Practices](../articles/dockerfile_best-practices.md) for a tip-oriented guide.
|
||||
|
||||
## Usage
|
||||
|
||||
The [`docker build`](/reference/commandline/build/) command builds an image from
|
||||
The [`docker build`](commandline/build.md) command builds an image from
|
||||
a `Dockerfile` and a *context*. The build's context is the files at a specified
|
||||
location `PATH` or `URL`. The `PATH` is a directory on your local filesystem.
|
||||
The `URL` is a the location of a Git repository.
|
||||
@@ -75,7 +75,7 @@ instructions.
|
||||
Whenever possible, Docker will re-use the intermediate images (cache),
|
||||
to accelerate the `docker build` process significantly. This is indicated by
|
||||
the `Using cache` message in the console output.
|
||||
(For more information, see the [Build cache section](/articles/dockerfile_best-practices/#build-cache)) in the
|
||||
(For more information, see the [Build cache section](../articles/dockerfile_best-practices.md#build-cache)) in the
|
||||
`Dockerfile` best practices guide:
|
||||
|
||||
$ docker build -t SvenDowideit/ambassador .
|
||||
@@ -92,7 +92,7 @@ the `Using cache` message in the console output.
|
||||
Successfully built 1a5ffc17324d
|
||||
|
||||
When you're done with your build, you're ready to look into [*Pushing a
|
||||
repository to its registry*]( /userguide/dockerrepos/#contributing-to-docker-hub).
|
||||
repository to its registry*](../userguide/dockerrepos.md#contributing-to-docker-hub).
|
||||
|
||||
## Format
|
||||
|
||||
@@ -106,7 +106,7 @@ be UPPERCASE in order to distinguish them from arguments more easily.
|
||||
|
||||
Docker runs the instructions in a `Dockerfile` in order. **The
|
||||
first instruction must be \`FROM\`** in order to specify the [*Base
|
||||
Image*](/reference/glossary/#base-image) from which you are building.
|
||||
Image*](glossary.md#base-image) from which you are building.
|
||||
|
||||
Docker will treat lines that *begin* with `#` as a
|
||||
comment. A `#` marker anywhere else in the line will
|
||||
@@ -283,11 +283,10 @@ Or
|
||||
|
||||
FROM <image>@<digest>
|
||||
|
||||
The `FROM` instruction sets the [*Base Image*](/reference/glossary/#base-image)
|
||||
The `FROM` instruction sets the [*Base Image*](glossary.md#base-image)
|
||||
for subsequent instructions. As such, a valid `Dockerfile` must have `FROM` as
|
||||
its first instruction. The image can be any valid image – it is especially easy
|
||||
to start by **pulling an image** from the [*Public Repositories*](
|
||||
/userguide/dockerrepos).
|
||||
to start by **pulling an image** from the [*Public Repositories*](../userguide/dockerrepos.md).
|
||||
|
||||
- `FROM` must be the first non-comment instruction in the `Dockerfile`.
|
||||
|
||||
@@ -358,7 +357,7 @@ cache for `RUN` instructions can be invalidated by using the `--no-cache`
|
||||
flag, for example `docker build --no-cache`.
|
||||
|
||||
See the [`Dockerfile` Best Practices
|
||||
guide](/articles/dockerfile_best-practices/#build-cache) for more information.
|
||||
guide](../articles/dockerfile_best-practices.md#build-cache) for more information.
|
||||
|
||||
The cache for `RUN` instructions can be invalidated by `ADD` instructions. See
|
||||
[below](#add) for details.
|
||||
@@ -488,14 +487,14 @@ To view an image's labels, use the `docker inspect` command.
|
||||
The `EXPOSE` instructions informs Docker that the container will listen on the
|
||||
specified network ports at runtime. Docker uses this information to interconnect
|
||||
containers using links (see the [Docker User
|
||||
Guide](/userguide/dockerlinks)) and to determine which ports to expose to the
|
||||
host when [using the -P flag](/reference/run/#expose-incoming-ports).
|
||||
Guide](../userguide/dockerlinks.md) and to determine which ports to expose to the
|
||||
host when [using the -P flag](run.md#expose-incoming-ports).
|
||||
|
||||
> **Note**:
|
||||
> `EXPOSE` doesn't define which ports can be exposed to the host or make ports
|
||||
> accessible from the host by default. To expose ports to the host, at runtime,
|
||||
> [use the `-p` flag](/userguide/dockerlinks) or
|
||||
> [the -P flag](/reference/run/#expose-incoming-ports).
|
||||
> [use the `-p` flag](../userguide/dockerlinks.md) or
|
||||
> [the -P flag](run.md#expose-incoming-ports).
|
||||
|
||||
## ENV
|
||||
|
||||
@@ -595,7 +594,7 @@ of whether or not the file has changed and the cache should be updated.
|
||||
> following instructions from the Dockerfile if the contents of `<src>` have
|
||||
> changed. This includes invalidating the cache for `RUN` instructions.
|
||||
> See the [`Dockerfile` Best Practices
|
||||
guide](/articles/dockerfile_best-practices/#build-cache) for more information.
|
||||
guide](../articles/dockerfile_best-practices.md#build-cache) for more information.
|
||||
|
||||
|
||||
`ADD` obeys the following rules:
|
||||
@@ -938,7 +937,7 @@ containers. The value can be a JSON array, `VOLUME ["/var/log/"]`, or a plain
|
||||
string with multiple arguments, such as `VOLUME /var/log` or `VOLUME /var/log
|
||||
/var/db`. For more information/examples and mounting instructions via the
|
||||
Docker client, refer to
|
||||
[*Share Directories via Volumes*](/userguide/dockervolumes/#mount-a-host-directory-as-a-data-volume)
|
||||
[*Share Directories via Volumes*](../userguide/dockervolumes.md#mount-a-host-directory-as-a-data-volume)
|
||||
documentation.
|
||||
|
||||
The `docker run` command initializes the newly created volume with any data
|
||||
@@ -1191,7 +1190,7 @@ or a signal name in the format SIGNAME, for instance SIGKILL.
|
||||
## Dockerfile examples
|
||||
|
||||
Below you can see some examples of Dockerfile syntax. If you're interested in
|
||||
something more realistic, take a look at the list of [Dockerization examples](/examples/).
|
||||
something more realistic, take a look at the list of [Dockerization examples](../examples/).
|
||||
|
||||
```
|
||||
# Nginx
|
||||
|
||||
@@ -37,7 +37,7 @@ parent = "smn_cli"
|
||||
Builds Docker images from a Dockerfile and a "context". A build's context is
|
||||
the files located in the specified `PATH` or `URL`. The build process can refer
|
||||
to any of the files in the context. For example, your build can use an
|
||||
[*ADD*](/reference/builder/#add) instruction to reference a file in the
|
||||
[*ADD*](../builder.md#add) instruction to reference a file in the
|
||||
context.
|
||||
|
||||
The `URL` parameter can specify the location of a Git repository; the repository
|
||||
@@ -93,7 +93,7 @@ In most cases, it's best to put each Dockerfile in an empty directory. Then,
|
||||
add to that directory only the files needed for building the Dockerfile. To
|
||||
increase the build's performance, you can exclude files and directories by
|
||||
adding a `.dockerignore` file to that directory as well. For information on
|
||||
creating one, see the [.dockerignore file](/reference/builder#dockerignore-file).
|
||||
creating one, see the [.dockerignore file](../builder.md#dockerignore-file).
|
||||
|
||||
If the Docker client loses connection to the daemon, the build is canceled.
|
||||
This happens if you interrupt the Docker client with `ctrl-c` or if the Docker
|
||||
@@ -124,7 +124,7 @@ There should be informational output of the reason for failure output to
|
||||
|
||||
See also:
|
||||
|
||||
[*Dockerfile Reference*](/reference/builder).
|
||||
[*Dockerfile Reference*](../builder.md).
|
||||
|
||||
## Examples
|
||||
|
||||
@@ -160,7 +160,7 @@ where to find the files for the "context" of the build on the Docker daemon.
|
||||
Remember that the daemon could be running on a remote machine and that no
|
||||
parsing of the Dockerfile happens at the client side (where you're running
|
||||
`docker build`). That means that *all* the files at `PATH` get sent, not just
|
||||
the ones listed to [*ADD*](/reference/builder/#add) in the Dockerfile.
|
||||
the ones listed to [*ADD*](../builder.md#add) in the Dockerfile.
|
||||
|
||||
The transfer of context from the local machine to the Docker daemon is what the
|
||||
`docker` client means when you see the "Sending build context" message.
|
||||
@@ -191,7 +191,7 @@ you must use `--rm=false`. This does not affect the build cache.
|
||||
This example shows the use of the `.dockerignore` file to exclude the `.git`
|
||||
directory from the context. Its effect can be seen in the changed size of the
|
||||
uploaded context. The builder reference contains detailed information on
|
||||
[creating a .dockerignore file](../../builder/#dockerignore-file)
|
||||
[creating a .dockerignore file](../builder.md#dockerignore-file)
|
||||
|
||||
$ docker build -t vieux/apache:2.0 .
|
||||
|
||||
@@ -250,11 +250,11 @@ the command line.
|
||||
|
||||
When `docker build` is run with the `--cgroup-parent` option the containers
|
||||
used in the build will be run with the [corresponding `docker run`
|
||||
flag](/reference/run/#specifying-custom-cgroups).
|
||||
flag](../run.md#specifying-custom-cgroups).
|
||||
|
||||
Using the `--ulimit` option with `docker build` will cause each build step's
|
||||
container to be started using those [`--ulimit`
|
||||
flag values](/reference/run/#setting-ulimits-in-a-container).
|
||||
flag values](../run.md#setting-ulimits-in-a-container).
|
||||
|
||||
You can use `ENV` instructions in a Dockerfile to define variable
|
||||
values. These values persist in the built image. However, often
|
||||
@@ -273,4 +273,4 @@ Dockerfile. Also, these values don't persist in the intermediate or final images
|
||||
like `ENV` values do.
|
||||
|
||||
For detailed information on using `ARG` and `ENV` instructions, see the
|
||||
[Dockerfile reference](/reference/builder).
|
||||
[Dockerfile reference](../builder.md).
|
||||
|
||||
@@ -31,7 +31,7 @@ each `docker` command with `sudo`. To avoid having to use `sudo` with the
|
||||
`docker` and add users to it.
|
||||
|
||||
For more information about installing Docker or `sudo` configuration, refer to
|
||||
the [installation](/installation) instructions for your operating system.
|
||||
the [installation](../../installation) instructions for your operating system.
|
||||
|
||||
## Environment variables
|
||||
|
||||
@@ -98,7 +98,7 @@ The property `psFormat` specifies the default format for `docker ps` output.
|
||||
When the `--format` flag is not provided with the `docker ps` command,
|
||||
Docker's client uses this property. If this property is not set, the client
|
||||
falls back to the default table format. For a list of supported formatting
|
||||
directives, see the [**Formatting** section in the `docker ps` documentation](../ps)
|
||||
directives, see the [**Formatting** section in the `docker ps` documentation](ps.md)
|
||||
|
||||
Following is a sample `config.json` file:
|
||||
|
||||
|
||||
@@ -83,8 +83,7 @@ This is useful when you want to set up a container configuration ahead of time
|
||||
so that it is ready to start when you need it. The initial status of the
|
||||
new container is `created`.
|
||||
|
||||
Please see the [run command](/reference/commandline/run) section and the [Docker run reference](
|
||||
/reference/run/) for more details.
|
||||
Please see the [run command](run.md) section and the [Docker run reference](run.md) for more details.
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -73,7 +73,7 @@ To run the daemon with debug output, use `docker daemon -D`.
|
||||
|
||||
## Daemon socket option
|
||||
|
||||
The Docker daemon can listen for [Docker Remote API](/reference/api/docker_remote_api/)
|
||||
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
|
||||
@@ -83,7 +83,7 @@ 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](/articles/https/), or by
|
||||
either using the [built in HTTPS encrypted socket](../../articles/https/), 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
|
||||
|
||||
@@ -23,7 +23,7 @@ the container, `docker export` will export the contents of the *underlying*
|
||||
directory, not the contents of the volume.
|
||||
|
||||
Refer to [Backup, restore, or migrate data
|
||||
volumes](/userguide/dockervolumes/#backup-restore-or-migrate-data-volumes) in
|
||||
volumes](../../userguide/dockervolumes.md#backup-restore-or-migrate-data-volumes) in
|
||||
the user guide for examples on exporting data in a volume.
|
||||
|
||||
## Examples
|
||||
|
||||
@@ -12,74 +12,74 @@ parent = "mn_reference"
|
||||
|
||||
# The Docker commands
|
||||
|
||||
This section contains reference information on using Docker's command line client. Each command has a reference page along with samples. If you are unfamiliar with the command line, you should start by reading about how to ["Use the Docker command line"](cli).
|
||||
This section contains reference information on using Docker's command line client. Each command has a reference page along with samples. If you are unfamiliar with the command line, you should start by reading about how to ["Use the Docker command line"](cli.md).
|
||||
|
||||
You start the Docker daemon with the command line. How you start the daemon affects your Docker containers. For that reason you should also make sure to read the [`daemon`](daemon) reference page.
|
||||
You start the Docker daemon with the command line. How you start the daemon affects your Docker containers. For that reason you should also make sure to read the [`daemon`](daemon.md) reference page.
|
||||
|
||||
### Docker management commands
|
||||
|
||||
* [daemon](daemon)
|
||||
* [info](info)
|
||||
* [inspect](inspect)
|
||||
* [version](version)
|
||||
* [daemon](daemon.md)
|
||||
* [info](info.md)
|
||||
* [inspect](inspect.md)
|
||||
* [version](version.md)
|
||||
|
||||
### Image commands
|
||||
|
||||
* [build](build)
|
||||
* [commit](commit)
|
||||
* [export](export)
|
||||
* [history](history)
|
||||
* [images](images)
|
||||
* [import](import)
|
||||
* [load](load)
|
||||
* [rmi](rmi)
|
||||
* [save](save)
|
||||
* [tag](tag)
|
||||
* [build](build.md)
|
||||
* [commit](commit.md)
|
||||
* [export](export.md)
|
||||
* [history](history.md)
|
||||
* [images](images.md)
|
||||
* [import](import.md)
|
||||
* [load](load.md)
|
||||
* [rmi](rmi.md)
|
||||
* [save](save.md)
|
||||
* [tag](tag.md)
|
||||
|
||||
### Container commands
|
||||
|
||||
* [attach](attach)
|
||||
* [cp](cp)
|
||||
* [create](create)
|
||||
* [diff](diff)
|
||||
* [events](events)
|
||||
* [exec](exec)
|
||||
* [kill](kill)
|
||||
* [logs](logs)
|
||||
* [pause](pause)
|
||||
* [port](port)
|
||||
* [ps](ps)
|
||||
* [rename](rename)
|
||||
* [restart](restart)
|
||||
* [rm](rm)
|
||||
* [run](run)
|
||||
* [start](start)
|
||||
* [stats](stats)
|
||||
* [stop](stop)
|
||||
* [top](top)
|
||||
* [unpause](unpause)
|
||||
* [wait](wait)
|
||||
* [attach](attach.md)
|
||||
* [cp](cp.md)
|
||||
* [create](create.md)
|
||||
* [diff](diff.md)
|
||||
* [events](events.md)
|
||||
* [exec](exec.md)
|
||||
* [kill](kill.md)
|
||||
* [logs](logs.md)
|
||||
* [pause](pause.md)
|
||||
* [port](port.md)
|
||||
* [ps](ps.md)
|
||||
* [rename](rename.md)
|
||||
* [restart](restart.md)
|
||||
* [rm](rm.md)
|
||||
* [run](run.md)
|
||||
* [start](start.md)
|
||||
* [stats](stats.md)
|
||||
* [stop](stop.md)
|
||||
* [top](top.md)
|
||||
* [unpause](unpause.md)
|
||||
* [wait](wait.md)
|
||||
|
||||
### Hub and registry commands
|
||||
|
||||
* [login](login)
|
||||
* [logout](logout)
|
||||
* [pull](pull)
|
||||
* [push](push)
|
||||
* [search](search)
|
||||
* [login](login.md)
|
||||
* [logout](logout.md)
|
||||
* [pull](pull.md)
|
||||
* [push](push.md)
|
||||
* [search](search.md)
|
||||
|
||||
### Network and connectivity commands
|
||||
|
||||
* [network_connect](network_connect)
|
||||
* [network_create](network_create)
|
||||
* [network_disconnect](network_disconnect)
|
||||
* [network_inspect](network_inspect)
|
||||
* [network_ls](network_ls)
|
||||
* [network_rm](network_rm)
|
||||
* [network_connect](network_connect.md)
|
||||
* [network_create](network_create.md)
|
||||
* [network_disconnect](network_disconnect.md)
|
||||
* [network_inspect](network_inspect.md)
|
||||
* [network_ls](network_ls.md)
|
||||
* [network_rm](network_rm.md)
|
||||
|
||||
### Shared data volume commands
|
||||
|
||||
* [volume_create](volume_create)
|
||||
* [volume_inspect](volume_inspect)
|
||||
* [volume_ls](volume_ls)
|
||||
* [volume_rm](volume_rm)
|
||||
* [volume_create](volume_create.md)
|
||||
* [volume_inspect](volume_inspect.md)
|
||||
* [volume_ls](volume_ls.md)
|
||||
* [volume_rm](volume_rm.md)
|
||||
|
||||
@@ -81,13 +81,12 @@ specified image, and then `starts` it using the specified command. That is,
|
||||
previous changes intact using `docker start`. See `docker ps -a` to view a list
|
||||
of all containers.
|
||||
|
||||
There is detailed information about `docker run` in the [Docker run reference](
|
||||
/reference/run/).
|
||||
There is detailed information about `docker run` in the [Docker run reference](run.md).
|
||||
|
||||
The `docker run` command can be used in combination with `docker commit` to
|
||||
[*change the command that a container runs*](/reference/commandline/commit).
|
||||
[*change the command that a container runs*](commit.md).
|
||||
|
||||
See the [Docker User Guide](/userguide/dockerlinks/) for more detailed
|
||||
See the [Docker User Guide](../../userguide/dockerlinks.md) for more detailed
|
||||
information about the `--expose`, `-p`, `-P` and `--link` parameters,
|
||||
and linking containers.
|
||||
|
||||
@@ -170,14 +169,14 @@ manipulate the host's Docker daemon.
|
||||
$ docker run -p 127.0.0.1:80:8080 ubuntu bash
|
||||
|
||||
This binds port `8080` of the container to port `80` on `127.0.0.1` of
|
||||
the host machine. The [Docker User Guide](/userguide/dockerlinks/)
|
||||
the host machine. The [Docker User Guide](../../userguide/dockerlinks.md)
|
||||
explains in detail how to manipulate ports in Docker.
|
||||
|
||||
$ docker run --expose 80 ubuntu bash
|
||||
|
||||
This exposes port `80` of the container for use within a link without
|
||||
publishing the port to the host system's interfaces. The [Docker User
|
||||
Guide](/userguide/dockerlinks) explains in detail how to manipulate
|
||||
Guide](../../userguide/dockerlinks.md) explains in detail how to manipulate
|
||||
ports in Docker.
|
||||
|
||||
$ docker run -e MYVAR1 --env MYVAR2=foo --env-file ./env.list ubuntu bash
|
||||
@@ -279,7 +278,7 @@ format:
|
||||
You can load multiple label-files by supplying multiple `--label-file` flags.
|
||||
|
||||
For additional information on working with labels, see [*Labels - custom
|
||||
metadata in Docker*](/userguide/labels-custom-metadata/) in the Docker User
|
||||
metadata in Docker*](../../userguide/labels-custom-metadata.md) in the Docker User
|
||||
Guide.
|
||||
|
||||
$ docker run --link /redis:redis --name console ubuntu bash
|
||||
@@ -466,7 +465,7 @@ This will run the `redis` container with a restart policy of **always**
|
||||
so that if the container exits, Docker will restart it.
|
||||
|
||||
More detailed information on restart policies can be found in the
|
||||
[Restart Policies (--restart)](/reference/run/#restart-policies-restart)
|
||||
[Restart Policies (--restart)](../run.md#restart-policies-restart)
|
||||
section of the Docker run reference page.
|
||||
|
||||
## Adding entries to a container hosts file
|
||||
|
||||
@@ -21,7 +21,7 @@ parent = "smn_cli"
|
||||
|
||||
Search [Docker Hub](https://hub.docker.com) for images
|
||||
|
||||
See [*Find Public Images on Docker Hub*](/userguide/dockerrepos/#searching-for-images) for
|
||||
See [*Find Public Images on Docker Hub*](../../userguide/dockerrepos.md#searching-for-images) for
|
||||
more details on finding shared images from the command line.
|
||||
|
||||
> **Note:**
|
||||
|
||||
@@ -18,4 +18,4 @@ parent = "smn_cli"
|
||||
--help=false Print usage
|
||||
|
||||
You can group your images together using names and tags, and then upload them
|
||||
to [*Share Images via Repositories*](/userguide/dockerrepos/#contributing-to-docker-hub).
|
||||
to [*Share Images via Repositories*](../../userguide/dockerrepos.md#contributing-to-docker-hub).
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
<!--[metadata]>
|
||||
+++
|
||||
title = "ps"
|
||||
title = "volume rm"
|
||||
description = "the volume rm command description and usage"
|
||||
keywords = ["volume, rm"]
|
||||
[menu.main]
|
||||
|
||||
@@ -69,7 +69,7 @@ By default, the logging driver connects to `localhost:24224`. Supply the
|
||||
### tag
|
||||
|
||||
By default, Docker uses the first 12 characters of the container ID to tag log messages.
|
||||
Refer to the [log tag option documentation](/reference/logging/log_tags/) for customizing
|
||||
Refer to the [log tag option documentation](log_tags.md) for customizing
|
||||
the log tag format.
|
||||
|
||||
|
||||
|
||||
@@ -13,8 +13,8 @@ weight=8
|
||||
|
||||
# Logging Drivers
|
||||
|
||||
* [Configuring logging drivers](overview)
|
||||
* [Configuring log tags](log_tags)
|
||||
* [Fluentd logging driver](fluentd)
|
||||
* [Journald logging driver](journald)
|
||||
* [Amazon CloudWatch Logs logging driver](awslogs)
|
||||
* [Configuring logging drivers](overview.md)
|
||||
* [Configuring log tags](log_tags.md)
|
||||
* [Fluentd logging driver](fluentd.md)
|
||||
* [Journald logging driver](journald.md)
|
||||
* [Amazon CloudWatch Logs logging driver](awslogs.md)
|
||||
|
||||
@@ -84,14 +84,14 @@ the following named facilities:
|
||||
* `local7`
|
||||
|
||||
By default, Docker uses the first 12 characters of the container ID to tag log messages.
|
||||
Refer to the [log tag option documentation](/reference/logging/log_tags/) for customizing
|
||||
Refer to the [log tag option documentation](log_tags.md) for customizing
|
||||
the log tag format.
|
||||
|
||||
|
||||
## journald options
|
||||
|
||||
The `journald` logging driver stores the container id in the journal's `CONTAINER_ID` field. For detailed information on
|
||||
working with this logging driver, see [the journald logging driver](/reference/logging/journald/)
|
||||
working with this logging driver, see [the journald logging driver](journald.md)
|
||||
reference documentation.
|
||||
|
||||
## gelf options
|
||||
@@ -109,7 +109,7 @@ driver to a GELF remote server at `192.168.0.42` on port `12201`
|
||||
$ docker run --log-driver=gelf --log-opt gelf-address=udp://192.168.0.42:12201
|
||||
|
||||
By default, Docker uses the first 12 characters of the container ID to tag log messages.
|
||||
Refer to the [log tag option documentation](/reference/logging/log_tags/) for customizing
|
||||
Refer to the [log tag option documentation](log_tags.md) for customizing
|
||||
the log tag format.
|
||||
|
||||
|
||||
@@ -126,7 +126,7 @@ For example, to specify both additional options:
|
||||
|
||||
If container cannot connect to the Fluentd daemon on the specified address,
|
||||
the container stops immediately. For detailed information on working with this
|
||||
logging driver, see [the fluentd logging driver](/reference/logging/fluentd/)
|
||||
logging driver, see [the fluentd logging driver](fluentd.md)
|
||||
|
||||
## Specify Amazon CloudWatch Logs options
|
||||
|
||||
@@ -137,5 +137,4 @@ The Amazon CloudWatch Logs logging driver supports the following options:
|
||||
--log-opt awslogs-stream=<log_stream_name>
|
||||
|
||||
|
||||
For detailed information on working with this logging driver, see [the awslogs logging driver](/reference/logging/awslogs/)
|
||||
reference documentation.
|
||||
For detailed information on working with this logging driver, see [the awslogs logging driver](awslogs.md) reference documentation.
|
||||
|
||||
+14
-15
@@ -31,7 +31,7 @@ The basic `docker run` command takes this form:
|
||||
|
||||
$ docker run [OPTIONS] IMAGE[:TAG|@DIGEST] [COMMAND] [ARG...]
|
||||
|
||||
The `docker run` command must specify an [*IMAGE*](/reference/glossary/#image)
|
||||
The `docker run` command must specify an [*IMAGE*](glossary.md#image)
|
||||
to derive the container from. An image developer can define image
|
||||
defaults related to:
|
||||
|
||||
@@ -45,11 +45,11 @@ With the `docker run [OPTIONS]` an operator can add to or override the
|
||||
image defaults set by a developer. And, additionally, operators can
|
||||
override nearly all the defaults set by the Docker runtime itself. The
|
||||
operator's ability to override image and Docker runtime defaults is why
|
||||
[*run*](/reference/commandline/cli/run/) has more options than any
|
||||
[*run*](commandline/run.md) has more options than any
|
||||
other `docker` command.
|
||||
|
||||
To learn how to interpret the types of `[OPTIONS]`, see [*Option
|
||||
types*](/reference/commandline/cli/#option-types).
|
||||
types*](commandline/cli.md#option-types).
|
||||
|
||||
> **Note**: Depending on your Docker system configuration, you may be
|
||||
> required to preface the `docker run` command with `sudo`. To avoid
|
||||
@@ -110,7 +110,7 @@ volumes. These are required because the container is no longer listening to the
|
||||
command line where `docker run` was run.
|
||||
|
||||
To reattach to a detached container, use `docker`
|
||||
[*attach*](/reference/commandline/attach) command.
|
||||
[*attach*](commandline/attach.md) command.
|
||||
|
||||
### Foreground
|
||||
|
||||
@@ -159,7 +159,7 @@ The UUID identifiers come from the Docker daemon, and if you do not
|
||||
assign a name to the container with `--name` then the daemon will also
|
||||
generate a random string name too. The name can become a handy way to
|
||||
add meaning to a container since you can use this name when defining
|
||||
[*links*](/userguide/dockerlinks) (or any
|
||||
[*links*](../userguide/dockerlinks.md) (or any
|
||||
other place you need to identify a container). This works for both
|
||||
background and foreground Docker containers.
|
||||
|
||||
@@ -404,8 +404,8 @@ Using the `--restart` flag on Docker run you can specify a restart policy for
|
||||
how a container should or should not be restarted on exit.
|
||||
|
||||
When a restart policy is active on a container, it will be shown as either `Up`
|
||||
or `Restarting` in [`docker ps`](/reference/commandline/ps). It can also be
|
||||
useful to use [`docker events`](/reference/commandline/events) to see the
|
||||
or `Restarting` in [`docker ps`](commandline/ps.md). It can also be
|
||||
useful to use [`docker events`](commandline/events.md) to see the
|
||||
restart policy in effect.
|
||||
|
||||
Docker supports the following restart policies:
|
||||
@@ -469,8 +469,7 @@ for at least 10 seconds), the delay is reset to its default value of 100 ms.
|
||||
You can specify the maximum amount of times Docker will try to restart the
|
||||
container when using the **on-failure** policy. The default is that Docker
|
||||
will try forever to restart the container. The number of (attempted) restarts
|
||||
for a container can be obtained via [`docker inspect`](
|
||||
/reference/commandline/inspect). For example, to get the number of restarts
|
||||
for a container can be obtained via [`docker inspect`](commandline/inspect.md). For example, to get the number of restarts
|
||||
for container "my-container";
|
||||
|
||||
$ docker inspect -f "{{ .RestartCount }}" my-container
|
||||
@@ -1076,12 +1075,12 @@ container's logging driver. The following options are supported:
|
||||
|
||||
The `docker logs` command is available only for the `json-file` and `journald`
|
||||
logging drivers. For detailed information on working with logging drivers, see
|
||||
[Configure a logging driver](/reference/logging/overview/).
|
||||
[Configure a logging driver](logging/overview.md).
|
||||
|
||||
|
||||
## Overriding Dockerfile image defaults
|
||||
|
||||
When a developer builds an image from a [*Dockerfile*](/reference/builder)
|
||||
When a developer builds an image from a [*Dockerfile*](builder.md)
|
||||
or when she commits it, the developer can set a number of default parameters
|
||||
that take effect when the image starts up as a container.
|
||||
|
||||
@@ -1192,7 +1191,7 @@ then the client container can access the exposed port via a private
|
||||
networking interface. Docker will set some environment variables in the
|
||||
client container to help indicate which interface and port to use. For
|
||||
more information on linking, see [the guide on linking container
|
||||
together](/userguide/dockerlinks/)
|
||||
together](../userguide/dockerlinks.md)
|
||||
|
||||
### ENV (environment variables)
|
||||
|
||||
@@ -1230,7 +1229,7 @@ variables automatically:
|
||||
|
||||
The container may also include environment variables defined
|
||||
as a result of the container being linked with another container. See
|
||||
the [*Container Links*](/userguide/dockerlinks/#connect-with-the-linking-system)
|
||||
the [*Container Links*](../userguide/dockerlinks.md#connect-with-the-linking-system)
|
||||
section for more details.
|
||||
|
||||
Additionally, the operator can **set any environment variable** in the
|
||||
@@ -1317,11 +1316,11 @@ container's `/etc/hosts` entry will be automatically updated.
|
||||
--volumes-from="": Mount all volumes from the given container(s)
|
||||
|
||||
> **Note**:
|
||||
> The auto-creation of the host path has been [*deprecated*](/misc/deprecated/#auto-creating-missing-host-paths-for-bind-mounts).
|
||||
> The auto-creation of the host path has been [*deprecated*](../misc/deprecated.md#auto-creating-missing-host-paths-for-bind-mounts).
|
||||
|
||||
The volumes commands are complex enough to have their own documentation
|
||||
in section [*Managing data in
|
||||
containers*](/userguide/dockervolumes). A developer can define
|
||||
containers*](../userguide/dockervolumes.md). A developer can define
|
||||
one or more `VOLUME`'s associated with an image, but only the operator
|
||||
can give access from one container to another (or from a container to a
|
||||
volume mounted on the host).
|
||||
|
||||
Reference in New Issue
Block a user