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

107 lines
3.2 KiB
Plaintext
Raw Normal View History

2020-02-06 23:45:31 +00:00
---
layout: docs
2020-02-06 23:45:31 +00:00
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
2020-12-07 15:08:31 +00:00
in production, please refer to the [Production Installation](/docs/install/production) guide here.
2020-02-06 23:45:31 +00:00
<Tabs>
<Tab heading="Interactive Online Environment">
2020-02-06 23:45:31 +00:00
2020-12-07 15:08:31 +00:00
Experiment with Nomad in your browser via Learn guides containing embedded Katacoda interactive learning environments.
2020-02-06 23:45:31 +00:00
2020-12-07 15:08:31 +00:00
- [Interactive Labs](https://learn.hashicorp.com/collections/nomad/interactive)
2020-02-06 23:45:31 +00:00
</Tab>
<Tab heading="Create a Cloud Lab">
2020-02-06 23:45:31 +00:00
Install Nomad on the public cloud.
- AWS
2020-02-06 23:45:31 +00:00
- [CloudFormation](https://aws.amazon.com/quickstart/architecture/nomad/)
2020-02-06 23:45:31 +00:00
- [Terraform](https://github.com/hashicorp/nomad/blob/master/terraform/aws/README.md)
2020-02-06 23:45:31 +00:00
- Azure
2020-02-06 23:45:31 +00:00
- [Terraform](https://github.com/hashicorp/nomad/tree/master/terraform/azure)
</Tab>
<Tab heading="Try it Locally">
2020-02-06 23:45:31 +00:00
## Install Nomad on your machine
2020-02-06 23:45:31 +00:00
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 `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](https://www.vagrantup.com/docs/installation/). You will
also need a virtualization tool, such as [VirtualBox][].
2020-12-07 15:08:31 +00:00
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
```
2020-12-07 15:08:31 +00:00
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>
2020-02-06 23:45:31 +00:00
[faq-win-mac]: /docs/faq#q-how-to-connect-to-my-host-network-when-using-docker-desktop-windows-and-macos
[installing-binary]: /docs/install#precompiled-binaries
[vagrant-environment]: https://learn.hashicorp.com/tutorials/nomad/get-started-install#vagrant-setup-optional
[virtualbox]: https://www.virtualbox.org/