Commit Graph

95 Commits

Author SHA1 Message Date
Misty Stanley-Jones 990a5be262 Cross-linking between compose and configs/secrets (#4869) 2017-10-10 11:08:51 -07:00
Gilad Peleg 25ed66a2c5 Make sure code example is correctly presented (#4839) 2017-10-09 17:01:57 -07:00
Misty Stanley-Jones 0201df7716 Clarify that enable_ipv6 requires v2 Compose file (#4811) 2017-10-05 12:15:03 -07:00
Victoria Bialas 6db50d4591 clarified Compose resource options for v2, v3 (#4712)
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-09-25 13:37:09 -07:00
Sébastien HOUZÉ 0c9ad498f9 Add tmpfs as mount type (#4704)
tmpfs was missing in the mount types of volumes long syntax.
2017-09-25 11:30:50 -07:00
Santiago Petrone 4204df859d Indentation fix (#4491) 2017-09-19 11:09:53 -07:00
rdxmb 207acedee2 healthcheck examples - considers valid exit codes (#4652)
As the exit codes for healthcheck must be 0 or 1 , these examples take care about that.
(curl could also exit with another code != 1)
2017-09-19 10:26:53 -07:00
Victoria Bialas 02fc66fde8 More info on resource constraints in Compose v3 and v2 (#4651)
* added more info about resource constraints to Compose docs

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* fixed link in Compose docs, added instructions in test for adding custom target link link IDs

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* fixed links

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-09-18 16:02:05 -07:00
Gwendolynne Barr 1d20f44618 Indent services in compose file (#4611) 2017-09-13 13:27:59 -07:00
Juan Pablo Picasso d92a15dbc9 fixed link to dns section (#4448) 2017-09-11 09:54:43 -07:00
Joffrey F 0b22c35a28 Remove delayed features from 1.16.0, fixed changelog (#4417) 2017-08-31 15:52:18 -07:00
Joffrey F 0702f23aae Document Compose 1.16.0 additions (#4293)
Signed-off-by: Joffrey F <joffrey@docker.com>
2017-08-31 15:52:18 -07:00
Wenxuan Zhao 4d43ae7ea2 Fix `depends_on` links across documents. (#4424)
NOTE: compose file v1 doesn't support `depends_on`,
      thus it's still a broken link.

Signed-off-by: Wenxuan Zhao <viz@linux.com>
2017-08-29 15:52:02 -07:00
Victoria Bialas 7e0033575a clarified links and services communication in Compose (#4416)
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-08-29 10:16:47 -07:00
Alon Bar Tzlil c5e28b8412 Fix file version in volumes long syntax example to 3.2 (#4202)
Fix docker-compose file version in the example given for the new volumes "long syntax", available from version 3.2.
Currently the example contains version 3 which does not support this syntax.
2017-08-17 14:43:03 -07:00
Brikou CARRE b812b9d775 Fix rendering of YAML snippet (#4185) 2017-08-17 14:14:52 -07:00
Joffrey F 45ac9fe357 Add clarification on env_file / environment interaction (#4177)
Signed-off-by: Joffrey F <joffrey@docker.com>
2017-08-17 14:09:43 -07:00
Sebastiaan van Stijn 4c41debee6 Fix credential-spec documentation (#4179)
The values that are provided in the docker-compose file
should be relative, not absolute.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2017-08-15 10:43:00 -07:00
Sebastiaan van Stijn 587248348c Remove warning for limitation in Docker 1.13.1 (#4180)
Docker 1.13.1 is EOL, and no longer supported, so
this warning is a bit redundant now.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2017-08-14 11:26:52 -07:00
cthomas15 fad97596eb Changes to compose/compose-file/index.md (#4172)
Added 'rollback' to the list in the following bullet:
- `failure_action`: What to do if an update fails. One of `continue`, `rollback`, or `pause` (default: `pause`).
2017-08-11 16:20:22 -07:00
James Guthrie e09f7063cb Remove superfluous sentence from compose-file docs (#4154) 2017-08-10 15:52:16 -07:00
Victoria Bialas 65fdf795f4 Fix Compose file samples for volumes and other (#4142)
* Fix Compose file samples for volumes and other

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* fixing Compose file example, adding another volume mount example

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* replaced x-ref to volumes info with the right one

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* add bullets to note

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* corrected for description of bind mount as example intro

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* modified volumes example per developer review

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* corrected for legacy stuff on examples, clarified named volumes

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* fixed capitalization in x-refs visible text

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-08-10 14:49:55 -07:00
Victoria Bialas 4be0abd93b surface Compose file example at top of topic (#4090)
* surface Compose file example at top of topic

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* removed extraneous intro

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-08-03 21:22:47 -07:00
ryota-murakami 24d6f9b1f7 fix typo (#4031) 2017-08-01 12:16:34 -07:00
Victoria Bialas a922be3d0f Update admonitions CSS for consistency and better writer workflow (#4019) 2017-07-31 21:49:56 -07:00
Victoria Bialas eb25815fb9 Better examples to show Compose file structure, expand/collapse accordion (#3967)
* better examples to show Compose file structure

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* cleaned up leading spaces in Compose file example

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* cleaned up leading spaces, added a test file

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* expand/collapse accordion full implementation, explanation in test.md

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* delete temporary test file from PR

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* fix accordion to work on mobile (cursor style)

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* verified fix for mobile worked, added same to test.md, updated notes and content

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* Clarifed details on test page, fixed references for FontAwesome icons

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-07-28 12:32:53 -07:00
Victoria Bialas 3558712894 added endpoint_mode topic for Compose file v3.3 (#3982)
* added endpoint_mode topic for Compose file v3.3

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* incorporated review comments re: features and versioning

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-07-26 10:33:46 -07:00
Victoria Bialas 1c6ff26042 added Compose topics on caching options for performance (#3932)
* added Compose topics on caching options for performance

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* updated title for Compose topic

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* line wrap per review

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-07-21 15:52:41 -04:00
Adrian Moisey 39dd81ec91 Fix example of "configs" (#3807)
This should be "configs" not "secrets" as it's an example of the new "configs" option.
2017-07-05 16:45:55 -07:00
Victoria Bialas c2bd959d1f env file list precedence Compose file (additional clarification) (#3822)
* clarified ordering of env files

* added env_file order of precedence to v1, v2 Compose

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* formatting

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-07-05 13:43:42 -07:00
Victoria Bialas d2b71ad555 clarified Mac vs. Linux steps on bash completion (#3800)
* clarified Mac vs. Linux steps on bash completion

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* copyedit on Compose file reference page

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-07-03 16:26:54 -07:00
Misty Stanley-Jones 08f830811d Add configs to compose file reference 2017-06-28 08:31:29 -07:00
Misty Stanley-Jones b1aa298c16 Docs for Compose 1.14 (#3697)
* Specify Compose version for Compose file formats (#3297)

* Specify Compose version for Compose file formats

Explicitly specifying Compose versions file formats 2.1 and 2.2.

* corrected typo 2.1 --> 2.2

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* Document new Compose 1.14.0 features (#3695)

Signed-off-by: Joffrey F <joffrey@docker.com>

* Current compose is 1.14.0 (#3690)

Signed-off-by: Guillaume Rose <guillaume.rose@docker.com>

* Fix typo
2017-06-23 18:15:01 -07:00
Victoria Bialas aee7e98fcb fixed links to topics w/underscores (#3583)
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-06-12 19:35:08 -07:00
Joffrey F b60dd6facb Remove unsupported link_local_ips param from v3 doc (#3506)
Signed-off-by: Joffrey F <joffrey@docker.com>
2017-06-12 18:59:53 -07:00
Victoria Bialas 2cfb7ba743 added links to Compose release versions, improved matrix description (#3580)
* added links to Compose release versions, improved matrix description

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* review comments, used include for matrix in all file references

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* incorporated review comments

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-06-12 18:40:51 -07:00
Victoria Bialas fa52e73dc5 Added notes and troubleshooting topic on volume mounts from host (#3556)
* added notes and troubleshooting topic on volume mounts from host

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* updates to troubleshooting, FAQs and shared drives topics and notes

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-06-12 15:10:15 -07:00
Misty Stanley-Jones a173c4630d Document OOME information (#3536) 2017-06-09 09:41:00 -07:00
Victoria Bialas 12f96be8d8 added note on external volumes with docker stack deploy (#3541)
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-06-08 17:35:02 -07:00
Victoria Bialas 63c7febfdd added Python, Docker Cloud install/run to known issues and setup notes (#3525)
* added Anaconda Python 3.5.2 install/run to known issues

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* added notes re: Python 3.x not supported in setup and install

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* fixed heading levels in Cloud known errors

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* fixed links (moby --> docker), formatting

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* fixed on-page link list alignments for toc max/min topics

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-06-07 18:36:50 -07:00
Victoria Bialas bb8146180f Compose improvements, env_file vars, rails sample (#3517)
* added example for env_file variables

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* copyedits and rework of Compose rails example

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-06-07 14:05:34 -07:00
Victoria Bialas da9734a626 updated syntax for command in Compose files (#3498)
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-06-05 16:37:54 -07:00
zasca 87d08620aa Added unless-stopped restart policy (#3278) 2017-05-22 10:39:29 -07:00
Victoria Bialas b62449b3c8 clarified logging options in Compose, fixed glaring note formats (#3272)
* clarified logging options in Compose, fixed glaring note formats

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* added link directly to JSON driver in supported drivers docs

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* took off code tags to make link stand out

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* fixed alignment of note text in markdown

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* x-ref to how to set environment variables in containers

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* copyedit in note

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-05-16 12:02:54 -07:00
Ben Reichert 07a105d724 Add max-size, max-file logging options documentation (#3243) 2017-05-13 22:14:01 -07:00
John Yani d0e12df054 Service create vs run (#3217)
This compose section should reference docker service create, not docker run options
https://github.com/moby/moby/issues/32844
2017-05-10 11:52:30 -07:00
Victoria Bialas 105333e079 clarified use of volumes with stack files, services, swarms (#3201)
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-05-08 18:50:45 -07:00
Vlad 1b7091501a Fix indentation (#3180) 2017-05-05 21:48:18 +00:00
Andy Neff 3de6ebc21e Update docker-compose index.md (#3090)
There were a number of things wrong with the `restart` definition

1. The volumes note came after the restart section rather than before
2. The restart command used array notation rather than map. This is confusing to those unfamiliar with yaml and inconsistent with the rest of the documentation
3. Using `docker-compose` myself, saying `restart: no` does not work, but `restart: "no"` does. 

```
ERROR: The Compose file './docker-compose.override.yml' is invalid because:
services.letsencrypt.restart contains an invalid type, it should be a string
```
2017-04-28 22:07:50 +00:00
hacfi 3e137458e8 Fix yml indention (#3089) 2017-04-28 22:06:04 +00:00