From f66abc0ad7ef40400c8fc8952448d43e916567e2 Mon Sep 17 00:00:00 2001 From: Alex Dadgar Date: Thu, 15 Oct 2015 17:28:25 -0700 Subject: [PATCH] Documentation --- website/source/docs/drivers/docker.html.md | 3 +++ .../source/docs/jobspec/environment.html.md | 21 +++++++++++++++++++ 2 files changed, 24 insertions(+) diff --git a/website/source/docs/drivers/docker.html.md b/website/source/docs/drivers/docker.html.md index bb6bdb9e6..02ead445d 100644 --- a/website/source/docs/drivers/docker.html.md +++ b/website/source/docs/drivers/docker.html.md @@ -23,6 +23,9 @@ The `docker` driver supports the following configuration in the job specificatio * `command` - (Optional) The command to run when starting the container. +* `args` - (Optional) Arguments to the optional `command`. If no `command` is + present, `args` are ignored. + * `network_mode` - (Optional) The network mode to be used for the container. Valid options are `default`, `bridge`, `host` or `none`. If nothing is specified, the container will start in `bridge` mode. The `container` diff --git a/website/source/docs/jobspec/environment.html.md b/website/source/docs/jobspec/environment.html.md index a9d865e7b..a80759843 100644 --- a/website/source/docs/jobspec/environment.html.md +++ b/website/source/docs/jobspec/environment.html.md @@ -56,6 +56,27 @@ exported as environment variables for consistency, e.g. `NOMAD_PORT_5000`. Please see the relevant driver documentation for details. +### Task Directories + +Nomad makes the following two directories available to tasks: + +* `alloc/`: This directory is shared across all tasks in a task group and can be + used to store data that needs to be used by multiple tasks, such as a log + shipper. +* `local/`: This directory is private to each task. It can be used to store + arbitrary data that shouldn't be shared by tasks in the task group. + +Both these directories are persisted until the allocation is removed, which +occurs hours after all the tasks in the task group enter terminal states. This +gives time to view the data produced by tasks. + +Depending on the driver and operating system being targeted, the directories are +made available in various ways. For example, on `docker` the directories are +binded to the container, while on `exec` on Linux the directories are mounted into the +chroot. Regardless of how the directories are made available, the path to the +directories can be read through the following environment variables: +`NOMAD_ALLOC_DIR` and `NOMAD_TASK_DIR`. + ## Meta The job specification also allows you to specify a `meta` block to supply arbitrary