Go to file
Michael Lange 8fe5c55594 New all-icons helper that's really only meant for development use
This returns an array of all icons. As the comment suggests, it's
because the SVGs file can't be imported in stories since it is generated
as part of the Ember project.
2020-10-26 12:25:34 -07:00
.circleci ci: make split between e2e and integration tests explicit (#9091) 2020-10-14 14:53:21 -04:00
.github remove local SECURITY.md in favor of org-wide policy 2020-08-24 15:41:28 -07:00
.netlify Remove most Netlify configuration (#6194) 2019-08-22 15:54:23 -05:00
acl fixup! handle when hcl parser panics 2020-08-25 11:28:55 -04:00
api address review feedback 2020-10-22 11:49:37 -04:00
client Add NOMAD_JOB_ID and NOMAD_JOB_PAERENT_ID env variables (#8967) 2020-10-23 10:49:58 -04:00
command event sink crud operation api (#9155) 2020-10-23 14:23:00 -04:00
contributing docs: add contributor docs for issue labels (#8723) 2020-08-24 10:19:57 -04:00
demo Provided base ceph-rbd CSI driver example (#8664) 2020-08-13 13:00:37 -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 docker: image_delay default missing without gc stanza (#9101) 2020-10-15 12:36:01 -04:00
e2e Revert "e2e: fix destination of templates in VaultSecrets test (#9146)" (#9163) 2020-10-23 09:01:25 -04:00
helper event sink crud operation api (#9155) 2020-10-23 14:23:00 -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 hclv1: tweak HCLv1 tests 2020-10-21 14:05:46 -04:00
jobspec2 address review feedback 2020-10-22 11:49:37 -04:00
lib deps: Switch to Go modules for dependency management 2020-06-02 14:30:36 -05:00
nomad event sink crud operation api (#9155) 2020-10-23 14:23:00 -04:00
plugins s/0.13/1.0/g 2020-10-14 15:17:47 -07:00
scheduler Events/msgtype cleanup (#9117) 2020-10-19 09:30:15 -04:00
scripts Merge pull request #8981 from hashicorp/b-vagrant-vault-setup 2020-09-29 11:40:02 -05:00
terraform Use latest AMI for Ubuntu Xenial based on search (#9076) 2020-10-14 11:01:54 -04:00
testutil Metrics gotemplate support, debug bundle features (#9067) 2020-10-14 15:16:10 -04:00
tools event sink crud operation api (#9155) 2020-10-23 14:23:00 -04:00
ui New all-icons helper that's really only meant for development use 2020-10-26 12:25:34 -07:00
vendor address review feedback 2020-10-22 11:49:37 -04:00
version s/0.13/1.0/g 2020-10-14 15:17:47 -07:00
website Merge pull request #9174 from hashicorp/f-bump-website-nomad-version 2020-10-26 13:30:39 +01: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
CHANGELOG.md changelog entry for #8967 (#9164) 2020-10-23 14:27:32 -04:00
GNUmakefile Use GOPATH/src explicitly in proto build target 2020-10-15 21:05:27 +00:00
LICENSE Initial commit 2015-06-01 12:21:00 +02:00
README.md Upgrade to golang 1.15 (#8858) 2020-09-09 15:59:29 -04:00
Vagrantfile only set args.Eval after all servers upgrade 2020-07-15 11:10:57 -04:00
build_linux_arm.go Fix 32bit arm build 2017-02-09 11:22:17 -08:00
go.mod Update vendored libraries 2020-10-21 15:46:56 -04:00
go.sum Update vendored libraries 2020-10-21 15:46:56 -04:00
main.go add helper commands for debugging state 2020-08-31 08:45:59 -04:00
main_test.go Adding initial skeleton 2015-06-01 13:46:21 +02:00

README.md

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

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.