Skip to content

RS: Cert based auth for CRDB - #3756

Open
kaitlynmichael wants to merge 5 commits into
mainfrom
DOC-6928
Open

RS: Cert based auth for CRDB#3756
kaitlynmichael wants to merge 5 commits into
mainfrom
DOC-6928

Conversation

@kaitlynmichael

@kaitlynmichael kaitlynmichael commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Note

Low Risk
Documentation-only updates to CLI, REST reference, and security guides; no application code changes in this PR.

Overview
Documents certificate-based cluster management for Redis Software when basic/digest REST auth is off or unavailable—especially Active-Active (CRDB) and node join—without changing product behavior in this diff.

crdb-cli reference pages for create, add-instance, and update now describe --instance / --credentials as accepting either username/password or client_cert / client_key / optional trusted_ca (PEM), including the mutual-exclusion error and examples for mixed clusters and migrating an instance to certs.

rladmin cluster join documents the same auth choice using file paths for cert/key/CA; rladmin tune cluster adds control_plane_basic_authentication.

REST object docs add cert fields on bootstrap credentials and a certificate_auth block on CRDB cluster_info (vs credentials).

Security guides gain a cluster management section in certificate-based authentication (bootstrap join, AA create/add-instance/update, REST certificate_auth) and a step-by-step order in disable-basic-authentication before turning off basic auth.

Reviewed by Cursor Bugbot for commit 5baf3bc. Bugbot is set up for automated code reviews on this repo. Configure here.

@kaitlynmichael kaitlynmichael self-assigned this Aug 6, 2026
@kaitlynmichael kaitlynmichael added the rs Redis Software label Aug 6, 2026
@github-actions

github-actions Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

DOC-6928

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes using high effort and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 5baf3bc. Configure here.

| replace_node | integer | Replaces the specified node with the new node (optional) |
| second_rack_id | string | The unique identifier of the node's second rack ID for two-dimensional rack awareness (optional) |
| username | email address | Admin user's email address |
| trusted_ca | filepath | Path to a file containing the CA that validates the API certificate the cluster presents, in PEM format. If you omit it, the node uses the certificates in the cluster's `mtls_trusted_ca.pem` file. (optional) |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Join trusted_ca default wording

Medium Severity

For optional trusted_ca on rladmin cluster join, the new text says the joining node falls back to the cluster's mtls_trusted_ca.pem. Before a successful join, that node is not yet a member of the target cluster, so implying the target cluster’s on-disk trust store is used is inconsistent with how join authentication works.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 5baf3bc. Configure here.

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

Labels

rs Redis Software

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant