diff --git a/docs/FAQ/README.md b/docs/FAQ/README.md new file mode 100644 index 00000000..e84d2a7f --- /dev/null +++ b/docs/FAQ/README.md @@ -0,0 +1,57 @@ +--- +title: FAQ | Stash +menu: + docs_{{ .version }}: + identifier: faq-readme + name: README + parent: faq + weight: -1 +product_name: stash +menu_name: docs_{{ .version }} +section_menu_id: faq +url: /docs/{{ .version }}/faq/ +aliases: + - /docs/{{ .version }}/faq/README/ +--- + +# Frequently Asked Questions + +## How to temporarily pause a backup? + +### Pause Backup + +Run the following commands to pasue a backup temporarily, + +```bash +# pause backup by patching BackupConfiguration +❯ kubectl patch backupconfiguration -n --type="merge" --patch='{"spec": {"paused": true}}' + +# pause backup using Stash `kubectl` plugin +❯ kubectl stash pause backup -n demo --backupconfig= +``` + +### Resume Backup + +Similarly you can also resume a paused backup. Run the following commands to resume a backup, + +```bash +# resume backup by patching BackupConfiguration +kubectl patch backupconfiguration -n --type="merge" --patch='{"spec": {"paused": false}}' + +# resume backup using Stash `kubectl` plugin +❯ kubectl stash resume backup -n demo --backupconfig= +``` + +## When `retentionPolicy` is applied? + +`retentionPolicy` specifies the policy to follow for cleaning old snapshots. Stash removes any snapshot from backend that falls outside the scope of the policy. When a `BackupSession` is completed, Stash checks for outdated snapshots according to the `retentionPolicy` and remove them. If you use the policy `keep-last-5`, Stash will remove any snapshot that is older than the most recent 5 snapshots. + +## Do I need to delete the init containers after recovery? + +You don't need to delete the init containers after recovery. If your workload restarts with the `stash-init` init-container for any reason, the init-container will skip running restore process if there is no pending RestoreSession for this workload. If you delete the RestoreSession, Stash will remove the `init-container` automatically. Beware that it will cause your workload to restart. + +## Need More Help? + +To speak with us, please leave a message on [our website](https://appscode.com/contact/). + +To join public discussions with the Stash community, join us in the [AppsCode Slack team](https://appscode.slack.com/messages/C8NCX6N23/details/) channel `#stash`. To sign up, use our [Slack inviter](https://slack.appscode.com/). diff --git a/docs/FAQ/_index.md b/docs/FAQ/_index.md new file mode 100644 index 00000000..c9499a5c --- /dev/null +++ b/docs/FAQ/_index.md @@ -0,0 +1,10 @@ +--- +title: FAQ +description: FAQ | Stash +menu: + docs_{{ .version }}: + identifier: faq + name: FAQ + weight: 1250 +menu_name: docs_{{ .version }} +---