You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Charlie Voiselle 455f9dd165
Merge pull request #6705 from hashicorp/docs-index-redir
5 hours ago
.circleci Merge pull request #6573 from hashicorp/update-cci-consul 1 week ago
.github docs: link to security page on website 1 month ago
.netlify Remove most Netlify configuration (#6194) 2 months ago
acl acl: check ACL against object namespace 1 month ago
api api: go-uuid is no longer needed 2 days ago
client add server-id to monitor specific server 12 hours ago
command serverID to target remote leader or server 12 hours ago
contributing Merge pull request #6447 from hashicorp/contributing-doc-tweaks 1 month ago
demo docs: bump website to Nomad 0.10.1 1 week ago
dev New monitor pkg for shared monitor functionality 1 week ago
devices/gpu/nvidia Update devices/gpu/nvidia/README.md 9 months ago
dist Set OOMScoreAdjust within systemd dist example (#6679) 2 days ago
drivers remove misleading networking log line (#6588) 2 weeks ago
e2e Merge pull request #6573 from hashicorp/update-cci-consul 1 week ago
helper Added service wrapper code (#6220) 3 days ago
integrations spelling: registrations 1 year ago
internal/testing/apitests Merge pull request #5664 from hashicorp/f-http-hcl-region 5 months ago
jobspec run 'make hclfmt' so that 'make dev' is idempotent (#6587) 2 weeks ago
lib circbufwritter: add defer to stop ticker in flush loop 9 months ago
nomad serverID to target remote leader or server 12 hours ago
plugins volumes: Add support for mount propagation 1 month ago
scheduler changed all tests to require from t.Fatalf 1 week ago
scripts update vagrant & packer consul versions 1 week ago
terraform separate vars and outputs into their own files and update default link in nomad binary variable to 0.10.0 release (#6550) 2 weeks ago
testutil acl: check ACL against object namespace 1 month ago
ui Remove inverse block for list-pagination (#6523) 3 weeks ago
vendor updates consul template deps to v0.22.1 13 hours ago
version Merge branch 'master' into release-0101 1 week ago
website a few more redirects 5 hours ago
.gitattributes Remove invalid gitattributes 1 year ago
.gitignore UI: Update to Ember 3.8 LTS (#5968) 1 month ago
CHANGELOG.md Merge branch 'master' into f-override-vault-constraint 2 days ago
GNUmakefile tests appear as github.com/hashicorp/nomad/api.test 2 days ago
LICENSE Initial commit 4 years ago
README.md doc: switch README to CircleCI build status badge (#6634) 1 week ago
Vagrantfile Bumping freebsd vagrant to 11.3-STABLE (#6500) 1 week ago
appveyor.yml Use golang 1.12.12 3 weeks ago
build_linux_arm.go Fix 32bit arm build 2 years ago
main.go fix comment typo 1 month ago
main_test.go Adding initial skeleton 4 years ago

README.md

Nomad Build Status

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.12.12+ is required).

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