open-nomad/website/content/docs/install/quickstart.mdx

107 lines
3.2 KiB
Plaintext

---
layout: docs
page_title: Installing Nomad for QuickStart
description: Learn how to install Nomad locally or in a sandbox.
---
# Quickstart
This page lists multiple methods to installing Nomad locally or in a sandbox
environment.
These installations are designed to get you started with Nomad easily and should
be used only for experimentation purposes. If you are looking to install Nomad
in production, please refer to the [Production Installation](/nomad/docs/install/production) guide here.
<Tabs>
<Tab heading="Interactive Online Environment">
Experiment with Nomad in your browser via guides containing embedded interactive learning environments.
- [Interactive Labs](/nomad/tutorials/interactive)
</Tab>
<Tab heading="Create a Cloud Lab">
Install Nomad on the public cloud.
- AWS
- [CloudFormation](https://aws.amazon.com/quickstart/architecture/nomad/)
- [Terraform](https://github.com/hashicorp/nomad/blob/master/terraform/aws/README.md)
- Azure
- [Terraform](https://github.com/hashicorp/nomad/tree/master/terraform/azure)
</Tab>
<Tab heading="Try it Locally">
## Install Nomad on your machine
If you would like to try Nomad locally, you can install Nomad on your local
machine using the same steps that you would for a production environments and
run a single-node development instance using the `sudo nomad agent -dev` command
[Installing Nomad][installing-binary]
-> **Note:** If you are using Docker Desktop for Windows or MacOS, please check
[our FAQ][faq-win-mac].
## Run Nomad in Vagrant
Alternatively, you can use a Vagrant to set up a development environment for Nomad.
Vagrant is a tool for building and managing virtual machine environments.
-> **Note**: To use the Vagrant environment, first install Vagrant following
these [instructions](/vagrant/docs/installation). You will
also need a virtualization tool, such as [VirtualBox][].
You can download a Vagrantfile which can start a small Nomad cluster. First
create a new directory for your Vagrant environment.
```shell-session
$ mkdir nomad-vagrant
```
Change into the directory you made with the previous command.
```shell-session
$ cd nomad-vagrant
```
Now you can get the Nomad installation configuration.
```shell-session
$ curl -O https://raw.githubusercontent.com/hashicorp/nomad/master/demo/vagrant/Vagrantfile
```
Now that you have created a new directory and downloaded the `Vagrantfile`
you must create the virtual machine with the `vagrant up` command.
```shell-session
$ vagrant up
```
This takes a few minutes as the base Ubuntu box must be downloaded
and provisioned with both Docker and Nomad. Once this completes, you should
see this output.
```plaintext
Bringing machine 'default' up with 'virtualbox' provider...
==> default: Importing base box 'bento/ubuntu-18.04'...
...
==> default: Running provisioner: docker...
```
At this point the Vagrant box is running and ready to go.
</Tab>
</Tabs>
[faq-win-mac]: /nomad/docs/faq#q-how-to-connect-to-my-host-network-when-using-docker-desktop-windows-and-macos
[installing-binary]: /nomad/docs/install#precompiled-binaries
[vagrant-environment]: /nomad/tutorials/get-started/get-started-install#vagrant-setup-optional
[virtualbox]: https://www.virtualbox.org/