Find a file
2020-08-05 12:02:22 -07:00
.circleci Use golang 1.14.6 2020-07-20 12:04:38 -04:00
.github remove stalebot (#8466) 2020-07-20 14:50:32 -04:00
.netlify Remove most Netlify configuration (#6194) 2019-08-22 15:54:23 -05:00
acl fix spelling errors (#6985) 2020-04-20 09:28:19 -04:00
api Merge pull request #8453 from hashicorp/oss-multi-vault-ns 2020-07-27 08:45:22 -04:00
client consul/connect: fixup some spelling, comments, consts 2020-07-29 09:26:01 -05:00
command ignore VAULT_NAMESPACE (#8581) 2020-07-31 10:33:21 -04:00
contributing doc: nomad debug cli (#8278) 2020-06-25 13:48:27 -04:00
demo update nomad to 0.12.1 2020-07-24 11:53:44 -04:00
dev build: use hashicorp hclfmt 2020-05-24 18:31:57 -05:00
devices/gpu/nvidia nvidia: support disabling the nvidia plugin (#8353) 2020-07-21 10:11:16 -04:00
dist dist: make README consistent with service unit (#7648) 2020-04-08 09:32:03 -04:00
drivers removes nvidia import from docker test (#8312) 2020-06-30 09:34:59 -04:00
e2e csi/e2e: add 2nd controller for node drain testing (#8573) 2020-07-31 08:03:49 -04:00
helper oss compoments for multi-vault namespaces 2020-07-24 10:14:59 -04:00
integrations spelling: registrations 2018-03-11 18:40:53 +00:00
internal/testing/apitests tests: non-CAS should be updated 2020-06-26 10:48:33 -04:00
jobspec oss compoments for multi-vault namespaces 2020-07-24 10:14:59 -04:00
lib deps: Switch to Go modules for dependency management 2020-06-02 14:30:36 -05:00
nomad Handle Scaling Policies in Job Plan endpoint (#8567) 2020-07-30 12:27:36 -04:00
plugins nvidia: support disabling the nvidia plugin (#8353) 2020-07-21 10:11:16 -04:00
scheduler scheduler: label loops with nested switch statements for effective break (#8528) 2020-07-24 08:50:41 -04:00
scripts Merge pull request #7735 from hashicorp/dependabot/npm_and_yarn/scripts/screenshots/src/https-proxy-agent-2.2.4 2020-07-24 15:13:36 -07:00
terraform demo: Fix Vagrantfile when building staging VM for Cloud build. 2020-06-17 12:22:24 +02:00
testutil gracefully shutdown test server 2020-05-27 08:59:06 -04:00
tools Generate files for 0.12.1 release 2020-07-23 13:17:59 +00:00
ui Use the correct gray for the info details 2020-08-05 12:02:22 -07:00
vendor oss compoments for multi-vault namespaces 2020-07-24 10:14:59 -04:00
version 0.12.2 version and changelog placeholder 2020-07-23 14:21:55 -04:00
website ignore VAULT_NAMESPACE (#8581) 2020-07-31 10:33:21 -04:00
.gitattributes Remove invalid gitattributes 2018-02-14 14:47:43 -08:00
.gitignore ignore vagrant directory even if symlinked (#8114) 2020-06-04 10:24:15 -04:00
.golangci.yml chore: Switch from gometalinter to golangci-lint 2019-12-05 18:58:13 -06:00
build_linux_arm.go Fix 32bit arm build 2017-02-09 11:22:17 -08:00
CHANGELOG.md Update CHANGELOG.md 2020-07-31 11:14:13 -05:00
GNUmakefile use specific sha (#8329) 2020-07-01 10:32:45 -04:00
go.mod tests: avoid os.Exit in a test 2020-07-01 15:25:13 -04:00
go.sum Update github.com/syndtr/gocapability 2020-06-22 17:10:41 -04:00
LICENSE Initial commit 2015-06-01 12:21:00 +02:00
main.go fix comment typo 2019-09-18 09:11:08 -04:00
main_test.go Adding initial skeleton 2015-06-01 13:46:21 +02:00
README.md docs: remove Nomad binary size from README and website. 2020-07-29 09:04:28 +02:00
Vagrantfile only set args.Eval after all servers upgrade 2020-07-15 11:10:57 -04:00

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: Nomads 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 to Nomad

If you wish to contribute to Nomad, you will need Go installed on your machine (version 1.14.6+ 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
...

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.