Commit Graph

312 Commits

Author SHA1 Message Date
Ben Barnard 8c0a4196f7 Minor documentation edits for grammar and clarity
These are things I noticed as I read through the documentation.
There are a couple of minor substantive corrections as well.
2016-10-11 15:52:50 -04:00
Michael Schurter 1a04d7a303 Fix ticks 2016-10-07 16:43:17 -07:00
Michael Schurter 2d5f973954 Add docker volume example 2016-10-07 16:23:55 -07:00
Michael Schurter 4a8dcf7e85 Add example docker load config 2016-10-07 16:19:05 -07:00
Michael Schurter f0173b361f Fix docker docs; add volumes/logging to changelog 2016-10-07 12:28:42 -07:00
Michael Schurter 44219cc083 Put docker volume support behind conf flag
Also add tests and fix bug with logging driver configuration.
2016-10-03 15:02:50 -07:00
Seth Vargo cbfa0b2df5
Fix formatting and add more examples to driver docs 2016-10-03 17:35:20 -04:00
Seth Vargo 3fd682076c Remove raw-exec example 2016-10-03 17:11:10 -04:00
Seth Vargo 36da4df3b1 Remove exec example 2016-10-03 17:10:53 -04:00
Seth Vargo 283ab84cdf
Update driver docs with constraint examples 2016-10-03 17:01:24 -04:00
Seth Vargo c60962045a
Fix docker args docs 2016-09-27 19:14:10 -07:00
Theo Hultberg adc0da890d Clarify that the Java driver needs root on Linux
Update the Java task driver docs to clarify that Nomad needs to run as root on Linux.
2016-09-12 18:22:31 +02:00
Dave Cohen b2a9f9db07 one last tiny pedantic fix, I swear. 2016-08-27 09:04:01 -04:00
Dave Cohen e5c39e53da more tiny doc fixes 2016-08-27 08:56:39 -04:00
Dave Cohen 7c31740e6d small spelling correction 2016-08-27 08:18:02 -04:00
ramukima 17b902f20f issue-1588 : Allow extra driver config args as a passthrough for qemu executable from a task specification 2016-08-15 23:36:13 -04:00
Diptanu Choudhury 9a75052d2c Merge pull request #1518 from pubnub/feature/chroot-map-rebase
Add config field to specify chroot mapping for exec driver
2016-08-10 17:00:03 -07:00
Kenjiro Nakayama 11a8a7218e Add debug option to rkt task config 2016-08-09 09:01:05 +09:00
Jay Oster 20d3d00b29 Add documentation for chroot_env client configuration 2016-08-05 15:59:06 -07:00
Alex Dadgar 096956257d changelog 2016-08-05 10:47:44 -07:00
Mathias Lafeldt d91f7dbdf8
Docker driver: allow to configure working directory 2016-08-03 16:18:15 +02:00
Alex Dadgar cec6d8a1eb remove gating of ipc, user ns and pidmode based on hosts priviledge mode config 2016-08-02 16:02:34 -07:00
Dara Kong 82e08d0606 Docs: Fix list of chroot directories
The chroot list was updated in be1266e42d
2016-07-20 18:13:06 -07:00
Diptanu Choudhury 917b687d95 Merge pull request #1440 from nak3/fix-allocating-ports-example
[docs] Write allocate ports example accurately
2016-07-20 10:08:11 -07:00
Kenjiro Nakayama d29579daf0 [docs] Write allocate ports example accurately in the doc of the docker driver 2016-07-20 20:55:42 +09:00
Kenjiro Nakayama 55d8862a81 Use array for jvm_options example in JAVA Driver 2016-07-20 16:31:44 +09:00
Mathias Lafeldt ace9cfa272
Fix indent of args block 2016-07-19 19:44:03 +02:00
Mathias Lafeldt a81e4fa3a7
Remove unrelated code snippet from docs 2016-07-19 19:39:22 +02:00
Mathias Lafeldt 722669451a
Fix typos in documentation 2016-07-18 16:24:30 +02:00
Diptanu Choudhury 91062dd83c Updated docs 2016-06-21 16:55:23 -07:00
Diptanu Choudhury ed67f1a347 Merge pull request #1285 from hashicorp/fix-selinux-options
Added a client options for setting selinux options
2016-06-16 22:45:24 +02:00
Diptanu Choudhury 266c417ac8 Changed the client options for docker volume selinux labels 2016-06-16 21:41:02 +01:00
Alex Dadgar 8765c25ce2 correct the dynamic port specification 2016-06-16 11:27:42 -07:00
Daniel Kerwin df7f5175a8 Add support for shm_size to docker driver. Required update of go-dockerclient
to more recent version (ba4298ecf4cfa216f1cce2befbf653359f62c722).
2016-05-27 12:30:04 +02:00
Diptanu Choudhury 2f5575962d Added doc for the SSL key of the docker driver config 2016-04-22 13:23:22 -07:00
Alex Dadgar a5a75e11d9 website 2016-04-14 13:04:04 -07:00
Alex Dadgar 78adfa8ed6 changelog + docker GC cleanup 2016-04-14 10:52:38 -07:00
Paul Hinze 044978783f client/docker: add `interactive` option
Equivalent to `docker run --interactive` - keeps STDIN open.

Also adds docs for both `tty` and `interactive` docker config.
2016-04-08 12:51:07 -05:00
Diptanu Choudhury 2601468708 Making the load a list of strings and added website docs 2016-03-30 17:23:29 -07:00
Alex Dadgar 7d2931d61f Clarify client options in drivers 2016-03-22 14:29:47 -07:00
Alex Dadgar 40adf40549 document artifact downloading 2016-03-16 09:56:04 -07:00
Matt ef5612212e Typo in docker.html.md
Fixing misspelling in docs.
2016-03-14 10:01:40 -04:00
Abhishek Chanda 3260254cb4 Enable passing DNS info to the rkt driver 2016-03-08 18:59:11 -08:00
Erik Evenson bef4b0d9b6 Merge branch 'master' into study/aws-ecr-1 2016-03-06 18:18:20 -06:00
Pete Shima d34e5fe52f Fix capitalization of Nomad in doc update 2016-03-01 23:52:42 -08:00
Pete Shima 1374ba8101 Add a specific doc entry for the common error you may see when you are
using the exec driver and not running as root.
2016-03-01 23:51:11 -08:00
Erik Evenson b2a1710614 updates docs 2016-02-27 12:10:36 -06:00
Stig Kleppe-Jørgensen 0164b53a33 Spelling: intepretable --> interpretable 2016-02-14 16:21:38 +01:00
Alex Dadgar e6e7c395df Merge pull request #775 from hashicorp/d-interpreted-vars
Documentation for interpreted variables
2016-02-11 08:40:31 -08:00
Alex Dadgar 40f510f168 interpreted variable docs 2016-02-06 15:35:07 -08:00
Diptanu Choudhury d0b6fb1993 Updated the docker auth config 2016-02-06 05:47:56 -08:00
Diptanu Choudhury 745bfaae7b Reading dockercfg files for authenticating with private registries 2016-02-06 05:43:30 -08:00
Alex Dadgar 5018f5dd1e Only interpret vars wrapped in braces 2016-02-04 17:26:46 -08:00
Alex Dadgar 77b89d15e4 Extract artifacts to the root of the task, not in the local directory 2016-02-04 15:18:22 -08:00
Alex Dadgar 36966ad2fe Chroot documentation 2016-01-21 15:02:51 -08:00
Alex Dadgar 08afeba499 Fix missing quote in driver docs 2016-01-14 08:14:57 -08:00
Ryan Slade ff8b50b8ee Update docker.html.md
Add a missing quote.
2016-01-14 17:58:40 +02:00
Alex Dadgar e41435e272 Documentation 2016-01-11 11:12:09 -08:00
Bastiaan Bakker 63f8f60314 add documentation for ipc_mode and uts_mode 2016-01-10 22:19:33 +01:00
Bastiaan Bakker fcfa8373b2 Add options ipc_mode, pid_mode and uts_mode to docker driver.
May only be used if priviliged mode is enabled in driver config.
2016-01-08 23:34:49 +01:00
Alex Dadgar f3dbccdb48 Update rkt docs 2015-12-22 10:37:45 -08:00
Abhishek Chanda 97b0fb3c49 Update some rkt docs 2015-12-23 00:05:25 +05:30
jorge.marey f2b89d2943 Fix dns_search_domains option in the documentation. 2015-12-15 22:22:58 +01:00
Charlie Drage 922e88b1a9 Update rkt docs for > v.0.10.0 of rkt 2015-11-26 18:10:12 -05:00
Matt Button 5a7a9aee2a Fix syntax error in raw_exec config documentation
Keys need to be surrounded by quotes if they contain periods
2015-11-21 20:18:16 +00:00
Chris Bednarski 4063b6583e Added docker.tls config file options and docs 2015-11-20 15:47:03 -08:00
Carlos Diaz-Padron 341e9da221 Fix small typo in Docker auth docs 2015-11-19 23:11:08 -08:00
Diptanu Choudhury 563bb60f52 Fixed the docs related to port map and networking 2015-11-18 21:03:50 -08:00
Chris Bednarski 51163eea36 Fix some typos 2015-11-18 17:49:20 -08:00
Chris Bednarski ea2756d6fb Reformat 2015-11-18 16:45:39 -08:00
Chris Bednarski b9999dffbe Merge branch 'master' into docs-networking 2015-11-18 16:40:20 -08:00
Chris Bednarski 92734c6d3b Added notes about container name and UDP/TCP 2015-11-18 16:39:02 -08:00
Chris Bednarski 2338af6438 Updated docker docs with information about port_map and auth options 2015-11-18 16:30:37 -08:00
Alex Dadgar 4d817f5cbc Revert "Revert "Make drivers take arguments as a list and not as a string"" 2015-11-18 15:16:42 -08:00
Alex Dadgar 0e51375285 Revert "Make drivers take arguments as a list and not as a string" 2015-11-18 13:46:43 -08:00
Alex Dadgar 5a678548fa Rebase 2015-11-18 12:30:35 -08:00
Alex Dadgar 28c2934e29 Docs 2015-11-18 12:29:04 -08:00
Chris Bednarski b9fcdc400a Merge branch 'master' into f-docker-dns-config 2015-11-18 10:31:06 -08:00
Carlos Diaz-Padron 4a6c3d773d Nest Docker driver auth under object 2015-11-18 01:37:42 -08:00
Carlos Diaz-Padron de6c06d332 De-nest docker registry auth and reformat related doc 2015-11-17 23:32:57 -08:00
Chris Bednarski 03ba7f4616 Updated docs to indicate you should use a list 2015-11-17 22:05:56 -08:00
Alex Dadgar 105ff25764 Fix docker config option name in docs 2015-11-17 21:30:15 -08:00
Alex Dadgar 4d339c198b Update qemu docs 2015-11-17 21:19:45 -08:00
Chris Bednarski e330107112 Reformat post-merge 2015-11-17 17:23:16 -08:00
Chris Bednarski 122220a424 Merge branch 'master' into f-docker-any-network 2015-11-17 17:22:13 -08:00
Chris Bednarski d94bd74bb5 Updated docs for networking_mode and also reformat the file 2015-11-17 17:20:28 -08:00
Chris Bednarski ffd3f114dd Merge branch 'docker-allow-to-add-labels' of https://github.com/fernandezvara/nomad into f-docker-labels 2015-11-17 16:02:42 -08:00
Alex Dadgar 74d95a0d2a Update rkt docs to denote its experimental status 2015-11-17 15:39:38 -08:00
Antonio Fernández 2521aea7d4 updating website: docker driver configuration 2015-11-17 14:14:35 +01:00
Carlos Diaz-Padron 3fabe47229 Add note to Docker hostname to explain hostname duplication 2015-11-16 23:14:28 -08:00
Carlos Diaz-Padron 77923255b4 Add hostname parameter to Docker driver 2015-11-16 22:44:44 -08:00
Alex Dadgar bb9f2aa66c Docker privileged checks if host enabled it 2015-11-06 10:38:54 -08:00
Alex Dadgar 149366b89e Merge pull request #390 from the-control-group/f-docker-driver-options
Expanded docker driver options
2015-11-06 10:32:54 -08:00
Shiem Edelbrock 1169bef912 Updated `priviliged` option, added client `priviliged` option
- Added error checking on priviliged mode.
- Added `docker.privileged.enabled` to client config/fingerprint
2015-11-05 16:40:20 -08:00
Shiem Edelbrock adb8d4c1f7 Merge branch 'master' of https://github.com/hashicorp/nomad into f-docker-driver-options
* 'master' of https://github.com/hashicorp/nomad: (59 commits)
  Move the executor and spawn package into driver
  Remove file watching
  Check if the PID is alive instead of heartbeating through modify time
  Update CHANGELOG.md
  nomad/watch: add a note about the Item struct
  go fmt this file
  Vet errors
  Search path
  Update website
  Make a basic executor that can be shared and fix some fingerprinting/tests
  Small improvements
  Use const value for AWS metadata URL
  Create Spawn pkg that handles IPC with the spawn-daemon and update exec_linux to use that
  Fixed the restart policy syntax
  Introducing vars to create default batch and service restart policies
  Fixed the tests
  Declaring Batch and Service default restart policies
  Fixing tests to not create a TG without restart policies
  This option only work -> This option only works
  leave -> leaving
  ...
2015-11-05 10:48:09 -08:00
Shiem Edelbrock c174f4819b Added task configuraton options for docker driver
- Added `priviliged` option to task config to allow containers to run in
 priviliged mode.
- Added `dns-servers` option to task config to allow containers to use
  custom DNS servers
- Added `search-domains` option to task config to allow containers to
  use custom dns search domains
- Added authentication options (under key namespace `auth.*`) to allow
  authentication on a task level for docker remote.
- Updated site docs to reflect changes
2015-11-05 10:47:41 -08:00
Clint Shryock 145a2e3610 refactor drivers to use new getter 2015-11-05 08:55:30 -06:00
Alex Dadgar ec2c9b6d52 Update website 2015-11-03 12:57:39 -08:00
Clint 4b0dc2cb39 Merge pull request #288 from hashicorp/f-go-getter
Drivers: Use go-getter for artifact retrieval, add artifact support to Exec, Raw Exec drivers
2015-10-26 10:00:29 -05:00
Clint Shryock 343daeb1ea drivers: Add/Use go-getter to fetch remote binaries
Updates Qemu, Java drivers to use go-getter to fetch binaries
Adds remote artifact support for Exec, Raw Exec drivers
2015-10-26 09:40:06 -05:00
Seth Vargo 4c7520c79f Merge pull request #338 from charlieok/patch-3
resources use -> resource use
2015-10-25 13:16:35 -04:00
Seth Vargo ffb8e7a17f Merge pull request #336 from charlieok/patch-1
diver -> driver
2015-10-25 13:15:38 -04:00
Charlie O'Keefe 4b796002b8 resources use -> resource use 2015-10-25 11:15:14 -06:00
Charlie O'Keefe 6b7b568219 systems -> system's 2015-10-25 11:10:37 -06:00
Charlie O'Keefe 3f28e609fb diver -> driver 2015-10-25 11:06:28 -06:00
Charlie O'Keefe 20b1274653 will be ran -> will be run 2015-10-25 11:00:08 -06:00
Alex Dadgar 0ef5ee51f6 Merge pull request #307 from hashicorp/qemu-checkup-doc-update
driver/qemu: Update docs, we use SHA256 not MD5
2015-10-19 13:35:15 -07:00
Clint Shryock 9d0005e87e driver/qemu: Update docs, we use SHA256 not MD5 2015-10-19 14:14:41 -05:00
Alex Dadgar 8582b4d7f9 Merge pull request #299 from charlieok/patch-2
suggested clarification on automatic port mapping
2015-10-19 10:53:04 -07:00
Charlie O'Keefe f360e9e9eb Update docker.html.md 2015-10-17 15:56:05 -06:00
Charlie O'Keefe 2e08ff67bd depending how how -> depending on how 2015-10-17 14:55:55 -06:00
Charlie O'Keefe 225f93f067 suggested clarification on automatic port mapping 2015-10-17 11:54:17 -06:00
Alex Dadgar fd77180d64 Merge pull request #291 from hashicorp/d-rkt-volume-mounts-blocked
Document that Rkt doesn't support task directory mounting
2015-10-16 17:07:53 -07:00
Abhishek Chanda 603526c341 Add docs for jvm_options 2015-10-16 12:44:43 -07:00
Alex Dadgar f185701d6d Rkt driver clears task environment variables 2015-10-15 18:19:13 -07:00
Alex Dadgar 9c7c88176a Rename from bug to issue 2015-10-15 17:56:36 -07:00
Alex Dadgar fe9c0f46bf Document that Rkt doesn't support task directory mounting 2015-10-15 17:55:26 -07:00
Alex Dadgar 75d158e3d5 Documentation 2015-10-15 17:28:25 -07:00
Alex Dadgar 1b52202482 Merge pull request #267 from achanda/docs
Some docs update
2015-10-13 14:45:36 -07:00
Abhishek Chanda 0af5f1390f Clarify that container is an invalid option 2015-10-13 13:31:56 -07:00
Alex Dadgar 3c7bbc6fd7 Update driver config names for consistency and make the trust_prefix optional 2015-10-12 14:37:56 -07:00
Alex Dadgar cd3135c874 Separate args from exec command; inject environment variables and general cleanup of Rkt driver 2015-10-12 14:33:18 -07:00
Abhishek Chanda e109057b66 Do not say the bool is set to true
This will be harmonized across all drivers soon
2015-10-12 13:40:31 -07:00
Alex Dadgar a4035050e8 Change Docker/Rkt to set driver to 1 not true for consistency 2015-10-12 13:15:37 -07:00
Abhishek Chanda 61215971b0 Fix formatting for qemu driver version 2015-10-11 12:55:23 -07:00
Abhishek Chanda f9bebb2f2e Add details to docker driver docs
- The driver sets a bool to `true`
- Clarify behavior when `network_mode` is `container`
2015-10-11 12:53:34 -07:00
Alex Dadgar 540007c1a3 Merge pull request #237 from hashicorp/f-raw-exec-driver
A raw fork/exec driver that provides no isolation.
2015-10-09 11:30:12 -07:00
Alex Dadgar db0ba9688d Better parsing of raw_exec option and updated docs 2015-10-09 11:29:59 -07:00
Chris Bednarski 0d6c75eefb Merge pull request #225 from hashicorp/b-docker-port
Change docker default port to support windows and boot2docker
2015-10-08 23:50:11 -07:00
Alex Dadgar f209a07d10 Documentation 2015-10-08 12:19:39 -07:00
Alex Dadgar 751a17ef0c Actually add the files 2015-10-08 12:19:39 -07:00
Chris Bednarski 85098bb797 Added documentation for DOCKER_HOST and docker.endpoint; also filled in docs for docker.cleanup 2015-10-08 00:08:54 -07:00
Abhishek Chanda 0e185b6eaf Add an optional exec parameter to task config
This overrides the default exec command in the ACI
2015-10-07 15:15:36 -07:00
Abhishek Chanda ab6d756dfe Remove a stray comment 2015-10-06 15:56:39 -07:00
Abhishek Chanda f3cc677527 Fix network mode
net is not a valid network mode
2015-10-02 16:11:38 -07:00
Abhishek Chanda 0cb649bd5f Enable setting networking mode for docker
This patch enables setting networking mode for the docker
driver. This does not handle the `container` mode.
Closes #175
2015-10-01 18:52:41 -07:00
Dave York b1720ea5b2 fixes a typo in the docs 2015-09-29 17:00:48 -04:00
Chris Bednarski 7021ac3ce8 Add docker 'command' to docs; cleanup some comments 2015-09-25 23:28:23 -07:00
Chris Bednarski a8c8fc2f96 Merge branch 'master' into b-docker-fixes
Conflicts:
	client/driver/docker_test.go
	client/driver/java_test.go
	client/driver/qemu_test.go
2015-09-25 18:35:23 -07:00
Chris Bednarski 32d260281f Added guards to tests so we can more gracefully degrade the test suite when thing are not installed 2015-09-25 16:49:26 -07:00
Armon Dadgar 5bc26c3f9d Merge pull request #101 from hashicorp/f-qemu-network-update
driver/qemu: Use Restricted Ports, additional port forwarding
2015-09-25 16:36:46 -07:00
Chris Bednarski ac9b7e7a31 Added group add command for docker to the docker docs 2015-09-25 11:29:38 -07:00
Chris Bednarski ee00969c1c Merge pull request #113 from hashicorp/docs-docker
Added docker docs; updated isolation notes for QEMU
2015-09-24 23:41:01 -07:00
Chris Bednarski ac0f07cd20 Add note on configuring the agent; fix some typos 2015-09-24 23:40:30 -07:00
Chris Bednarski e4686e1872 Lowercase some cases of docker 2015-09-24 19:35:52 -07:00
Chris Bednarski 1aaef18d0a Added docker docs; updated isolation notes for QEMU 2015-09-24 19:33:06 -07:00
Clint Shryock bdfb035cf5 misc cleanups 2015-09-24 16:37:32 -05:00
Clint Shryock 0ac8fa4a23 update docs on port matching for Qemu 2015-09-24 14:36:03 -05:00
Armon Dadgar 3bdae950c5 Merge pull request #97 from hashicorp/f-qemu-driver-docs
Basic Qemu docs
2015-09-23 14:37:56 -07:00
Clint Shryock e2c1bfe19c Basic Qemu docs 2015-09-23 14:44:49 -05:00
Clint Shryock 0db8ce12d4 Update Java docs on how Java is detected 2015-09-23 14:16:43 -05:00
Clint Shryock b93518b509 start the Qemu docs 2015-09-23 13:58:42 -05:00
Clint Shryock 69dff9f608 some Java driver docs 2015-09-23 11:44:17 -05:00
Clint Shryock a330cdc80e Merge branch 'master' into f-java-driver-docs
* master: (115 commits)
  Ignore common files
  demo/vagrant: Adding files for getting started
  website: adding clustering to getting started
  scheduler: job anti-affinity score should record as negative
  scheduler: do not skip job anti-affinity
  client: reset response struct to avoid decode errors
  client: create dir, handle not exist more gracefully
  website: starting cluster section
  website: skip HTTP in intro
  command/init: tweak constraint
  website: typo fixes
  command/run: update synopsis
  command/run: update help output
  website: update 'run' docs
  website: getting started
  command/init: fixing inconsistencies
  command/node-status: removing extra formating input
  command/init: reworking behavior and default file
  website: getting started
  website: getting started
  ...
2015-09-23 10:55:43 -05:00
Alex Dadgar 925edfa46d Update website documentation on the fork/exec driver + Vagrantfile fixes 2015-09-22 18:31:13 -07:00
Clint Shryock e195f29cde start java docs 2015-09-21 14:20:51 -05:00
Armon Dadgar 22779cf323 website: improve cross linking 2015-09-20 15:51:49 -07:00
Armon Dadgar a3c7def68f website: document exec driver 2015-09-20 15:42:33 -07:00
Armon Dadgar 0b3d488d81 website: skeleton drivers 2015-09-20 15:31:33 -07:00
Seth Vargo 7703edb86c Update website to remove a lot of copy-paste with Vault + improve images 2015-09-20 16:37:22 -04:00
Armon Dadgar 201cfc4be1 website: adding drivers section 2015-09-19 12:18:08 -07:00
Armon Dadgar 5cd47f54d7 website: cleanup dead docs 2015-09-19 12:14:13 -07:00