/nomad

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.

Primary LanguageGoMozilla Public License 2.0MPL-2.0

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, CloudFlare, Roblox, Pandora, 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 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 applications 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. Guides are available on HashiCorp Learn website here.

Resources

Who Uses Nomad

...and more!

Contributing

See the contributing directory for more developer documentation.

Developing with Vagrant

A development environment is supplied via Vagrant to make getting started easier.

  1. Install Vagrant
  2. Install Virtualbox
  3. Bring up the Vagrant project 
    $ 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 within the VM.

Developing without Vagrant

  1. Install Go 1.15.5+ (Note: gcc-go is not supported)
  2. Clone this repo 
    $ git clone https://github.com/hashicorp/nomad.git
$ cd nomad
  3. Bootstrap your environment 
    $ make bootstrap
  4. (Optionally) Set a higher ulimit, as Nomad creates many file handles during normal operations 
    $ [ "$(ulimit -n)" -lt 1024 ] && ulimit -n 1024
  5. Verify you can run tests 
    $ make test

Running a development build

  1. Compile a development binary (see the UI README to include the web UI in the binary) 
    $ make dev
# find the built binary at ./bin/nomad
  2. Start the agent in dev mode 
    $ sudo bin/nomad agent -dev
  3. (Optionally) Run Consul to enable service discovery and health checks
    1. Download Consul
    2. Start Consul in dev mode 
      $ consul agent -dev

Compiling Protobufs

If in the course of your development you change a Protobuf file (those ending in .proto), you'll need to recompile the protos.

  1. Install Buf
  2. Compile Protobufs 
    $ make proto

Building the Web UI

See the UI README for instructions.

Create a release binary

To create a release binary:

$ make prerelease
$ make release
$ ls ./pkg

This will generate all the static assets, compile Nomad for multiple platforms and place the resulting binaries into the ./pkg directory.

API Compatibility

Only the api/ and plugins/ packages are intended to be imported by other projects. The root Nomad module does not follow semver and is not intended to be imported directly by other projects.