hashicorp / hashicorp/nomad

docs: inconsistency in documenting behavior of reload vault config

Open
#11,080 0 comments 0 reactions 0 assignees View on GitHub
theme/docs
Dominant language
Go
Stars
17k
Forks
2.1k
Avg merge
1d 9h
Merged PRs (30d)
105

Description

https://www.nomadproject.io/docs/configuration#configuration-reload

> note this only reloads the TLS configuration between Nomad and Vault, but not other configuration values

https://www.nomadproject.io/docs/configuration/vault#vault-configuration-reloads

> The Vault configuration can be reloaded on servers. This can be useful if a new token needs to be given to the servers without having to restart them

Not sure which one is the expected behavior (clearly the second one would be much preferable), so could you help to verify and correct the documentation?

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the two linked Nomad documentation sections and compare their descriptions of Vault configuration reloads. Verify the actual behavior before deciding which statement is correct, then update the documentation so both sections describe it consistently.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.