Skip to content

Conversation

@aimeeu
Copy link
Contributor

@aimeeu aimeeu commented Oct 28, 2025

Description

  • Add a new page on how to create, update, delete, and lock Nomad variables. This replaces the navigation link to the page in tutorials. I left the Nomad variables pages in the tutorial repo and linked to them. We can revisit in 6 months to see if people are still accessing those tutorials.
  • Pull CLI examples into partials, update, and use in new page and CLI command reference.

Links

Jira: CE-974

https://nomad-git-ce974vars-hashicorp.vercel.app/nomad/docs/manage/manage-variables

Contributor Checklist

  • Changelog Entry If this PR changes user-facing behavior, please generate and add a
    changelog entry using the make cl command.
  • Testing Please add tests to cover any new functionality or to demonstrate bug fixes and
    ensure regressions will be caught.
  • Documentation If the change impacts user-facing functionality such as the CLI, API, UI,
    and job configuration, please update the Nomad website documentation to reflect this. Refer to
    the website README for docs guidelines. Please also consider whether the
    change requires notes within the upgrade guide.

Reviewer Checklist

  • Backport Labels Please add the correct backport labels as described by the internal
    backporting document.
  • Commit Type Ensure the correct merge method is selected which should be "squash and merge"
    in the majority of situations. The main exceptions are long-lived feature branches or merges where
    history should be preserved.
  • Enterprise PRs If this is an enterprise only PR, please add any required changelog entry
    within the public repository.
  • If a change needs to be reverted, we will roll out an update to the code within 7 days.

Changes to Security Controls

Are there any changes to security controls (access controls, encryption, logging) in this pull request? If so, explain.


@aimeeu aimeeu requested review from a team as code owners October 28, 2025 16:20
@aimeeu aimeeu added theme/docs Documentation issues and enhancements backport/website This will backport PR changes to `stable-website` && the latest release-branch backport/1.10.x backport to 1.10.x release line labels Oct 28, 2025
@aimeeu aimeeu marked this pull request as draft October 28, 2025 16:20
@aimeeu aimeeu changed the title Docs: Add manage Nomad variables page Docs: Add manage Nomad variables page DRAFT Oct 28, 2025
@aimeeu aimeeu changed the title Docs: Add manage Nomad variables page DRAFT Docs: Add manage Nomad variables page Oct 29, 2025
@aimeeu aimeeu marked this pull request as ready for review October 29, 2025 14:40
Copy link
Contributor

@boruszak boruszak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work.

All I have is little nits. Including this request: Can you change manage/manage-variables.mdx to manage/variables.mdx to simplify the path?

Comment on lines +15 to +20
Most Nomad workloads need access to configuration values or secrets. Nomad has a
`template` block to [provide such configuration to
tasks](/nomad/docs/job-specification/template#nomad-variables). Nomad variables
provide the option to store configuration at file-like paths
directly in Nomad's state store. Access these variables directly from
your task templates. Nomad encrypts and replicates the contents of these variables between servers via Raft. Access to variables is controlled by
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Most Nomad workloads need access to configuration values or secrets. Nomad has a
`template` block to [provide such configuration to
tasks](/nomad/docs/job-specification/template#nomad-variables). Nomad variables
provide the option to store configuration at file-like paths
directly in Nomad's state store. Access these variables directly from
your task templates. Nomad encrypts and replicates the contents of these variables between servers via Raft. Access to variables is controlled by
Most Nomad workloads need access to configuration values or secrets. Nomad has a
`template` block to [provide these values to
tasks](/nomad/docs/job-specification/template#nomad-variables). Nomad variables
provide the option to store configuration at file-like paths
directly in Nomad's state store so that you can access these variables directly from
your task templates. Nomad encrypts and replicates the contents of these variables between servers with Raft communication. Access to variables is controlled by

Comment on lines +25 to +26
Nomad scopes a Nomad variable to a namespace. You may control access to Nomad
variables with ACL policies.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Nomad scopes a Nomad variable to a namespace. You may control access to Nomad
variables with ACL policies.
Nomad scopes a Nomad variable to a namespace and allows access to Nomad
variables according to ACL policies.

Comment on lines +93 to +94
To learn how to access Nomad variables in your job specification, refer to the
[Use Nomad variables in tasks](/nomad/docs/job-declare/nomad-variables) guide.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To learn how to access Nomad variables in your job specification, refer to the
[Use Nomad variables in tasks](/nomad/docs/job-declare/nomad-variables) guide.
To learn how to access Nomad variables in your job specification, refer to [Use Nomad variables in tasks](/nomad/docs/job-declare/nomad-variables).

$ nomad var put -namespace prod secret/foo @spec.nv.json
```

Use a hyphen ("-") to instruct the command to read the variable value from
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Use a hyphen ("-") to instruct the command to read the variable value from
Use a hyphen (`-`) to instruct the command to read the variable value from

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport/website This will backport PR changes to `stable-website` && the latest release-branch backport/1.10.x backport to 1.10.x release line theme/docs Documentation issues and enhancements

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants