Nomad

@hashicorp

The Nomad plugin deploys a Docker container to a Nomad cluster. It also launches on-demand runners to do operations remotely.

Official
Built-in

Updated 6 months ago

GitHub
(opens in new tab)

Nomad Platform

Deploy to a nomad cluster as a service using Docker.

Interface

Input: docker.Image
Output: nomad.Deployment

Examples

deploy {
        use "nomad" {
          region = "global"
          datacenter = "dc1"
          auth {
            username = "username"
            password = "password"
          }
          static_environment = {
            "environment": "production",
            "LOG_LEVEL": "debug"
          }
          service_port = 3000
          replicas = 1
        }
}

Parameters

Required only

13 Results

authRequirednomad.AuthConfig
The credentials for docker registry.
consul_tokenRequired
The Consul ACL token used to register services with the Nomad job. Uses the runner config environment variable CONSUL_HTTP_TOKEN.
datacenterOptionalstring
The Nomad datacenter to deploy the job to.
namespaceOptionalstring
The Nomad namespace to deploy the job to.
regionOptionalstring
The Nomad region to deploy the job to.
replicasOptionalint
The replica count for the job.
resourcesOptionalcategory
The amount of resources to allocate to the deployed allocation.
- resources.cpuOptionalint
  Amount of CPU in MHz to allocate to this task
- resources.memorymbOptionalint
  Amount of memory in MB to allocate to this task.
service_portOptionaluint
TCP port the job is listening on.
service_providerOptionalstring
Specifies the service registration provider to use for registering a service for the job
static_environmentOptionalmap of string to string
Environment variables to add to the job.
vault_tokenRequired
The Vault token used to deploy the Nomad job with a token having specific Vault policies attached. Uses the runner config environment variable VAULT_TOKEN.

Outputs

3 Results

idstring
namestring
resource_stateopaqueany.Any