README
¶
Nomad 
Nomad is a simple and flexible workload orchestrator to deploy and manage containers (docker, podman), non-containerized applications (executable, Java), and virtual machines (qemu) across on-prem and clouds at scale.
Nomad is supported on Linux, Windows, and macOS. A commercial version of Nomad, Nomad Enterprise, is also available.
- Website: https://nomadproject.io
- Tutorials: HashiCorp Learn
- Forum: Discuss
- Mailing List: Google Groups
- Gitter: hashicorp-nomad
Nomad provides several key features:
-
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.
Quick Start
Testing
See Learn: Getting Started for instructions on setting up a local Nomad cluster for non-production use.
Optionally, find Terraform manifests for bringing up a development Nomad cluster on a public cloud in the terraform directory.
Production
See Learn: Nomad Reference Architecture for recommended practices and a reference architecture for production deployments.
Documentation
Full, comprehensive documentation is available on the Nomad website: https://www.nomadproject.io/docs
Guides are available on HashiCorp Learn.
Contributing
See the contributing directory for more developer documentation.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
api
module
|
|
|
allocwatcher
Package allocwatcher allows blocking until another allocation - whether running locally or remotely - completes and migrates the allocation directory if necessary.
|
Package allocwatcher allows blocking until another allocation - whether running locally or remotely - completes and migrates the allocation directory if necessary. |
|
devicemanager
Package devicemanager is used to manage device plugins
|
Package devicemanager is used to manage device plugins |
|
dynamicplugins
dynamicplugins is a package that manages dynamic plugins in Nomad.
|
dynamicplugins is a package that manages dynamic plugins in Nomad. |
|
lib/fifo
Package fifo implements functions to create and open a fifo for inter-process communication in an OS agnostic way.
|
Package fifo implements functions to create and open a fifo for inter-process communication in an OS agnostic way. |
|
pluginmanager/csimanager
* csimanager manages locally running CSI Plugins on a Nomad host, and provides a few different interfaces.
|
* csimanager manages locally running CSI Plugins on a Nomad host, and provides a few different interfaces. |
|
servers
Package servers provides an interface for choosing Servers to communicate with from a Nomad Client perspective.
|
Package servers provides an interface for choosing Servers to communicate with from a Nomad Client perspective. |
|
demo
|
|
|
grpc-checks
Module
|
|
|
devices
|
|
|
drivers
|
|
|
docker/cmd
This package provides a mechanism to build the Docker driver plugin as an external binary.
|
This package provides a mechanism to build the Docker driver plugin as an external binary. |
|
e2e
|
|
|
framework
Package framework implements a model for developing end-to-end test suites.
|
Package framework implements a model for developing end-to-end test suites. |
|
boltdd
BOLTdd contains a wrapper around BoltDB to deduplicate writes and encode values using mgspack.
|
BOLTdd contains a wrapper around BoltDB to deduplicate writes and encode values using mgspack. |
|
constraints/semver
semver is a Semver Constraints package copied from github.com/hashicorp/go-version @ 2046c9d0f0b03c779670f5186a2a4b2c85493a71 Unlike Constraints in go-version, Semver constraints use Semver 2.0 ordering rules and only accept properly formatted Semver versions.
|
semver is a Semver Constraints package copied from github.com/hashicorp/go-version @ 2046c9d0f0b03c779670f5186a2a4b2c85493a71 Unlike Constraints in go-version, Semver constraints use Semver 2.0 ordering rules and only accept properly formatted Semver versions. |
|
envoy
Package envoy provides a high level view of the variables that go into selecting an envoy version.
|
Package envoy provides a high level view of the variables that go into selecting an envoy version. |
|
freeport
Copied from github.com/hashicorp/consul/sdk/freeport and tweaked for use by Nomad.
|
Copied from github.com/hashicorp/consul/sdk/freeport and tweaked for use by Nomad. |
|
noxssrw
Package noxssrw (No XSS ResponseWriter) behaves like the Go standard library's ResponseWriter by detecting the Content-Type of a response if it has not been explicitly set.
|
Package noxssrw (No XSS ResponseWriter) behaves like the Go standard library's ResponseWriter by detecting the Content-Type of a response if it has not been explicitly set. |
|
pluginutils/catalog
Package catalog is used to register internal plugins such that they can be loaded.
|
Package catalog is used to register internal plugins such that they can be loaded. |
|
raftutil
Code generated by go generate; DO NOT EDIT.
|
Code generated by go generate; DO NOT EDIT. |
|
snapshot
The archive utilities manage the internal format of a snapshot, which is a tar file with the following contents: meta.json - JSON-encoded snapshot metadata from Raft state.bin - Encoded snapshot data from Raft SHA256SUMS - SHA-256 sums of the above two files The integrity information is automatically created and checked, and a failure there just looks like an error to the caller.
|
The archive utilities manage the internal format of a snapshot, which is a tar file with the following contents: meta.json - JSON-encoded snapshot metadata from Raft state.bin - Encoded snapshot data from Raft SHA256SUMS - SHA-256 sums of the above two files The integrity information is automatically created and checked, and a failure there just looks like an error to the caller. |
|
testlog
Package testlog creates a *log.Logger backed by *testing.T to ease logging in tests.
|
Package testlog creates a *log.Logger backed by *testing.T to ease logging in tests. |
|
testtask
Package testtask implements a portable set of commands useful as stand-ins for user tasks.
|
Package testtask implements a portable set of commands useful as stand-ins for user tasks. |
|
addrs
Package addrs contains types that represent "addresses", which are references to specific objects within a Packer configuration.
|
Package addrs contains types that represent "addresses", which are references to specific objects within a Packer configuration. |
|
lib
|
|
|
deploymentwatcher
deploymentwatcher creates and tracks Deployments, which hold meta data describing the process of upgrading a running job to a new set of Allocations.
|
deploymentwatcher creates and tracks Deployments, which hold meta data describing the process of upgrading a running job to a new set of Allocations. |
|
csi/fake
fake is a package that includes fake implementations of public interfaces from the CSI package for testing.
|
fake is a package that includes fake implementations of public interfaces from the CSI package for testing. |
|
tools
module
|
|