diff --git a/website/source/docs/drivers/exec.html.md b/website/source/docs/drivers/exec.html.md index 4aad6bf8e..17d7d9a44 100644 --- a/website/source/docs/drivers/exec.html.md +++ b/website/source/docs/drivers/exec.html.md @@ -12,7 +12,7 @@ Name: `exec` The `exec` driver is used to simply execute a particular command for a task. However, unlike [`raw_exec`](raw_exec.html) it uses the underlying isolation -primitives of the operating system to limit the tasks access to resources. While +primitives of the operating system to limit the task's access to resources. While simple, since the `exec` driver can invoke any command, it can be used to call scripts or other wrappers which provide higher level features. @@ -73,7 +73,7 @@ To execute a binary downloaded from an [`artifact`](/docs/jobspec/index.html#art The `exec` driver can only be run when on Linux and running Nomad as root. `exec` is limited to this configuration because currently isolation of resources -is only guaranteed on Linux. Further the host must have cgroups mounted properly +is only guaranteed on Linux. Further, the host must have cgroups mounted properly in order for the driver to work. If you are receiving the error `* Constraint "missing drivers" filtered <> nodes` @@ -97,7 +97,7 @@ On Linux, Nomad will use cgroups, and a chroot to isolate the resources of a process and as such the Nomad agent must be run as root. ### Chroot -The chroot is populated with data in the following folders from the host +The chroot is populated with data in the following directories from the host machine: `["/bin", "/etc", "/lib", "/lib32", "/lib64", "/run/resolvconf", "/sbin", diff --git a/website/source/docs/drivers/java.html.md b/website/source/docs/drivers/java.html.md index a34719a36..7e0ca6ff8 100644 --- a/website/source/docs/drivers/java.html.md +++ b/website/source/docs/drivers/java.html.md @@ -33,7 +33,7 @@ The `java` driver supports the following configuration in the job spec: ``` * `jvm_options` - (Optional) A list of JVM options to be passed while invoking - java. These options are passed not validated in any way in Nomad. + java. These options are passed without being validated in any way by Nomad. ## Examples @@ -61,8 +61,8 @@ task "web" { ## Client Requirements -The `java` driver requires Java to be installed and in your systems `$PATH`. The -task must also specify at least one artifact to download as this is the only way +The `java` driver requires Java to be installed and in your system's `$PATH`. The +task must also specify at least one artifact to download, as this is the only way to retrieve the Jar being run. ## Client Attributes @@ -82,7 +82,7 @@ the client and the configuration. On Linux, Nomad will attempt to use cgroups, namespaces, and chroot to isolate the resources of a process. If the Nomad agent is not -running as root many of these mechanisms cannot be used. +running as root, many of these mechanisms cannot be used. As a baseline, the Java jars will be run inside a Java Virtual Machine, providing a minimum amount of isolation. diff --git a/website/source/docs/drivers/qemu.html.md b/website/source/docs/drivers/qemu.html.md index 5a1f44918..182af6828 100644 --- a/website/source/docs/drivers/qemu.html.md +++ b/website/source/docs/drivers/qemu.html.md @@ -33,7 +33,7 @@ The `Qemu` driver supports the following configuration in the job spec: * `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` + `kvm` for the `accelerator`. Default is `tcg`. * `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, @@ -41,7 +41,7 @@ The `Qemu` driver supports the following configuration in the job spec: guest VM's port 6539. * `args` - (Optional) A `[]string` that is passed to qemu as command line options. - For example, `args = [ "-nodefconfig", "-nodefaults" ] + For example, `args = [ "-nodefconfig", "-nodefaults" ]`. ## Examples @@ -71,7 +71,7 @@ task "virtual" { ## Client Requirements The `Qemu` driver requires Qemu to be installed and in your system's `$PATH`. -The task must also specify at least one artifact to download as this is the only +The task must also specify at least one artifact to download, as this is the only way to retrieve the image being run. ## Client Attributes diff --git a/website/source/docs/drivers/raw_exec.html.md b/website/source/docs/drivers/raw_exec.html.md index 92d226984..bf8441822 100644 --- a/website/source/docs/drivers/raw_exec.html.md +++ b/website/source/docs/drivers/raw_exec.html.md @@ -20,7 +20,7 @@ The `raw_exec` driver supports the following configuration in the job spec: * `command` - The command to execute. Must be provided. If executing a binary that exists on the host, the path must be absolute. If executing a binary that - is download from an [`artifact`](/docs/jobspec/index.html#artifact_doc), the + is downloaded from an [`artifact`](/docs/jobspec/index.html#artifact_doc), the path can be relative from the allocations's root directory. * `args` - (Optional) A list of arguments to the optional `command`. diff --git a/website/source/docs/drivers/rkt.html.md b/website/source/docs/drivers/rkt.html.md index 72ba3a006..aacb0033c 100644 --- a/website/source/docs/drivers/rkt.html.md +++ b/website/source/docs/drivers/rkt.html.md @@ -19,7 +19,7 @@ this driver is being marked as experimental and should be used with care. The `rkt` driver supports the following configuration in the job spec: -* `image` - The image to run which may be specified by name, hash, ACI address +* `image` - The image to run. May be specified by name, hash, ACI address or docker registry. * `command` - (Optional) A command to execute on the ACI. @@ -37,21 +37,21 @@ The `rkt` driver supports the following configuration in the job spec: reachable from the box running the nomad agent. If not specified, the image is run without verifying the image signature. -* `dns_servers` - (Optional) A list of DNS servers to be used in the containers +* `dns_servers` - (Optional) A list of DNS servers to be used in the containers. * `dns_search_domains` - (Optional) A list of DNS search domains to be used in - the containers + the containers. -* `debug` - (Optional) Enable rkt command debug option +* `debug` - (Optional) Enable rkt command debug option. ## Task Directories -The `rkt` driver currently does not support mounting of the `alloc/` and `local/` directory. +The `rkt` driver currently does not support mounting of the `alloc/` and `local/` directories. Once support is added, version `v0.10.0` or above of `rkt` will be required. ## Client Requirements -The `rkt` driver requires rkt to be installed and in your systems `$PATH`. +The `rkt` driver requires rkt to be installed and in your system's `$PATH`. The `trust_prefix` must be accessible by the node running Nomad. This can be an internal source, private to your cluster, but it must be reachable by the client over HTTP.