Go to file
Seth Vargo 252252a3a5
Migrate API layouts
2017-05-30 20:25:11 -04:00
api Fix template canonicalize test 2017-05-26 16:42:16 -07:00
client Merge pull request #2636 from hashicorp/f-gc-alloc-limit 2017-05-30 16:14:09 -07:00
command Merge pull request #2636 from hashicorp/f-gc-alloc-limit 2017-05-30 16:14:09 -07:00
demo Make example clients generate random HostIDs 2017-05-21 19:20:32 -04:00
dist Separate agent configuration into its own pages 2016-11-02 18:30:00 -04:00
helper Move task env into execcontext 2017-05-23 13:53:34 -07:00
jobspec Test env parsing 2017-05-26 15:31:40 -07:00
nomad Update consul/api and comment to custom http.Client 2017-05-30 15:11:32 -07:00
scheduler Fix tests 2017-05-01 13:54:26 -07:00
scripts Update go-winio to remove cgo on Windows 2017-05-08 15:43:48 -07:00
testutil Use a lock to increment the vault port 2017-05-16 13:25:07 -04:00
vendor Update consul-template to fix compat with consul/api 2017-05-30 15:11:32 -07:00
website Migrate API layouts 2017-05-30 20:25:11 -04:00
.gitattributes Initial commit 2015-06-01 12:21:00 +02:00
.gitignore add intellij iml as an ignored file 2016-07-28 22:20:20 -05:00
.travis.yml Bump Travis to latest Go 1.8.x 2017-05-04 17:04:59 -07:00
CHANGELOG.md Merge pull request #2636 from hashicorp/f-gc-alloc-limit 2017-05-30 16:14:09 -07:00
GNUmakefile Merge pull request #2442 from jen20/deps-test-vault 2017-03-16 15:10:05 -07:00
ISSUE_TEMPLATE.md Update ISSUE_TEMPLATE.md 2016-03-21 18:12:50 -07:00
LICENSE Initial commit 2015-06-01 12:21:00 +02:00
README.md fix badge 2017-04-04 16:38:49 -07:00
Vagrantfile go-winio now requires cgo which requires mingw 2017-05-03 17:09:12 -07:00
appveyor.yml install with tags 2017-04-04 16:32:26 -07:00
build_linux_arm.go Fix 32bit arm build 2017-02-09 11:22:17 -08:00
commands.go Operator command/endpoint/documentation 2017-02-09 18:04:46 -08:00
main.go Operator command/endpoint/documentation 2017-02-09 18:04:46 -08:00
main_test.go Adding initial skeleton 2015-06-01 13:46:21 +02:00
version.go version bump 2017-04-04 14:29:41 -07:00

README.md

Nomad Build Status Build status Join the chat at https://gitter.im/hashicorp-nomad/Lobby

Nomad is a cluster manager, designed for both long lived services and short lived batch processing workloads. Developers use a declarative job specification to submit work, and Nomad ensures constraints are satisfied and resource utilization is optimized by efficient task packing. Nomad supports all major operating systems and virtualized, containerized, or standalone applications.

The key features of Nomad are:

  • Docker Support: Jobs can specify tasks which are Docker containers. Nomad will automatically run the containers on clients which have Docker installed, scale up and down based on the number of instances requested, and automatically recover from failures.

  • Multi-Datacenter and Multi-Region Aware: Nomad is designed to be a global-scale scheduler. Multiple datacenters can be managed as part of a larger region, and jobs can be scheduled across datacenters if requested. Multiple regions join together and federate jobs making it easy to run jobs anywhere.

  • Operationally Simple: Nomad runs as a single binary that can be either a client or server, and is completely self contained. Nomad does not require any external services for storage or coordination. This means Nomad combines the features of a resource manager and scheduler in a single system.

  • Distributed and Highly-Available: Nomad servers cluster together and perform leader election and state replication to provide high availability in the face of failure. The Nomad scheduling engine is optimized for optimistic concurrency allowing all servers to make scheduling decisions to maximize throughput.

  • HashiCorp Ecosystem: Nomad integrates with the entire HashiCorp ecosystem of tools. Along with all HashiCorp tools, Nomad is designed in the unix philosophy of doing something specific and doing it well. Nomad integrates with tools like Packer, Consul, and Terraform to support building artifacts, service discovery, monitoring and capacity management.

For more information, see the introduction section of the Nomad website.

Getting Started & Documentation

All documentation is available on the Nomad website.

Developing Nomad

If you wish to work on Nomad itself or any of its built-in systems, you will first need Go installed on your machine (version 1.8+ is required).

Developing with Vagrant There is an included Vagrantfile that can help bootstrap the process. The created virtual machine is based off of Ubuntu 14, and installs several of the base libraries that can be used by Nomad.

To use this virtual machine, checkout Nomad and run vagrant up from the root of the repository:

$ git clone https://github.com/hashicorp/nomad.git
$ cd nomad
$ vagrant up

The virtual machine will launch, and a provisioning script will install the needed dependencies.

Developing locally For local dev first make sure Go is properly installed, including setting up a GOPATH. After setting up Go, clone this repository into $GOPATH/src/github.com/hashicorp/nomad. Then you can download the required build tools such as vet, cover, godep etc by bootstrapping your environment.

$ make bootstrap
...

Afterwards type make test. This will run the tests. If this exits with exit status 0, then everything is working!

$ make test
...

To compile a development version of Nomad, run make dev. This will put the Nomad binary in the bin and $GOPATH/bin folders:

$ make dev
...
$ bin/nomad
...

To cross-compile Nomad, run make bin. This will compile Nomad for multiple platforms and place the resulting binaries into the ./pkg directory:

$ make bin
...
$ ls ./pkg
...