2015-09-12 00:01:02 +00:00
|
|
|
---
|
|
|
|
|
layout: "intro"
|
2015-09-17 23:33:37 +00:00
|
|
|
page_title: "Install Nomad"
|
2015-09-20 20:37:22 +00:00
|
|
|
sidebar_current: "getting-started-install"
|
2015-09-12 00:01:02 +00:00
|
|
|
description: |-
|
2015-09-17 23:33:37 +00:00
|
|
|
The first step to using Nomad is to get it installed.
|
2015-09-12 00:01:02 +00:00
|
|
|
---
|
|
|
|
|
|
2015-09-17 23:33:37 +00:00
|
|
|
# Install Nomad
|
2015-09-12 00:01:02 +00:00
|
|
|
|
2015-09-17 23:33:37 +00:00
|
|
|
Nomad must first be installed on your machine. Nomad is distributed as
|
2015-09-12 00:01:02 +00:00
|
|
|
a [binary package](/downloads.html) for all supported platforms and
|
2015-09-17 23:33:37 +00:00
|
|
|
architectures. This page will not cover how to compile Nomad from source,
|
2015-09-12 00:01:02 +00:00
|
|
|
but compiling from source is covered in the [documentation](/docs/install/index.html)
|
|
|
|
|
for those who want to be sure they're compiling source they trust into
|
|
|
|
|
the final binary.
|
|
|
|
|
|
2015-09-17 23:33:37 +00:00
|
|
|
## Installing Nomad
|
2015-09-12 00:01:02 +00:00
|
|
|
|
2015-09-17 23:33:37 +00:00
|
|
|
To install Nomad, find the [appropriate package](/downloads.html) for
|
|
|
|
|
your system and download it. Nomad is packaged as a zip archive.
|
2015-09-12 00:01:02 +00:00
|
|
|
|
2015-09-17 23:33:37 +00:00
|
|
|
After downloading Nomad, unzip the package. Nomad runs as a single binary
|
2015-09-20 20:37:22 +00:00
|
|
|
named `nomad`. Any other files in the package can be safely removed and
|
2015-09-17 23:33:37 +00:00
|
|
|
Nomad will still function.
|
2015-09-12 00:01:02 +00:00
|
|
|
|
2015-09-20 20:37:22 +00:00
|
|
|
The final step is to make sure that `nomad` is available on the PATH.
|
|
|
|
|
See [this page](https://stackoverflow.com/questions/14637979/how-to-permanently-set-path-on-linux)
|
2015-09-12 00:01:02 +00:00
|
|
|
for instructions on setting the PATH on Linux and Mac.
|
2015-09-20 20:37:22 +00:00
|
|
|
[This page](https://stackoverflow.com/questions/1618280/where-can-i-set-path-to-make-exe-on-windows)
|
2015-09-12 00:01:02 +00:00
|
|
|
contains instructions for setting the PATH on Windows.
|
|
|
|
|
|
|
|
|
|
## Verifying the Installation
|
|
|
|
|
|
2015-09-17 23:33:37 +00:00
|
|
|
After installing Nomad, verify the installation worked by opening a new
|
2015-09-20 20:37:22 +00:00
|
|
|
terminal session and checking that `nomad` is available. By executing
|
|
|
|
|
`nomad`, you should see help output similar to the following:
|
2015-09-12 00:01:02 +00:00
|
|
|
|
|
|
|
|
```
|
2015-09-20 20:37:22 +00:00
|
|
|
$ nomad
|
|
|
|
|
usage: nomad [--version] [--help] <command> [<args>]
|
|
|
|
|
|
|
|
|
|
Available commands are:
|
|
|
|
|
agent Runs a Nomad agent
|
|
|
|
|
agent-force-leave Force a member into the 'left' state
|
|
|
|
|
agent-info Display status information about the local agent
|
|
|
|
|
agent-join Join server nodes together
|
|
|
|
|
agent-members Display a list of known members and their status
|
|
|
|
|
node-drain Toggle drain mode on a given node
|
|
|
|
|
node-status Display status information about nodes
|
|
|
|
|
status Display status information about jobs
|
|
|
|
|
version Prints the Nomad version
|
2015-09-12 00:01:02 +00:00
|
|
|
```
|
|
|
|
|
|
2015-09-17 23:33:37 +00:00
|
|
|
If you get an error that Nomad could not be found, then your PATH environment
|
2015-09-12 00:01:02 +00:00
|
|
|
variable was not setup properly. Please go back and ensure that your PATH
|
2015-09-17 23:33:37 +00:00
|
|
|
variable contains the directory where Nomad was installed.
|
2015-09-12 00:01:02 +00:00
|
|
|
|
2015-09-17 23:33:37 +00:00
|
|
|
Otherwise, Nomad is installed and ready to go!
|
