Skip to content

RS: Documented CRDB default_db_config usage and config requirements#3540

Open
rrelledge wants to merge 1 commit into
mainfrom
DOC-6768
Open

RS: Documented CRDB default_db_config usage and config requirements#3540
rrelledge wants to merge 1 commit into
mainfrom
DOC-6768

Conversation

@rrelledge

@rrelledge rrelledge commented Jun 23, 2026

Copy link
Copy Markdown
Collaborator

Note

Low Risk
Documentation-only changes with no runtime or security impact; corrects API examples operators may follow.

Overview
Clarifies how Active-Active (CRDB) database settings should be applied via default_db_config versus per-instance db_config, and wires that guidance through the REST API, crdb-cli, and planning/memory docs.

The CRDB database config reference is restructured into required default_db_config fields (e.g. sharding, shard_key_regex, tls_mode, module_list), recommended global settings (including replication_oom_threshold_percent), and per-instance db_config (certs, port, mTLS flags). Related pages now link to that reference and explain that updating default_db_config affects all instances while instance db_config overrides defaults.

Replication OOM protection instructions in Active-Active planning and memory-limit docs now use PATCH /v1/crdbs/{crdb_guid} with default_db_config.replication_oom_threshold_percent instead of PUT /v1/bdbs, so cluster-wide AA tuning is documented correctly. Minor API doc copy edits (PATCH vs updates POST, typo fix) and small CRDB object table formatting updates round out the change.

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

@rrelledge rrelledge requested review from a team and pkm93 June 23, 2026 23:05
@rrelledge rrelledge self-assigned this Jun 23, 2026
@rrelledge rrelledge added the rs Redis Software label Jun 23, 2026
@github-actions

github-actions Bot commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

DOC-6768

@jit-ci

jit-ci Bot commented Jun 23, 2026

Copy link
Copy Markdown

🛡️ Jit Security Scan Results

CRITICAL HIGH MEDIUM

✅ No security findings were detected in this PR


Security scan by Jit

@andy-stark-redis andy-stark-redis left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Text LGTM.

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.

2 participants