Add Sandbox backup/restore API docs#28449
Open
ask-bonk[bot] wants to merge 1 commit intoproductionfrom
Open
Conversation
Add documentation for the new createBackup() and restoreBackup() methods introduced in cloudflare/sandbox-sdk#396. - New API reference page: /sandbox/api/backups/ - New how-to guide: /sandbox/guides/backup-restore/ - Updated API index with Backups card - Updated Wrangler config page with BACKUP_BUCKET R2 binding docs Closes #28448
ask-bonk
bot
requested review from
a team,
ghostwriternr and
whoiskatrin
as code owners
Contributor
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
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
2 participants
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.
All done. Here is a summary of the changes:
Summary
Created documentation for the Sandbox SDK backup and restore API (from cloudflare/sandbox-sdk#396). Four files were changed:
New files
src/content/docs/sandbox/api/backups.mdx- API reference page documenting:createBackup()method - creates point-in-time squashfs snapshots uploaded to R2restoreBackup()method - restores backups using FUSE overlayfs with copy-on-writeBackupOptions,DirectoryBackup,RestoreBackupResultsrc/content/docs/sandbox/guides/backup-restore.mdx- How-to guide covering:BACKUP_BUCKETbinding)Modified files
src/content/docs/sandbox/api/index.mdx- Added Backups card to the API reference navigationsrc/content/docs/sandbox/configuration/wrangler.mdx- Added "Backup storage" section documenting theBACKUP_BUCKETR2 bindingValidation
npm run check- 0 errors, 0 warningsnpm run format:core:check- all files pass PrettierCloses #28448
github run