Go to file
Seth Vargo 38126220cf s/Vault/Nomad in code comment 2015-09-20 16:37:11 -04:00
api api: test job sort 2015-09-17 13:15:45 -07:00
client Support running Linux exec as a non-root user 2015-09-15 20:17:23 -07:00
command command: fix tests after job validation 2015-09-16 11:42:28 -07:00
helper agent: moving functions into helpers 2015-08-23 16:57:54 -07:00
jobspec jobspec: default job ID also comes from key 2015-09-16 22:06:55 -07:00
nomad nomad: ensure job ID does not contain space 2015-09-15 17:38:30 -07:00
scheduler scheduler: ignore allocations in terminal state 2015-09-17 21:25:55 -07:00
scripts Use = in -X because it's deprecated without 2015-09-20 16:36:30 -04:00
testutil testutil: fix bootstrap on test server 2015-09-14 13:52:19 -07:00
website website: custom 2015-09-19 21:18:08 -07:00
.gitattributes
.gitignore
LICENSE
Makefile README fillin 2015-09-13 19:04:06 -07:00
README.md Weird whitespace in the README 2015-09-20 16:36:52 -04:00
Vagrantfile small update to remove dupe 2015-09-14 10:06:12 -05:00
commands.go s/Vault/Nomad in code comment 2015-09-20 16:37:11 -04:00
main.go Adding initial skeleton 2015-06-01 13:46:21 +02:00
main_test.go Adding initial skeleton 2015-06-01 13:46:21 +02:00
version.go Adding initial skeleton 2015-06-01 13:46:21 +02: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.4+ 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. This will put the Nomad binary in the bin and $GOPATH/bin folders:

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