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