Go to file
Diptanu Choudhury 4a1797e2c6 Merge branch 'master' of github.com:hashicorp/nomad 2016-03-21 17:45:13 -07:00
Godeps update vendored go-getter 2016-03-14 17:15:27 -07:00
api Add nomad inspect command 2016-03-21 12:46:35 -07:00
client Merge branch 'master' of github.com:hashicorp/nomad 2016-03-21 17:45:13 -07:00
command Merge pull request #952 from hashicorp/f-nomad-inspect 2016-03-21 13:01:48 -07:00
demo demo client configs 2016-03-16 15:42:27 -07:00
dist Change /usr/local/bin to /usr/bin 2015-12-03 09:27:03 -08:00
helper Allow dashes in var names 2016-02-27 18:42:33 +02:00
jobspec add destination to artifact block and validate it 2016-03-18 12:01:46 -07:00
nomad add destination to artifact block and validate it 2016-03-18 12:01:46 -07:00
scheduler Allow count zero 2016-03-17 11:02:59 -07:00
scripts Update rkt and docker 2016-03-18 22:18:59 -07:00
testutil Use the CI env variable 2016-02-06 01:11:44 -08:00
vendor update vendored go-getter 2016-03-14 17:15:27 -07:00
website Merge pull request #941 from hashicorp/f-interface-name 2016-03-20 23:57:44 -07:00
.gitattributes Initial commit 2015-06-01 12:21:00 +02:00
.gitignore Switch to using go/codec and use code generation 2016-02-20 18:05:17 -08:00
.travis.yml Put docker version in the script 2016-03-02 14:04:14 -08:00
CHANGELOG.md changelog 2016-03-21 13:03:19 -07:00
GNUmakefile Include number of allocations in node-status 2016-03-03 12:19:56 -05:00
ISSUE_TEMPLATE.md Update ISSUE_TEMPLATE.md 2016-03-10 15:30:31 -08:00
LICENSE Initial commit 2015-06-01 12:21:00 +02:00
README.md Update Readme for local dev. 2016-02-15 12:15:16 +01:00
Vagrantfile Setup rkt in vagrant 2016-03-20 15:37:20 -07:00
commands.go Add nomad inspect command 2016-03-21 12:46:35 -07:00
main.go hide the fs subcommands 2016-03-20 17:05:46 -07:00
main_test.go Adding initial skeleton 2015-06-01 13:46:21 +02:00
version.go update version 2016-03-16 10:38:31 -07: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, 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
...