github.com/jrxfive/nomad@v0.6.1-0.20170802162750-1fef470e89bf/website/source/intro/getting-started/install.html.md (about)

     1  ---
     2  layout: "intro"
     3  page_title: "Install Nomad"
     4  sidebar_current: "getting-started-install"
     5  description: |-
     6    The first step to using Nomad is to get it installed.
     7  ---
     8  
     9  # Install Nomad
    10  
    11  The task drivers that are available to Nomad vary by operating system,
    12  for example Docker is only available on Linux machines. To simplify the
    13  getting started experience, we will be working in a Vagrant environment.
    14  Create a new directory, and download [this `Vagrantfile`](https://raw.githubusercontent.com/hashicorp/nomad/master/demo/vagrant/Vagrantfile).
    15  
    16  ## Vagrant Setup
    17  
    18  Note: To use the Vagrant Setup first install Vagrant following these instructions: https://www.vagrantup.com/docs/installation/
    19  
    20  Once you have created a new directory and downloaded the `Vagrantfile`
    21  you must create the virtual machine:
    22  
    23      $ vagrant up
    24  
    25  This will take a few minutes as the base Ubuntu box must be downloaded
    26  and provisioned with both Docker and Nomad. Once this completes, you should
    27  see output similar to:
    28  
    29      Bringing machine 'default' up with 'vmware_fusion' provider...
    30      ==> default: Checking if box 'puphpet/ubuntu1404-x64' is up to date...
    31      ==> default: Machine is already running.
    32  
    33  At this point the Vagrant box is running and ready to go.
    34  
    35  ## Verifying the Installation
    36  
    37  After starting the Vagrant box, verify the installation worked by connecting
    38  to the box using SSH and checking that `nomad` is available. By executing
    39  `nomad`, you should see help output similar to the following:
    40  
    41  ```
    42  $ vagrant ssh
    43  ...
    44  
    45  vagrant@nomad:~$ nomad
    46  
    47  usage: nomad [--version] [--help] <command> [<args>]
    48  
    49  Available commands are:
    50      agent                 Runs a Nomad agent
    51      agent-info            Display status information about the local agent
    52      alloc-status          Display allocation status information and metadata
    53      client-config         View or modify client configuration details
    54      deployment            Interact with deployments
    55      eval-status           Display evaluation status and placement failure reasons
    56      fs                    Inspect the contents of an allocation directory
    57      init                  Create an example job file
    58      inspect               Inspect a submitted job
    59      job                   Interact with jobs
    60      keygen                Generates a new encryption key
    61      keyring               Manages gossip layer encryption keys
    62      logs                  Streams the logs of a task.
    63      node-drain            Toggle drain mode on a given node
    64      node-status           Display status information about nodes
    65      operator              Provides cluster-level tools for Nomad operators
    66      plan                  Dry-run a job update to determine its effects
    67      run                   Run a new job or update an existing job
    68      server-force-leave    Force a server into the 'left' state
    69      server-join           Join server nodes together
    70      server-members        Display a list of known servers and their status
    71      status                Display status information about jobs
    72      stop                  Stop a running job
    73      validate              Checks if a given job specification is valid
    74      version               Prints the Nomad version
    75  ```
    76  
    77  If you get an error that Nomad could not be found, then your Vagrant box
    78  may not have provisioned correctly. Check for any error messages that may have
    79  been emitted during `vagrant up`. You can always destroy the box and
    80  re-create it.
    81  
    82  ## Next Steps
    83  
    84  Vagrant is running and Nomad is installed. Let's [start Nomad](/intro/getting-started/running.html)!
    85  
    86