README

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.1+ 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
...
Expand ▾ Collapse ▴

Documentation

The Go Gopher

There is no documentation for this package.

Source Files

Directories

Path Synopsis
acl
client
client/allocdir
client/allocdir/input
client/allochealth
client/allocrunner
client/allocrunner/interfaces
client/allocrunner/state
client/allocrunner/taskrunner
client/allocrunner/taskrunner/getter
client/allocrunner/taskrunner/interfaces
client/allocrunner/taskrunner/restarts
client/allocrunner/taskrunner/state
client/allocrunner/taskrunner/template
client/allocwatcher Package allocwatcher allows blocking until another allocation - whether running locally or remotely - completes and migrates the allocation directory if necessary.
client/config
client/consul
client/devicemanager Package devicemanager is used to manage device plugins
client/devicemanager/state
client/dynamicplugins dynamicplugins is a package that manages dynamic plugins in Nomad.
client/fingerprint
client/interfaces
client/lib/fifo Package fifo implements functions to create and open a fifo for inter-process communication in an OS agnostic way.
client/lib/nsutil
client/lib/streamframer
client/logmon
client/logmon/logging
client/logmon/proto
client/pluginmanager
client/pluginmanager/csimanager * csimanager manages locally running CSI Plugins on a Nomad host, and provides a few different interfaces.
client/pluginmanager/drivermanager
client/pluginmanager/drivermanager/state
client/servers Package servers provides an interface for choosing Servers to communicate with from a Nomad Client perspective.
client/state
client/stats
client/structs
client/taskenv
client/testutil
client/vaultclient
command
command/agent
command/agent/consul
command/agent/event
command/agent/monitor
command/agent/pprof
demo/digitalocean/app
devices/gpu/nvidia
devices/gpu/nvidia/cmd
devices/gpu/nvidia/nvml
drivers/docker
drivers/docker/cmd This package provides a mechanism to build the Docker driver plugin as an external binary.
drivers/docker/docklog
drivers/docker/docklog/proto
drivers/docker/util
drivers/exec
drivers/java
drivers/mock
drivers/qemu
drivers/rawexec
drivers/shared/eventer
drivers/shared/executor
drivers/shared/executor/proto
e2e/affinities
e2e/cli
e2e/cli/command
e2e/clientstate
e2e/connect
e2e/consul
e2e/consulacls
e2e/consultemplate
e2e/csi
e2e/deployment
e2e/e2eutil
e2e/example
e2e/execagent
e2e/framework Package framework implements a model for developing end-to-end test suites.
e2e/framework/provisioning
e2e/hostvolumes
e2e/metrics
e2e/nomad09upgrade
e2e/nomadexec
e2e/spread
e2e/systemsched
e2e/taskevents
helper
helper/args
helper/boltdd BOLTdd contains a wrapper around BoltDB to deduplicate writes and encode values using mgspack.
helper/codec
helper/constraints/semver semver is a Semver Constraints package copied from github.com/hashicorp/go-version @ 2046c9d0f0b03c779670f5186a2a4b2c85493a71 Unlike Constraints in go-version, Semver constraints use Semver 2.0 ordering rules and only accept properly formatted Semver versions.
helper/discover
helper/escapingio
helper/fields
helper/flag-helpers
helper/flatmap
helper/freeport Copied from github.com/hashicorp/consul/sdk/freeport and tweaked for use by Nomad.
helper/gated-writer
helper/grpc-middleware/logging
helper/logging
helper/mount
helper/noxssrw Package noxssrw (No XSS ResponseWriter) behaves like the Go standard library's ResponseWriter by detecting the Content-Type of a response if it has not been explicitly set.
helper/pluginutils/catalog Package catalog is used to register internal plugins such that they can be loaded.
helper/pluginutils/grpcutils
helper/pluginutils/hclspecutils
helper/pluginutils/hclutils
helper/pluginutils/loader
helper/pluginutils/singleton
helper/pool
helper/stats
helper/testlog Package testlog creates a *log.Logger backed by *testing.T to ease logging in tests.
helper/testtask Package testtask implements a portable set of commands useful as stand-ins for user tasks.
helper/tlsutil
helper/useragent
helper/uuid
helper/winsvc
jobspec
lib/circbufwriter
lib/delayheap
lib/kheap
nomad
nomad/deploymentwatcher deploymentwatcher creates and tracks Deployments, which hold meta data describing the process of upgrading a running job to a new set of Allocations.
nomad/drainer
nomad/mock
nomad/state
nomad/structs
nomad/structs/config
nomad/types
nomad/volumewatcher
plugins
plugins/base
plugins/base/proto
plugins/base/structs
plugins/csi
plugins/csi/fake fake is a package that includes fake implementations of public interfaces from the CSI package for testing.
plugins/csi/testing
plugins/device
plugins/device/cmd/example
plugins/device/cmd/example/cmd
plugins/device/proto
plugins/drivers
plugins/drivers/proto
plugins/drivers/testutils
plugins/drivers/utils
plugins/shared/cmd/launcher
plugins/shared/cmd/launcher/command
plugins/shared/hclspec
plugins/shared/structs
plugins/shared/structs/proto
scheduler
testutil
version