github.com/uchennaokeke444/nomad@v0.11.8/website/pages/intro/getting-started/index.mdx (about)

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