Go to file
Sean Chittenden 89df36b7c7 Rename Makefile to GNUmakefile 2016-02-12 16:59:31 -08:00
Godeps vendor 2016-02-12 15:42:05 -08:00
api Formatting test 2016-02-12 10:37:34 -08:00
client Merge branch 'master' of github.com:hashicorp/nomad 2016-02-12 16:20:41 -08:00
command Add human readable output to fs 2016-02-12 15:36:52 -08:00
demo Slightly less node copying 2016-02-10 14:09:23 -08:00
dist Change /usr/local/bin to /usr/bin 2015-12-03 09:27:03 -08:00
helper Only interpret vars wrapped in braces 2016-02-04 17:26:46 -08:00
jobspec Fixed some more tests 2016-02-11 22:33:41 -08:00
nomad Merge branch 'master' of https://github.com/hashicorp/nomad 2016-02-12 16:13:28 -08:00
scheduler go vet 2016-02-12 16:08:58 -08:00
scripts Fixed the make dev target 2016-02-12 10:36:11 -08:00
testutil Use the CI env variable 2016-02-06 01:11:44 -08:00
vendor vendor 2016-02-12 15:42:05 -08:00
website Rename Makefile to GNUmakefile 2016-02-12 16:59:31 -08:00
.gitattributes Initial commit 2015-06-01 12:21:00 +02:00
.gitignore git-ignore pkg directory 2015-09-30 12:40:24 -07:00
.travis.yml Replacing tip with 1.6rc2 in travis 2016-02-12 10:03:45 -08:00
CHANGELOG.md Changelog 2016-02-11 11:14:23 -08:00
GNUmakefile Rename Makefile to GNUmakefile 2016-02-12 16:59:31 -08:00
LICENSE Initial commit 2015-06-01 12:21:00 +02:00
README.md Update README.md 2016-02-05 16:33:20 -08:00
Vagrantfile Installing gox while setting up the VM 2016-02-06 18:15:16 -08:00
commands.go Starting the syslog collector along with a docker container 2016-02-09 18:24:30 -08:00
main.go Starting the syslog collector along with a docker container 2016-02-09 18:24:30 -08:00
main_test.go Adding initial skeleton 2015-06-01 13:46:21 +02:00
version.go Changelog and version 2015-12-22 10:20:07 -08:00

README.md

Nomad Build Status

Nomad

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 request, 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.5+ 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, you can download the required build tools such as vet, cover, godep etc by bootstrapping your environment.

$ make bootstrap
...

Next, clone this repository into $GOPATH/src/github.com/hashicorp/nomad. Then 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
...