github.com/zhizhiboom/nomad@v0.8.5-0.20180907175415-f28fd3a1a056/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  To simplify the getting started experience, we will be working in a Vagrant
    12  environment. Create a new directory, and download [this
    13  `Vagrantfile`](https://raw.githubusercontent.com/hashicorp/nomad/master/demo/vagrant/Vagrantfile).
    14  
    15  ## Vagrant Setup
    16  
    17  Note: To use the Vagrant Setup first install Vagrant following these instructions: https://www.vagrantup.com/docs/installation/
    18  
    19  Once you have created a new directory and downloaded the `Vagrantfile`
    20  you must create the virtual machine:
    21  
    22  ```shell
    23  $ vagrant up
    24  ```
    25  
    26  This will take a few minutes as the base Ubuntu box must be downloaded
    27  and provisioned with both Docker and Nomad. Once this completes, you should
    28  see output similar to:
    29  
    30  ```text
    31  Bringing machine 'default' up with 'virtualbox' provider...
    32  ==> default: Importing base box 'bento/ubuntu-16.04'...
    33  ...
    34  ==> default: Running provisioner: docker...
    35  
    36  ```
    37  
    38  At this point the Vagrant box is running and ready to go.
    39  
    40  ## Verifying the Installation
    41  
    42  After starting the Vagrant box, verify the installation worked by connecting
    43  to the box using SSH and checking that `nomad` is available. By executing
    44  `nomad`, you should see help output similar to the following:
    45  
    46  ```shell
    47  $ vagrant ssh
    48  ...
    49  
    50  vagrant@nomad:~$ nomad
    51  Usage: nomad [-version] [-help] [-autocomplete-(un)install] <command> [args]
    52  
    53  Common commands:
    54      run         Run a new job or update an existing job
    55      stop        Stop a running job
    56      status      Display the status output for a resource
    57      alloc       Interact with allocations
    58      job         Interact with jobs
    59      node        Interact with nodes
    60      agent       Runs a Nomad agent
    61  
    62  Other commands:
    63      acl             Interact with ACL policies and tokens
    64      agent-info      Display status information about the local agent
    65      deployment      Interact with deployments
    66      eval            Interact with evaluations
    67      namespace       Interact with namespaces
    68      operator        Provides cluster-level tools for Nomad operators
    69      quota           Interact with quotas
    70      sentinel        Interact with Sentinel policies
    71      server          Interact with servers
    72      ui              Open the Nomad Web UI
    73      version         Prints the Nomad version
    74  ```
    75  
    76  If you get an error that Nomad could not be found, then your Vagrant box
    77  may not have provisioned correctly. Check for any error messages that may have
    78  been emitted during `vagrant up`. You can always [destroy the box][destroy] and
    79  re-create it.
    80  
    81  ## Next Steps
    82  
    83  Vagrant is running and Nomad is installed. Let's [start Nomad](/intro/getting-started/running.html)!
    84  
    85  [destroy]: https://www.vagrantup.com/docs/cli/destroy.html