Sebastiaan van Stijn
e295a6e6cb
Use site parameter to use latest compose file versions in examples ( #8630 )
...
* Use site parameter to use latest compose file versions in examples
Make sure that examples use the latest version of the compose file
format, to encourage using the latest version, and to prevent
users from running into "not supported by this version" problems
when copy/pasting, and combining examples that use different
versions.
Also add a note about `version: x` not being equivalent to
`version: x.latest`.
Note that there are still some examples using fixed versions
in the UCP sections; we need to evaluate those to make sure
the right (and supported) versions are used for UCP (which may
be different than "latest").
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* Address some v3/v2 issues, and YAML syntax error
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* Minor edit
* Final updates
- Added note around v2 and v3 versioning
- Updated note for v3 to match the v2 update
2019-04-12 15:25:47 +02:00
Shubh
68bf0b3dcd
Update index.md : #### host or none - network ( #8425 )
...
* Update index.md : #### host or none - network
Choosing specific network for a build instead of the [network_mode]. network_mode doesn't work when providing a network for a particular build rather it skips the block and move to next service thus using network.
* Minor syntax updates
* Update index.md
those changes were a result of conflict that i tried to resolve.
2019-04-01 13:28:59 -04:00
Maria Bermudez
ec0bcc6870
Merge pull request #8399 from eMPee584/patch-1
...
stop_signal supported with docker stack deploy
2019-03-19 14:18:08 -07:00
Sebastiaan van Stijn
38423908d4
Add highlighting to compose-file reference
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-03-19 12:14:44 +01:00
Maria Bermudez
755ac92c05
Merge pull request #8246 from frank-dspeed/patch-1
...
Update index.md
2019-03-18 12:02:08 -07:00
Maria Bermudez
4d463d7c97
Link to FROM and ARG interaction section
2019-03-18 12:01:28 -07:00
paigehargrave
a15783c694
Minor syntax updates
2019-03-17 12:47:00 -04:00
Frank Lemanschik
0934b5baa7
Update index.md
2019-03-16 03:43:51 +01:00
Maria Bermudez
ccbb5e2630
Revert "Revert "Merge branch 'master' of github.com:docker/docker.github.io""
...
This reverts commit 4b5fbbdbc9
.
2019-03-08 10:53:00 -08:00
Marcel Partap
580312e771
stop_signal supported with docker stack deploy
...
support was added nearly two years ago,
c.f. https://github.com/docker/cli/issues/370
2019-03-04 17:29:31 +01:00
Paige Hargrave
4b5fbbdbc9
Revert "Merge branch 'master' of github.com:docker/docker.github.io"
...
This reverts commit 813f45bdd7
, reversing
changes made to 2349c62566
.
2019-02-28 13:11:13 -05:00
Maria Bermudez
46b8b5a1bc
Merge pull request #8174 from docker/compose-legacy-option
...
Thank you, @seemethere !
2019-02-26 18:21:29 +00:00
L-Hudson
30807046cd
Merge pull request #7416 from artdgn/master
...
Clarifying some confusing explanations for limiting cpus resource.
2019-02-26 07:53:36 -05:00
Frank Lemanschik
3a553b9e3f
Update index.md
...
corrected typo buld => build
2019-02-14 08:50:24 +01:00
Frank Lemanschik
ba09fac0b9
Update index.md
...
Updated ARGS section to point out that args defined befor FROM in Dockerfiles do not get regonized after FROM without explicit redeclartion
2019-02-14 08:30:48 +01:00
L-Hudson
8292e0dc29
Merge pull request #8198 from thaJeztah/note_picking
...
Use consistent formatting for notes
2019-02-12 11:59:49 -05:00
Sergey Bon
5d944298d9
Fix typo: docker_compose.yml -> docker-compose.yml
2019-02-09 15:11:15 +02:00
Sebastiaan van Stijn
03d5b3396d
Use consistent formatting for notes
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-02-09 00:49:57 +01:00
Maria Bermudez
e9272d0977
Specify that mac_address is a legacy option
2019-02-06 18:07:30 -08:00
Wi1dcard
f6deeeafd1
Remove non-sense angle brackets.
2019-02-06 00:24:12 +08:00
paigehargrave
0dab4ade68
Merge branch 'master' into name-change-for-Docker-Desktop
2019-01-14 11:14:48 -05:00
paigehargrave
b47ac9ae3b
Update index.md
2019-01-11 16:10:52 -05:00
L-Hudson
387d1a14f7
Update index.md
...
Editorial crx
2019-01-10 11:45:35 -05:00
Maria Bermudez
dba97175ff
Merge branch 'master' into patch-1
2019-01-10 06:48:27 -08:00
Maria Bermudez
e6edbdd945
Merge pull request #7178 from adamancini/patch-8
...
Merging based on previous conversation
2019-01-02 13:42:00 -08:00
paigehargrave
2788a53481
Merge pull request #7728 from siyu6974/patch-1
...
Update example for deprecated name
2018-12-28 13:09:11 -05:00
Anne Henmi
30c6242a3e
Merge pull request #7624 from shin-/c4601-exclusive-external
...
Update docs for volume and networks about the changed behavior of the external key
2018-12-26 10:01:30 -07:00
Maria Bermudez
c01ab3cbda
Clarify versions of secrets config samples
2018-12-19 17:19:42 -08:00
Maria Bermudez
500c265a09
Merge branch 'master' into patch-1
2018-12-18 13:27:43 -08:00
Siyu
aac5701eae
Update index.md
2018-12-18 10:44:53 +01:00
Siyu
c52e3c834e
Add back old example but mark as deprecated
2018-12-18 10:44:10 +01:00
Dima Tisnek
6dd9fa00e9
Document consistency flag in mounts
2018-12-11 12:46:25 +09:00
Siyu
915f740182
Update example for deprecated name
...
secret.external.name is deprecated in favor of secret.name
2018-11-20 12:43:08 +01:00
Henré Botha
5c0fe6c663
Fix ordering of service config reference
2018-11-12 14:57:27 +02:00
Joffrey F
2efd2456d7
Update docs for volume and networks about the changed behavior of the external key
...
in newer versions of the format
Signed-off-by: Joffrey F <joffrey@docker.com>
2018-11-06 16:02:54 -08:00
arthur_x1
7753a6cd5a
Clarifying confusing explanations for limiting cpus resource in docker-compose file to prevent misunderstanding as "percent of total CPU available".
2018-09-25 10:55:18 +10:00
Oscar Caballero
269c80d2d9
Spelling revision
2018-09-23 21:43:11 +02:00
ada
5e8f7a25ab
NFS example for driver_opts
...
People ask me how to do this all the time, and I can't find a good example documented anyhwere else. I figure this is a better example of the actual usage of the driver_opts parameter with a real-world use case.
2018-08-06 13:42:15 -04:00
Cameron Steffen
35cefb2f73
fix init example version
2018-07-31 04:11:26 -05:00
Tammy Fox
9a0cb8c058
Merge pull request #6975 from sascha-egerer/patch-4
...
Fix copy and paste error
2018-07-26 00:35:28 -04:00
Joffrey F
caad3ebe13
1.22.0 release notes and documentation
...
Signed-off-by: Joffrey F <joffrey@docker.com>
2018-07-05 13:32:51 -07:00
Sascha Egerer
1165708794
Fix copy and paste error
...
"networks" must be "volumes" at that place
2018-06-30 22:04:59 +02:00
Ben Creasy
14ef9244e3
Cannot find reference to --net
...
Is network intended? It looks like this is talking about https://docs.docker.com/engine/reference/run/#network-settings
2018-06-15 14:59:56 -07:00
Xander Marjoram
87c84916f3
Documentation typo fixes
2018-05-18 10:06:05 -07:00
Trapier Marshall
2a62bcf235
fix version in compose placement pref example ( #6569 )
2018-04-27 09:22:24 -07:00
Teoh Han Hui
37f9546e32
Quote port numbers when using short syntax
...
Comply with our own advice.
2018-04-23 10:39:45 -07:00
James Gentes
a8b93a59ea
Added note to 'ports' section: Port mapping is incompatible with `network_mode: host`
...
Took a while to figure this one out. Source: https://github.com/docker/compose/issues/4799#issuecomment-299605031
2018-04-16 13:57:53 -07:00
rdxmb
246e8e2e3a
DO-NOT-MERGE update the docs for using host-network ( #6124 )
2018-04-11 13:09:49 -07:00
Gwendolynne Barr
c39ddd656a
Repair arg example to match v2 ( #6253 )
2018-03-17 22:00:02 -07:00
Marcus Geißler
11c1b1c65f
Use Compose stop instead of down
2018-03-05 09:49:49 +01:00
Marcus Geißler
67f6404740
Add information on stop order
...
Documentation should also mention that compose takes dependency order into account for shutdown as well.
docker/compose#2679
2018-03-03 15:46:59 +01:00
Joffrey F
1ba03f1a34
Add build target to v3 reference ( #6107 )
2018-02-27 16:11:01 -08:00
Diego Rabatone Oliveira
2f0e2b684a
Fix grammar error on compose-file index.md ( #6070 )
2018-02-25 09:03:19 -08:00
Joffrey F
2d12fdf671
Add docs for Compose file v3.5 and v3.6 ( #5912 )
...
Signed-off-by: Joffrey F <joffrey@docker.com>
2018-02-08 13:54:12 -08:00
Steven Showers
b7a9862728
Clarified max_attempts behavior ( #5949 )
2018-02-07 16:09:51 -08:00
ethan-haynes
074268b8ca
added doc changes for upcoming tmpfs-mode 3.6 compose ( #5777 )
...
Signed-off-by: Ethan Haynes <ethanhaynes@alumni.harvard.edu>
2018-02-07 13:18:54 -08:00
Misty Stanley-Jones
a4f5e30249
Various copyedits to reduce future tense, wordiness, and use of 'please' ( #5788 )
...
* Reword lots of instances of 'will'
* Reword lots of instances of won't
* Reword lots of instances of we'll
* Eradicate you'll
* Eradicate 'be able to' type of phrases
* Eradicate 'unable to' type of phrases
* Eradicate 'has / have to' type of phrases
* Eradicate 'note that' type of phrases
* Eradicate 'in order to' type of phrases
* Redirect to official Chef and Puppet docs
* Eradicate gratuitous 'please'
* Reduce use of e.g.
* Reduce use of i.e.
* Reduce use of N.B.
* Get rid of 'sexagesimal' and correct some errors
2018-01-25 17:37:23 -08:00
Bret Fisher
ead81f511c
Add restart to options not supported in stacks ( #5680 )
...
- added restart to list of sub-options not supported in stack deploy
- added note to the bottom of restart description that it isn't supported in stack deploy, and to use restart_policy instead.
2018-01-18 09:40:52 -08:00
Daniel Nephin
a83592ddaf
Update compose reference for name fields ( #5755 )
...
Signed-off-by: Daniel Nephin <dnephin@gmail.com>
2018-01-16 14:15:05 -08:00
Glenn O. Larsen
4626e6ed23
Document 'start_period' option in healthcheck ( #5735 )
2018-01-16 14:14:33 -08:00
new-guy
21c517a026
Note about setting ipv4/ipv6 not working in swarm ( #5466 )
...
* Note about setting ipv4/ipv6 not working in swarm
I spent a few hours yesterday assuming this was possible, but it turns out it isn't. Hopefully this will help prevent others from making the same mistake I did.
2018-01-08 12:30:35 -08:00
mouhamed
9a2141cf78
Use `docker container create` instead of `docker run` ( #5667 )
...
In this context, I think `docker container create` is more suitable and more respectful to the new syntax and better analogy with `docker network create` and `docker volume create`
2018-01-05 10:59:15 -08:00
Alex Finnarn
f57b348089
Update Example To Use Version 3 ( #5662 )
2018-01-03 16:52:15 -08:00
Peter Kokot
4c9fae8e23
Fix anchor link ( #5639 )
2018-01-02 10:01:49 -08:00
Joffrey F
6e4339fc4d
Update Compose docs to reflect changes in 1.18 release
...
Signed-off-by: Joffrey F <joffrey@docker.com>
2017-12-18 15:11:03 -08:00
Gwendolynne Barr
e2ea9531a6
Emphasize existing placement preference code ( #5531 )
2017-12-15 16:13:19 -08:00
Gwendolynne Barr
7ac30bb1af
Add legacy link warning ( #5535 )
2017-12-15 16:12:15 -08:00
ada
26ea6f3250
Remove dns & dns_search from "unsupported in compose v3"
...
6b60a60729
adds support for custom dns and dns_search settings to 'stack deploy'.
Tested on my lab in 17.06 with the following docker-compose.yml:
```
version: "3"
services:
bb1:
image: busybox
command: nslookup google.com
dns: 8.8.8.8
bb2:
image: busybox
command: nslookup google.com
```
results in:
```docker service inspect --format "{{ .Spec.TaskTemplate.ContainerSpec.DNSConfig }}" bbdns_bb1
{[8.8.8.8] [] []} ```
```
ada@trogdor ~/docker/docker-ee 17.06 git --no-pager log --all --grep 6b60a60729e0b22cc74197e5d00d1621435da7f7
commit 7254b7d7835250677ba58a10127b51e6db61c4ce
Author: Benjamin Boudreau <boudreau.benjamin@gmail.com>
Date: Thu Mar 23 19:38:17 2017 -0400
Adding support for dns in stack files
Signed-off-by: Benjamin Boudreau <boudreau.benjamin@gmail.com>
Upstream-commit: 6b60a60729e0b22cc74197e5d00d1621435da7f7
Component: engine
ada@trogdor ~/docker/docker-ee 17.06 git --no-pager tag --contains 7254b7d78v17.06.0-ce
v17.06.0-ce-rc1
v17.06.0-ce-rc2
v17.06.0-ce-rc3
v17.06.0-ce-rc4
v17.06.0-ce-rc5
v17.06.1-ce-rc1
v17.06.1-ee-1
v17.06.1-ee-1-rc1
v17.06.1-ee-1-rc2
v17.06.1-ee-1-rc3
v17.06.1-ee-1-rc4
v17.06.1-ee-2
v17.06.1-ee-2-rc1
v17.06.1-ee-2-rc2
v17.06.2-ee-3
v17.06.2-ee-3-rc1
v17.06.2-ee-4
v17.06.2-ee-4-rc1
v17.06.2-ee-4-rc2
v17.06.2-ee-4-rc3
v17.06.2-ee-5
v17.06.2-ee-5-rc1
v17.06.2-ee-5-rc2
v17.06.2-ee-6
v17.06.2-ee-6-rc1
v17.07.0-ce-rc1
v18.01.0-ee-1-tp3
v18.01.0-ee-1-tp4
v18.01.0-ee-1-tp5
```
2017-12-14 15:06:43 -08:00
Laura Frank
5701d86f06
Add example for `preferences` under deploy `placement` ( #5415 )
2017-11-30 13:55:52 -08:00
Alexandre Rio
d0cab2a0d5
Use valid CPU limits ( #5272 )
...
Use 50% and 25% CPU limits instead of invalid 0.001. Fix #5271
2017-11-10 12:25:21 -08:00
Dave Henderson
a38c5a6f9f
Document order option in update_config ( #5089 )
2017-11-01 18:40:56 -07:00
Misty Stanley-Jones
a9314c7ec7
Document new features in Compose 1.17 ( #5019 ) ( #5021 )
...
Signed-off-by: Joffrey F <joffrey@docker.com>
2017-11-01 18:40:56 -07:00
Misty Stanley-Jones
52de4ef650
Revert "Document order option in update_config ( #5089 )" ( #5105 )
...
This reverts commit 6c5c888882
.
2017-10-25 10:04:24 -07:00
Dave Henderson
6c5c888882
Document order option in update_config ( #5089 )
2017-10-24 16:30:03 -07:00
Misty Stanley-Jones
2eb70ea3c2
Add info about network: host ( #4959 )
2017-10-20 16:17:45 -07:00
Misty Stanley-Jones
d8adc37e74
Revert "Document new features in Compose 1.17 ( #5019 ) ( #5021 )" ( #5038 )
...
This reverts commit 52fe0df34b
.
2017-10-18 16:07:20 -07:00
Misty Stanley-Jones
52fe0df34b
Document new features in Compose 1.17 ( #5019 ) ( #5021 )
...
Signed-off-by: Joffrey F <joffrey@docker.com>
2017-10-17 21:17:28 -07:00
Misty Stanley-Jones
06c3b7cd34
Add docs for attachable key in composefile ( #4957 )
2017-10-13 16:00:56 -07:00
Misty Stanley-Jones
26ab6617b4
Backport note about links being legacy ( #4956 )
2017-10-13 16:00:26 -07:00
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