docs(settings): document Backupstore Poll Interval cost implications - #1407
Open
0byte-coding wants to merge 1 commit into
Open
docs(settings): document Backupstore Poll Interval cost implications#14070byte-coding wants to merge 1 commit into
0byte-coding wants to merge 1 commit into
Conversation
The 'Backupstore Poll Interval' setting has been referenced from 'Failed Backup Time To Live' and listed in the table of contents for years, but had no dedicated section explaining what it does or its cost implications on S3-compatible backup targets. This gap contributed to longhorn/longhorn#1547 (open since 2020): many users only discovered the setting - and that disabling/raising it doesn't require DR volumes - via GitHub issue comments rather than documentation, after already accumulating significant Backblaze B2 / S3 API costs. Add the missing section (based on the original wording from v1.0.1 docs, which existed before this section was dropped), and a warning explaining the per-poll request cost model and pointing at the tracking issue and companion code fixes.
✅ Deploy Preview for longhornio ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
This PR is stale because it has been open for 30 days with no activity. Remove stale label or comment or this will be closed in 10 days. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Which issue(s) this PR fixes:
Issue longhorn/longhorn#1547
What this PR does / why we need it:
Backupstore Poll Intervalis referenced from theFailed Backup Time To Livesection and listed in the table of contents, but has no dedicated section explaining what it does or its cost implications - it was present in the very first (v1.0.1) docs but dropped at some point.This gap is a recurring theme in longhorn/longhorn#1547 (open since 2020, 40+ comments): many users only discovered this setting - and that it isn't required unless using DR volumes - via GitHub issue comments, after already accumulating unexpected S3 API costs (Backblaze B2 Class C transactions in particular).
Adds the missing section back (based on the original v1.0.1 wording) with an explanation of the per-poll request cost model on S3-compatible backends, and points at the tracking issue and companion code fixes (longhorn/backupstore#313, longhorn/longhorn-manager#5030) that reduce that cost.
Special notes for your reviewer:
Added to
content/docs/1.13.0/references/settings.md(current dev docs). Happy to backport to other still-supported versions if that's the convention for this kind of doc gap.Additional documentation or context
longhorn/longhorn#1547