-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Frequently Asked Questions (FAQ) (#209)
* Add FAQ Signed-off-by: hmsayem <[email protected]> * Update FAQ Signed-off-by: hmsayem <[email protected]> Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
- Loading branch information
1 parent
6603b69
commit 3a872ce
Showing
2 changed files
with
67 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 <namespace> <backupconfiguration name> --type="merge" --patch='{"spec": {"paused": true}}' | ||
|
||
# pause backup using Stash `kubectl` plugin | ||
❯ kubectl stash pause backup -n demo --backupconfig=<backupconfiguration name> | ||
``` | ||
|
||
### 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 <namespace> <backupconfiguration name> --type="merge" --patch='{"spec": {"paused": false}}' | ||
|
||
# resume backup using Stash `kubectl` plugin | ||
❯ kubectl stash resume backup -n demo --backupconfig=<backupconfiguration name> | ||
``` | ||
|
||
## 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/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
title: FAQ | ||
description: FAQ | Stash | ||
menu: | ||
docs_{{ .version }}: | ||
identifier: faq | ||
name: FAQ | ||
weight: 1250 | ||
menu_name: docs_{{ .version }} | ||
--- |