MCPcopy
hub / github.com/hashicorp/nomad

github.com/hashicorp/nomad @v2.0.3 sqlite

repository ↗ · DeepWiki ↗ · release v2.0.3 ↗
29,616 symbols 164,648 edges 3,113 files 9,319 documented · 31%
README

Nomad License: BUSL-1.1 Discuss ===

HashiCorp Nomad logo

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.

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

Refer to the Getting Started tutorials 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

Refer to Production reference architecture for recommended practices and a reference architecture for production deployments.

Documentation

Nomad product documentation is stored in the web-unified-docs repo.

Roadmap

A timeline of major features expected for the next release or two can be found in the Public Roadmap.

This roadmap is a best guess at any given point, and both release dates and projects in each release are subject to change. Do not take any of these items as commitments, especially ones later than one major release away.

Contributing

See the contributing directory for more developer documentation.

Extension points exported contracts — how you extend this code

PluginManager (Interface)
PluginManager orchestrates the lifecycle of a set of plugins [7 implementers]
client/pluginmanager/manager.go
SystemScanner (Interface)
A SystemScanner represents one methodology of detecting CPU hardware on a system. Detectable information is accumulated [8 …
client/lib/numalib/detect.go
NetworkConfigurator (Interface)
NetworkConfigurator sets up and tears down the interfaces, routes, firewall rules, etc for the configured networking mod [6 …
client/allocrunner/networking.go
ReloadableFingerprint (Interface)
ReloadableFingerprint can be implemented if the fingerprinter needs to be run during client reload. If implemented, the [19 …
client/fingerprint/fingerprint.go
ArtifactGetter (Interface)
ArtifactGetter is an interface satisfied by the getter package. [36 implementers]
client/interfaces/client.go
WorkloadRestarter (Interface)
WorkloadRestarter allows the checkWatcher to restart tasks or entire task groups. [10 implementers]
client/serviceregistration/service_registration.go
RPCHandler (Interface)
RPCHandler can be provided to the Client if there is a local server to avoid going over the network. If not provided, th [6 …
client/config/config.go
FeasibleIterator (Interface)
FeasibleIterator is used to iteratively yield nodes that match feasibility constraints. The iterators may manage some st [15 …
scheduler/feasible/feasible.go

Core symbols most depended-on inside this repo

Parallel
called by 4316
ci/slow.go
Error
called by 4012
helper/winsvc/event_logger.go
Fatalf
called by 3900
ci/ports.go
append
called by 3195
ui/app/utils/classes/abstract-stats-tracker.js
new
called by 3179
command/agent/monitor/monitor.go
Equal
called by 2401
helper/funcs.go
Run
called by 2288
client/widmgr/widmgr.go
State
called by 1628
helper/raftutil/fsm.go

Shape

Method 15,732
Function 9,480
Struct 2,821
Class 999
Interface 257
TypeAlias 200
FuncType 127

Languages

Go89%
TypeScript11%
Java1%
Python1%

Modules by API surface

nomad/structs/structs.generated.go2,848 symbols
plugins/drivers/proto/driver.pb.go914 symbols
nomad/structs/structs.go650 symbols
drivers/shared/executor/proto/executor.pb.go284 symbols
nomad/state/state_store.go254 symbols
plugins/device/proto/device.pb.go209 symbols
nomad/state/state_store_test.go200 symbols
plugins/shared/hclspec/hcl_spec.pb.go170 symbols
plugins/base/proto/base.pb.go165 symbols
nomad/structs/acl.go153 symbols
nomad/structs/services.go131 symbols
api/jobs.go130 symbols

Dependencies from manifests, versioned

cel.dev/exprv0.25.1 · 1×
cloud.google.com/gov0.123.0 · 1×
cloud.google.com/go/auth/oauth2adaptv0.2.8 · 1×
cloud.google.com/go/compute/metadatav0.9.0 · 1×
cloud.google.com/go/kmsv1.26.0 · 1×
cloud.google.com/go/longrunningv0.9.0 · 1×
cloud.google.com/go/monitoringv1.24.3 · 1×
cloud.google.com/go/storagev1.61.3 · 1×
cyphar.com/go-pathrsv0.2.4 · 1×
dario.cat/mergov1.0.2 · 1×

For agents

$ claude mcp add nomad \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact