Skip to content
Nomad is an easy-to-use, flexible, and performant workload orchestrator that can deploy a mix of microservice, batch, containerized, and non-containerized applications. Nomad is easy to operate and scale and has native Consul and Vault integrations.
Go JavaScript HTML CSS HCL Shell Other
Branch: master
Clone or download

Latest commit

backspace Remove minor version from audit comparison action (#8048)
Making this less specific means we can benefit from updates
to the action without needing to change the workflow, such
as the bug fix in backspace/ember-test-audit-comparison-action@a87d252,
which addresses the incorrect duration delta here:
#7964 (comment)
Latest commit 6e7c180 May 26, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci build: update from Go 1.14.1 to Go 1.14.3 May 16, 2020
.github Remove minor version from audit comparison action (#8048) May 26, 2020
.netlify Remove most Netlify configuration (#6194) Aug 22, 2019
acl fix spelling errors (#6985) Apr 20, 2020
api Revert "disable license cli commands" May 26, 2020
client cleanup driver eventor goroutines May 26, 2020
command Revert "disable license cli commands" May 26, 2020
contributing structs: fix compatibility between api and nomad/structs proxy defini… Apr 13, 2020
demo Merge pull request #7781 from hashicorp/demo-countdash-docker May 7, 2020
dev build: use hashicorp hclfmt May 24, 2020
devices/gpu/nvidia cleanup driver eventor goroutines May 26, 2020
dist dist: make README consistent with service unit (#7648) Apr 8, 2020
drivers cleanup driver eventor goroutines May 26, 2020
e2e build: use hashicorp hclfmt May 24, 2020
helper cleanup driver eventor goroutines May 26, 2020
integrations spelling: registrations Mar 11, 2018
internal/testing/apitests update rest of consul packages Feb 16, 2020
jobspec build: use hashicorp hclfmt May 24, 2020
lib circbufwritter: add defer to stop ticker in flush loop Jan 28, 2019
nomad {volume|deployment}watcher: check for nil batcher May 26, 2020
plugins cleanup driver eventor goroutines May 26, 2020
scheduler server: stop after client disconnect (#7939) May 13, 2020
scripts build: update from Go 1.14.1 to Go 1.14.3 May 16, 2020
terraform separate vars and outputs into their own files and update default lin… Oct 25, 2019
testutil tests: wait until leadership loop finishes Mar 6, 2020
ui Merge pull request #8035 from hashicorp/f-ui/ember-fetch May 26, 2020
vendor Update hcl2 vendoring May 19, 2020
version release: prep for 0.11.3 dev cycle May 14, 2020
website Add Carousel Item May 26, 2020
.gitattributes Remove invalid gitattributes Feb 14, 2018
.gitignore Remove Ember server from Storybook startup (#7980) May 15, 2020
.golangci.yml chore: Switch from gometalinter to golangci-lint Dec 6, 2019
CHANGELOG.md Merge pull request #8018 from hashicorp/b-sidecar-task-resources-npe May 26, 2020
GNUmakefile build: use hashicorp hclfmt May 24, 2020
LICENSE Initial commit Jun 1, 2015
README.md build: update from Go 1.14.1 to Go 1.14.3 May 16, 2020
Vagrantfile Remove rkt as a built-in driver Feb 27, 2020
build_linux_arm.go Fix 32bit arm build Feb 9, 2017
main.go fix comment typo Sep 18, 2019
main_test.go Adding initial skeleton Jun 1, 2015

README.md

Nomad Build Status Discuss

Overview

Nomad is an easy-to-use, flexible, and performant workload orchestrator that deploys:

Nomad enables developers to use declarative infrastructure-as-code for deploying their applications (jobs). Nomad uses bin packing to efficiently schedule jobs and optimize for resource utilization. Nomad is supported on macOS, Windows, and Linux.

Nomad is widely adopted and used in production by PagerDuty, Target, Citadel, Trivago, SAP, Pandora, Roblox, eBay, Deluxe Entertainment, and more.

  • Deploy Containers and Legacy Applications: Nomad’s flexibility as an orchestrator enables an organization to run containers, legacy, and batch applications together on the same infrastructure. Nomad brings core orchestration benefits to legacy applications without needing to containerize via pluggable task drivers.

  • Simple & Reliable: Nomad runs as a single 75MB binary and is entirely self contained - combining resource management and scheduling into a single system. Nomad does not require any external services for storage or coordination. Nomad automatically handles application, node, and driver failures. Nomad is distributed and resilient, using leader election and state replication to provide high availability in the event of failures.

  • Device Plugins & GPU Support: Nomad offers built-in support for GPU workloads such as machine learning (ML) and artificial intelligence (AI). Nomad uses device plugins to automatically detect and utilize resources from hardware devices such as GPU, FPGAs, and TPUs.

  • Federation for Multi-Region, Multi-Cloud: Nomad was designed to support infrastructure at a global scale. Nomad supports federation out-of-the-box and can deploy jobs across multiple regions and clouds.

  • Proven Scalability: Nomad is optimistically concurrent, which increases throughput and reduces latency for workloads. Nomad has been proven to scale to clusters of 10K+ nodes in real-world production environments.

  • HashiCorp Ecosystem: Nomad integrates seamlessly with Terraform, Consul, Vault for provisioning, service discovery, and secrets management.

Getting Started

Get started with Nomad quickly in a sandbox environment on the public cloud or on your computer.

These methods are not meant for production.

Documentation & Guides

Documentation is available on the Nomad website here.

Resources

Who Uses Nomad

...and more!

Contributing to Nomad

If you wish to contribute to Nomad, you will need Go installed on your machine (version 1.14.3+ is required, and gcc-go is not supported).

See the contributing directory for more developer documentation.

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
...

Nomad creates many file handles for communicating with tasks, log handlers, etc. In some development environments, particularly macOS, the default number of file descriptors is too small to run Nomad's test suite. You should set ulimit -n 1024 or higher in your shell. This setting is scoped to your current shell and doesn't affect other running shells or future shells.

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

Optionally run Consul to enable service discovery and health checks:

$ sudo consul agent -dev

And finally start the nomad agent:

$ sudo bin/nomad agent -dev

If the Nomad UI is desired in the development version, run make dev-ui. This will build the UI from source and compile it into the dev binary.

$ make dev-ui
...
$ bin/nomad
...

To compile protobuf files, installing protoc is required: See
https://github.com/google/protobuf for more information.

Note: Building the Nomad UI from source requires Node, Yarn, and Ember CLI. These tools are already in the Vagrant VM. Read the UI README for more info.

To cross-compile Nomad, run make prerelease and make release. This will generate all the static assets, compile Nomad for multiple platforms and place the resulting binaries into the ./pkg directory:

$ make prerelease
$ make release
...
$ ls ./pkg
...
You can’t perform that action at this time.