diff --git a/website/source/docs/drivers/docker.html.md b/website/source/docs/drivers/docker.html.md index d1c6bafbe..a50bc1cec 100644 --- a/website/source/docs/drivers/docker.html.md +++ b/website/source/docs/drivers/docker.html.md @@ -19,13 +19,13 @@ and cleaning up after containers. The `docker` driver supports the following configuration in the job specification: -* `image` - (Required) The Docker image to run. The image may include a tag or +* `image` - The Docker image to run. The image may include a tag or custom URL. By default it will be fetched from Docker Hub. * `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. +* `args` - (Optional) A list of 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. In order to support userspace networking plugins in Docker 1.9 this accepts any diff --git a/website/source/docs/drivers/exec.html.md b/website/source/docs/drivers/exec.html.md index f897b1ea4..3d921aa6d 100644 --- a/website/source/docs/drivers/exec.html.md +++ b/website/source/docs/drivers/exec.html.md @@ -20,15 +20,19 @@ scripts or other wrappers which provide higher level features. The `exec` driver supports the following configuration in the job spec: -* `command` - (Required) The command to execute. Must be provided. -* `artifact_source` – (Optional) Source location of an executable artifact. Must be accessible -from the Nomad client. If you specify an `artifact_source` to be executed, you -must reference it in the `command` as show in the examples below -* `checksum` - **(Optional)** The checksum type and value for the `artifact_source` image. -The format is `type:value`, where type is any of `md5`, `sha1`, `sha256`, or `sha512`, -and the value is the computed checksum. If a checksum is supplied and does not -match the downloaded artifact, the driver will fail to start -* `args` - The argument list to the command, space seperated. Optional. +* `command` - The command to execute. Must be provided. + +* `artifact_source` – (Optional) Source location of an executable artifact. Must + be accessible from the Nomad client. If you specify an `artifact_source` to be + executed, you must reference it in the `command` as show in the examples below + +* `checksum` - (Optional) The checksum type and value for the `artifact_source` + image. The format is `type:value`, where type is any of `md5`, `sha1`, + `sha256`, or `sha512`, and the value is the computed checksum. If a checksum + is supplied and does not match the downloaded artifact, the driver will fail + to start + +* `args` - (Optional) A list of arguments to the `command`. ## Client Requirements diff --git a/website/source/docs/drivers/java.html.md b/website/source/docs/drivers/java.html.md index f2bbd2b76..3d74fc751 100644 --- a/website/source/docs/drivers/java.html.md +++ b/website/source/docs/drivers/java.html.md @@ -18,16 +18,18 @@ HTTP from the Nomad client. The `java` driver supports the following configuration in the job spec: -* `artifact_source` - **(Required)** The hosted location of the source Jar file. Must be accessible -from the Nomad client -* `checksum` - **(Optional)** The checksum type and value for the `artifact_source` image. -The format is `type:value`, where type is any of `md5`, `sha1`, `sha256`, or `sha512`, -and the value is the computed checksum. If a checksum is supplied and does not -match the downloaded artifact, the driver will fail to start +* `artifact_source` - The hosted location of the source Jar file. Must be + accessible from the Nomad client -* `args` - **(Optional)** The argument list for the `java` command, space separated. +* `checksum` - (Optional) The checksum type and value for the `artifact_source` + image. The format is `type:value`, where type is any of `md5`, `sha1`, + `sha256`, or `sha512`, and the value is the computed checksum. If a checksum + is supplied and does not match the downloaded artifact, the driver will fail + to start -* `jvm_options` - **(Optional)** JVM options to be passed while invoking java. These options +* `args` - (Optional) A list of arguments to the `java` command. + +* `jvm_options` - (Optional) JVM options to be passed while invoking java. These options are passed not validated in any way in Nomad. ## Client Requirements diff --git a/website/source/docs/drivers/qemu.html.md b/website/source/docs/drivers/qemu.html.md index 84909e331..d329c7a8e 100644 --- a/website/source/docs/drivers/qemu.html.md +++ b/website/source/docs/drivers/qemu.html.md @@ -23,16 +23,19 @@ The `Qemu` driver can execute any regular `qemu` image (e.g. `qcow`, `img`, The `Qemu` driver supports the following configuration in the job spec: -* `artifact_source` - **(Required)** The hosted location of the source Qemu image. Must be accessible +* `artifact_source` - The hosted location of the source Qemu image. Must be accessible from the Nomad client, via HTTP. -* `checksum` - **(Optional)** The checksum type and value for the `artifact_source` image. + +* `checksum` - (Optional) The checksum type and value for the `artifact_source` image. The format is `type:value`, where type is any of `md5`, `sha1`, `sha256`, or `sha512`, and the value is the computed checksum. If a checksum is supplied and does not match the downloaded artifact, the driver will fail to start + * `accelerator` - (Optional) The type of accelerator to use in the invocation. If the host machine has `Qemu` installed with KVM support, users can specify `kvm` for the `accelerator`. Default is `tcg` -* `port_map` - **(Optional)** A `map[string]int` that maps port labels to ports + +* `port_map` - (Optional) A `map[string]int` that maps port labels to ports on the guest. This forwards the host port to the guest vm. For example, `port_map { db = 6539 }` would forward the host port with label `db` to the guest vm's port 6539. diff --git a/website/source/docs/drivers/raw_exec.html.md b/website/source/docs/drivers/raw_exec.html.md index 2dc741887..c76825f25 100644 --- a/website/source/docs/drivers/raw_exec.html.md +++ b/website/source/docs/drivers/raw_exec.html.md @@ -18,15 +18,19 @@ As such, it should be used with extreme care and is disabled by default. The `raw_exec` driver supports the following configuration in the job spec: -* `command` - (Required) The command to execute. Must be provided. -* `artifact_source` – (Optional) Source location of an executable artifact. Must be accessible -from the Nomad client. If you specify an `artifact_source` to be executed, you -must reference it in the `command` as show in the examples below -* `checksum` - **(Optional)** The checksum type and value for the `artifact_source` image. -The format is `type:value`, where type is any of `md5`, `sha1`, `sha256`, or `sha512`, -and the value is the computed checksum. If a checksum is supplied and does not -match the downloaded artifact, the driver will fail to start -* `args` - The argument list to the command, space seperated. Optional. +* `command` - The command to execute. Must be provided. + +* `artifact_source` – (Optional) Source location of an executable artifact. Must + be accessible from the Nomad client. If you specify an `artifact_source` to be + executed, you must reference it in the `command` as show in the examples below + +* `checksum` - (Optional) The checksum type and value for the `artifact_source` + image. The format is `type:value`, where type is any of `md5`, `sha1`, + `sha256`, or `sha512`, and the value is the computed checksum. If a checksum + is supplied and does not match the downloaded artifact, the driver will fail + to start + +* `args` - (Optional) A list of arguments to the `command`. ## Client Requirements diff --git a/website/source/docs/drivers/rkt.html.md b/website/source/docs/drivers/rkt.html.md index ddbb76601..7ce3e1a49 100644 --- a/website/source/docs/drivers/rkt.html.md +++ b/website/source/docs/drivers/rkt.html.md @@ -20,13 +20,16 @@ being marked as experimental and should be used with care. The `rkt` driver supports the following configuration in the job spec: -* `trust_prefix` - **(Optional)** The trust prefix to be passed to rkt. Must be reachable from -the box running the nomad agent. If not specified, the image is run without -verifying the image signature. -* `image` - **(Required)** The image to run which may be specified by name, -hash, ACI address or docker registry. -* `command` - **(Optional**) A command to execute on the ACI. -* `args` - **(Optional**) A string of args to pass into the image. +* `image` - The image to run which may be specified by name, hash, ACI address + or docker registry. + +* `command` - (Optional) A command to execute on the ACI. + +* `args` - (Optional) A list of arguments to the image. + +* `trust_prefix` - (Optional) The trust prefix to be passed to rkt. Must be + reachable from the box running the nomad agent. If not specified, the image is + run without verifying the image signature. ## Task Directories