Backport of Update lock.mdx (Node Health Check and TTL) into release/1.20.x #22262
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.
Backport
This PR is auto-generated from #22258 to be assessed for backporting due to the inclusion of the label backport/1.20.
The below text is copied from the body of the original PR.
Overview of commits
Title
Consul lock docs: Clarify node checks & TTL behavior, plus manual session workaround
Description
This PR updates the
consul lock
command documentation to explain how an ephemeral session is automatically created with node checks (e.g.serfHealth
), which can cause the lock’s TTL to be effectively auto-renewed as long as the node is healthy. It also outlines a recommended workaround (manually creating and managing a custom session) for users who need strict TTL enforcement without node checks.Testing & Reproduction Steps
agent/session_endpoint.go
setsNodeChecks
to[serfHealth]
by default.consul lock
does not expose a built-in flag for removing node checks.Links
PR Checklist
Overview of commits