Commit Graph

1094 Commits

Author SHA1 Message Date
Misty Stanley-Jones 669b51a889 Fix broken links (#2521) 2017-03-28 16:42:44 -07:00
Victoria Bialas 93bab5a66f Vnext compose (#2509)
* Adds documentation about the `--ignore-override` option

For PR https://github.com/docker/compose/pull/4543

When option `--ignore-override` is provided the `docker-compose.override.yml`
file, if it exists, will not be considered for any command. This option
has no effect when the `-f` option is used as that explicitly lists the
set of files to be considered.

Signed-off-by: Dennis Gove <dpgove@gmail.com>

* Compose 1.12.0 additions (#2472)

* Add mem_reservation to list of v2 options

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

* Add dns_opt to v2 service configuration

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

* Add pids_limit to service configurations

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

* Update list of options for docker-compose rm

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

* Update list of options for docker-compose config

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

* Add --exit-code-from to docker-compose up documentation

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

* Add --parallel to docker-compose pull reference

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

* Add build-args to docker-compose build reference

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

* Add --volume to docker-compose run reference

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

* Add --project-directory to list of docker-compose options

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

* Add reference docs for images command

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

* Add documentation for COMPOSE_PATH_SEPARATOR

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

* Add documentation for cache_from option

Signed-off-by: Joffrey F <joffrey@docker.com>
2017-03-28 10:50:44 -07:00
Daniel Nephin add1325878 Add ports and volumes long form syntax to compose-file reference (#2283)
* Add long form for ports.

Signed-off-by: Daniel Nephin <dnephin@gmail.com>

* Remove volume_driver from v3 reference.

Signed-off-by: Daniel Nephin <dnephin@gmail.com>

* Add docs for expanded mount syntax.

Signed-off-by: Daniel Nephin <dnephin@gmail.com>
2017-03-27 20:49:00 -07:00
Victoria Bialas 2f14b6ea51 added compose file example in accordion (#2477)
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-03-24 19:48:19 -07:00
Joffrey F f6c62c3934 Typo in compose overview page (#2445)
Add missing space.
2017-03-22 17:53:32 -07:00
Mateusz Kurek 92523b274e Fix external links from compose file docs (#2401)
Compose file v1 and v2 docs had relative links to some non-existing pages (especially about extending services). It was probably introduced when `compose-file.md` was detached into directory with single file per compose file version.
2017-03-21 11:55:35 -07:00
Victoria Bialas 5591401a2d clarified Compose file topic structure, and file examples (#2322)
copyedits, rewrite

fixed some links

simplified/shortened this topic

tweaked description of key, option, value

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-03-15 10:13:11 -07:00
Derek Bender 330ed3d24a fixup compose-file/index.md link (#2347) 2017-03-15 09:56:17 -07:00
Misty Stanley-Jones fb7c73908b Update the styleguide (#2332)
* Update the styleguide

Also normalize admonition titles with the colon outside the bold.
2017-03-15 09:46:30 -07:00
Victoria Bialas 9e244bbb9c added links to example of using overlay network in swarm mode (#2331)
added more links re: overlay networks

provided more links to networking topics, restructured the section

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-03-14 18:46:44 -07:00
Daniel Nephin 37333c8fe8 Fix depends_on in Compose file v3 reference (#2278)
* docker swarm does not respect depends_on

Swarmkit does not seem to have the concept of starting services in a particular order.

Tested with docker 1.13.1. Also, `docker-compose bundle` warns us about depends_on being unsupported.

* Remove condition form of depends_on from the V3 compose file docs.

Signed-off-by: Daniel Nephin <dnephin@gmail.com>
2017-03-14 17:38:59 -07:00
Victoria Bialas d784ad5c1f added more detail for Compose env (#2310)
incorporated Joffrey's comment

fixed heading levels

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-03-14 14:30:35 -07:00
Victoria Bialas f9d7107499 update to docker-compose rm reference per Compose v3 (#2288)
corrected docs to reflect docker-compose version update

updates per Joffrey's comments

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-03-13 15:53:19 -07:00
Victoria Bialas 4b9493d276 fleshed out Machine scp command description, fixed Compose file notes (#2265)
copyedit to fix typo

wrapped text properly

replaced original example with Nathan's

added a better sub-title

specifically mentioned not using relative paths

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-03-10 16:30:26 -08:00
Ryan Sanford a1ce533207 Update tail docs to match built-in docs (#2253)
Default value for tail helps me remember it's not a switch, but requires a value. This change makes it match the built-in docs.
2017-03-10 11:56:24 -08:00
Victoria Bialas 66d905032a Merge pull request #2239 from londoncalling/compose-startup-order-waitforit
clarified scripts logic for compose startup order
2017-03-09 17:10:54 -08:00
Victoria Bialas d1723bfe1f copyedit
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-03-09 16:59:17 -08:00
Misty Stanley-Jones a9bac844a5 Merge pull request #2160 from endlos/patch-2
Update rails.md
2017-03-09 15:45:09 -08:00
Victoria Bialas ec7774f46c clarified scripts logic for compose startup order
changed 'note' to 'tip'

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-03-09 12:04:26 -08:00
Victoria Bialas a020b82489 fixed link to Compose v2 restart
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-03-08 18:26:52 -08:00
Hugo 7b83cfebab Update rails.md 2017-03-06 20:01:57 -05:00
Piyush Maurya b582d52d94 update v1.11.1 to v1.11.2 (#2102) 2017-03-06 12:06:06 -08:00
Victoria Bialas 00d60e3054 Merge pull request #1979 from flemzord/patch-1
Change version for docker-compose
2017-03-02 15:34:02 -08:00
Victoria Bialas 09c432495f clarified docker stack deploy and bundles
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-03-01 18:30:48 -08:00
Joe Meissler b93760bea5 merge other changes, fix typo 2017-03-01 15:01:26 -08:00
Joe Meissler 32e4923e32 Merge branch 'master' into patch-1 2017-03-01 15:00:00 -08:00
Joe Meissler 963e6b5e6c mem_swappiness for current version and v1 2017-03-01 14:56:18 -08:00
Joe Meissler 5c87ba4009 Add documentation for mem_swappiness 2017-03-01 14:48:19 -08:00
Misty Stanley-Jones a3b95e3f0c Merge pull request #1803 from mtoothman/patch-1
Update run.md
2017-03-01 14:24:53 -08:00
Victoria Bialas 1b05f61663 Added "related topics" section 2017-03-01 13:47:13 -08:00
Matt d53941fa43 Update run.md
Address PR feedback.
2017-02-28 21:30:53 -05:00
Maxence Maireaux 28b1897289 Update install.md 2017-02-25 21:12:12 +01:00
John Mulhausen 4d93d1790b Fixes #1887 2017-02-22 13:56:50 -08:00
Misty Stanley-Jones 4576e1a6b7 Merge pull request #1921 from docker/fix-secrets-mode-doc
Fix error about permissions in secrets doc
2017-02-22 10:39:22 -08:00
Misty Stanley-Jones 93709c2b12 Merge pull request #1900 from shin-/missing_options_composefileref
Updated miscellaneous list of options for each format
2017-02-22 10:13:39 -08:00
Misty Stanley-Jones 33857cfe29 Tweaks 2017-02-22 09:49:09 -08:00
Misty Stanley-Jones 85bcea8ac1 Fix error about permissions in secrets doc
Also link to a resource for figuring out the right mode, since not all our readers are UNIX gurus.
2017-02-22 09:45:56 -08:00
Misty Stanley-Jones 9578525701 Merge pull request #1853 from knaperek/patch-1
Clarify compatibility of "networks" with more recent versions of compose.
2017-02-22 09:35:06 -08:00
Joffrey F 3e4005c360 Updated miscellaneous list of options for each format
Signed-off-by: Joffrey F <joffrey@docker.com>
2017-02-21 13:11:37 -08:00
Misty Stanley-Jones ef4671f75e Document secrets in compose file reference 2017-02-21 09:09:32 -08:00
mapk0y edfcf0c485 fix broken links in composer-file/index.md (#1857)
Signed-off-by: mapk0y <mapk0y@gmail.com>
2017-02-20 02:48:33 -08:00
Jozef 3083031907 Update networking.md
Clarify compatibility of "networks" with more recent versions of compose.
2017-02-18 20:16:35 +01:00
Victoria Bialas 4a70dd4cb2 removed on-page topic menu from ref pages
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-02-17 18:02:58 -08:00
Victoria Bialas a6eb34f018 added x-ref from scale reference to replicas in v3 Compose
incorporated Joffrey's comments

surface h1's in left menu on Compose file refs, fix liquid issue

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-02-17 17:23:52 -08:00
Andy Bulford 5160f1cf0b Remove 1.10.0 references from install.md
These were missed from PR #1819 so also needed updating to 1.11.1.
2017-02-17 14:30:45 -08:00
Victoria Bialas d9e2d542ca Merge pull request #1831 from londoncalling/compose-restart-link
fixed link in Compose file, modified on-page TOC
2017-02-17 14:18:57 -08:00
Victoria Bialas f36ad2fa3a fixed link in Compose file, expanded on-page TOC's to show more subtopics
fixed a link to variable substition in Compose v.3

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-02-17 14:07:32 -08:00
Andy Bulford a09e279035 Update install.md to refer to version 1.11.1 2017-02-17 13:11:25 -08:00
Matt fb0f9d56bc Update run.md
Minor grammar cleanup.
2017-02-16 22:20:42 -05:00
Victoria Bialas 40f912237b Merge pull request #1802 from londoncalling/Compose-extends-update
edit per Joffrey re: PR #1763
2017-02-16 18:37:30 -08:00
Victoria Bialas 49323a1137 edit per Joffrey re: PR #1763
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-02-16 18:20:09 -08:00
Victoria Bialas e845620aaf fixed nav menus to surface Compose file reference, changed links to several manuals to overviews
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-02-16 18:06:05 -08:00
Victoria Bialas 0396353b08 Merge pull request #1763 from Electron-libre/master
fix(compose:extends): not supported from version 3
2017-02-16 16:35:21 -08:00
Dirk d8d822adff Added a bit more detail to restart.md (#1668)
This killed me for a while, I expected that since environment variables were set after the build process that they would be reloaded on restart.
2017-02-16 16:00:24 -08:00
Roque Pinel be682d4f42 Fix startup-order.md link (#1769) 2017-02-16 14:48:46 -08:00
Victoria Bialas 03464b70cb changed `version 3` to `version 3.x` per Joffrey 2017-02-16 14:37:03 -08:00
John Mulhausen 989b3a7113 Update compose-versioning.md 2017-02-16 11:54:32 -08:00
Cedric Brancourt 0f4a08f916 fix(compose:extends): not supported from version 3 2017-02-16 19:39:23 +01:00
Tarun Chinmai 06583c91d9 Changed the `rails` command to `rake`
changed `rails db:create` to `rake db:create`
2017-02-15 22:14:18 +05:30
Devis Lucato 73662f59cb Fix broken links
Fix the broken links at the bottom of https://docs.docker.com/compose/compose-file/ page
2017-02-14 10:47:06 -08:00
Misty Stanley-Jones 404fa2295a Merge pull request #1608 from joaquincasares/patch-1
Update index.md
2017-02-13 16:51:44 -08:00
Misty Stanley-Jones 4e9553176f Merge pull request #1630 from ifraixedes/patch-1
Fix yml file in compose alias example
2017-02-13 16:44:07 -08:00
Misty Stanley-Jones 6cbbf69ca0 Merge pull request #1636 from shin-/v3-network-config
Remove unsupported IPAM config entries in v3
2017-02-13 16:41:58 -08:00
Josh Wyatt d5f60821fd Correct misspelling 2017-02-13 12:37:17 -08:00
Joffrey F 11f7db62e5 Remove unsupported IPAM config entries in v3
Signed-off-by: Joffrey F <joffrey@docker.com>
2017-02-13 12:14:50 -08:00
Ivan Fraixedes e7f6f5ab36 Fix yml file in compose alias example 2017-02-13 16:21:37 +01:00
Joaquin Casares 483d318528 Update index.md 2017-02-10 19:16:53 -06:00
Victoria Bialas b9f6524a28 Merge pull request #1603 from londoncalling/compose-and-docker-run
compose copyedit
2017-02-10 14:54:31 -08:00
Victoria Bialas 1db710d8f3 compose copyedit
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-02-10 14:18:32 -08:00
John Mulhausen 9abc9e9f41 Add documentation for new top command (#1534) (#1601)
Update command lists to include recent additions

Signed-off-by: Joffrey F <joffrey@docker.com>
2017-02-10 13:59:06 -08:00
Victoria Bialas 19b5b6ad9e clarified getting started Compose topics based on user feedback
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-02-10 11:49:52 -08:00
Marko Schulz 107be08421 Small documentation fix
There are four files (`Dockerfile`, `Gemfile`, `Gemfile.lock`, `docker-compose.yml`) described for the setup.
2017-02-10 12:29:47 +01:00
Victoria Bialas b7dfc2921e re-wording, copy-edit 2017-02-09 22:43:37 -08:00
Victoria Bialas 2b7c238b0c copyedits and improvements to Compose reference
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-02-09 19:40:27 -08:00
Victoria Bialas 55b004036a added drafts of versioned compose reference files
pruning Compose file v2 reference

updated Compose v1, v2, v3 files, still WIP

added includes for compatibility matrix, fixed TOC menu

new topic organziation Compose reference, split two 3 files plus versioning

Daniel's comments, fixed links, added more to versioning details

fixed volumes_from example per Daniel's comments for v1

simplified links to version references

copyedits and improved/surfaced links to versioning/upgrade docs

removed for version specific content re: volume_drivers from various files

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-02-09 17:39:08 -08:00
pedep be447bf1b5 Fix markdown rendering of example configuration (#1544)
* fix code block formatting after list

add comment between code block and list to fix markdown rendering

* Update compose-file.md

* Update compose-file.md
2017-02-08 15:49:14 -08:00
Juan Eugenio Abadie 91cc808b23 Fix link (#1392) 2017-01-26 14:12:28 -08:00
Michael Friis 2fb946b8f0 fix anchors (#1381)
signed-off by Michael Friis <friism@gmail.com>
2017-01-26 02:58:54 -08:00
Victoria Bialas bfbfbeeec5 added missing descriptions for update_config options
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-01-25 14:31:07 -08:00
Misty Stanley-Jones ef95a915eb Fixing broken links
Formatting improvements along the way
2017-01-25 11:51:14 -08:00
Juan Eugenio Abadie 2f472446a1 Add udp ports example (#1098) 2017-01-24 15:49:44 -08:00
Nick van der Meij bb81ccb937 Update envvars.md (#1008)
* Update envvars.md

Update envvars.md to reflect the supported values of COMPOSE_CONVERT_WINDOWS_PATHS

* Update envvars.md
2017-01-24 15:37:06 -08:00
Zhe Zhang cf42e71f2e update compose install to 1.10.0 (#1314) 2017-01-24 14:48:37 -08:00
Alex Urquhart 8b1117ad58 Update django.md
Fixed typo
2017-01-23 09:21:17 -05:00
John Mulhausen ebe778b906 Update imports to work properly (#1221)
Update imports to work properly
2017-01-20 09:58:54 -08:00
Victoria Bialas 3b314c12db draft 3 voting app sample updates
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-01-19 22:14:44 -08:00
Tim Smid 7063c5e921 Add notice for unsupported Compose file option when deploying stack. 2017-01-19 21:33:45 -08:00
Tim Smid 1e6b46b700 Add notice for ignored Compose file options when deploying a stack. 2017-01-19 21:33:45 -08:00
Joffrey F 19777ec0b9 Add new depends_on syntax documentation (#1031)
Miscellaneous fixes

Signed-off-by: Joffrey F <joffrey@docker.com>
2017-01-19 21:25:03 -08:00
Jari Takkala 5eb55e8414 Add sysctls option documentation
Describe the sysctls compose-file option.
2017-01-19 21:25:03 -08:00
Aanand Prasad 6c9616177e Update Compose file reference for version 3
Signed-off-by: Aanand Prasad <aanand.prasad@gmail.com>
2017-01-19 21:24:59 -08:00
Yong Wen Chua 8c458d4d82 Add documentation for service `userns_mode` key 2017-01-19 21:24:05 -08:00
Misty Stanley-Jones 3af3a8b7a2 Merge pull request #1146 from shin-/ipv6_networks_compose
Update instructions for IPv6-enabled networks
2017-01-18 15:28:22 -08:00
Victoria Bialas 749701f7d9 minor copyedits (#1148)
* minor copyedits

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-01-18 15:27:27 -08:00
Victoria Bialas ec839d5bf8 Merge pull request #1007 from NickvdMeij/patch-2
Update overview.md
2017-01-17 23:23:32 -08:00
Joffrey F efb8c5e492 Update instructions for IPv6-enabled networks
Signed-off-by: Joffrey F <joffrey@docker.com>
2017-01-17 15:43:52 -08:00
LRubin a3a53fc3ff more more link link fixes fixes
Signed-off-by: LRubin <lrubin@docker.com>
2017-01-11 15:02:28 -08:00
LRubin fde978afc5 more link fixes
Signed-off-by: LRubin <lrubin@docker.com>
2017-01-11 14:43:52 -08:00
Nick van der Meij e5e2b2d34a Update overview.md
Update overview.md to reference possible issues regarding windows to unix path convert issues
2016-12-30 21:46:29 +01:00
Misty Stanley-Jones 0d7778af0c Merge pull request #991 from sergei-solomonov/patch-1
typo fixed
2016-12-29 14:28:10 -08:00