Update all GC TTL and range size mentions to DRY #16506
Conversation
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify site settings. |
rmloveland
force-pushed
the
20230316-DOC-6820
branch
from
16685c1 to
3b549dc
Compare
Files changed:
|
|
@irfansharif added you since my understanding is you are the primary engineer on the change to the GC TTL default for v23.1 based on cockroachdb/cockroach#89233, cockroachdb/cockroach#93836, and your filing of cockroachdb/cockroach#98105 @kathancox adding you as well per our discussion earlier today. I suspect some of these changes will be obsoleted by your work on DOC-1012, DOC-6654, and friends, but hopefully this PR is not too disruptive b/c the changes are small and will ensure consistent pointing to one place for the GC TTL default values (even if for a short time because your subsequent work will be rewriting some of this stuff Very Soon (tm)) |
|
also @irfansharif there will almost certainly be more doc updates to come re: the new GC TTL this is a first pass at just pointing users to one place for the updated defaults and making sure when they get to that one place we have more cross-linking to concepts like MVCC and range splits they need to understand if they are going to be changing this setting |
There was a problem hiding this comment.
This is great! Thanks for setting the bed for the forthcoming GC TTL specific documentation. It LGTM, but I noticed some out-of-date or incorrect information that I've commented on below. Those corrections are unrelated to what this PR itself is changing, but appeared adjacent to text this PR changed. So it caught my eye.
rmloveland
force-pushed
the
20230316-DOC-6820
branch
from
3b549dc to
21c5cde
Compare
|
Thanks for the reviews @irfansharif and @kathancox ! I have made updates based on your comments. Please let me know if I got them approximately right, or if further changes are needed |
rmloveland
force-pushed
the
20230316-DOC-6820
branch
from
21c5cde to
e16f1d4
Compare
... where DRY = Don't Repeat Yourself Addresses: DOC-6539 DOC-6540 DOC-6820 DOC-6834 Summary of changes: - Update all mentions in v23.1 docs of the default GC TTL (`gc.ttlseconds`) and default/max range size (`range_max_bytes`) to point to their respective entries on the 'Configure Replication Zones' page. - Update the description of the `gc.ttlseconds` zcfg variable to link to more salient info re: MVCC, range splits, etc. to provide the reader with add'l context - Make a few small text updates to weave in the above, as well as a few opportunistic link additions (to range splitting docs, for example) - Update several places that make it seem like GC runs at a specific time (whether 25 hours or, now, 4 hours) to hopefully make it clear that things are *eligible* for GC past a threshold - Update `gc.ttlseconds` replication zone variable docs to make it clearer that the recommendations around GC TTL vs backups only apply if you are not using scheduled backups (which you should be)
rmloveland
force-pushed
the
20230316-DOC-6820
branch
from
e16f1d4 to
36f3e93
Compare
... where DRY = Don't Repeat Yourself
Addresses:
DOC-6539
DOC-6540
DOC-6820
DOC-6834
Summary of changes:
Update all mentions in v23.1 docs of the default GC TTL (
gc.ttlseconds) and default/max range size (range_max_bytes) to point to their respective entries on the 'Configure Replication Zones' page.Update the description of the
gc.ttlsecondszcfg variable to link to more salient info re: MVCC, range splits, etc. to provide the reader with add'l contextMake a few small text updates to weave in the above, as well as a few opportunistic link additions (to range splitting docs, for example)