Skip to main content

Nomad

Nomad is a flexible workload orchestrator and cluster manager developed by HashiCorp that enables organizations to deploy and manage applications across on-premises and cloud infrastructure. This data integration platform provides comprehensive access to Nomad's orchestration data, allowing users to query and analyze their container deployments, batch jobs, virtual machine workloads, and cluster configurations.

CategoryContainers
DirectionQuery source
Sign-inACL Token
Query languagesSQLite
Tables12
Query templates49
Websitenomadgoods.com

Before you start​

Huntbase signs in to Nomad with ACL Token. Create the credential in Nomad first, then keep it to hand for the Connect step.

  1. Write a read-only policy file that sets policy = "read" for namespace "*", node and agent.
  2. Load it with a management token by running nomad acl policy apply <policy-name> <file>.
  3. Create a client token for it with nomad acl token create -name="huntbase" -policy="<policy-name>".
  4. Copy the Secret ID from the output. That is the ACL token.

For the vendor's own instructions, see Nomad ACL token documentation.

tip

Use a dedicated, read-only credential for Huntbase where the product allows it. Huntbase only needs to read.

Connect Nomad​

  1. Go to Connections and click New connection, or click New connection on the Nomad product page.
  2. On Product, pick Nomad and choose the Owner.
  3. On Details, give the connection a Name and, optionally, a Description.
  4. On Connect, fill in the settings and credentials described below.
  5. On Verify, review the summary and click Create & check.

For everything else on the setup page — saving a draft, I'll do this later, and what each check result means — see Connections.

Settings​

Where your Nomad lives:

FieldRequiredNotes
Nomad AddressYesThe HTTP address of your Nomad server, including the port, such as http://nomad.example.com:4646.
NamespaceNoLeave empty for the default namespace, or enter * for all namespaces.

Credentials​

The only Method is ACL Token. Enter a Credential label (for example Production), then fill in:

FieldRequiredNotes
ACL TokenNoLeave empty if ACLs are not enabled on your cluster. Secret — not shown again after you save it.

Query it​

Once connected, Nomad can serve these languages in a query tab, and Scout can use it when you ask in Auto:

LanguageUse it for
SQLiteSQL over the 12 tables listed below, alongside every other connected source.

Example: SQLite​

List disabled task drivers of Nomad namespaces — Identify task drivers that are disabled within each Nomad namespace.

SELECT
name,
description,
json_extract(capabilities, '$.DisabledTaskDrivers') AS disabled_task_drivers
FROM
nomad_namespace;

Nomad ships with 49 query templates. Find them in Library › Queries — see Query templates.

Tables​

Nomad adds 12 tables. Browse their columns from Schema in the query bar's ⋯ menu.

All 12 tables
TableContains
nomad_acl_auth_methodRetrieve information about your ACL auth methods.
nomad_acl_binding_ruleRetrieve information about your ACL binding rules.
nomad_acl_policyRetrieve information about your ACL policies.
nomad_acl_roleRetrieve information about your ACL roles.
nomad_acl_tokenRetrieve information about your ACL tokens.
nomad_agent_memberRetrieve information about your agent members.
nomad_deploymentRetrieve information about your deployments.
nomad_jobRetrieve information about your jobs.
nomad_namespaceRetrieve information about your namespaces.
nomad_nodeRetrieve information about your nodes.
nomad_pluginRetrieve information about your plugins.
nomad_volumeRetrieve information about your volumes.

Next steps​