mirror of https://github.com/docker/docs.git
Merge pull request #11221 from geetha-rangaswamaiah/compose-docs
Fix compose docs grammatical errors
This commit is contained in:
commit
9ddc2fc75f
|
|
@ -55,7 +55,7 @@ and a `docker-compose.yml` file. (You can use either a `.yml` or `.yaml` extensi
|
||||||
The `docker-compose.yml` file describes the services that make your app. In
|
The `docker-compose.yml` file describes the services that make your app. In
|
||||||
this example those services are a web server and database. The compose file
|
this example those services are a web server and database. The compose file
|
||||||
also describes which Docker images these services use, how they link
|
also describes which Docker images these services use, how they link
|
||||||
together, any volumes they might need mounted inside the containers.
|
together, any volumes they might need to be mounted inside the containers.
|
||||||
Finally, the `docker-compose.yml` file describes which ports these services
|
Finally, the `docker-compose.yml` file describes which ports these services
|
||||||
expose. See the [`docker-compose.yml` reference](compose-file/index.md) for more
|
expose. See the [`docker-compose.yml` reference](compose-file/index.md) for more
|
||||||
information on how this file works.
|
information on how this file works.
|
||||||
|
|
|
||||||
|
|
@ -167,10 +167,10 @@ backup, include the `docker-compose.admin.yml` as well.
|
||||||
> not supported in Compose version 3.x. See the [Version 3 summary](compose-file/compose-versioning.md#version-3)
|
> not supported in Compose version 3.x. See the [Version 3 summary](compose-file/compose-versioning.md#version-3)
|
||||||
> of keys added and removed, along with information on [how to upgrade](compose-file/compose-versioning.md#upgrading).
|
> of keys added and removed, along with information on [how to upgrade](compose-file/compose-versioning.md#upgrading).
|
||||||
> See [moby/moby#31101](https://github.com/moby/moby/issues/31101) to follow the
|
> See [moby/moby#31101](https://github.com/moby/moby/issues/31101) to follow the
|
||||||
> discussion thread on possibility of adding support for `extends` in some form in
|
> discussion thread on the possibility of adding support for `extends` in some form in
|
||||||
> future versions.
|
> future versions.
|
||||||
|
|
||||||
Docker Compose's `extends` keyword enables sharing of common configurations
|
Docker Compose's `extends` keyword enables the sharing of common configurations
|
||||||
among different files, or even different projects entirely. Extending services
|
among different files, or even different projects entirely. Extending services
|
||||||
is useful if you have several services that reuse a common set of configuration
|
is useful if you have several services that reuse a common set of configuration
|
||||||
options. Using `extends` you can define a common set of service options in one
|
options. Using `extends` you can define a common set of service options in one
|
||||||
|
|
|
||||||
|
|
@ -47,7 +47,7 @@ add an explicit signal handler for `SIGTERM`.
|
||||||
* If you can't modify the application, wrap the application in a lightweight init
|
* If you can't modify the application, wrap the application in a lightweight init
|
||||||
system (like [s6](http://skarnet.org/software/s6/)) or a signal proxy (like
|
system (like [s6](http://skarnet.org/software/s6/)) or a signal proxy (like
|
||||||
[dumb-init](https://github.com/Yelp/dumb-init) or
|
[dumb-init](https://github.com/Yelp/dumb-init) or
|
||||||
[tini](https://github.com/krallin/tini)). Either of these wrappers take care of
|
[tini](https://github.com/krallin/tini)). Either of these wrappers takes care of
|
||||||
handling `SIGTERM` properly.
|
handling `SIGTERM` properly.
|
||||||
|
|
||||||
## How do I run multiple copies of a Compose file on the same host?
|
## How do I run multiple copies of a Compose file on the same host?
|
||||||
|
|
|
||||||
|
|
@ -55,7 +55,7 @@ using the Postgres database.
|
||||||
It is important to note the distinction between `HOST_PORT` and `CONTAINER_PORT`.
|
It is important to note the distinction between `HOST_PORT` and `CONTAINER_PORT`.
|
||||||
In the above example, for `db`, the `HOST_PORT` is `8001` and the container port is
|
In the above example, for `db`, the `HOST_PORT` is `8001` and the container port is
|
||||||
`5432` (postgres default). Networked service-to-service
|
`5432` (postgres default). Networked service-to-service
|
||||||
communication use the `CONTAINER_PORT`. When `HOST_PORT` is defined,
|
communication uses the `CONTAINER_PORT`. When `HOST_PORT` is defined,
|
||||||
the service is accessible outside the swarm as well.
|
the service is accessible outside the swarm as well.
|
||||||
|
|
||||||
Within the `web` container, your connection string to `db` would look like
|
Within the `web` container, your connection string to `db` would look like
|
||||||
|
|
|
||||||
|
|
@ -40,7 +40,7 @@ redirect_from:
|
||||||
|
|
||||||
- Allowed compatibility option with `COMPOSE_COMPATIBILITY` environment variable.
|
- Allowed compatibility option with `COMPOSE_COMPATIBILITY` environment variable.
|
||||||
|
|
||||||
- Bumped `Pytest` to 5.3.4 and add refactor compatibility with new version.
|
- Bumped `Pytest` to 5.3.4 and add refactor compatibility with the new version.
|
||||||
|
|
||||||
- Bumped `OpenSSL` from 1.1.1f to 1.1.1g.
|
- Bumped `OpenSSL` from 1.1.1f to 1.1.1g.
|
||||||
|
|
||||||
|
|
@ -1128,7 +1128,7 @@ naming scheme accordingly before upgrading.
|
||||||
to separate the `COMPOSE_FILE` environment value using the
|
to separate the `COMPOSE_FILE` environment value using the
|
||||||
`COMPOSE_PATH_SEPARATOR` environment variable
|
`COMPOSE_PATH_SEPARATOR` environment variable
|
||||||
|
|
||||||
- Added support for port range to single port in port mappings, such as
|
- Added support for port range to a single port in port mappings, such as
|
||||||
`8000-8010:80`.
|
`8000-8010:80`.
|
||||||
|
|
||||||
### Bug Fixes
|
### Bug Fixes
|
||||||
|
|
@ -1221,7 +1221,7 @@ naming scheme accordingly before upgrading.
|
||||||
|
|
||||||
### Bug Fixes
|
### Bug Fixes
|
||||||
|
|
||||||
- Fixed an issue where presence of older versions of the docker-py
|
- Fixed an issue where the presence of older versions of the docker-py
|
||||||
package would cause unexpected crashes while running Compose
|
package would cause unexpected crashes while running Compose
|
||||||
|
|
||||||
- Fixed an issue where healthcheck dependencies would be lost when
|
- Fixed an issue where healthcheck dependencies would be lost when
|
||||||
|
|
@ -1496,8 +1496,8 @@ naming scheme accordingly before upgrading.
|
||||||
### Breaking Changes
|
### Breaking Changes
|
||||||
|
|
||||||
- `docker-compose logs` no longer follows log output by default. It now
|
- `docker-compose logs` no longer follows log output by default. It now
|
||||||
matches the behaviour of `docker logs` and exits after the current logs
|
matches the behavior of `docker logs` and exits after the current logs
|
||||||
are printed. Use `-f` to get the old default behaviour.
|
are printed. Use `-f` to get the old default behavior.
|
||||||
|
|
||||||
- Booleans are no longer allows as values for mappings in the Compose file
|
- Booleans are no longer allows as values for mappings in the Compose file
|
||||||
(for keys `environment`, `labels` and `extra_hosts`). Previously this
|
(for keys `environment`, `labels` and `extra_hosts`). Previously this
|
||||||
|
|
@ -1738,7 +1738,7 @@ naming scheme accordingly before upgrading.
|
||||||
- Fixed an incorrect warning when a container volume was defined in
|
- Fixed an incorrect warning when a container volume was defined in
|
||||||
the Compose file.
|
the Compose file.
|
||||||
|
|
||||||
- Fixed a bug that prevented the force shutdown behaviour of `up` and
|
- Fixed a bug that prevented the force shutdown behavior of `up` and
|
||||||
`logs`.
|
`logs`.
|
||||||
|
|
||||||
- Fixed a bug that caused `None` to be printed as the network driver name
|
- Fixed a bug that caused `None` to be printed as the network driver name
|
||||||
|
|
@ -2042,7 +2042,7 @@ Thanks @dano, @josephpage, @kevinsimper, @lieryan, @phemmer, @soulrebel and @ssc
|
||||||
|
|
||||||
### New features
|
### New features
|
||||||
|
|
||||||
- `docker-compose up` has an **experimental** new behaviour: it will only recreate containers for services whose configuration has changed in `docker-compose.yml`. This will eventually become the default, but for now you can take it for a spin:
|
- `docker-compose up` has an **experimental** new behavior: it will only recreate containers for services whose configuration has changed in `docker-compose.yml`. This will eventually become the default, but for now you can take it for a spin:
|
||||||
|
|
||||||
$ docker-compose up --x-smart-recreate
|
$ docker-compose up --x-smart-recreate
|
||||||
|
|
||||||
|
|
@ -2231,7 +2231,7 @@ Thanks @ryanbrainard and @d11wtq!
|
||||||
|
|
||||||
- The `net` and `workdir` options are now supported in `fig.yml`.
|
- The `net` and `workdir` options are now supported in `fig.yml`.
|
||||||
- The `hostname` option now works in the same way as the Docker CLI, splitting out into a `domainname` option.
|
- The `hostname` option now works in the same way as the Docker CLI, splitting out into a `domainname` option.
|
||||||
- TTY behaviour is far more robust, and resizes are supported correctly.
|
- TTY behavior is far more robust, and resizes are supported correctly.
|
||||||
- Load YAML files safely.
|
- Load YAML files safely.
|
||||||
|
|
||||||
Thanks to @d11wtq, @ryanbrainard, @rail44, @j0hnsmith, @binarin, @Elemecca, @mozz100 and @marksteve for their help with this release!
|
Thanks to @d11wtq, @ryanbrainard, @rail44, @j0hnsmith, @binarin, @Elemecca, @mozz100 and @marksteve for their help with this release!
|
||||||
|
|
@ -2355,7 +2355,7 @@ Big thanks to @tomstuart, @EnTeQuAk, @schickling, @aronasorman and @GeoffreyPlit
|
||||||
|
|
||||||
- Improve documentation
|
- Improve documentation
|
||||||
- Try to connect to Docker on `tcp://localdocker:4243` and a UNIX socket in addition to `localhost`.
|
- Try to connect to Docker on `tcp://localdocker:4243` and a UNIX socket in addition to `localhost`.
|
||||||
- Improve `fig up` behaviour
|
- Improve `fig up` behavior
|
||||||
- Add confirmation prompt to `fig rm`
|
- Add confirmation prompt to `fig rm`
|
||||||
- Add `fig build` command
|
- Add `fig build` command
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue