Commit Graph

54 Commits

Author SHA1 Message Date
Aanand Prasad e700d7ca6a Fix version in docs example
Signed-off-by: Aanand Prasad <aanand.prasad@gmail.com>
2016-03-08 18:15:18 +01:00
Aanand Prasad aa7b862f4c Clarify depends_on logic
Signed-off-by: Aanand Prasad <aanand.prasad@gmail.com>
2016-03-02 10:29:24 -08:00
Aanand Prasad 7684604830 Merge pull request #3023 from londoncalling/fix-note-3019
WIP: updated note format for dockerfile per Aanand's comments on PR #…
2016-03-01 11:11:55 -08:00
Aanand Prasad fc99c7ee19 Merge pull request #2584 from mjgpy3/patch-1
Update `volumes_from` docs to state default
2016-02-29 15:37:46 -08:00
Aanand Prasad 5be48ba1ed Update docs about using build and image together
Signed-off-by: Aanand Prasad <aanand.prasad@gmail.com>
2016-02-25 17:19:58 -08:00
Victoria Bialas 5cc420e727 WIP: updated note format for dockerfile per Aanand's comments on PR #3019
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2016-02-25 16:47:46 -08:00
Joffrey F 176b966486 Update documentation for volume_driver option.
Signed-off-by: Joffrey F <joffrey@docker.com>
2016-02-22 16:51:33 -08:00
Daniel Nephin 0d218c34c7 Make config validation error messages more consistent.
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2016-02-19 13:12:57 -05:00
Victoria Bialas eb4a98c0d1 corrected description of network aliases, added real-world example per #2907
copyedit to make  show as file format

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2016-02-18 18:05:52 -08:00
Joffrey F 7152f7ea76 Handle mismatched network formats in config files
Signed-off-by: Joffrey F <joffrey@docker.com>
2016-02-18 15:24:41 -08:00
Joffrey F 825a0941f0 Network aliases are now part of the network dictionary
Signed-off-by: Joffrey F <joffrey@docker.com>
2016-02-18 15:23:47 -08:00
Joffrey F 7801cfc5d1 Document network_aliases config
Signed-off-by: Joffrey F <joffrey@docker.com>
2016-02-18 15:23:47 -08:00
Daniel Nephin 4de12ad7a1 Update link to docker volume create docs.
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2016-02-16 16:43:22 -05:00
Spencer Rinehart 5e6dc3521c Add support for shm_size. Fixes #2823.
shm_size controls the size of /dev/shm in the container and requires
Docker 1.10 or newer (API version 1.22).  This requires docker-py 1.8.0
(docker/docker-py#923).

Similar to fields like `mem_limit`, `shm_size` may be specified as
either an integer or a string (e.g., `64M`).

Updating docker-py to the master branch in order to get the unreleased
dependency on `shm_size` there in place.

Signed-off-by: Spencer Rinehart <anubis@overthemonkey.com>
2016-02-10 15:25:18 -06:00
Aanand Prasad c43b25b0cf Merge pull request #2827 from loic/patch-1
Fixed typo in compose-file.md
2016-02-10 15:58:54 +00:00
Yohan Graterol 59a2920758 Typo into the doc with `networks` in yaml
Signed-off-by: Yohan Graterol <yohangraterol92@gmail.com>
2016-02-09 18:45:04 -05:00
Loïc Bistuer b635647105 Fixed typo in compose-file.md
Signed-off-by: Loïc Bistuer <loic.bistuer@gmail.com>
2016-02-05 09:50:22 +07:00
Aanand Prasad 422ff623b4 Merge pull request #2819 from bfirsh/improve-names-in-compose-file-2-example
Improve names in Compose file 2 example
2016-02-04 19:42:22 +00:00
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
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 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
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 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
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 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
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
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
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
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
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
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
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
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
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 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 53a0de7cf2 Add missing title to compose file reference.
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2015-11-02 15:16:23 -05: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