K8s: Document disconnectClientsOnPasswordRemoval (RED-197499) - #3794
Open
oshribr wants to merge 1 commit into
Open
K8s: Document disconnectClientsOnPasswordRemoval (RED-197499)#3794oshribr wants to merge 1 commit into
oshribr wants to merge 1 commit into
Conversation
Documents the operator's new disconnectClientsOnPasswordRemoval CRD fields (REC enum, REDB boolean, REAADB via globalConfigurations), canonically on the REC page, with the REDB section and a manage-users rotation cross-link pointing at it. The draft survived two structural reversals worth knowing about. It first duplicated the ownership semantics on both the REC and REDB pages, then deduplicated REDB-canonical, and finally flipped to REC-canonical because the cluster policy is the parent concept. More importantly, the first draft had the semantics backwards. Per the RS source (Bdb::disconnect_clients_on_password_removal in dmcproxy/dmc/bdb/bdb.cpp, release-8.0.2), the cluster value is a cluster-wide override — Enabled/Disabled force the behavior for every database — and a database's boolean takes effect only when the cluster is Auto. "Auto" does not mean "Redis Software decides"; it means "defer to the per-database setting". A REAADB paragraph in active-active/global-config.md was written and then removed; the REAADB field is covered by a bullet in the REC canonical section instead. Learned: cluster value is the override; per-database boolean applies only when the cluster policy is Auto Constraint: operator version X.Y.Z gates only CRD-based configuration; with RS 8.0.2+ the setting is configurable via REST on any operator version Rejected: duplicating ownership semantics on REC and REDB pages | subtle text that drifts Rejected: REDB page as canonical location | cluster policy is the parent concept, so the REC page holds the full explanation Directive: do not hand-edit reference/api pages for the new fields; they arrive with the next CRD regeneration Recheck: when the first operator release with this feature ships, replace every X.Y.Z placeholder (TODO comments mark them) Ticket: RED-197499
|
|
Contributor
🧠 Redis MemoryFound 5 related items from repository history (5 new this commit):
Memory updated at eb9563e |
Contributor
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Summary
Documents the operator's new CRD fields exposing the Redis Software
setting
disconnect_clients_on_password_removal(controls whether clientconnections that authenticated with a removed, revoked, or rotated
password are actively disconnected):
spec.disconnectClientsOnPasswordRemoval—Enabled/Disabled/Auto. Cluster-wide policy:Enabled/Disabledforcethe behavior for all databases;
Auto(the Redis Software default)defers to each database's own setting.
spec.disconnectClientsOnPasswordRemoval— boolean (defaultfalse). Takes effect only when the cluster policy isAuto.spec.globalConfigurations.disconnectClientsOnPasswordRemoval— boolean, propagated to all participating clusters.
The canonical explanation (setting semantics + operator ownership /
upgrade path) lives on the REC page; the REDB section and a
manage-users rotation cross-link point to it.
Pages changed
content/operate/kubernetes/re-clusters/_index.md— canonical sectioncontent/operate/kubernetes/re-databases/db-controller.md— REDBexample + pointer
content/operate/kubernetes/security/access-control/manage-users.md—cross-link after the Rotatable password-rotation steps
Notes for reviewers
released — the version appears as
X.Y.Zwith<!-- TODO -->comments marking every occurrence. Replace them when the release
number is fixed.
reference/api/are intentionally untouched; the new field entriesarrive with the next regeneration.
Ticket: RED-197499
Note
Low Risk
Documentation-only changes with no code, API, or runtime impact. Placeholder operator version
X.Y.Zstill needs replacement before release.Overview
Documents how to configure disconnect clients on password removal through Kubernetes custom resources (requires Redis Software 8.0.2+ and operator
X.Y.Z).Adds a canonical section on the REC page covering cluster-wide policy (
Enabled/Disabled/Auto), per-database and Active-Active settings, YAML examples, and when the operator takes ownership vs. preserving pre-upgrade REST API values.Also adds a REDB configuration section with an example, and a cross-link from the Rotatable password-rotation steps in manage-users.
Reviewed by Cursor Bugbot for commit eb9563e. Bugbot is set up for automated code reviews on this repo. Configure here.