open-nomad/website/source/docs/job-specification/meta.html.md

layout	page_title	sidebar_current	description
docs	meta Stanza - Job Specification	docs-job-specification-meta	The "meta" stanza allows for user-defined arbitrary key-value pairs.

meta Stanza

Placement	job -> **meta** job -> group -> **meta** job -> group -> task -> **meta**

The meta stanza allows for user-defined arbitrary key-value pairs. It is possible to use the meta stanza at the job, group, or task level.

job "docs" {
  meta {
    my-key = "my-value"
  }

  group "example" {
    meta {
      my-key = "my-value"
    }

    task "server" {
      meta {
        my-key = "my-value"
      }
    }
  }
}

Metadata is merged up the job specification, so metadata defined at the job level applies to all groups and tasks within that job. Metadata defined at the group layer applies to all tasks within that group.

meta Parameters

The "parameters" for the meta stanza can be any key-value. The keys and values are both of type string, but they can be specified as other types. They will automatically be converted to strings.

meta Examples

The following examples only show the meta stanzas. Remember that the meta Remember that the meta stanza is only valid in the placements listed above.

Coercion

This example shows the different ways to specify key-value pairs. Internally, these values will be stored as their string representation. No type information is preserved.

meta {
  key = "true"
  key = true

  "key" = true

  key = 1.4
  key = "1.4"
}

Interpolation

This example shows using Nomad interpolation to populate environment variables.

meta {
  class = "${nomad.class}"
}