Go to file
Christian Winther b12323f08c Fix #2445
Close #2445 - typo in docs
2017-03-14 10:12:48 +01:00
api Merge pull request #2412 from barnardb/agent-self 2017-03-13 13:29:15 -07:00
client Merge pull request #2426 from hashicorp/f-tg-port-ip-env-var 2017-03-13 12:00:59 -07:00
command Return AgentSelf struct from Agent.Self() instead of map 2017-03-08 15:59:10 +01:00
demo remove second client1 2017-03-11 17:25:03 -08:00
dist Separate agent configuration into its own pages 2016-11-02 18:30:00 -04:00
helper Round two of env var cleaning 2017-03-08 16:46:13 -08:00
jobspec Unoptimized implementation + testing 2017-03-07 14:48:54 -08:00
nomad Merge pull request #2432 from hashicorp/b-batch-gc 2017-03-13 10:06:55 -07:00
scheduler Fix in-place update 2017-03-09 22:03:10 -08:00
scripts make bin creates a release binary for the host arch 2017-03-08 17:42:28 -08:00
testutil Cleanup and skip test 2017-01-27 15:06:01 -08:00
vendor Merge pull request #2439 from jen20/dep-update-gopsutil 2017-03-13 13:36:26 -07:00
website Fix #2445 2017-03-14 10:12:48 +01: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 2017-02-20 15:14:44 -08:00
CHANGELOG.md Windows wasn't fixed -- see #2343 for updates 2017-03-13 18:22:05 -07:00
GNUmakefile make bin creates a release binary for the host arch 2017-03-08 17:42:28 -08: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 changes request to requested 2017-02-25 15:23:31 -05:00
Vagrantfile Fix Go 1.8 in Vagrantfile 2017-02-23 13:27:18 -08: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 bump version 2017-03-03 15:49:24 -08: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.7+ 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
...