github.com/blixtra/nomad@v0.7.2-0.20171221000451-da9a1d7bb050/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  ```shell
    24  $ vagrant up
    25  ```
    26  
    27  This will take a few minutes as the base Ubuntu box must be downloaded
    28  and provisioned with both Docker and Nomad. Once this completes, you should
    29  see output similar to:
    30  
    31  ```text
    32  Bringing machine 'default' up with 'virtualbox' provider...
    33  ==> default: Importing base box 'bento/ubuntu-16.04'...
    34  ...
    35  ==> default: Running provisioner: docker...
    36  
    37  ```
    38  
    39  At this point the Vagrant box is running and ready to go.
    40  
    41  ## Verifying the Installation
    42  
    43  After starting the Vagrant box, verify the installation worked by connecting
    44  to the box using SSH and checking that `nomad` is available. By executing
    45  `nomad`, you should see help output similar to the following:
    46  
    47  ```shell
    48  $ vagrant ssh
    49  ...
    50  
    51  vagrant@nomad:~$ nomad
    52  
    53  Usage: nomad [-version] [-help] [-autocomplete-(un)install] <command> [<args>]
    54  
    55  Available commands are:
    56      acl                   Interact with ACL policies and tokens
    57      agent                 Runs a Nomad agent
    58      agent-info            Display status information about the local agent
    59      alloc-status          Display allocation status information and metadata
    60      client-config         View or modify client configuration details
    61      deployment            Interact with deployments
    62      eval-status           Display evaluation status and placement failure reasons
    63      fs                    Inspect the contents of an allocation directory
    64      init                  Create an example job file
    65      inspect               Inspect a submitted job
    66      job                   Interact with jobs
    67      keygen                Generates a new encryption key
    68      keyring               Manages gossip layer encryption keys
    69      logs                  Streams the logs of a task.
    70      namespace             Interact with namespaces
    71      node-drain            Toggle drain mode on a given node
    72      node-status           Display status information about nodes
    73      operator              Provides cluster-level tools for Nomad operators
    74      plan                  Dry-run a job update to determine its effects
    75      quota                 Interact with quotas
    76      run                   Run a new job or update an existing job
    77      sentinel              Interact with Sentinel policies
    78      server-force-leave    Force a server into the 'left' state
    79      server-join           Join server nodes together
    80      server-members        Display a list of known servers and their status
    81      status                Display the status output for a resource
    82      stop                  Stop a running job
    83      ui                    Open the Nomad Web UI
    84      validate              Checks if a given job specification is valid
    85      version               Prints the Nomad version
    86  ```
    87  
    88  If you get an error that Nomad could not be found, then your Vagrant box
    89  may not have provisioned correctly. Check for any error messages that may have
    90  been emitted during `vagrant up`. You can always [destroy the box][destroy] and
    91  re-create it.
    92  
    93  ## Next Steps
    94  
    95  Vagrant is running and Nomad is installed. Let's [start Nomad](/intro/getting-started/running.html)!
    96  
    97  [destroy]: https://www.vagrantup.com/docs/cli/destroy.html