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

92 lines
2.6 KiB
Markdown
Raw Normal View History

2015-10-08 19:18:44 +00:00
---
layout: "docs"
page_title: "Drivers: Raw Exec"
sidebar_current: "docs-drivers-raw-exec"
description: |-
The Raw Exec task driver simply fork/execs and provides no isolation.
---
# Raw Fork/Exec Driver
Name: `raw_exec`
The `raw_exec` driver is used to execute a command for a task without any
isolation. Further, the task is started as the same user as the Nomad process.
As such, it should be used with extreme care and is disabled by default.
2015-10-08 19:18:44 +00:00
## Task Configuration
The `raw_exec` driver supports the following configuration in the job spec:
* `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
2016-01-11 19:12:09 +00:00
* `args` - (Optional) A list of arguments to the optional `command`.
References to environment variables or any [intepretable Nomad
variables](/docs/jobspec/index.html#interpreted_vars) will be interpreted
before launching the task. For example:
```
2016-02-05 00:50:20 +00:00
args = ["${nomad.ip}", "${MY_ENV}", "${meta.foo}"]
2016-01-11 19:12:09 +00:00
```
2015-10-08 19:18:44 +00:00
## Client Requirements
The `raw_exec` driver can run on all supported operating systems. It is however
disabled by default. In order to be enabled, the Nomad client configuration must
explicitly enable the `raw_exec` driver in the client's
2015-10-08 19:18:44 +00:00
[options](../agent/config.html#options) field:
```
client {
options = {
"driver.raw_exec.enable" = "1"
}
}
2015-10-08 19:18:44 +00:00
```
You must specify a `command` to be executed. Optionally you can specify an
`artifact_source` to be executed. 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"
2015-11-03 21:16:17 +00:00
checksum = "sha256:133jifjiofu9090fsadjofsdjlk"
command = "binary.bin"
}
```
2015-10-08 19:18:44 +00:00
## Client Attributes
The `raw_exec` driver will set the following client attributes:
* `driver.raw_exec` - This will be set to "1", indicating the
driver is available.
## Resource Isolation
The `raw_exec` driver provides no isolation.