luxolus
/
open-nomad
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

Add more examples and links to installation instructions

This commit is contained in:
Seth Vargo 2016-10-08 18:58:18 +08:00
parent 00bbcc9010
commit 2fbd4a0cba
1 changed files with 36 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
website/source/docs/install/index.html.md
View File

@ -1,19 +1,22 @@
--- ---
layout: "docs" layout: "docs"
page_title: "Install Nomad" page_title: "Installing Nomad"
sidebar_current: "docs-install" sidebar_current: "docs-installing"
description: |- description: |-
Learn how to install Nomad. Learn how to install Nomad.
--- ---
# Install Nomad # Installing Nomad
Installing Nomad is simple. There are two approaches to installing Nomad: Installing Nomad is simple. There are two approaches to installing Nomad:
downloading a precompiled binary for your system, or installing from source.
1. Using a <a href="#precompiled-binaries">precompiled binary</a>
1. Installing <a href="#from-source">from source</a>
Downloading a precompiled binary is easiest, and we provide downloads over Downloading a precompiled binary is easiest, and we provide downloads over
TLS along with SHA256 sums to verify the binary. TLS along with SHA256 sums to verify the binary.
<a name="precompiled-binaries"></a>
## Precompiled Binaries ## Precompiled Binaries
To install the precompiled binary, To install the precompiled binary,
@ -23,35 +26,49 @@ plans to provide system packages.
Once the zip is downloaded, unzip it into any directory. The Once the zip is downloaded, unzip it into any directory. The
`nomad` binary inside is all that is necessary to run Nomad (or `nomad` binary inside is all that is necessary to run Nomad (or
`nomad.exe` for Windows). Any additional files, if any, aren't `nomad.exe` for Windows). Any additional files, if any, are not
required to run Nomad. required to run Nomad.
Copy the binary to anywhere on your system. If you intend to access it Copy the binary to anywhere on your system. If you intend to access it
from the command-line, make sure to place it somewhere on your `PATH`. from the command-line, make sure to place it somewhere on your `PATH`.
<a name="from-source"></a>
## Compiling from Source ## Compiling from Source
To compile from source, you will need [Go](https://golang.org) installed and To compile from source, you will need [Go](https://golang.org) installed and
configured properly (including a `GOPATH` environment variable set), as well configured properly (including a `GOPATH` environment variable set), as well
as a copy of [`git`](https://www.git-scm.com/) in your `PATH`. as a copy of [`git`](https://www.git-scm.com/) in your `PATH`.
1. Clone the Nomad repository into your `GOPATH`: `mkdir -p $GOPATH/src/github.com/hashicorp && cd $GOPATH/src/github.com/hashicorp && git clone https://github.com/hashicorp/nomad.git && cd nomad` 1. Clone the Nomad repository from GitHub into your `GOPATH`:
1. Run `make bootstrap`. This will download and compile libraries and tools needed ```shell
to compile Nomad. $ mkdir -p $GOPATH/src/github.com/hashicorp && cd $!
$ git clone https://github.com/hashicorp/nomad.git
$ cd nomad
```
1. Run `make dev`. This will build Nomad for your current system and put 1. Bootstrap the project. This will download and compile libraries and tools
the binary in `./bin/` (relative to the git checkout). The `make dev` needed to compile Nomad:
target is just a shortcut that builds `nomad` for only your local build
environment (no cross-compiled targets). If you would like to
cross-compile Nomad for different platforms, just run `make`.
1. Run `make install`. This will install `./bin/nomad` into ```shell
`/usr/local/bin/nomad`. $ make bootstrap
```
1. Build Nomad for your current system and put the
binary in `./bin/` (relative to the git checkout). The `make dev` target is
just a shortcut that builds `nomad` for only your local build environment (no
cross-compiled targets).
```shell
$ make dev
```
## Verifying the Installation ## Verifying the Installation
To verify Nomad is properly installed, execute the `nomad` binary on To verify Nomad is properly installed, run `nomad -v` on your system. You should
your system. You should see help output. If you are executing it from see help output. If you are executing it from the command line, make sure it is
the command line, make sure it is on your `PATH` or you may get an error on your `PATH` or you may get an error about `nomad` not being found.
about `nomad` not being found.
```shell
$ nomad -v
```