Add callouts for S3-compatible storage support policy #20503
Conversation
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
I think i'm fine publicly documenting that AWS_SKIP_CHECKSUM is a common workaround for clones, but i think the language in this doc update goes against an internal proposal @rimadeodhar is working on. I'd like to her review this before this lands.
imho, we should align internally on the language we're using before making the public docs update
alicia-l2
left a comment
alicia-l2
left a comment
There was a problem hiding this comment.
lgtm, getting someone from support to review
|
Discussed offline with Alicia, longer term we would like to have a dedicated section or page about unsupported S3-compatible systems where the |
| Cockroach Labs does not officially support S3-compatible storage solutions other than AWS S3, Google Cloud Storage (GCS), and Azure Blob Storage.{% if page.version.version !="v24.1" %} Some common compatibility issues may be fixed by adding the `AWS_SKIP_CHECKSUM` option to the S3 URLs.{% endif %}. | ||
|
|
||
|
|
||
| The [Cockroach Labs Support team]({% link {{page.version.version}}/support-resources.md %}) is available to offer assistance where possible. If you encounter issues when using unsupported S3-compatible storage, drivers, or frameworks, contact the maintainer. |
There was a problem hiding this comment.
this language is a lot better. could you provide a preview web page so i can understand how this renders? There are several repeat lines in this page, but maybe it renders nicely.
There was a problem hiding this comment.
Sure thing, here's how it renders - https://deploy-preview-20503--cockroachdb-docs.netlify.app/docs/stable/backup-and-restore-overview#backup-storage
The repeat lines are because I'm using some in-page logic to slightly adjust the text based on which page it's on. For the v24.1 version of the page, exclude the line about AWS_SKIP_CHECKSUM. For the pages in the Cloud docs, the link to the support page needs to be modified in order to resolve. Etc.
There was a problem hiding this comment.
For ease of review on docs PRs, about ~10 minutes after a commit to a docs PR is pushed, there should be a comment automatically posted by Netlify that (if successful) includes a link to a render preview of the PR. Just FYI for future reference.
rimadeodhar
left a comment
rimadeodhar
left a comment
There was a problem hiding this comment.
Overall, LGTM. As Alicia mentioned earlier, we will need to have a follow up to move this section into its own page. Do we have a follow up docs issue to track that work?
| {{ site.data.alerts.end }} | ||
| {% else %} | ||
| {{ site.data.alerts.callout_danger }} | ||
| Cockroach Labs does not officially support S3-compatible storage solutions other than AWS S3, Google Cloud Storage (GCS), and Azure Blob Storage.{% if page.version.version !="v24.1" %} Some common compatibility issues may be fixed by adding the `AWS_SKIP_CHECKSUM` option to the S3 URLs.{% endif %}. |
There was a problem hiding this comment.
This language looks good! Thanks for the update.
Nit: remove the double period at the end of this sentence (after the option to S3 URLs bit).
Yep, I just created https://cockroachlabs.atlassian.net/browse/DOC-15043 with my notes on what content should be included. I'll triage to someone else on the docs team since I'm out for the next two weeks, please feel free to chime in on the ticket with additional notes or suggestions. |
5 participants
https://cockroachlabs.atlassian.net/browse/DOC-14822
Add emphasis to Cockroach Labs offering "best-effort" support of untested S3-compatible storage options, plus mention of using the
AWS_SKIP_CHECKSUMoption to resolve common issues in v24.3+.