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

feat: pv backup restore docs #29

Merged
merged 2 commits into from
Feb 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 42 additions & 4 deletions docs/dashboard/persistent-volumes.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,45 @@

![Persistent Volume List](/assets/persistent-volumes.png)

**You can **
- **Create** a new persistent volume by clicking on `Add New` button.
- **Delete** a persistent volume by clicking on `Delete` button.
> Note : You can only delete a persistent volume if it is not being used by any application.
### Create a Persistent Volume
1. Click on `Add New` button.
2. Put a name for the persistent volume.
> Note : The name should be unique and can't contain spaces.
3. Submit.

### Delete a Persistent Volume
Just click on `Delete` button to delete a persistent volume.

### Analyze Size of Persistent Volume
You can click on `Fetch Size` button to fetch size of the persistent volume.

### Backup Volume
1. You can backup and take snapshot of the persistent volume by clicking on `Create Backup` button.

Check warning on line 24 in docs/dashboard/persistent-volumes.md

View workflow job for this annotation

GitHub Actions / Language check

[LanguageTool] reported by reviewdog 🐶 The word “backup” is a noun. The verb is spelled with a space. (NOUN_VERB_CONFUSION[1]) Suggestions: `back up` Rule: https://community.languagetool.org/rule/show/NOUN_VERB_CONFUSION?lang=en-US&subId=1 Category: GRAMMAR Raw Output: docs/dashboard/persistent-volumes.md:24:9: The word “backup” is a noun. The verb is spelled with a space. (NOUN_VERB_CONFUSION[1]) Suggestions: `back up` Rule: https://community.languagetool.org/rule/show/NOUN_VERB_CONFUSION?lang=en-US&subId=1 Category: GRAMMAR
2. You can choose type of backup.
- **Local** : The backup will be stored locally in the server itself.
- **S3** : The backup will be stored in S3 bucket. You need to configure S3 beforehand to avail this feature.
> You can open swiftwave config by [`swiftwave config -e vim`](/docs/cli/config) command
3. Submit to create backup.
4. You can open the backup history by `Show Backups` button to see the status of the backup.

### Backup History
You can click on `Show Backups` button to see the backup history of the volume.

![Backup History](/assets/backup-history.png)

- You can check status of old backups.
- You can also download the backup file by clicking on `Download Backup` button.


### Restore Volume
1. You can upload a backup file to restore the volume by clicking on `Restore Now` button.
2. Upload the backup file.
3. Submit to restore the volume.
4. You can open the restore history by `Show Restores` button to see the status of the restore.

### Restore History
You can click on `Restore History` button to see the restore history of the volume.

![Restore History](/assets/restore-history.png)

- You can check status of all restores.
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Experience the ease of deployment and management with SwiftWave! 🌊
- **Flexible Restart**: Restart your application at your convenience 🔄
- **Scaling Made Easy**: Scale your application effortlessly with just one click 🔍
- **Log Insight**: Easily check logs for your application 📋
- **Backup & Restore**: Backup and restore your application with just one click 🔄

### 🛣️ Traffic Control
- **Custom Domains**: Add custom domains and auto-issue SSL certificates with just one click 🔒
Expand Down
16 changes: 8 additions & 8 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -114,17 +114,17 @@ const config = {
items: [
{
to: "/docs",
label: "📚 Docs",
label: "Docs",
position: "left",
},
{
to: "/docs/contribution_guideline",
label: "🤝 Contribute",
label: "Contribute",
position: "left",
},
{
to: "/docs/support_us",
label: "Support Us",
label: "Support Us",
position: "left",
},
// {
Expand All @@ -137,11 +137,11 @@ const config = {
// type: "localeDropdown",
// position: "right",
// },
{
to: "/docs/manifesto",
label: "🌱 Manifesto",
position: "right",
},
// {
// to: "/docs/manifesto",
// label: "🌱 Manifesto",
// position: "right",
// },
{
type: 'custom-github-star-btn',
position: 'right'
Expand Down
Binary file added static/assets/backup-history.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/assets/persistent-volumes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/assets/restore-history.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading