steampipe plugin install nomadsteampipe plugin install nomad

Nomad + Steampipe

Nomad is a simple and flexible scheduler and orchestrator for managing containers and non-containerized applications across on-prem and clouds at scale.

Steampipe is an open source CLI to instantly query cloud APIs using SQL.

List your Nomad jobs:

select
  id,
  name,
  status,
  dispatched,
  namespace,
  priority,
  region
from
  nomad_job;

+------+------+---------+------------+-----------+----------+--------+
| id   | name | status  | dispatched | namespace | priority | region |
+------+------+---------+------------+-----------+----------+--------+
| docs | docs | pending | false      | default   | 50       | global |
+------+------+---------+------------+-----------+----------+--------+

Documentation

Table definitions & examples →

Quick start

Install

Download and install the latest Nomad plugin:

steampipe plugin install nomad

Credentials

Item	Description
Credentials	Nomad requires an `address` and `namespace` or `address`, `namespace` and Secret ID for all requests.
Permissions	The permission scope of Secret IDs is set by the Admin at the creation time of the ACL tokens.
Radius	Each connection represents a single Nomad Installation.
Resolution	1. Credentials explicitly set in a steampipe config file (`~/.steampipe/config/nomad.spc`) 2. Credentials specified in environment variables, e.g., `NOMAD_ADDR` and `NOMAD_TOKEN`.

Configuration

Installing the latest nomad plugin will create a config file (~/.steampipe/config/nomad.spc) with a single connection named nomad:

Configure your account details in ~/.steampipe/config/nomad.spc:

connection "nomad" {
  plugin = "nomad"

  # Address is required for requests. Required.
  # This can also be set via the NOMAD_ADDR environment variable.
  # address = "http://18.118.164.168:4646"

  # The secret ID of ACL token is required for ACL-enabled Nomad servers. Optional.
  # For more information on the ACL Token, please see https://developer.hashicorp.com/nomad/tutorials/access-control/access-control-tokens.
  # This can also be set via the NOMAD_TOKEN environment variable.
  # secret_id = "c178b810-8b18-6f38-016f-725ddec5d58"

  # Namespace is required for Nomad Enterprise access. Optional.
  # API will execute with default namespace if this parameter is not set.
  # This can also be set via the NOMAD_NAMESPACE environment variable.
  # "*" indicates all the namespaces available.
  # namespace = "*"
}

secret_id parameter is only required to query the ACL tables like nomad_acl_auth_method, nomad_acl_binding_rule, nomad_acl_policy, nomad_acl_role and nomad_acl_token tables.
namespace parameter is only required to query the nomad_namespace table.

Alternatively, you can also use the standard Nomad environment variable to obtain credentials only if other arguments (address, token, and namespace) are not specified in the connection:

export NOMAD_ADDR=http://18.118.144.168:4646
export NOMAD_TOKEN=c178b810-8b18-6f38-016f-725ddec5d58
export NOMAD_NAMESPACE=*

Get involved

Open source: https://github.com/turbot/steampipe-plugin-nomad
Community: Join #steampipe on Slack →

turbot/nomad