Go to file
Chelsea Holland Komlo faabf61c6d updated documentation 2017-09-13 19:21:21 +00:00
acl sync acls 2017-09-13 11:38:29 -07:00
api sync acls 2017-09-13 11:38:29 -07:00
client Merge pull request #3191 from hashicorp/b-tagged-metrics-panic 2017-09-11 14:28:50 -04:00
command updated documentation 2017-09-13 19:21:21 +00:00
demo bump getting started vagrant 2017-09-11 16:46:54 -07:00
dev Update README.md 2017-08-29 15:50:52 -07:00
dist Lots of fixes from @sethvargo 2017-08-01 15:40:36 -07:00
helper Add Header and Method support for HTTP checks 2017-08-17 16:44:21 -07:00
jobspec Sync namespace changes 2017-09-07 17:04:21 -07:00
nomad Merge pull request #3201 from hashicorp/b-periodic-restore 2017-09-13 11:42:29 -07:00
scheduler Sync namespace changes 2017-09-07 17:04:21 -07:00
scripts Fix permissions of $GOPATH in Vagrantfile 2017-09-11 22:38:10 -07:00
terraform Code highlighting 2017-08-10 14:23:25 +03:00
testutil testutil: Allow enabling ACLs 2017-09-04 13:07:44 -07:00
vendor vendor necessary libraries for prometheus metrics 2017-09-13 19:21:21 +00:00
version bump version 2017-09-13 09:54:55 -07:00
website add documentation for prometheus config option 2017-09-13 19:21:21 +00:00
.gitattributes Initial commit 2015-06-01 12:21:00 +02:00
.gitignore re-ignore generated files 2017-09-01 12:27:29 -07:00
.travis.yml remove f-acl 2017-09-13 11:13:04 -07:00
CHANGELOG.md changelog 2017-09-13 11:43:13 -07:00
GNUmakefile build: Lint shell scripts, and make all shell scripts lint cleanly 2017-09-08 19:50:39 -05: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 Include google compare library 2017-09-01 16:42:09 -07:00
Vagrantfile Fix permissions of $GOPATH in Vagrantfile 2017-09-11 22:38:10 -07:00
appveyor.yml Just run go install until we fix tests on Windows 2017-08-28 16:16:37 -07:00
build_linux_arm.go Fix 32bit arm build 2017-02-09 11:22:17 -08:00
commands.go command: Add ACL bootstrap command 2017-09-11 10:47:39 -07:00
main.go Hide non-user commands from autocomplete output 2017-09-08 11:24:21 -07:00
main_test.go Adding initial skeleton 2015-06-01 13:46:21 +02:00

README.md

Nomad 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.9+ 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 16, 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 release. This will compile Nomad for multiple platforms and place the resulting binaries into the ./pkg directory:

$ make release
...
$ ls ./pkg
...