clearlinux/docker
2
0
Fork 0
mirror of https://github.com/clearlinux/docker.git synced 2026-09-05 05:01:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Enabled GitHub Flavored Markdown

Browse Source 
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:
Mary Anthony
2015-10-11 07:49:54 -07:00
parent fb8217ee62
commit 8fee1c2020
112 changed files with 502 additions and 630 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/reference/api/docker-io_api.md
+1 -1
View File
@@ -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.
docs/reference/api/docker_remote_api.md
+9 -9
View File
@@ -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.
![States](../images/event_state.png)
![States](images/event_state.png)
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
docs/reference/api/docker_remote_api_v1.10.md
+2 -2
View File
@@ -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:
docs/reference/api/docker_remote_api_v1.11.md
+2 -2
View File
@@ -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:
docs/reference/api/docker_remote_api_v1.12.md
+3 -4
View File
@@ -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:
docs/reference/api/docker_remote_api_v1.13.md
+3 -4
View File
@@ -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:
docs/reference/api/docker_remote_api_v1.14.md
+3 -5
View File
@@ -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:
docs/reference/api/docker_remote_api_v1.15.md
+3 -5
View File
@@ -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:
docs/reference/api/docker_remote_api_v1.16.md
+3 -4
View File
@@ -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:
docs/reference/api/docker_remote_api_v1.17.md
+3 -4
View File
@@ -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:
docs/reference/api/docker_remote_api_v1.18.md
+3 -4
View File
@@ -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.
docs/reference/api/docker_remote_api_v1.19.md
+3 -4
View File
@@ -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.
docs/reference/api/docker_remote_api_v1.20.md
+3 -4
View File
@@ -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.
docs/reference/api/docker_remote_api_v1.21.md
+4 -5
View File
@@ -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:
docs/reference/api/docker_remote_api_v1.6.md
+1 -1
View File
@@ -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.
docs/reference/api/docker_remote_api_v1.7.md
+2 -2
View File
@@ -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:
docs/reference/api/docker_remote_api_v1.8.md
+2 -2
View File
@@ -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:
docs/reference/api/docker_remote_api_v1.9.md
+1 -1
View File
@@ -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:
docs/reference/api/hub_registry_spec.md
+2 -2
View File
@@ -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.