open-nomad/website/source/docs/drivers/exec.html.md

76 lines
2.3 KiB
Markdown
Raw Normal View History

2015-09-20 22:31:33 +00:00
---
layout: "docs"
page_title: "Drivers: Exec"
sidebar_current: "docs-drivers-exec"
description: |-
The Exec task driver is used to run binaries using OS isolation primitives.
---
2015-10-08 18:36:22 +00:00
# Isolated Fork/Exec Driver
2015-09-20 22:31:33 +00:00
Name: `exec`
2015-09-20 22:42:33 +00:00
The `exec` driver is used to simply execute a particular command for a task.
2015-10-08 19:18:44 +00:00
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
simple, since the `exec` driver can invoke any command, it can be used to call
scripts or other wrappers which provide higher level features.
2015-09-20 22:42:33 +00:00
## Task Configuration
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
2015-09-20 22:42:33 +00:00
* `args` - The argument list to the command, space seperated. Optional.
## Client Requirements
The `exec` driver can run on all supported operating systems but to provide
proper isolation the client must be run as root on non-Windows operating systems.
Further, to support cgroups, `/sys/fs/cgroups/` must be mounted.
2015-09-20 22:42:33 +00:00
You must specify a `command` to be executed. Optionally you can specify an
`artifact_source` to be downloaded as well. Any `command` is assumed to be present on the
running client, or a downloaded artifact.
## Examples
To run a binary present on the Node:
```
config {
command = "/bin/sleep"
args = 1
}
```
To execute a binary specified by `artifact_source`:
```
config {
artifact_source = "https://dl.dropboxusercontent.com/u/1234/binary.bin"
command = "$NOMAD_TASK_DIR/binary.bin"
}
```
2015-09-20 22:42:33 +00:00
## Client Attributes
The `exec` driver will set the following client attributes:
* `driver.exec` - This will be set to "1", indicating the
2015-09-20 22:42:33 +00:00
driver is available.
## Resource Isolation
The resource isolation provided varies by the operating system of
the client and the configuration.
On Linux, Nomad will use cgroups, namespaces, and chroot to isolate the
resources of a process and as such the Nomad agent must be run as root.
2015-09-20 22:31:33 +00:00
On Windows, the task driver will just execute the command with no additional
resource isolation.