Go to file
Mahmood Ali ccac5ad3e4
Merge pull request #5722 from hashicorp/f-nomad-exec-escape-try2
escapingio: handle stalled readers
2019-05-17 14:52:54 -04:00
.circleci add circleci website build 2018-11-20 16:59:34 -05:00
.github stalebot: Add 'thinking' as an exempt label (#5684) 2019-05-10 11:00:35 -04:00
acl Add ACL capabilities for nomad exec 2019-04-30 14:02:16 -04:00
api Add flag similar to --all for allocs to be able to filter deployments by latest 2019-05-13 18:33:41 -05:00
client docs: changelog entry for #5669 and fix comment 2019-05-14 10:54:00 -07:00
command Restore tty start before emitting errors 2019-05-17 11:58:31 -04:00
demo Fixup mixed tabs in script for Vagrantfile demo 2019-03-26 15:23:38 -07:00
dev code review feedback 2019-05-07 16:23:32 -05:00
devices/gpu/nvidia Update devices/gpu/nvidia/README.md 2019-01-23 17:44:24 -08:00
dist docs: sync systemd unit files; update deploy guide 2019-03-19 15:18:12 -07:00
drivers drivers/mock: implement InspectTask 2019-05-14 10:53:27 -07:00
e2e Merge pull request #5702 from hashicorp/f-filter-by-create-index 2019-05-15 21:50:41 -05:00
helper escapingio: handle stalled readers 2019-05-17 11:58:31 -04:00
integrations spelling: registrations 2018-03-11 18:40:53 +00:00
internal/testing/apitests Merge pull request #5632 from hashicorp/f-nomad-exec-parts-01-base 2019-05-09 18:09:27 -04:00
jobspec copied consts used by jobspec parsing from structs into api package, to avoid referencing structs package in jobspec (#5663) 2019-05-09 08:23:49 -04:00
lib circbufwritter: add defer to stop ticker in flush loop 2019-01-28 14:33:20 -05:00
nomad Merge pull request #5717 from hashicorp/b-plan-apply-preemptions 2019-05-16 11:01:05 -05:00
plugins Add basic drivers conformance tests 2019-05-09 16:49:08 -04:00
scheduler Fix comment and assert score in test case 2019-05-15 12:35:57 -05:00
scripts use ugorji/go/codec version that's in vendor.json 2019-05-01 12:47:14 -04:00
terraform docs: update s3 urls to use virtual bucket style 2019-05-06 10:39:51 -04:00
testutil test helper for registering jobs with acl 2019-04-30 10:23:56 -04:00
ui Merge pull request #5715 from hashicorp/b-precommit-linting 2019-05-15 16:44:19 -05:00
vendor vendor github.com/kr/pty 2019-05-10 19:17:14 -04:00
version Update master to reflect 0.9.1/0.9.2 split 2019-04-30 10:33:41 +02:00
website Merge pull request #5709 from jweissig/patch-10 2019-05-16 11:06:43 -05:00
.gitattributes Remove invalid gitattributes 2018-02-14 14:47:43 -08:00
.gitignore Upgrade to Ember 3.4 2019-04-10 14:54:34 -07:00
.travis.yml Force Travis to use node 10 2019-04-10 14:55:30 -07:00
CHANGELOG.md Add preemption to changelog 2019-05-16 16:21:15 -05:00
GNUmakefile Merge pull request #5581 from hashicorp/dev-make-boostrap-git-hooks 2019-04-30 16:36:10 -04:00
LICENSE Initial commit 2015-06-01 12:21:00 +02:00
README.md Merge pull request #5636 from hashicorp/yishan/website-revised-resources-page 2019-05-01 18:45:47 -07:00
Vagrantfile Add a Docker release scripts 2019-03-17 10:37:36 -04:00
appveyor.yml run fifo tests on Windows 2019-04-01 13:18:03 -04:00
build_linux_arm.go Fix 32bit arm build 2017-02-09 11:22:17 -08:00
main.go ui: Support colored output on Windows 2019-02-20 14:01:35 +01:00
main_test.go Adding initial skeleton 2015-06-01 13:46:21 +02:00

README.md

Nomad Build Status Join the chat at https://gitter.im/hashicorp-nomad/Lobby

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

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

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