open-nomad/website/source/intro/getting-started/install.html.md

76 lines
2.8 KiB
Markdown
Raw Normal View History

2015-09-12 00:01:02 +00:00
---
layout: "intro"
2015-09-17 23:33:37 +00:00
page_title: "Install Nomad"
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-22 22:24:01 +00:00
The task drivers that are available to Nomad vary by operating system,
for example Docker is only available on Linux machines. To simplify the
getting started experience, we will be working in a Vagrant environment.
2015-09-29 17:24:28 +00:00
Create a new directory, and download [this `Vagrantfile`](https://raw.githubusercontent.com/hashicorp/nomad/master/demo/vagrant/Vagrantfile).
2015-09-12 00:01:02 +00:00
2015-09-22 22:24:01 +00:00
## Vagrant Setup
2015-09-12 00:01:02 +00:00
2015-09-22 22:24:01 +00:00
Once you have created a new directory and downloaded the `Vagrantfile`
2015-10-10 17:31:22 +00:00
you must create the virtual machine:
2015-09-12 00:01:02 +00:00
2015-09-22 22:24:01 +00:00
$ vagrant up
2015-09-12 00:01:02 +00:00
2015-09-22 22:24:01 +00:00
This will take a few minutes as the base Ubuntu box must be downloaded
and provisioned with both Docker and Nomad. Once this completes, you should
see output similar to:
Bringing machine 'default' up with 'vmware_fusion' provider...
==> default: Checking if box 'puphpet/ubuntu1404-x64' is up to date...
==> default: Machine is already running.
At this point the Vagrant box is running and ready to go.
2015-09-12 00:01:02 +00:00
## Verifying the Installation
2015-09-22 22:24:01 +00:00
After starting the Vagrant box, verify the installation worked by connecting
to the box using SSH 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-22 22:24:01 +00:00
$ vagrant ssh
...
vagrant@nomad:~$ nomad
2015-09-28 00:04:34 +00:00
usage: nomad [--version] [--help] <command> [<args>]
Available commands are:
2015-09-22 22:24:01 +00:00
agent Runs a Nomad agent
agent-info Display status information about the local agent
2015-09-28 00:04:34 +00:00
alloc-status Display allocation status information and metadata
client-config View or modify client configuration details
2015-09-22 22:24:01 +00:00
eval-monitor Monitor an evaluation interactively
2015-09-28 00:04:34 +00:00
init Create an example job file
2015-09-22 22:24:01 +00:00
node-drain Toggle drain mode on a given node
node-status Display status information about nodes
2015-09-28 00:04:34 +00:00
run Run a new job or update an existing job
2015-09-22 22:24:01 +00:00
server-force-leave Force a server into the 'left' state
server-join Join server nodes together
server-members Display a list of known servers and their status
status Display status information about jobs
stop Stop a running job
2015-09-28 00:04:34 +00:00
validate Checks if a given job specification is valid
2015-09-22 22:24:01 +00:00
version Prints the Nomad version
2015-09-12 00:01:02 +00:00
```
2015-09-22 22:24:01 +00:00
If you get an error that Nomad could not be found, then your Vagrant box
2015-10-10 17:45:34 +00:00
may not have provisioned correctly. Check for any error messages that may have
been emitted during `vagrant up`. You can always destroy the box and
2015-09-22 22:24:01 +00:00
re-create it.
2015-09-12 00:01:02 +00:00
2015-09-22 22:57:12 +00:00
## Next Steps
Vagrant is running and Nomad is installed. Let's [start Nomad](/intro/getting-started/running.html)!
2015-09-22 22:24:01 +00:00