Learn how to use CSI plugins for stateful storage.
Learn to deploy applications at any scale with HashiCorp Nomad
Getting Started
Install and run Nomad. Schedule jobs and explore the web UI.
Explore the Nomad Web UI
This track will provide a quick survey of the Nomad web user interface and how to perform common operations with it. Get started here.
Access the Web UI
3 minLearn how to access the Nomad Web UI from a browser or from the CLI.
Inspect Cluster Workload
9 minLearn how to operate a job from the Web UI.
Inspect the Cluster
7 minLearn how to inspect the state of the cluster from the Web UI.
Submit a Job from the Web UI
9 minLearn how to submit a job from the Web UI.
Nomad UI Considerations
3 minConsiderations for your exploration and organizational deployment of the Nomad UI.
Deploy and Manage Nomad Jobs
This track provides foundational knowledge for expressing your workload as Nomad jobs. This track also discusses how to submit, inspect, and monitor a running Nomad job.
Deploy and Manage Applications
4 minLearn how to deploy and manage a Nomad Job.
Learn How to Configure Tasks
6 minMost applications require some kind of configuration. Whether the configuration is provided via the command line, environment variables, or a configuration file, Nomad has built-in functionality for configuration. This section details three common patterns for configuring tasks.
Learn How to Submit Jobs to Nomad
7 minThe job file is the unit of work in Nomad. Upon authoring, the job file is submitted to the server for evaluation and scheduling. This section discusses some techniques for submitting jobs.
Inspect Running Jobs
8 minNomad exposes a number of tools and techniques for inspecting a running job. This is helpful in ensuring the job started successfully. Additionally, it can output any errors that occurred while starting the job.
Access Application Logs for Troubleshooting
6 minNomad provides a top-level mechanism for viewing application logs and data files via the command line interface. This section discusses the nomad alloc logs command and API interface.
Collect Resource Utilization Metrics
5 minNomad supports reporting detailed job statistics and resource utilization metrics for most task drivers. This section describes the ways to inspect a job's resource consumption and utilization.
Access the Web UI
3 minLearn how to access the Nomad Web UI from a browser or from the CLI.
Inspect Cluster Workload
9 minLearn how to operate a job from the Web UI.
Inspect the Cluster
7 minLearn how to inspect the state of the cluster from the Web UI.
Submit a Job from the Web UI
9 minLearn how to submit a job from the Web UI.
Nomad UI Considerations
3 minConsiderations for your exploration and organizational deployment of the Nomad UI.
Deploy and Manage Applications
4 minLearn how to deploy and manage a Nomad Job.
Learn How to Configure Tasks
6 minMost applications require some kind of configuration. Whether the configuration is provided via the command line, environment variables, or a configuration file, Nomad has built-in functionality for configuration. This section details three common patterns for configuring tasks.
Learn How to Submit Jobs to Nomad
7 minThe job file is the unit of work in Nomad. Upon authoring, the job file is submitted to the server for evaluation and scheduling. This section discusses some techniques for submitting jobs.
Inspect Running Jobs
8 minNomad exposes a number of tools and techniques for inspecting a running job. This is helpful in ensuring the job started successfully. Additionally, it can output any errors that occurred while starting the job.
Access Application Logs for Troubleshooting
6 minNomad provides a top-level mechanism for viewing application logs and data files via the command line interface. This section discusses the nomad alloc logs command and API interface.
Collect Resource Utilization Metrics
5 minNomad supports reporting detailed job statistics and resource utilization metrics for most task drivers. This section describes the ways to inspect a job's resource consumption and utilization.
Operations and Development Tracks
Design Nomad Jobs for Resiliency
Nomad provides configurable options to enable recovering failed tasks to avoid downtime. Nomad will try to restart a failed task on the node it is running on and also try to reschedule it on another node.
Select an Upgrade Strategy
Nomad has built-in support for rolling, blue/green, and canary updates to simplify upgrades while minimizing or eliminating downtime.
Nomad Job Update Strategies
3 minThis section describes common patterns for updating already-running jobs including rolling upgrades, blue/green deployments, and canary builds. Nomad provides built-in support for this functionality.
Rolling Upgrades
11 minNomad provides a built-in mechanism for rolling upgrades. Rolling upgrades incrementally transitions jobs between versions and using health check information to reduce downtime.
Blue/Green & Canary Deployments
14 minNomad has built-in support for doing blue/green and canary deployments to more safely update existing applications and services.
Configure Exit Signals for Jobs
4 minWell-behaved applications expose a way to perform cleanup prior to exiting. Nomad can optionally send a configurable signal to applications before killing them, allowing them to drain connections or gracefully terminate.
Define Application Placement Preferences
Nomad allows operators methods to express their placement preferences for job allocations within their cluster using affinities and spread. Nomad also helps to prevent priority inversion with preemption.
Advanced Scheduling with Nomad
6 minLearn about advanced scheduling features including affinity and spread.
Prevent Priority Inversion with Preemption
enterprise20 minLearn how to enabling and using preemption on service and batch jobs in Nomad Enterprise (0.9.3 and above).
Express Job Placement Preferences with Affinities
20 minAffinities allows operators to express placement preferences for their jobs.
Increase Failure Tolerance with Spread
20 minBy using spread criteria in their job specification, Nomad job operators can ensure that failures across a physical domain such as datacenter or rack do not affect application availability.
Operating Nomad Clusters
This section covers features operators will need to understand to build and maintain Nomad clusters.
Connect Nodes into a Cluster
4 minLearn how to join nodes to create a Nomad cluster using Consul. You can manually join nodes. You can also automatically join nodes using cloud-provider metadata or Consul without operator involvement.
Multi-Region Federation
20 minFederation enables users to submit jobs or interact with the HTTP API targeting any region, from any server, even if that server resides in a different region.
Workload Migration
12 minWorkload migration is a normal part of cluster operations for a variety of reasons: server maintenance, operating system upgrades, etc. Nomad offers a number of parameters for controlling how running jobs are migrated off of draining nodes.
Outage Recovery
10 minDon't panic! This is a critical first step. Depending on your deployment configuration, it may take only a single server failure for cluster unavailability. Recovery requires an operator to intervene, but recovery is straightforward.
Using Prometheus to Monitor Nomad Metrics
25 minIt is possible to collect metrics on Nomad with Prometheus after enabling telemetry on Nomad servers and clients.
Enable Transport Encryption for Nomad
Nomad has two primary types of traffic— UDP gossip and TCP API/RPC traffic. Learn how to configure Nomad to encrypt these protocols.
Transport Security Overview
8 minNomad uses two different protocols for communication between cluster members. This guide introduces them and teaches you the appropriate security approach for each communication protocol.
Enable Gossip Encryption for Nomad
10 minLearn how to encrypt Nomad's gossip protocol with a symmetric key. The gossip protocol is used to communicate membership and liveliness information between the servers.
Enable TLS Encryption for Nomad
45 minNomad uses mTLS to encrypt communication between Nomad cluster members. Learn how to configure Nomad for mTLS communication to increase network security between nodes.
Secure Nomad with Access Control
Nomad provides capability-based access control. In this track explore Nomad access control objects, such as policies, rules, capabilities, and tokens; learn how to configure a Nomad cluster for ACLs; bootstrap the ACL system; submit your first policy; and grant a token based on it.
Nomad ACL System Fundamentals
10 minIn this concept focused guide, you'll explore the three major components to the ACL system: capabilities, policies, and tokens.
Bootstrap Nomad ACL System
5 minBefore using the Nomad ACL system, it must be enabled and bootstrapped. This guide explains the process.
Nomad ACL Policy Concepts
20 minNomad provides an optional Access Control List (ACL) system which can be used to control access to data and APIs. The ACL system is capability-based, relying on tokens which are associated with policies to determine which fine grained rules can be applied.
Nomad ACL Tokens Fundamentals
30 minNomad uses tokens to authenticate requests to the cluster. Tokens map requests to ACL policies for Nomad to determine if a request is authorized.
Create Nomad ACL policies
20 minIn this guide, you will practice creating Nomad ACL policies to provide controlled access for two different personas to your Nomad Cluster.
Generate Nomad Tokens with HashiCorp Vault
45 minHashiCorp Vault has a secrets engine for generating short-lived Nomad tokens. This enables you to leverage Vault-supported authentication methods (token, LDAP, Okta, Amazon IAM, etc.) to obtain a short-lived Nomad token. This guide will demonstrate using Vault token to obtain a Nomad token
Stateful Workloads
This track will explore techniques to run jobs on Nomad that require access to persistent storage.
Stateful Workloads Overview
3 minNomad allows users to mount persistent data from local or remote storage volumes into task environments in several ways: Container Storage Interface plugins, Nomad Host Volume support, and Docker Volume drivers.
Stateful Workloads with Nomad Host Volumes
20 minThis guide walks you through configuring a host volume and then deploying a MySQL workload that uses it for persistent storage.
Stateful Workloads with Container Storage Interface
30 minThis guide walks you through deploying Container Storage Interface plugins, registering an AWS EBS volume with CSI, and then deploying a MySQL workload that uses it for persistent storage.
Stateful Workloads with Portworx
20 minYou will deploy a MySQL database which uses the Portworx Docker-volume driver to enable persistent volumes.
Task Dependencies
This track explores patterns for expressing task dependencies in Nomad jobs.
Load Balancer Integrations
There are multiple approaches to load balancing within a Nomad cluster. Here we explore the most popular strategies.
Load Balancer Deployment Considerations
20 minThere are a few approaches you can consider when deploying your load balancers for performance and HA
Load Balancing with Fabio
20 minFabio integrates natively with Consul and provides rich features with an optional Web UI.
Load Balancing with HAProxy
20 minHAProxy natively integrates with service discovery data from Consul.
Load Balancing with NGINX
20 minNGINX pairs with Nomad's template stanza to allow for dynamic updates to its load balancing configuration.
Load Balancing with Traefik
20 minTraefik natively integrates with Consul using the Consul Catalog Provider.
Use External Plugins
Starting with Nomad 0.9, task and device drivers are now pluggable. This gives users the flexibility to introduce their own drivers by providing a binary rather than having to fork Nomad to make code changes to it. See the navigation menu on the left or the list below for guides on how to use some of the external drivers available for Nomad.
Governance and Policy
Learn the Nomad objects necessary to operate Nomad securely in a multi-team environment. Explore Nomad Enterprise features such as namespaces, resource quotas, and Sentinel.
Governance & Policy on Nomad
enterprise3 minLearn the Nomad objects necessary to operate Nomad securely in a multi-team environment. Explore Nomad Enterprise features such as namespaces, resource quotas, and Sentinel.
Namespaces
enterprise8 minNomad Enterprise provides support for namespaces, which allow jobs and their associated objects to be segmented from each other and other users of the cluster.
Resource Quotas
enterprise8 minNomad Enterprise provides support for resource quotas, which allow operators to restrict the aggregate resource usage of namespaces.
Sentinel Policies
enterprise8 minSentinel allows operators to express their policies as code, and have their policies automatically enforced.
Leverage Nomad's Vault Integration
From configuring Nomad to fetch Vault secrets for jobs to configuring Vault to provide Nomad secrets for operators, this track contains all of the guides with Nomad and Vault.
Generate Nomad Tokens with HashiCorp Vault
45 minHashiCorp Vault has a secrets engine for generating short-lived Nomad tokens. This enables you to leverage Vault-supported authentication methods (token, LDAP, Okta, Amazon IAM, etc.) to obtain a short-lived Nomad token. This guide will demonstrate using Vault token to obtain a Nomad token
Generate mTLS Certificates for Nomad using Vault
30 minSecuring Nomad's cluster communication with TLS is important for both security and easing operations. Nomad can use mutual TLS (mTLS) for authenticating for all HTTP and RPC communication. This guide will leverage Vault's PKI secrets engine to accomplish this task.
Vault Integration and Retrieving Dynamic Secrets
20 minLearn how to deploy an application, PostgreSQL, in Nomad and retrieve dynamic credentials by integrating with Vault.
Leverage Nomad's Consul Integration
Consul enhances your Nomad cluster by bringing health checking, service discovery, and service mesh capabilities. Learn more about using Nomad's Consul integration in this track.
Enterprise Reference Architecture and Deployment Guides
Deploy a production ready Nomad Enterprise cluster with the Reference Architecture and Deployment guide.
Nomad 0.9 Reference Architecture
enterprise15 minThis reference architecture describes the recommended compute and networking resources you should provision when using Nomad Enterprise in a production environment.
Nomad 0.9 Deployment Guide
enterprise12 minThis deployment guide covers the steps required to install and configure a single Nomad Enterprise cluster as defined in the Nomad Enterprise Reference Architecture.
Nomad Job Update Strategies
3 minThis section describes common patterns for updating already-running jobs including rolling upgrades, blue/green deployments, and canary builds. Nomad provides built-in support for this functionality.
Rolling Upgrades
11 minNomad provides a built-in mechanism for rolling upgrades. Rolling upgrades incrementally transitions jobs between versions and using health check information to reduce downtime.
Blue/Green & Canary Deployments
14 minNomad has built-in support for doing blue/green and canary deployments to more safely update existing applications and services.
Configure Exit Signals for Jobs
4 minWell-behaved applications expose a way to perform cleanup prior to exiting. Nomad can optionally send a configurable signal to applications before killing them, allowing them to drain connections or gracefully terminate.
Advanced Scheduling with Nomad
6 minLearn about advanced scheduling features including affinity and spread.
Prevent Priority Inversion with Preemption
enterprise20 minLearn how to enabling and using preemption on service and batch jobs in Nomad Enterprise (0.9.3 and above).
Express Job Placement Preferences with Affinities
20 minAffinities allows operators to express placement preferences for their jobs.
Increase Failure Tolerance with Spread
20 minBy using spread criteria in their job specification, Nomad job operators can ensure that failures across a physical domain such as datacenter or rack do not affect application availability.
Connect Nodes into a Cluster
4 minLearn how to join nodes to create a Nomad cluster using Consul. You can manually join nodes. You can also automatically join nodes using cloud-provider metadata or Consul without operator involvement.
Multi-Region Federation
20 minFederation enables users to submit jobs or interact with the HTTP API targeting any region, from any server, even if that server resides in a different region.
Workload Migration
12 minWorkload migration is a normal part of cluster operations for a variety of reasons: server maintenance, operating system upgrades, etc. Nomad offers a number of parameters for controlling how running jobs are migrated off of draining nodes.
Outage Recovery
10 minDon't panic! This is a critical first step. Depending on your deployment configuration, it may take only a single server failure for cluster unavailability. Recovery requires an operator to intervene, but recovery is straightforward.
Using Prometheus to Monitor Nomad Metrics
25 minIt is possible to collect metrics on Nomad with Prometheus after enabling telemetry on Nomad servers and clients.
Transport Security Overview
8 minNomad uses two different protocols for communication between cluster members. This guide introduces them and teaches you the appropriate security approach for each communication protocol.
Enable Gossip Encryption for Nomad
10 minLearn how to encrypt Nomad's gossip protocol with a symmetric key. The gossip protocol is used to communicate membership and liveliness information between the servers.
Enable TLS Encryption for Nomad
45 minNomad uses mTLS to encrypt communication between Nomad cluster members. Learn how to configure Nomad for mTLS communication to increase network security between nodes.
Nomad ACL System Fundamentals
10 minIn this concept focused guide, you'll explore the three major components to the ACL system: capabilities, policies, and tokens.
Bootstrap Nomad ACL System
5 minBefore using the Nomad ACL system, it must be enabled and bootstrapped. This guide explains the process.
Nomad ACL Policy Concepts
20 minNomad provides an optional Access Control List (ACL) system which can be used to control access to data and APIs. The ACL system is capability-based, relying on tokens which are associated with policies to determine which fine grained rules can be applied.
Nomad ACL Tokens Fundamentals
30 minNomad uses tokens to authenticate requests to the cluster. Tokens map requests to ACL policies for Nomad to determine if a request is authorized.
Create Nomad ACL policies
20 minIn this guide, you will practice creating Nomad ACL policies to provide controlled access for two different personas to your Nomad Cluster.
Generate Nomad Tokens with HashiCorp Vault
45 minHashiCorp Vault has a secrets engine for generating short-lived Nomad tokens. This enables you to leverage Vault-supported authentication methods (token, LDAP, Okta, Amazon IAM, etc.) to obtain a short-lived Nomad token. This guide will demonstrate using Vault token to obtain a Nomad token
Stateful Workloads Overview
3 minNomad allows users to mount persistent data from local or remote storage volumes into task environments in several ways: Container Storage Interface plugins, Nomad Host Volume support, and Docker Volume drivers.
Stateful Workloads with Nomad Host Volumes
20 minThis guide walks you through configuring a host volume and then deploying a MySQL workload that uses it for persistent storage.
Stateful Workloads with Container Storage Interface
30 minThis guide walks you through deploying Container Storage Interface plugins, registering an AWS EBS volume with CSI, and then deploying a MySQL workload that uses it for persistent storage.
Stateful Workloads with Portworx
20 minYou will deploy a MySQL database which uses the Portworx Docker-volume driver to enable persistent volumes.
Load Balancer Deployment Considerations
20 minThere are a few approaches you can consider when deploying your load balancers for performance and HA
Load Balancing with Fabio
20 minFabio integrates natively with Consul and provides rich features with an optional Web UI.
Load Balancing with HAProxy
20 minHAProxy natively integrates with service discovery data from Consul.
Load Balancing with NGINX
20 minNGINX pairs with Nomad's template stanza to allow for dynamic updates to its load balancing configuration.
Load Balancing with Traefik
20 minTraefik natively integrates with Consul using the Consul Catalog Provider.
Governance & Policy on Nomad
enterprise3 minLearn the Nomad objects necessary to operate Nomad securely in a multi-team environment. Explore Nomad Enterprise features such as namespaces, resource quotas, and Sentinel.
Namespaces
enterprise8 minNomad Enterprise provides support for namespaces, which allow jobs and their associated objects to be segmented from each other and other users of the cluster.
Resource Quotas
enterprise8 minNomad Enterprise provides support for resource quotas, which allow operators to restrict the aggregate resource usage of namespaces.
Sentinel Policies
enterprise8 minSentinel allows operators to express their policies as code, and have their policies automatically enforced.
Generate Nomad Tokens with HashiCorp Vault
45 minHashiCorp Vault has a secrets engine for generating short-lived Nomad tokens. This enables you to leverage Vault-supported authentication methods (token, LDAP, Okta, Amazon IAM, etc.) to obtain a short-lived Nomad token. This guide will demonstrate using Vault token to obtain a Nomad token
Generate mTLS Certificates for Nomad using Vault
30 minSecuring Nomad's cluster communication with TLS is important for both security and easing operations. Nomad can use mutual TLS (mTLS) for authenticating for all HTTP and RPC communication. This guide will leverage Vault's PKI secrets engine to accomplish this task.
Vault Integration and Retrieving Dynamic Secrets
20 minLearn how to deploy an application, PostgreSQL, in Nomad and retrieve dynamic credentials by integrating with Vault.
Nomad 0.9 Reference Architecture
enterprise15 minThis reference architecture describes the recommended compute and networking resources you should provision when using Nomad Enterprise in a production environment.
Nomad 0.9 Deployment Guide
enterprise12 minThis deployment guide covers the steps required to install and configure a single Nomad Enterprise cluster as defined in the Nomad Enterprise Reference Architecture.
Looking for specific Nomad information? The Nomad documentation provides reference material and in-depth details on: