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

Enhance the getting started guide: scheduled backups #1746

Merged
merged 6 commits into from
Jun 3, 2024

Conversation

frouioui
Copy link
Member

@frouioui frouioui commented May 17, 2024

This Pull Request adds another segment to our getting started guide with the operator to teach how to schedule backups. It comes as a very last step right after Resharding.

This PR is related to planetscale/vitess-operator#553 and vitessio/vitess#15969

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
Copy link

netlify bot commented May 17, 2024

Deploy Preview for vitess ready!

Name Link
🔨 Latest commit 5a977a2
🔍 Latest deploy log https://app.netlify.com/sites/vitess/deploys/665e2f7d7d98390008271bf1
😎 Deploy Preview https://deploy-preview-1746--vitess.netlify.app
📱 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 configuration.

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
@frouioui frouioui marked this pull request as ready for review May 17, 2024 17:08
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
@frouioui
Copy link
Member Author


{{< info >}}
This guide follows on from the Get Started guides. Please make sure that you have
an [Operator](../../../../get-started/operator) or [local](../../../../get-started/local) installation ready. It also assumes
Copy link
Member

Choose a reason for hiding this comment

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

Since this works only with operator, we should remove the reference to local installation from here.

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed via 5a977a2

## Backups

If you are not familiar with how backups in Vitess work we suggest you familiarize yourself with it.
An [entire guide](../overview/) is available in this section.
Copy link
Member

Choose a reason for hiding this comment

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

Remove this line, and hyperlink from [how backups work]

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed via 5a977a2

the two `customer` shards, and the second one will backup the `commerce` keyspace.
The backups will be stored directly inside the Minikube node, but if you want to backup to for instance S3, you can
change the `location` of the backup in `401_scheduled_backups.yaml`.

Copy link
Member

Choose a reason for hiding this comment

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

It is worth putting a big WARNING here. Something like:
Please note that is not recommended to run production backups every minute. These schedules are only an example.

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed via 5a977a2

@shlomi-noach
Copy link
Contributor

Only merge once vitessio/vitess#15969 is merged.

frouioui and others added 2 commits June 3, 2024 14:59
Co-authored-by: Deepthi Sigireddi <deepthi@planetscale.com>
Signed-off-by: Florent Poinsard <35779988+frouioui@users.noreply.github.com>
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
@frouioui frouioui requested a review from deepthi June 3, 2024 21:04
@frouioui
Copy link
Member Author

frouioui commented Jun 3, 2024

DCO is working wrong right now, manually verified signoff

@frouioui frouioui merged commit dff193b into prod Jun 3, 2024
4 checks passed
@frouioui frouioui deleted the add-how-take-backup-guides branch June 3, 2024 22:10
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.

None yet

4 participants