github.com/smintz/nomad@v0.8.3/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  Usage: nomad [-version] [-help] [-autocomplete-(un)install] <command> [args]
    53  
    54  Common commands:
    55      run         Run a new job or update an existing job
    56      stop        Stop a running job
    57      status      Display the status output for a resource
    58      alloc       Interact with allocations
    59      job         Interact with jobs
    60      node        Interact with nodes
    61      agent       Runs a Nomad agent
    62  
    63  Other commands:
    64      acl             Interact with ACL policies and tokens
    65      agent-info      Display status information about the local agent
    66      deployment      Interact with deployments
    67      eval            Interact with evaluations
    68      namespace       Interact with namespaces
    69      operator        Provides cluster-level tools for Nomad operators
    70      quota           Interact with quotas
    71      sentinel        Interact with Sentinel policies
    72      server          Interact with servers
    73      ui              Open the Nomad Web UI
    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][destroy] 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  [destroy]: https://www.vagrantup.com/docs/cli/destroy.html