Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add vtbackup reference and refactor backup/restore docs #1351

Merged
merged 3 commits into from
Jan 27, 2023

Conversation

maxenglander
Copy link
Collaborator

@maxenglander maxenglander commented Jan 18, 2023

Accompanies vitessio/vitess#11979.

In order to document all of the new metrics introduced by vitessio/vitess#11979, I would like to be able to talk about vtbackup. Currently the docs don't mention vtbackup at all. This PR reorganizes adds a reference page for vtbackup and re-organizes the backup/restore docs a bit to make it easier to talk about vtbackup.

@netlify
Copy link

netlify bot commented Jan 18, 2023

Deploy Preview for vitess ready!

Name Link
🔨 Latest commit 3570f02
🔍 Latest deploy log https://app.netlify.com/sites/vitess/deploys/63c81f7717d47d0008022778
😎 Deploy Preview https://deploy-preview-1351--vitess.netlify.app/docs/16.0/user-guides/operating-vitess/backup-and-restore/bootstrap-and-restore
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@maxenglander maxenglander changed the title content/end/docs/16.0: add reference program docs for vtbackup content/end/docs/16.0: add vtbackup reference and refactor backup/restore docs Jan 18, 2023
@maxenglander maxenglander changed the title content/end/docs/16.0: add vtbackup reference and refactor backup/restore docs add vtbackup reference and refactor backup/restore docs Jan 18, 2023
@@ -0,0 +1,232 @@
---
Copy link
Collaborator

@rsajwani rsajwani Jan 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I actually have another PR for vtbackup .. but I will go through yours and if needed will close mine ..

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you have another one feel free to go with that and close this one! I have no preference, whichever you prefer.

Copy link
Collaborator

@rsajwani rsajwani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall looks good.. There are few deprecation in the flags but I have taken care of it in another PR (https://github.com/vitessio/website/pull/1330/files)... once you push this change .. I will apply my PR on top of it.

- Alerting human operators if the failure is persistent.

## Example Usage

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minor: Consider you have running Vitess cluster, the following command will create backup of keyspace commerce having shard 0

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have taken care of this in my PR.

@rsajwani rsajwani merged commit 905bc3b into prod Jan 27, 2023
@rsajwani rsajwani deleted the maxeng-details-backup-stats branch January 27, 2023 01:36
@rsajwani rsajwani mentioned this pull request Jan 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants