mirror of
https://github.com/kemko/nomad.git
synced 2026-01-08 03:15:42 +03:00
53b083b8c5
* Move commands from docs to its own root-level directory * temporarily use modified dev-portal branch with nomad ia changes * explicitly clone nomad ia exp branch * retrigger build, fixed dev-portal broken build * architecture, concepts and get started individual pages * fix get started section destinations * reference section * update repo comment in website-build.sh to show branch * docs nav file update capitalization * update capitalization to force deploy * remove nomad-vs-kubernetes dir; move content to what is nomad pg * job section * Nomad operations category, deploy section * operations category, govern section * operations - manage * operations/scale; concepts scheduling fix * networking * monitor * secure section * remote auth-methods folder and move up pages to sso; linkcheck * Fix install2deploy redirects * fix architecture redirects * Job section: Add missing section index pages * Add section index pages so breadcrumbs build correctly * concepts/index fix front matter indentation * move task driver plugin config to new deploy section * Finish adding full URL to tutorials links in nav * change SSO to Authentication in nav and file system * Docs NomadIA: Move tutorials into NomadIA branch (#26132) * Move governance and policy from tutorials to docs * Move tutorials content to job-declare section * run jobs section * stateful workloads * advanced job scheduling * deploy section * manage section * monitor section * secure/acl and secure/authorization * fix example that contains an unseal key in real format * remove images from sso-vault * secure/traffic * secure/workload-identities * vault-acl change unseal key and root token in command output sample * remove lines from sample output * fix front matter * move nomad pack tutorials to tools * search/replace /nomad/tutorials links * update acl overview with content from deleted architecture/acl * fix spelling mistake * linkcheck - fix broken links * fix link to Nomad variables tutorial * fix link to Prometheus tutorial * move who uses Nomad to use cases page; move spec/config shortcuts add dividers * Move Consul out of Integrations; move namespaces to govern * move integrations/vault to secure/vault; delete integrations * move ref arch to docs; rename Deploy Nomad back to Install Nomad * address feedback * linkcheck fixes * Fixed raw_exec redirect * add info from /nomad/tutorials/manage-jobs/jobs * update page content with newer tutorial * link updates for architecture sub-folders * Add redirects for removed section index pages. Fix links. * fix broken links from linkcheck * Revert to use dev-portal main branch instead of nomadIA branch * build workaround: add intro-nav-data.json with single entry * fix content-check error * add intro directory to get around Vercel build error * workound for emtpry directory * remove mdx from /intro/ to fix content-check and git snafu * Add intro index.mdx so Vercel build should work --------- Co-authored-by: Tu Nguyen <im2nguyen@gmail.com>
76 lines
2.6 KiB
Plaintext
76 lines
2.6 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: Nomad variable specification
|
|
description: |-
|
|
Learn about Nomad's variable specification. Review an example variable specification. Configure path, namespace, and items.
|
|
---
|
|
|
|
# Nomad variable specification
|
|
|
|
[Nomad variables][nv] let you store and use encrypted configuration data in your
|
|
job specifications. Specify variables as HCL files and submit them with the
|
|
[`nomad var put` command][var-put. Unlike [job specifications][jobspecs], Nomad
|
|
Variables specifications do not support HCL2 features like functions.
|
|
|
|
This example is a variable specification generated by [`nomad var init` command][var-init].
|
|
|
|
```hcl
|
|
# A variable path can be specified in the specification file
|
|
# and will be used when writing the variable without specifying a
|
|
# path in the command or when writing JSON directly to the `/var/`
|
|
# HTTP API endpoint
|
|
# path = "path/to/variable"
|
|
|
|
# The Namespace to write the variable can be included in the specification. This
|
|
# value can be overridden by specifying the "-namespace" flag on the "put"
|
|
# command.
|
|
# namespace = "default"
|
|
|
|
# The items map is the only strictly required part of a variable
|
|
# specification, since path and namespace can be set via other means.
|
|
# It contains the sensitive material to encrypt and store as a Nomad
|
|
# variable. The entire items map is encrypted and decrypted as a
|
|
# single unit.
|
|
|
|
# REMINDER: While keys in the items map can contain dots, using them
|
|
# in templates is easier when they do not. As a best practice, avoid
|
|
# dotted keys when possible.
|
|
items {
|
|
key1 = "value 1"
|
|
key2 = "value 2"
|
|
}
|
|
```
|
|
|
|
Example usage if the above is in a file named `spec.nv.hcl`:
|
|
|
|
```shell-session
|
|
$ nomad var put -in hcl some/path @spec.nv.hcl
|
|
```
|
|
|
|
## Parameters
|
|
|
|
- `path` `(string: <optional>)` - The path to the variable being defined. If
|
|
empty it must be specified on the command line.
|
|
|
|
- `namespace` `(string: <optional>)` - The namespace of the variable. May be
|
|
overridden by the `-namespace` command line flag or `NOMAD_NAMESPACE`
|
|
environment variable.
|
|
|
|
- `items` `(object: <required>)` - Object of keys and values to set. Must be
|
|
strings.
|
|
|
|
Refer to the [Restrictions section][var-restrict] in the command reference for
|
|
details on `path` and `items` name restrictions.
|
|
|
|
## Resources
|
|
|
|
Visit the [Nomad Variables tutorial][tutorial] to learn how to create variables,
|
|
configure access control for variables, and access variables from within job tasks.
|
|
|
|
[nv]: /nomad/docs/concepts/variables
|
|
[var-init]: /nomad/commands/var/init
|
|
[var-put]: /nomad/commands/var/put
|
|
[jobspecs]: /nomad/docs/job-specification
|
|
[var-restrict]: /nomad/commands/var/put#restrictions
|
|
[tutorial]: /nomad/tutorials/variables
|