Skip to content

Commit

Permalink
Merge branch 'master' into fix-broken-link
Browse files Browse the repository at this point in the history
  • Loading branch information
Misty Stanley-Jones authored Jan 26, 2017
2 parents 15697da + e4a1a9d commit 0055c98
Show file tree
Hide file tree
Showing 79 changed files with 1,451 additions and 1,040 deletions.
4 changes: 2 additions & 2 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ RUN svn co https://github.com/docker/docker/branches/$ENGINE_BRANCH/docs/extend
&& rm -rf allv/tests \
&& wget -O allv/engine/api/v1.25/swagger.yaml https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/api/swagger.yaml \
&& jekyll build -s allv -d allvbuild \
&& find allvbuild/engine/reference -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/#g' \
&& find allvbuild/engine/extend -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/#g' \
&& rm -rf allv/apidocs/layouts \
&& find allvbuild -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/#g' \
&& rm -rf allv

# Serve the site, which is now all static HTML
Expand Down
1 change: 1 addition & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ defaults:
values:
layout: docs
defaultassignee: johndmulhausen
enginebranch: 1.13.x
- scope:
path: "compose"
values:
Expand Down
31 changes: 30 additions & 1 deletion _data/dockerd-cli/dockerd.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ long: |
## Daemon socket option
The Docker daemon can listen for [Docker Remote API](../api/docker_remote_api.md)
The Docker daemon can listen for [Docker Remote API](/engine/api/index.md)
requests via three different types of Socket: `unix`, `tcp`, and `fd`.
By default, a `unix` domain socket (or IPC socket) is created at
Expand Down Expand Up @@ -985,6 +985,33 @@ long: |
option on `docker create` and `docker run`, and takes precedence over
the `--cgroup-parent` option on the daemon.
## Daemon Metrics
The `--metrics-addr` option takes a TCP address to serve the metrics API. This
feature is still experimental, therefore, the daemon must be running in
experimental mode for this feature to work.
To serve the metrics API on localhost:9323 you would specify
`--metrics-addr 127.0.0.1:9323` allowing you to make requests on the API at
`127.0.0.1:9323/metrics` to receive metrics in the
[prometheus](https://prometheus.io/docs/instrumenting/exposition_formats/)
format.
If you are running a prometheus server you can add this address to your scrape
configs to have prometheus collect metrics on Docker. For more information on
prometheus you can view the website [here](https://prometheus.io/).
```yml
scrape_configs:
- job_name: 'docker'
static_configs:
- targets: ['127.0.0.1:9323']
```
Please note that this feature is still marked as experimental as metrics and
metric names could change while this feature is still in experimental. Please
provide feedback on what you would like to see collected in the API.
## Daemon configuration file
The `--config-file` option allows you to set any configuration option
Expand Down Expand Up @@ -1327,6 +1354,8 @@ options:
- option: max-concurrent-uploads
default_value: 5
description: Set the max concurrent uploads for each push
- option: metrics-addr
description: Set address and port to serve the metrics api
- option: mtu
description: Set the containers network MTU
- option: oom-score-adjust
Expand Down
4 changes: 4 additions & 0 deletions _data/redirects.csv
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,7 @@
/v1.9/docker-hub/,/docker-hub/
/v1.10/docker-hub/,/docker-hub/
/v1.11/docker-hub/,/docker-hub/
/login,https://cloud.docker.com/app/login
/bitbucket/use-docker-images-as-build-environments-in-bitbucket-pipelines-792298897.html,https://confluence.atlassian.com/bitbucket/use-docker-images-as-build-environments-in-bitbucket-pipelines-792298897.html
/blog/docker-data-science/,https://www.dataquest.io/blog/docker-data-science/
/questions/19335444/how-to-assign-a-port-mapping-to-an-existing-docker-container,http://stackoverflow.com/questions/19335444/how-to-assign-a-port-mapping-to-an-existing-docker-container
8 changes: 5 additions & 3 deletions _data/toc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ toc:
- sectiontitle: Define and deploy your app
section:
- path: /engine/getstarted-voting-app/
title: Tour the voting app sample
title: Sample app overview
- path: /engine/getstarted-voting-app/node-setup/
title: Set up Dockerized machines
- path: /engine/getstarted-voting-app/create-swarm/
Expand All @@ -150,7 +150,7 @@ toc:
- path: /engine/getstarted-voting-app/test-drive/
title: Try out the voting app
- path: /engine/getstarted-voting-app/customize-app/
title: Customize the app and redploy
title: Customize the app and redeploy
- sectiontitle: Learn by example
section:
- path: /engine/tutorials/networkingcontainers/
Expand Down Expand Up @@ -440,7 +440,7 @@ toc:
- path: /engine/reference/commandline/cli/
title: Use the Docker command line
- path: /engine/reference/commandline/dockerd/
title: Daemon CLI reference
title: Daemon CLI reference (dockerd)
- sectiontitle: Engine CLI reference
section:
- path: /engine/reference/commandline/docker/
Expand All @@ -449,6 +449,8 @@ toc:
title: docker attach
- path: /engine/reference/commandline/build/
title: docker build
- path: /engine/reference/commandline/checkpoint/
title: docker checkpoint
- path: /engine/reference/commandline/commit/
title: docker commit
- sectiontitle: docker container *
Expand Down
2 changes: 1 addition & 1 deletion _includes/content/typical_docker_workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
- Build, then run your containers on a virtual host via [Docker Machine](machine/overview.md) as you develop.
2. Configure [networking](engine/tutorials/networkingcontainers.md) and
[storage](engine/tutorials/dockervolumes.md) for your solution, if needed.
3. Upload builds to a registry ([ours](engine/tutorials/dockerrepos.md), [yours](/datacenter/dtr/2.0/index.md), or your cloud provider's), to collaborate with your team.
3. Upload builds to a registry ([ours](/engine/getstarted/step_six.md), [yours](/datacenter/dtr/2.0/index.md), or your cloud provider's), to collaborate with your team.
4. If you're gonna need to scale your solution across multiple hosts (VMs or physical machines), [plan
for how you'll set up your Swarm cluster](engine/swarm/key-concepts.md) and [scale it to meet demand](engine/swarm/swarm-tutorial/index.md).
- Note: Use [Universal Control Plane](/datacenter/ucp/1.1/overview.md) and you can manage your
Expand Down
4 changes: 2 additions & 2 deletions _layouts/docs.html
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@
<li class="leaf menu-mlid-402"><a href="https://training.docker.com/" target="_blank">Training</a></li>
<li class="leaf menu-mlid-2000"><a href="https://www.docker.com/partners/partner-program">Partners</a></li>
<li class="leaf menu-mlid-602"><a href="https://blog.docker.com/" target="_blank">Blog</a></li>
<li class="leaf menu-mlid-2001"><a href="https://cloud.docker.com/login/" target="_blank">Log-In</a></li>
<li class="leaf menu-mlid-2001"><a href="https://id.docker.com/login/" target="_blank">Log-In</a></li>
<li class="last leaf menu-mlid-2002"><a href="https://cloud.docker.com/" target="_blank">Sign-up</a></li>
</ul>
<ul class="nav-main">
Expand Down Expand Up @@ -185,7 +185,7 @@
<li class="leaf menu-mlid-402"><a href="https://training.docker.com/" target="_blank">Training</a></li>
<li class="leaf menu-mlid-2000"><a href="https://www.docker.com/partners/partner-program">Partners</a></li>
<li class="leaf menu-mlid-602"><a href="https://blog.docker.com/" target="_blank">Blog</a></li>
<li class="leaf menu-mlid-2001"><a href="https://cloud.docker.com/login/" target="_blank">Log-In</a></li>
<li class="leaf menu-mlid-2001"><a href="https://id.docker.com/login/" target="_blank">Log-In</a></li>
<li class="last leaf menu-mlid-2002"><a href="https://cloud.docker.com/" target="_blank">Sign-up</a></li>
</ul>
</aside>
Expand Down
9 changes: 5 additions & 4 deletions compose/compose-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -253,8 +253,8 @@ updates.
- `delay`: The time to wait between updating a group of containers.
- `failure_action`: What to do if an update fails. One of `continue` or `pause`
(default: `pause`).
- `monitor`: TODO
- `max_failure_ratio`: TODO
- `monitor`: Duration after each task update to monitor for failure `(ns|us|ms|s|m|h)` (default 0s).
- `max_failure_ratio`: Failure rate to tolerate during an update.

update_config:
parallelism: 2
Expand Down Expand Up @@ -768,7 +768,7 @@ Specify logging options as key-value pairs. An example of `syslog` options:
### net

> [Version 1 file format](compose-file.md#version-1) only. In version 2, use
> [network_mode](compose-file.md#network_mode).
> [network_mode](compose-file.md#networkmode).
Network mode. Use the same values as the docker client `--net` parameter.
The `container:...` form can take a service name instead of a container name or
Expand Down Expand Up @@ -942,6 +942,7 @@ port (a random host port will be chosen).
- "49100:22"
- "127.0.0.1:8001:8001"
- "127.0.0.1:5000-5010:5000-5010"
- "6060:6060/udp"

### security_opt

Expand All @@ -961,7 +962,7 @@ Override the default labeling scheme for each container.
Specify how long to wait when attempting to stop a container if it doesn't
handle SIGTERM (or whatever stop signal has been specified with
[`stop_signal`](compose-file.md#stop_signal)), before sending SIGKILL. Specified
[`stop_signal`](compose-file.md#stopsignal)), before sending SIGKILL. Specified
as a [duration](compose-file.md#specifying-durations).

stop_grace_period: 1s
Expand Down
95 changes: 58 additions & 37 deletions compose/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,46 +8,54 @@ You can run Compose on macOS, Windows and 64-bit Linux. To install it, you'll ne

To install Compose, do the following:

1. Install Docker Engine:
1. Install Docker Engine:

* <a href="/engine/installation/mac/" target="_blank">macOS installation</a>
* [macOS installation](/docker-for-mac/index.md){: target="_blank" class="_"}

* <a href="/engine/installation/windows/" target="_blank">Windows installation</a>
* [Windows installation](/docker-for-windows/index.md){: target="_blank" class="_"}

* <a href="/engine/installation/linux/ubuntulinux/" target="_blank">Ubuntu installation</a>
* [Ubuntu installation](/engine/installation/linux/ubuntu.md){: target="_blank" class="_"}

* <a href="/engine/installation/" target="_blank">other system installations</a>
* [Other systems](/engine/installation/index.md){: target="_blank" class="_"}

2. The Docker Toolbox installation includes both Engine and Compose, so Mac and Windows users are done installing. Others should continue to the next step.
2. The Docker Toolbox installation includes both Engine and Compose, so Mac and
Windows users are done installing. Others should continue to the next step.

3. Go to the <a href="https://github.com/docker/compose/releases" target="_blank">Compose repository release page on GitHub</a>.
3. Go to the
[Compose repository release page on GitHub](https://github.com/docker/compose/releases){: target="_blank" class="_"}.

4. Follow the instructions from the release page and run the `curl` command,
which the release page specifies, in your terminal.
4. Follow the instructions from the release page and run the `curl` command,
which the release page specifies, in your terminal.

> Note: If you get a "Permission denied" error, your `/usr/local/bin` directory
probably isn't writable and you'll need to install Compose as the superuser. Run
`sudo -i`, then the two commands below, then `exit`.
> Note: If you get a "Permission denied" error, your `/usr/local/bin` directory
> probably isn't writable and you'll need to install Compose as the superuser. Run
> `sudo -i`, then the two commands below, then `exit`.
The following is an example command illustrating the format:
The following is an example command illustrating the format:

$ curl -L "https://github.com/docker/compose/releases/download/1.9.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
```bash
$ curl -L "https://github.com/docker/compose/releases/download/1.10.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
```

If you have problems installing with `curl`, see
[Alternative Install Options](install.md#alternative-install-options).
If you have problems installing with `curl`, see
[Alternative Install Options](install.md#alternative-install-options).

5. Apply executable permissions to the binary:
5. Apply executable permissions to the binary:

chmod +x /usr/local/bin/docker-compose
```bash
$ chmod +x /usr/local/bin/docker-compose
```

6. Optionally, install [command completion](completion.md) for the
`bash` and `zsh` shell.
`bash` and `zsh` shell.

7. Test the installation.
7. Test the installation.

$ docker-compose --version
docker-compose version: 1.9.0
```bash
$ docker-compose --version
docker-compose version: 1.10.0
```

## Alternative install options

Expand All @@ -60,7 +68,9 @@ have python system packages that conflict with docker-compose dependencies. See
the [virtualenv tutorial](http://docs.python-guide.org/en/latest/dev/virtualenvs/)
to get started.

pip install docker-compose
```bash
$ pip install docker-compose
```

> **Note:** pip version 6.0 or greater is required

Expand All @@ -69,15 +79,18 @@ to get started.
Compose can also be run inside a container, from a small bash script wrapper.
To install compose as a container run:

$ curl -L https://github.com/docker/compose/releases/download/1.9.0/run.sh > /usr/local/bin/docker-compose
$ chmod +x /usr/local/bin/docker-compose
```bash
$ curl -L https://github.com/docker/compose/releases/download/1.10.0/run.sh > /usr/local/bin/docker-compose
$ chmod +x /usr/local/bin/docker-compose
```

## Master builds

If you're interested in trying out a pre-release build you can download a
binary from [https://dl.bintray.com/docker-compose/master/](https://dl.bintray.com/docker-compose/master/). Pre-release
builds allow you to try out new features before they are released, but may
be less stable.
binary from
[https://dl.bintray.com/docker-compose/master/](https://dl.bintray.com/docker-compose/master/).
Pre-release builds allow you to try out new features before they are released,
but may be less stable.
## Upgrading
Expand All @@ -92,27 +105,35 @@ to run so that you don't end up with two sets of them. If you want to keep using
your existing containers (for example, because they have data volumes you want
to preserve) you can use compose 1.5.x to migrate them with the following command:

docker-compose migrate-to-labels
```bash
$ docker-compose migrate-to-labels
```

Alternatively, if you're not worried about keeping them, you can remove them.
Compose will just create new ones.
docker rm -f -v myapp_web_1 myapp_db_1 ...
```bash
docker rm -f -v myapp_web_1 myapp_db_1 ...
```
## Uninstallation
To uninstall Docker Compose if you installed using `curl`:
rm /usr/local/bin/docker-compose
```bash
rm /usr/local/bin/docker-compose
```
To uninstall Docker Compose if you installed using `pip`:
pip uninstall docker-compose
```bash
$ pip uninstall docker-compose
```
>**Note**: If you get a "Permission denied" error using either of the above
>methods, you probably do not have the proper permissions to remove
>`docker-compose`. To force the removal, prepend `sudo` to either of the above
>commands and run again.
> **Note**: If you get a "Permission denied" error using either of the above
> methods, you probably do not have the proper permissions to remove
> `docker-compose`. To force the removal, prepend `sudo` to either of the above
> >commands and run again.
## Where to go next
Expand All @@ -122,5 +143,5 @@ To uninstall Docker Compose if you installed using `pip`:
- [Get started with Django](django.md)
- [Get started with Rails](rails.md)
- [Get started with WordPress](wordpress.md)
- [Command line reference](./reference/index.md)
- [Command line reference](/compose/reference/index.md)
- [Compose file reference](compose-file.md)
3 changes: 2 additions & 1 deletion compose/reference/envvars.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,8 @@ Supported values are: `TLSv1`, `TLSv1_1`, `TLSv1_2`.
## COMPOSE\_CONVERT\_WINDOWS\_PATHS

Enable path conversion from Windows-style to Unix-style in volume definitions.
Users of Docker Machine and Docker Toolbox on Windows should always set this.
Users of Docker Machine and Docker Toolbox on Windows should always set this. Defaults to `0`
Supported values: `true` or `1` to enable, `false` or `0` to disable.


## Related Information
Expand Down
25 changes: 25 additions & 0 deletions cs-engine/release-notes/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,18 @@ cannot be adopted as quickly for consistency and compatibility reasons.
These notes refer to the current and immediately prior releases of the
CS Engine. For notes on older versions, see the [CS Engine prior release notes archive](prior-release-notes.md).

## CS Engine 1.12.6-cs7
(24 Jan 2017)

This release addresses the following issues:

* [#28406](https://github.com/docker/docker/issues/28406) Fix conflicts introduced
by the updated `selinux-policy` base package from RHEL/CentOS 7.3
* [#26639](https://github.com/docker/docker/issues/26639) Resolves hostnames passed
to the local volume driver for nfs mount options.
* [26111](https://github.com/docker/docker/issues/26111) Fix issue with adding
iptables rules due to xtables lock message change.

## CS Engine 1.12.6-cs6
(10 Jan 2017)

Expand Down Expand Up @@ -69,6 +81,19 @@ This release addresses the following issues:
to connect to swarm-mode overlay network
* Various bug fixes in swarm mode networking

## CS Engine 1.11.2-cs7
(24 Jan 2017)

This release addresses the following issues:

* [#26639](https://github.com/docker/docker/issues/26639) Resolves hostnames passed
to the local volume driver for nfs mount options.
* [26111](https://github.com/docker/docker/issues/26111) Fix issue with adding
iptables rules due to xtables lock message change.
* [#1572](github.com/docker/libnetwork/issues/1572) Fix daemon panic
* [1130](https://github.com/docker/libnetwork/pull/1130) Fix IPAM out of sync
issue on ungraceful shutdown.

## CS Engine 1.11.2-cs6
(12 Jan 2017)

Expand Down
Loading

0 comments on commit 0055c98

Please sign in to comment.