Add docs on delegated Raft snapshots#16876
Conversation
Files changed: |
|
@andrewbaptist it appears the cluster settings in the code in cockroachdb/cockroach#83991 were different than the ones in the PR comment, so I went with the former Open to not including the description of the settings so explicitly, since it's not clear we necessarily want folks changing them? In any case they will appear in the autogenerated cluster settings docs for the very curious This is mostly based on a mix of the PR commit message and the press release Gdoc. Please feel free to suggest any corrections/improvements as you see fit of course! |
andrewbaptist
left a comment
andrewbaptist
left a comment
There was a problem hiding this comment.
Thanks for doing this, a few small changes.
|
|
||
| Delegated snapshots are enabled by default, and managed automatically by the cluster with no need for user involvement. If you want to control how delegated snapshots work, the following cluster settings are available: | ||
|
|
||
| - [`kv.snapshot_delegation.num_follower`](../cluster-settings.html#setting-kv-snapshot-delegation-num-follower): The number of delegates to try when sending snapshots, before falling back to sending from the leaseholder. If set to `0`, snapshot delegation is disabled. |
There was a problem hiding this comment.
I'm not sure if you want to mention this only applies if the entire cluster is on v23.1
The settings were renamed I checked the code and they are currently. (Sorry for the confusion)
kv.snapshot_delegation.max_delegation_attempts (replaces num_followers)
kv.snapshot_delegations.queue_limit (replaces num_requests)
See https://github.com/cockroachdb/cockroach/blob/master/pkg/kv/kvserver/replica_command.go#L2978 for details (including the help text).
There was a problem hiding this comment.
Thanks for the updated info. I took another look and it appears these settings are not marked as public in the code so they are not appearing in the v23.1 cluster settings docs (which are generated automatically from the cockroach repo, but only for "public" settings).
Was that intentional? If so I would recommend we remove the cluster setting info from this PR for consistency with how we document other cluster settings.
If this was not intentional and these settings should be "public", I can add some info here from your comment. For now I have removed mention of the cluster settings
Advanced users can always see all the non-public cluster settings and their help text using SHOW ALL CLUSTER SETTINGS if they want to.
PTAL and let me know what you think
andrewbaptist
left a comment
andrewbaptist
left a comment
There was a problem hiding this comment.
Thanks for doing this, a few small changes.
rmloveland
force-pushed
the
20230502-DOC-6815-delegated-raft-snapshots
branch
from
e48f56f to
919fa69
Compare
ianjevans
left a comment
ianjevans
left a comment
There was a problem hiding this comment.
Looks good, but see my comment about possibly linking to the setting that enables/disables delegated snapshots.
rmloveland
force-pushed
the
20230502-DOC-6815-delegated-raft-snapshots
branch
from
919fa69 to
0df7ee0
Compare
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify site settings. |
3 participants
Fixes DOC-6815, DOC-6850