docs: clarify requirements for Consul token policies and TTLs #24167
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tgross
added
theme/docs
tgross
added
backport/1.7.x
aimeeu
approved these changes
Oct 10, 2024
tgross
force-pushed
the
docs-consul-auth-method-ttl
branch
from
c18b8ea to
29f61e0
Compare
As of #24166, Nomad agents will use their own token to deregister services and checks from Consul. This returns the deregistration path to the pre-Workload Identity workflow. Expand the documentation to make clear why certain ACL policies are required for clients. Additionally, we did not explicitly call out that auth methods should not set an expiration on Consul tokens. Nomad does not have a facility to refresh these tokens if they expire. Even if Nomad could, there's no way to re-inject them into Envoy sidecars for Consul Service Mesh without recreating the task anyways, which is what happens today. Warn users that they should not set an expiration. Closes: #20185 (wontfix) Ref: https://hashicorp.atlassian.net/browse/NET-10262
tgross
force-pushed
the
docs-consul-auth-method-ttl
branch
from
29f61e0 to
070e476
Compare
shoenig
reviewed
Oct 11, 2024
Comment on lines
+346
to
+348
| permissions vary slightly between Nomad servers and clients. The following | ||
| Consul ACL policies represent the minimal permissions Nomad servers and clients | ||
| need. |
There was a problem hiding this comment.
should we include the (optional) kv permissions on the client?
There was a problem hiding this comment.
The client doesn't read from KV anymore using its own token; that's only done via Workload Identity.
shoenig
approved these changes
Oct 11, 2024
tgross
added
backport/1.9.x
This was referenced Oct 11, 2024
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As of #24166, Nomad agents will use their own token to deregister services and checks from Consul. This returns the deregistration path to the pre-Workload Identity workflow. Expand the documentation to make clear why certain ACL policies are required for clients.
Additionally, we did not explicitly call out that auth methods should not set an expiration on Consul tokens. Nomad does not have a facility to refresh these tokens if they expire. Even if Nomad could, there's no way to re-inject them into Envoy sidecars for Consul Service Mesh without recreating the task anyways, which is what happens today. Warn users that they should not set an expiration.
Closes: #20185 (wontfix)
Ref: https://hashicorp.atlassian.net/browse/NET-10262