Add a webpage that walks through the new backup and restore examples for a local Vitess environment. #1861

shailpujan88 · 2024-10-11T12:08:27Z

This PR is For Add new getting started example #1798.

This pull request adds documentation for managing backups and restorations in a local Vitess environment.
Key Changes:

Included detailed instructions for setting up a backup schedule.
Added guidelines for restoring data from backups.

…ment. Signed-off-by: Shail Pujan <[email protected]>

netlify · 2024-10-11T12:09:59Z

✅ Deploy Preview for vitess ready!

Name	Link
🔨 Latest commit	`2822e8e`
🔍 Latest deploy log	https://app.netlify.com/sites/vitess/deploys/670d42e1ec850400086e1332
😎 Deploy Preview	https://deploy-preview-1861--vitess.netlify.app
📱 Preview on mobile	Toggle 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: Shail Pujan <[email protected]>

content/en/docs/21.0/user-guides/configuration-advanced/resharding.md

frouioui · 2024-10-11T16:05:31Z

...ent/en/docs/21.0/user-guides/operating-vitess/backup-and-restore/backup_and_restore_local.md

+that the [MoveTables](../../../migration/move-tables/) and [Resharding](../../../configuration-advanced/resharding) user guides have been followed (which take you through
+steps `101` to `306`).
+
+This guide is useful only if you are using Vitess in a local environment.


The steps defined here could theoretically be almost replicated on K8S as we are only using vtctldclient commands. We should mention that this guide is intended for the local getting started guide, but similar steps can be done on a K8S deployment.

I am not seeing this change

I just now push now you can see the changes.

...ent/en/docs/21.0/user-guides/operating-vitess/backup-and-restore/backup_and_restore_local.md

frouioui · 2024-10-11T16:10:31Z

...ent/en/docs/21.0/user-guides/operating-vitess/backup-and-restore/backup_and_restore_local.md

+Expected Output
+When you run the script, the following output can be expected:


Something is wrong with the format of Expected Output, both lines 32 and 33 are rendered on the same line.

removed line 32

I am not seeing it removed

...ent/en/docs/21.0/user-guides/operating-vitess/backup-and-restore/backup_and_restore_local.md

frouioui · 2024-10-11T16:26:34Z

...ent/en/docs/21.0/user-guides/operating-vitess/backup-and-restore/backup_and_restore_local.md

+For example, navigating to the directory:
+```bash
+cd /path/to/local/backup/directory
+ls -l
+```


We should put the full path directly here, so the user can copy-paste. We already know the path ahead of time since it will be under the VTDATAROOT directory.

...ent/en/docs/21.0/user-guides/operating-vitess/backup-and-restore/backup_and_restore_local.md

frouioui · 2024-10-11T18:51:54Z

...ent/en/docs/21.0/user-guides/operating-vitess/backup-and-restore/backup_and_restore_local.md

+```bash
+$ ./401_backup.sh
+```


There is an inconsistency here between how you run 401 and 402. One contains a $ and the other does not, let's make it consistent please.

Ok added $ to each scripts for maling it consistent

teardown does not have it

...ent/en/docs/21.0/user-guides/operating-vitess/backup-and-restore/backup_and_restore_local.md

frouioui · 2024-10-11T18:55:29Z

...ent/en/docs/21.0/user-guides/operating-vitess/backup-and-restore/backup_and_restore_local.md

+
+Expected Output
+When you run the restore script, the following output can be expected:
+```bash


Suggested change

```bash

remove bash

…n.sh for cleanup Signed-off-by: Shail Pujan <[email protected]>

frouioui · 2024-10-14T14:59:41Z

...ent/en/docs/21.0/user-guides/operating-vitess/backup-and-restore/backup_and_restore_local.md

+
+## Local Environment Backup And Restore Steps:
+
+### Adding a Backup for Local Environment


Suggested change

### Adding a Backup for Local Environment

### Taking a Backup

frouioui · 2024-10-14T15:13:29Z

...ent/en/docs/21.0/user-guides/operating-vitess/backup-and-restore/backup_and_restore_local.md

+This will start the backup process for the customer keyspace and all its shards.
+
+When you run the script, the following output can be expected:


Suggested change

This will start the backup process for the customer keyspace and all its shards.

When you run the script, the following output can be expected:

This will start the backup process for the customer keyspace and all its shards. When you run the script, the following output can be expected:

frouioui · 2024-10-14T15:16:47Z

...ent/en/docs/21.0/user-guides/operating-vitess/backup-and-restore/backup_and_restore_local.md

+
+For example, navigating to the directory:
+```bash
+$ cd /vtdataroot/backups


i think using $VTDATAROOT makes more sense, people might not use /vtdataroot

frouioui · 2024-10-14T15:17:51Z

...ent/en/docs/21.0/user-guides/operating-vitess/backup-and-restore/backup_and_restore_local.md

+shail_pujan@SHAIL-PUJAN:~/vtdataroot/backups $ ls
+customer
+shail_pujan@SHAIL-PUJAN:~/vtdataroot/backups$ cd customer
+shail_pujan@SHAIL-PUJAN:~/vtdataroot/backups/customer$ ls
+-80  80-
+ ls -l ./-80/ ./80-/
+./-80/:
+total 4
+drwxr-xr-x 2 shail_pujan shail_pujan 4096 Oct 12 12:15 2024-10-12.064518.zone1-0000000300
+
+./80-/:
+total 4
+drwxr-xr-x 2 shail_pujan shail_pujan 4096 Oct 12 12:15 2024-10-12.064523.zone1-0000000401
+
+shail_pujan@SHAIL-PUJAN:~/vtdataroot/backups/customer$ cd ./-80/2024-10-12.064518.zone1-0000000300
+shail_pujan@SHAIL-PUJAN:~/vtdataroot/backups/customer/-80/2024-10-12.064518.zone1-0000000300$ ls -l


In this block, there is a mix of command thats begins with $ and with shail_pujan@ ..., so it is a little hard to understand what is going on.

shall we remove shail_pujan?

i think it would be better yes

also it is not clear what instructions we need to follow because the first step is cd /vtdataroot/backups but then we are in ~/vtdataroot/backups

frouioui · 2024-10-14T15:19:06Z

...ent/en/docs/21.0/user-guides/operating-vitess/backup-and-restore/backup_and_restore_local.md

+```
+This will safely remove the cluster and associated data, ensuring a clean environment without manual deletions.
+
+If needed, use the [vtctldclient](../../backup-and-restore/managing-backups)command to remove specific backups, but this is generally not required if you are running the teardown script.


Suggested change

If needed, use the [vtctldclient](../../backup-and-restore/managing-backups)command to remove specific backups, but this is generally not required if you are running the teardown script.

If needed, use the [vtctldclient](../../backup-and-restore/managing-backups) command to remove specific backups, but this is generally not required if you are running the teardown script.

done with changes.

frouioui · 2024-10-14T15:19:26Z

...ent/en/docs/21.0/user-guides/operating-vitess/backup-and-restore/backup_and_restore_local.md

+```bash
+./501_teardown.sh
+```
+This will safely remove the cluster and associated data, ensuring a clean environment without manual deletions.


this sentence feels redundant with what we have already written above

Suggested change

This will safely remove the cluster and associated data, ensuring a clean environment without manual deletions.

done with changes

…stent commands, clearer outputs, and improved directory navigation. Signed-off-by: Shail Pujan <[email protected]>

Add backup and restore example documentation for local Vitess environ…

6b366f8

…ment. Signed-off-by: Shail Pujan <[email protected]>

Remove file e -i HEAD~2 from PR

7f28048

Signed-off-by: Shail Pujan <[email protected]>

shailpujan88 marked this pull request as ready for review October 11, 2024 13:29

frouioui reviewed Oct 11, 2024

View reviewed changes

content/en/docs/21.0/user-guides/configuration-advanced/resharding.md Outdated Show resolved Hide resolved

frouioui reviewed Oct 11, 2024

View reviewed changes

...ent/en/docs/21.0/user-guides/operating-vitess/backup-and-restore/backup_and_restore_local.md Outdated Show resolved Hide resolved

frouioui reviewed Oct 11, 2024

View reviewed changes

...ent/en/docs/21.0/user-guides/operating-vitess/backup-and-restore/backup_and_restore_local.md Outdated Show resolved Hide resolved

frouioui reviewed Oct 11, 2024

View reviewed changes

...ent/en/docs/21.0/user-guides/operating-vitess/backup-and-restore/backup_and_restore_local.md Outdated Show resolved Hide resolved

frouioui reviewed Oct 11, 2024

View reviewed changes

...ent/en/docs/21.0/user-guides/operating-vitess/backup-and-restore/backup_and_restore_local.md Outdated Show resolved Hide resolved

frouioui reviewed Oct 11, 2024

View reviewed changes

...ent/en/docs/21.0/user-guides/operating-vitess/backup-and-restore/backup_and_restore_local.md Outdated Show resolved Hide resolved

frouioui reviewed Oct 11, 2024

View reviewed changes

Update backup documentation as per instructions and added 501_teardow…

1056e43

…n.sh for cleanup Signed-off-by: Shail Pujan <[email protected]>

shailpujan88 mentioned this pull request Oct 14, 2024

LFX 2024 Term 3: Add new getting started examples #1798

Closed

24 tasks

frouioui reviewed Oct 14, 2024

View reviewed changes

Enhance local environment backup and restore documentation with consi…

2822e8e

…stent commands, clearer outputs, and improved directory navigation. Signed-off-by: Shail Pujan <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a webpage that walks through the new backup and restore examples for a local Vitess environment. #1861

Add a webpage that walks through the new backup and restore examples for a local Vitess environment. #1861

shailpujan88 commented Oct 11, 2024

netlify bot commented Oct 11, 2024 •

edited

Loading

frouioui Oct 11, 2024

shailpujan88 Oct 11, 2024

frouioui Oct 11, 2024

shailpujan88 Oct 12, 2024

frouioui Oct 11, 2024

shailpujan88 Oct 11, 2024

frouioui Oct 11, 2024

frouioui Oct 11, 2024

shailpujan88 Oct 12, 2024

frouioui Oct 11, 2024

shailpujan88 Oct 12, 2024

frouioui Oct 14, 2024

frouioui Oct 11, 2024

frouioui Oct 11, 2024

shailpujan88 Oct 12, 2024

frouioui Oct 14, 2024 •

edited

Loading

frouioui Oct 14, 2024

frouioui Oct 14, 2024

frouioui Oct 14, 2024

shailpujan88 Oct 14, 2024 •

edited

Loading

frouioui Oct 14, 2024

frouioui Oct 14, 2024

shailpujan88 Oct 14, 2024

frouioui Oct 14, 2024

shailpujan88 Oct 14, 2024

frouioui Oct 14, 2024

frouioui Oct 14, 2024

shailpujan88 Oct 14, 2024

		Expected Output
		When you run the script, the following output can be expected:


		## Local Environment Backup And Restore Steps:

		### Adding a Backup for Local Environment

	### Adding a Backup for Local Environment
	### Taking a Backup

		This will start the backup process for the customer keyspace and all its shards.

		When you run the script, the following output can be expected:

	If needed, use the [vtctldclient](../../backup-and-restore/managing-backups)command to remove specific backups, but this is generally not required if you are running the teardown script.
	If needed, use the [vtctldclient](../../backup-and-restore/managing-backups) command to remove specific backups, but this is generally not required if you are running the teardown script.

Add a webpage that walks through the new backup and restore examples for a local Vitess environment. #1861

Are you sure you want to change the base?

Add a webpage that walks through the new backup and restore examples for a local Vitess environment. #1861

Conversation

shailpujan88 commented Oct 11, 2024

netlify bot commented Oct 11, 2024 • edited Loading

✅ Deploy Preview for vitess ready!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

frouioui Oct 14, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shailpujan88 Oct 14, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

netlify bot commented Oct 11, 2024 •

edited

Loading

frouioui Oct 14, 2024 •

edited

Loading

shailpujan88 Oct 14, 2024 •

edited

Loading