Skip to content

RS: Documented CRDB default_db_config usage and config requirements - #3540

Merged
rrelledge merged 2 commits into
mainfrom
DOC-6768
Jul 6, 2026
Merged

RS: Documented CRDB default_db_config usage and config requirements#3540
rrelledge merged 2 commits into
mainfrom
DOC-6768

Conversation

@rrelledge

@rrelledge rrelledge commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Note

Low Risk
Documentation-only changes with no runtime or API behavior changes; incorrect guidance could mislead operators but does not alter product code.

Overview
Documents how Active-Active (CRDB) settings should be applied via default_db_config versus per-instance db_config, and wires that guidance through the REST API, CLI, and memory/OOM topics.

The CRDB database_config reference is restructured into four buckets: settings that must use default_db_config (replication-breaking if mismatched), should use it (operational consistency), recommended defaults (including replication_oom_threshold_percent with a link to replication OOM protection), and fields that belong in per-instance db_config (certs, port, mTLS flags, etc.). Related pages (crdb, instance_info, PATCH/POST crdbs, and crdbs/updates) now point readers at that reference and clarify that updating default_db_config applies to existing and new instances while instance db_config overrides defaults.

Replication OOM tuning in Active-Active planning and memory limits no longer documents single-BDB PUT /v1/bdbs; it shows PATCH /v1/crdbs/{crdb_guid} with default_db_config.replication_oom_threshold_percent so the change applies across participating clusters. crdb-cli create/update descriptions for --default-db-config / file options now link to the same config reference.

Reviewed by Cursor Bugbot for commit 2be5c19. 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.

@rrelledge
rrelledge merged commit bb30fd0 into main Jul 6, 2026
75 checks passed
@rrelledge
rrelledge deleted the DOC-6768 branch July 6, 2026 19:48
EliShteinman added a commit to EliShteinman/docs that referenced this pull request Jul 18, 2026
Document CRDB default_db_config usage and config requirements.
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