Skip to content

Commit

Permalink
Docker 17.05 docs (docker#3092)
Browse files Browse the repository at this point in the history
* Add Netlify build script

* Pull 'edge' stuff from master for now

* Add env-regex logging opt (docker#2688)

* Update Dockerfile to pull from 17.05 branch

* Update YAML files from 17.05.x branch

* Add scaffolding for 17.05 content

* Document highlights for 17.05

* Add v1.29 API

* Document multi-stage builds
  • Loading branch information
Misty Stanley-Jones authored and johndmulhausen committed May 5, 2017
1 parent 6456b4a commit 9c648cf
Show file tree
Hide file tree
Showing 54 changed files with 1,242 additions and 696 deletions.
5 changes: 3 additions & 2 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ COPY . md_source
## To get master from svn the svn branch needs to be 'trunk'. To get a branch from svn it needs to be 'branches/branchname'

# Engine
ENV ENGINE_SVN_BRANCH="branches/17.03.x"
ENV ENGINE_BRANCH="17.03.x"
ENV ENGINE_SVN_BRANCH="branches/17.05.x"
ENV ENGINE_BRANCH="17.05.x"

# Distribution
ENV DISTRIBUTION_SVN_BRANCH="branches/release/2.6"
Expand All @@ -32,3 +32,4 @@ RUN md_source/_scripts/fetch-upstream-resources.sh \
&& rm -rf target/apidocs/layouts \
&& find target -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/#g' \
&& rm -rf md_source

2 changes: 1 addition & 1 deletion _data/engine-cli-edge/docker_attach.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
command: docker attach
short: Attach to a running container
short: Attach local standard input, output, and error streams to a running container
long: |-
Use `docker attach` to attach your terminal's standard input, output, and error
(or any combination of the three) to a running container using the container's
Expand Down
432 changes: 159 additions & 273 deletions _data/engine-cli-edge/docker_build.yaml

Large diffs are not rendered by default.

3 changes: 1 addition & 2 deletions _data/engine-cli-edge/docker_commit.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ command: docker commit
short: Create a new image from a container's changes
long: |-
It can be useful to commit a container's file changes or settings into a new
image. This allows you debug a container by running an interactive shell, or to
image. This allows you to debug a container by running an interactive shell, or to
export a working dataset to another server. Generally, it is better to use
Dockerfiles to manage your images in a documented and maintainable way.
[Read more about valid image names and tags](tag.md).
Expand All @@ -27,7 +27,6 @@ options:
description: Author (e.g., "John Hannibal Smith <[email protected]>")
- option: change
shorthand: c
default_value: '[]'
description: Apply Dockerfile instruction to the created image
- option: message
shorthand: m
Expand Down
4 changes: 2 additions & 2 deletions _data/engine-cli-edge/docker_container_attach.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
command: docker container attach
short: Attach to a running container
long: Attach to a running container
short: Attach local standard input, output, and error streams to a running container
long: Attach local standard input, output, and error streams to a running container
usage: docker container attach [OPTIONS] CONTAINER
pname: docker container
plink: docker_container.yaml
Expand Down
1 change: 0 additions & 1 deletion _data/engine-cli-edge/docker_container_commit.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ options:
description: Author (e.g., "John Hannibal Smith <[email protected]>")
- option: change
shorthand: c
default_value: '[]'
description: Apply Dockerfile instruction to the created image
- option: message
shorthand: m
Expand Down
36 changes: 6 additions & 30 deletions _data/engine-cli-edge/docker_container_create.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,9 @@ pname: docker container
plink: docker_container.yaml
options:
- option: add-host
default_value: '[]'
description: Add a custom host-to-IP mapping (host:ip)
- option: attach
shorthand: a
default_value: '[]'
description: Attach to STDIN, STDOUT or STDERR
- option: blkio-weight
default_value: "0"
Expand All @@ -20,10 +18,8 @@ options:
default_value: '[]'
description: Block IO weight (relative device weight)
- option: cap-add
default_value: '[]'
description: Add Linux capabilities
- option: cap-drop
default_value: '[]'
description: Drop Linux capabilities
- option: cgroup-parent
description: Optional parent cgroup for the container
Expand Down Expand Up @@ -52,19 +48,14 @@ options:
default_value: "0"
description: CPU shares (relative weight)
- option: cpus
default_value: "0.000"
description: Number of CPUs
- option: cpuset-cpus
description: CPUs in which to allow execution (0-3, 0,1)
- option: cpuset-mems
description: MEMs in which to allow execution (0-3, 0,1)
- option: credentialspec
description: Credential spec for managed service account (Windows only)
- option: device
default_value: '[]'
description: Add a host device to the container
- option: device-cgroup-rule
default_value: '[]'
description: Add a rule to the cgroup allowed devices list
- option: device-read-bps
default_value: '[]'
Expand All @@ -82,31 +73,23 @@ options:
default_value: "true"
description: Skip image verification
- option: dns
default_value: '[]'
description: Set custom DNS servers
- option: dns-opt
default_value: '[]'
description: Set DNS options
- option: dns-option
default_value: '[]'
description: Set DNS options
- option: dns-search
default_value: '[]'
description: Set custom DNS search domains
- option: entrypoint
description: Overwrite the default ENTRYPOINT of the image
- option: env
shorthand: e
default_value: '[]'
description: Set environment variables
- option: env-file
default_value: '[]'
description: Read in a file of environment variables
- option: expose
default_value: '[]'
description: Expose a port or a range of ports
- option: group-add
default_value: '[]'
description: Add additional groups to join
- option: health-cmd
description: Command to run to check health
Expand All @@ -116,6 +99,10 @@ options:
- option: health-retries
default_value: "0"
description: Consecutive failures needed to report unhealthy
- option: health-start-period
default_value: 0s
description: |
Start period for the container to initialize before starting health-retries countdown (ns|us|ms|s|m|h) (default 0s)
- option: health-timeout
default_value: 0s
description: |
Expand Down Expand Up @@ -156,21 +143,16 @@ options:
description: Kernel memory limit
- option: label
shorthand: l
default_value: '[]'
description: Set meta data on a container
- option: label-file
default_value: '[]'
description: Read in a line delimited file of labels
- option: link
default_value: '[]'
description: Add link to another container
- option: link-local-ip
default_value: '[]'
description: Container IPv4/IPv6 link-local addresses
- option: log-driver
description: Logging driver for the container
- option: log-opt
default_value: '[]'
description: Log driver options
- option: mac-address
description: Container MAC address (e.g., 92:d0:c6:0a:29:33)
Expand All @@ -188,19 +170,19 @@ options:
- option: memory-swappiness
default_value: "-1"
description: Tune container memory swappiness (0 to 100)
- option: mount
description: Attach a filesystem mount to the container
- option: name
description: Assign a name to the container
- option: net
default_value: default
description: Connect a container to a network
- option: net-alias
default_value: '[]'
description: Add network-scoped alias for the container
- option: network
default_value: default
description: Connect a container to a network
- option: network-alias
default_value: '[]'
description: Add network-scoped alias for the container
- option: no-healthcheck
default_value: "false"
Expand All @@ -221,7 +203,6 @@ options:
description: Give extended privileges to this container
- option: publish
shorthand: p
default_value: '[]'
description: Publish a container's port(s) to the host
- option: publish-all
shorthand: P
Expand All @@ -239,7 +220,6 @@ options:
- option: runtime
description: Runtime to use for this container
- option: security-opt
default_value: '[]'
description: Security Options
- option: shm-size
default_value: "0"
Expand All @@ -251,13 +231,11 @@ options:
default_value: "0"
description: Timeout (in seconds) to stop a container
- option: storage-opt
default_value: '[]'
description: Storage driver options for the container
- option: sysctl
default_value: map[]
description: Sysctl options
- option: tmpfs
default_value: '[]'
description: Mount a tmpfs directory
- option: tty
shorthand: t
Expand All @@ -275,12 +253,10 @@ options:
description: UTS namespace to use
- option: volume
shorthand: v
default_value: '[]'
description: Bind mount a volume
- option: volume-driver
description: Optional volume driver for the container
- option: volumes-from
default_value: '[]'
description: Mount volumes from the specified container(s)
- option: workdir
shorthand: w
Expand Down
1 change: 0 additions & 1 deletion _data/engine-cli-edge/docker_container_exec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ options:
description: Override the key sequence for detaching a container
- option: env
shorthand: e
default_value: '[]'
description: Set environment variables
- option: interactive
shorthand: i
Expand Down
4 changes: 0 additions & 4 deletions _data/engine-cli-edge/docker_container_prune.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@ examples: |-
The following removes containers created more than 5 minutes ago:
```bash
{% raw %}
$ docker ps -a --format 'table {{.ID}}\t{{.Image}}\t{{.Command}}\t{{.CreatedAt}}\t{{.Status}}'
CONTAINER ID IMAGE COMMAND CREATED AT STATUS
Expand All @@ -67,13 +66,11 @@ examples: |-
CONTAINER ID IMAGE COMMAND CREATED AT STATUS
61b9efa71024 busybox "sh" 2017-01-04 13:23:33 -0800 PST Exited (0) 44 seconds ago
{% endraw %}
```
The following removes containers created before `2017-01-04T13:10:00`:
```bash
{% raw %}
$ docker ps -a --format 'table {{.ID}}\t{{.Image}}\t{{.Command}}\t{{.CreatedAt}}\t{{.Status}}'
CONTAINER ID IMAGE COMMAND CREATED AT STATUS
Expand All @@ -91,6 +88,5 @@ examples: |-
CONTAINER ID IMAGE COMMAND CREATED AT STATUS
53a9bc23a516 busybox "sh" 2017-01-04 13:11:59 -0800 PST Exited (0) 9 minutes ago
{% endraw %}
```
Loading

0 comments on commit 9c648cf

Please sign in to comment.