Commit Graph

515 Commits

Author SHA1 Message Date
Daniel Nephin a7c2987991 Update docs for version being a string.
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2016-02-04 12:19:43 -05:00
Ben Firshman bdddbe3a73 Improve names in Compose file 2 example
Just makes it a bit clearer what's going on.

Signed-off-by: Ben Firshman <ben@firshman.co.uk>
2016-02-03 17:42:57 -08:00
Spencer Rinehart f612bc98d9 Fix example formatting for depends_on.
Markdown was acting against expectations here by merging the example indented YAML into the previous list item instead of treating it as a code block.

I decided that a better way of handling this would be to add a "Simple example:" line that is also used elsewhere in this file.  It resets the markdown indentation in a way that works.

Signed-off-by: Spencer Rinehart <anubis@overthemonkey.com>
2016-02-03 14:36:46 -06:00
Mary Anthony a713447e0b Fixing duplicate identifiers
Signed-off-by: Mary Anthony <mary@docker.com>
2016-02-02 12:04:13 -08:00
Daniel Nephin 4c4e94bc19 Merge pull request #2785 from dnephin/depends_on_with_extends
Fix list options when used with extends and multiple files
2016-02-02 13:36:46 -05:00
Daniel Nephin 3ec87adccc Update merge docs with depends_on, and correction about how links and volumes_from are merged.
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2016-02-02 10:49:43 -05:00
Daniel Nephin 7b03de7d01 Move command reference to overview.
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2016-02-02 10:46:52 -05:00
Daniel Nephin cf24c36c55 Rename the old environment variable page to link environment variables.
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2016-02-02 10:46:29 -05:00
Daniel Nephin 2df5593e8f Cleanup command-line reference docs by renaming overview to envvars.
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2016-02-02 10:46:28 -05:00
Daniel Nephin 5e30f089e3 Use the same capitalization for all menu items in the docs.
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2016-02-02 10:46:28 -05:00
Daniel Nephin 4f92004d9a Re-order compose docs so that quickstart guides come before other documentation.
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2016-02-02 10:46:28 -05:00
Mary Anthony 3fc72038c5 New navigation for 1.10 release
Updating with Joffrey's comments

Signed-off-by: Mary Anthony <mary@docker.com>
2016-01-27 12:05:56 -08:00
Aanand Prasad 8c250e220c Merge pull request #2754 from aanand/upgrading-improvements
Improvements to upgrade guide and script
2016-01-27 13:48:23 +00:00
Aanand Prasad d3a1cea170 Remove outdated warnings about links from docs
Signed-off-by: Aanand Prasad <aanand.prasad@gmail.com>
2016-01-27 02:34:59 +00:00
Aanand Prasad 650b0cec38 Remove ability to join bridge network + user-defined networks
Containers connected to the bridge network can't have aliases, so it's
simpler to rule that they can *either* be connected to the bridge
network (via `network_mode: bridge`) *or* be connected to user-defined
networks (via `networks` or the default network).

Signed-off-by: Aanand Prasad <aanand.prasad@gmail.com>
2016-01-27 00:42:09 +00:00
Aanand Prasad b84da7c78b Fix trailing whitespace in docker-compose.md
Signed-off-by: Aanand Prasad <aanand.prasad@gmail.com>
2016-01-26 23:22:21 +00:00
Aanand Prasad bacc2b730e Merge pull request #2748 from schmunk42/master
fixed documentation about traversing yml files
2016-01-26 17:20:40 +00:00
Aanand Prasad c39d5a3f06 Add note about named volumes to upgrade guide
Signed-off-by: Aanand Prasad <aanand.prasad@gmail.com>
2016-01-26 15:51:09 +00:00
Aanand Prasad e566a4dc1c Implement network_mode in v2
Signed-off-by: Aanand Prasad <aanand.prasad@gmail.com>
2016-01-25 23:24:55 +00:00
Tobias Munk 5fe0b57e5c fixed documentation about traversing yml files
Signed-off-by: Tobias Munk <schmunk@usrbin.de>
2016-01-25 19:33:39 +01:00
Dimitar Bonev 3a72edb906 Network fields schema validation
Signed-off-by: Dimitar Bonev <dimitar.bonev@gmail.com>
2016-01-22 16:42:10 +02:00
Daniel Nephin 963ec1ceda Merge pull request #2707 from dnephin/add_stop_signal_to_docs
Add stop signal to the docs
2016-01-21 18:41:28 -05:00
Joffrey F fec8cc9f80 Update documentation for `external` param
Signed-off-by: Joffrey F <joffrey@docker.com>

Conflicts:
	docs/compose-file.md
2016-01-21 18:51:28 +00:00
Aanand Prasad 59493dd7aa Add links to networks key references
Signed-off-by: Aanand Prasad <aanand.prasad@gmail.com>
2016-01-21 18:51:28 +00:00
Aanand Prasad 2f41f3aa7e Update documentation for links
Signed-off-by: Aanand Prasad <aanand.prasad@gmail.com>
2016-01-21 18:51:28 +00:00
Aanand Prasad 9a3378930f Document depends_on
Signed-off-by: Aanand Prasad <aanand.prasad@gmail.com>
2016-01-21 18:50:44 +00:00
Aanand Prasad 0554c6e6fd Update Compose file documentation for version 2
- Explain each version in its own section
- Explain how to upgrade from version 1 to 2
- Note which keys are restricted to particular versions
- A few corrections to the docs for version-specific keys

Signed-off-by: Aanand Prasad <aanand.prasad@gmail.com>
2016-01-21 18:50:44 +00:00
Daniel Nephin 3b1a0e6fc9 Add stop signal to the docs.
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2016-01-19 21:33:04 -05:00
Aanand Prasad 6b105a6e92 Update networking docs
Signed-off-by: Aanand Prasad <aanand.prasad@gmail.com>
2016-01-18 18:45:29 +00:00
Joffrey F 1ae57d92d4 Remove duplicate functions
Signed-off-by: Joffrey F <joffrey@docker.com>
2016-01-14 14:39:06 -08:00
Garrett Heel 9cfa71ceee Add support for build arguments
Allows 'build' configuration option to be specified as an
object and adds support for build args.

Signed-off-by: Garrett Heel <garrettheel@gmail.com>
2016-01-14 12:14:56 -08:00
Daniel Nephin 77b4ebc31f Merge pull request #2591 from moxiegirl/remove-todo
Fixing TODO visible in docs
2016-01-14 15:06:38 -05:00
Daniel Nephin c64af0a459 Add an acceptance test and docs for the down subcommand
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2016-01-14 11:11:08 -05:00
Michael A. Smith 9bff308251 Document Entrypoints and Commands as Lists
Signed-off-by: Michael A. Smith <msmith3@ebay.com>
2016-01-13 17:47:30 -05:00
Evgeniy Dobrohvalov bf48a781db Add flag for stops all containers if any container was stopped.
Signed-off-by: Evgeniy Dobrohvalov <scipetr@gmail.com>
2016-01-13 13:12:09 +03:00
Joffrey F ad8faad296 Merge pull request #2579 from vdemeester/update-reference-with-config-and-create
Add config and create to docs/reference
2016-01-12 15:16:45 -08:00
Aanand Prasad 52e50a9d9a Merge pull request #2626 from shin-/dbonev-2503-move-logging-config-under-separate-key
Move logging config under separate key in v2 compose files
2016-01-12 15:21:10 +00:00
Aanand Prasad 063a25ae7d Merge pull request #2392 from dnephin/docker_compose_events
docker-compose events
2016-01-12 11:45:27 +00:00
Daniel Nephin 2f8cb55412 Merge pull request #2571 from vdemeester/fix-unpause-typo
Fix typo in unpause reference doc
2016-01-09 12:31:21 -05:00
Daniel Nephin 37d41f22c6 Merge pull request #2572 from vdemeester/fix-run-missing-flag
Add missing --name flag to run reference doc
2016-01-09 12:30:57 -05:00
Daniel Nephin d1d3969661 Add docker-compose event
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2016-01-08 13:43:30 -05:00
Dimitar Bonev ed5f7bd394 log_driver and log_opt moved to logging key.
Signed-off-by: Dimitar Bonev <dimitar.bonev@gmail.com>
2016-01-08 01:54:45 +02:00
Vincent Demeester 0bca8d9cb3 Add config and create to docs/reference
Signed-off-by: Vincent Demeester <vincent@sbr.pm>
2016-01-06 21:28:52 +01:00
Vincent Demeester 4e75ed4231 Add missing --name flag to run reference doc
Signed-off-by: Vincent Demeester <vincent@sbr.pm>
2016-01-06 21:15:11 +01:00
Vincent Demeester 77d2aae72d Fix typo in unpause reference doc
Signed-off-by: Vincent Demeester <vincent@sbr.pm>
2016-01-06 21:14:30 +01:00
Joffrey F b253efd8a7 Update docs to define and document new compose.yml file format
Add volume configuration reference section.

Signed-off-by: Joffrey F <joffrey@docker.com>
2016-01-05 15:09:39 -08:00
Mary Anthony d4e913e42c Fixing TODO visible in docs
Signed-off-by: Mary Anthony <mary@docker.com>
2015-12-31 19:04:38 -08:00
Michael Gilliland 39af6b653b Update `volumes_from` docs to state default
[Proof of read-write](cfb1b37da2/compose/config/types.py (L26)).

I found myself wondering what the default was a couple of times, and finally decided to change it :)

Signed-off-by: Michael Gilliland <gillilandmj@upmc.edu>
2015-12-28 16:44:31 -05:00
Sebastiaan van Stijn 5ed559fa0e Update links
Updates some links to their new locations, and
replaces some http:// with https:// links.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2015-12-21 01:52:54 +01:00
Aanand Prasad 12a08255b5 Merge pull request #2554 from aanand/clarify-rm-behaviour
Clarify behaviour of 'rm'
2015-12-18 16:42:05 +00:00
Aanand Prasad 2e9a49b4eb Clarify behaviour of 'rm'
Signed-off-by: Aanand Prasad <aanand.prasad@gmail.com>
2015-12-17 17:50:45 +00:00
Dimitar Bonev a542041264 Added support for cpu_quota flag
Signed-off-by: Dimitar Bonev <dimitar.bonev@gmail.com>
2015-12-16 21:25:30 +02:00
Aanand Prasad dc39b01e00 Merge pull request #2512 from albers/completion-url
Use more robust download URL for completions
2015-12-08 16:27:09 +00:00
Aanand Prasad ecf2dd11f9 Merge pull request #2467 from dnephin/remove_migrate_to_labels
Remove migrate-to-labels.
2015-12-07 14:31:23 +00:00
Harald Albers 2525752a05 Use more robust download URL for completions
Signed-off-by: Harald Albers <github@albersweb.de>
2015-12-07 09:10:19 +01:00
Daniel Nephin de4a18ea6c Cherry-pick release notes for 1.5.2
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2015-12-04 10:26:20 -08:00
Daniel Nephin 3f39ffe72e FAQ document for Compose
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2015-12-02 10:47:32 -08:00
moxiegirl 0eba234c54 Merge pull request #2461 from SvenDowideit/move-to-docs-base-latest
Use FROM docs/base:latest again
2015-12-01 08:54:13 -08:00
Daniel Nephin a21f9993b3 Remove migrate-to-labels.
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2015-11-27 12:04:45 -05:00
Daniel Nephin 2ab3cb212a Add integration test and docs for build with a git url.
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2015-11-26 11:32:39 -05:00
Sven Dowideit fd06d699f2 Use FROM docs/base:latest again
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2015-11-26 20:30:12 +10:00
Daniel Nephin 6e89a5708f cherry-pick release notes from 1.5.1
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2015-11-24 13:24:46 -05:00
Daniel Nephin 3fdf0f43be Add note about required pip version.
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2015-11-19 12:55:03 -05:00
Sven Dowideit acf31181e8 Some small changes to clear up docs-validation complaints
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2015-11-19 13:35:09 +10:00
Daniel Nephin 7365a398b3 Update doc wording for ulimits.
and move tests to the correct module

Signed-off-by: Daniel Nephin <dnephin@docker.com>
2015-11-10 15:03:20 -05:00
Kevin Greene 22d90d2180 Added ulimits functionality to docker compose
Signed-off-by: Kevin Greene <kevin@spantree.net>
2015-11-10 14:07:04 -05:00
Adrian Budau c5c36d8b00 Added --force-rm to compose build.
It's a flag passed to docker build that removes the intermediate
containers left behind on fail builds.

Signed-off-by: Adrian Budau <budau.adi@gmail.com>
2015-11-10 13:05:04 -05:00
Daniel Nephin 6b002fb922 Cherry-pick release notes froim 1.5.0
And bump version to 1.6.0dev

Signed-off-by: Daniel Nephin <dnephin@docker.com>
2015-11-05 10:25:46 -05:00
Daniel Nephin e503e085ac Re-order extends docs.
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2015-11-03 11:52:44 -05:00
Daniel Nephin 8bdde9a731 Replace composition with Compose app.
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2015-11-03 11:28:51 -05:00
Daniel Nephin eab265befa Document using multiple Compose files use cases.
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2015-11-03 11:28:51 -05:00
Daniel Nephin c5cf5cfad4 Changes to production.md for working with multiple Compose files.
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2015-11-03 11:28:51 -05:00
Daniel Nephin 1c4c7ccfac Support a volume to the docs directory and add --watch, so docs can be refreshed.
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2015-11-03 11:28:51 -05:00
Daniel Nephin 7014cabb04 Remove duplication from extends docs.
Start restructuring extends docs in preparation for adding documentation about using multiple compose files.

Signed-off-by: Daniel Nephin <dnephin@docker.com>
2015-11-03 11:28:51 -05:00
Daniel Nephin c58cf036e3 Touch up intro paragraph with feedback from @moxiegirl.
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2015-11-02 15:16:23 -05:00
Daniel Nephin a3fb13e141 Add another feature to the docs - multiple environments per host.
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2015-11-02 15:16:23 -05:00
Daniel Nephin d9bc91b7cc Update intro docs based on feedback.
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2015-11-02 15:16:23 -05:00
Daniel Nephin db3b90b84e Updates to gettingstarted guide from PR feedback.
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2015-11-02 15:16:23 -05:00
Daniel Nephin 86d845fde3 Flush out features and use cases.
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2015-11-02 15:16:23 -05:00
Daniel Nephin 186d43c59f Extract the getting started guide from the index page.
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2015-11-02 15:16:23 -05:00
Daniel Nephin 53a0de7cf2 Add missing title to compose file reference.
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2015-11-02 15:16:23 -05:00
Daniel Nephin c7d164d01c Fixes #1843, #1936 - chown files back to host user in django example.
Also add a missing 'touch Gemfile.lock' to fix the rails tutorial.

Signed-off-by: Daniel Nephin <dnephin@docker.com>
2015-10-30 12:42:15 -04:00
Mazz Mosley 983dc12160 Clarify the command is an example
Signed-off-by: Mazz Mosley <mazz@houseofmnowster.com>
2015-10-29 16:52:00 +00:00
mnowster 6cd9bab35b Merge pull request #2276 from dnephin/update_networking_docs
Update docs about networking for current release
2015-10-29 15:19:02 +00:00
mnowster 3a2df57f3d Merge pull request #2273 from mnowster/cross-ref-docs
Add cross references for env/cli
2015-10-29 12:04:10 +00:00
Daniel Nephin 0ef3b47f74 Update docs about networking for current release.
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2015-10-28 15:17:11 -04:00
Mazz Mosley e13b8949b0 Add cross references for env/cli
Signed-off-by: Mazz Mosley <mazz@houseofmnowster.com>
2015-10-28 17:42:30 +00:00
Mazz Mosley c341860d11 Clarify `dockerfile` requires `build` key
Credit to @funkyfuture for the first PR addressing the clarification.
https://github.com/docker/compose/pull/1767

Signed-off-by: Mazz Mosley <mazz@houseofmnowster.com>
2015-10-28 17:27:38 +00:00
Sven Dowideit cf197253cd Possible link fixes
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2015-10-23 09:00:08 +10:00
Daniel Nephin ae3c66baed Merge pull request #2204 from mnowster/2123-escaping-env-variables
Attempt to document escaping env vars
2015-10-16 15:51:58 -04:00
mnowster a712d828d4 Merge pull request #2200 from aanand/revert-tutorials
Revert networking-related changes to getting started guides
2015-10-16 17:06:31 +01:00
Mazz Mosley 7b109bc026 Attempt to document escaping env vars
People are likely to run into their env vars being set to empty strings,
if they're not aware that they need to escape them for Compose to not
interpolate them.

Signed-off-by: Mazz Mosley <mazz@houseofmnowster.com>
2015-10-16 15:32:02 +01:00
mnowster b0c895c5f5 Merge pull request #2193 from mrfuxi/less-verbose-extends-docs
Docs for shorthand notation of extends. Issue #1989
2015-10-16 10:25:10 +01:00
Aanand Prasad 1ed23fb2de Revert networking-related changes to getting started guides
Signed-off-by: Aanand Prasad <aanand.prasad@gmail.com>
2015-10-16 11:58:27 +05:30
Karol Duleba ccfb6e6fa8 Docs for shorthand notation of extends. Issue #1989
Signed-off-by: Karol Duleba <mr.fuxi@gmail.com>
2015-10-15 22:17:13 +01:00
Per Persson c6ff81fe30 Remove incorrectly placed comment
I'm not sure if it should be there at all, but at least it should hardly be where it currently is located.

Signed-off-by: Per Persson <per.persson@exertisztorm.com>
2015-10-15 15:25:52 +02:00
Aanand Prasad d5f5eb1924 Enable use of Docker networking with the --x-networking flag
Signed-off-by: Aanand Prasad <aanand.prasad@gmail.com>
2015-10-14 11:19:43 -04:00
Mohit Soni f4efa29377 Added support for cgroup_parent
This change adds cgroup-parent support to compose project. It allows
each service to specify a 'cgroup_parent' option.

Signed-off-by: Mohit Soni <mosoni@paypal.com>
2015-10-14 15:02:42 +01:00
Daniel Nephin fbfbe60246 Rename yml.md to compose-file.md and add an alias for the old url.
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2015-10-14 09:51:34 -04:00
Daniel Nephin 01f44efe0d Re-arrange volume_driver in compose file reference.
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2015-10-14 09:50:37 -04:00