diff --git a/docs/guides/mongodb/backup/kubestash/auto-backup/index.md b/docs/guides/mongodb/backup/kubestash/auto-backup/index.md index abde5fc780..523c098d36 100644 --- a/docs/guides/mongodb/backup/kubestash/auto-backup/index.md +++ b/docs/guides/mongodb/backup/kubestash/auto-backup/index.md @@ -19,21 +19,20 @@ In this tutorial, we are going to show how you can configure a backup blueprint ## Before You Begin -- At first, you need to have a Kubernetes cluster, and the `kubectl` command-line tool must be configured to communicate with your cluster. -- Install KubeStash Enterprise in your cluster following the steps [here](https://stash.run/docs/latest/setup/install/stash/). -- Install KubeDB in your cluster following the steps [here](/docs/setup/README.md). -- If you are not familiar with how Stash backup and restore MongoDB databases, please check the following guide [here](/docs/guides/mongodb/backup/stash/overview/index.md). -- If you are not familiar with how auto-backup works in Stash, please check the following guide [here](https://stash.run/docs/latest/guides/auto-backup/overview/). -- If you are not familiar with the available auto-backup options for databases in Stash, please check the following guide [here](https://stash.run/docs/latest/guides/auto-backup/database/). +- At first, you need to have a Kubernetes cluster, and the `kubectl` command-line tool must be configured to communicate with your cluster. If you do not already have a cluster, you can create one by using `Minikube` or `Kind`. +- Install `KubeDB` in your cluster following the steps [here](/docs/setup/README.md). +- Install `KubeStash` in your cluster following the steps [here](https://kubestash.com/docs/latest/setup/install/kubestash). +- Install KubeStash `kubectl` plugin following the steps [here](https://kubestash.com/docs/latest/setup/install/kubectl-plugin/). +- If you are not familiar with how KubeStash backup and restore `MongoDB` databases, please check the following guide [here](/docs/guides/mongodb/backup/kubestash/overview/index.md). You should be familiar with the following `KubeStash` concepts: -- [BackupBlueprint](https://stash.run/docs/latest/concepts/crds/backupblueprint/) -- [BackupConfiguration](https://stash.run/docs/latest/concepts/crds/backupconfiguration/) -- [BackupSession](https://stash.run/docs/latest/concepts/crds/backupsession/) -- [Repository](https://stash.run/docs/latest/concepts/crds/repository/) -- [Function](https://stash.run/docs/latest/concepts/crds/function/) -- [Task](https://stash.run/docs/latest/concepts/crds/task/) +- [BackupBlueprint](https://kubestash.com/docs/latest/concepts/crds/backupblueprint/) +- [BackupConfiguration](https://kubestash.com/docs/latest/concepts/crds/backupconfiguration/) +- [BackupSession](https://kubestash.com/docs/latest/concepts/crds/backupsession/) +- [BackupStorage](https://kubestash.com/docs/latest/concepts/crds/backupstorage/) +- [Function](https://kubestash.com/docs/latest/concepts/crds/function/) +- [Addon](https://kubestash.com/docs/latest/concepts/crds/addon/) To keep things isolated, we are going to use a separate namespace called `demo` throughout this tutorial. Create `demo` namespace if you haven't created yet. @@ -81,7 +80,7 @@ spec: bucket: kubestash-testing region: us-east-1 prefix: demo - secret: s3-secret + secretName: s3-secret usagePolicy: allowedNamespaces: from: All @@ -147,28 +146,30 @@ spec: backupConfigurationTemplate: deletionPolicy: OnDelete backends: - - name: s3-backend - storageRef: - namespace: ${storageNamespace} - name: ${storageName} - retentionPolicy: - name: backup-rp - namespace: demo + - name: s3-backend + storageRef: + namespace: ${storageNamespace} + name: ${storageName} + retentionPolicy: + name: backup-rp + namespace: demo sessions: - - name: frequent - scheduler: - schedule: ${scheduleTime} - repositories: - - name: ${repoName} - backend: s3-backend - directory: ${backupPath} - encryptionSecret: - name: encry-secret - namespace: demo - addon: - name: mongodb-addon - tasks: - - name: LogicalBackup + - name: frequent + scheduler: + jobTemplate: + backoffLimit: 1 + schedule: ${scheduleTime} + repositories: + - name: ${repoName} + backend: s3-backend + directory: ${backupPath} + encryptionSecret: + name: encry-secret + namespace: demo + addon: + name: mongodb-addon + tasks: + - name: LogicalBackup ``` Here, we define a template for `BackupConfiguration`. Notice the `backends` and `sessions` fields of `backupConfigurationTemplate` section. We have used some variables in form of `${VARIABLE_NAME}`. KubeStash will automatically resolve those variables from the database annotations information to make `BackupConfiguration` according to that databases need. diff --git a/docs/guides/mongodb/backup/kubestash/customization/index.md b/docs/guides/mongodb/backup/kubestash/customization/index.md index 59549ce249..c73eb267fb 100644 --- a/docs/guides/mongodb/backup/kubestash/customization/index.md +++ b/docs/guides/mongodb/backup/kubestash/customization/index.md @@ -44,18 +44,20 @@ spec: name: s3-storage retentionPolicy: name: backup-rp - namespace: demo + namespace: demo sessions: - name: frequent scheduler: schedule: "*/5 * * * *" + jobTemplate: + backoffLimit: 1 repositories: - name: s3-repo backend: s3-backend directory: /mongodb encryptionSecret: - name: encry-secret - namespace: demo + name: encry-secret + namespace: demo addon: name: mongodb-addon tasks: diff --git a/docs/guides/mongodb/backup/kubestash/logical/replicaset/index.md b/docs/guides/mongodb/backup/kubestash/logical/replicaset/index.md index 9707437312..6c19a3e68a 100644 --- a/docs/guides/mongodb/backup/kubestash/logical/replicaset/index.md +++ b/docs/guides/mongodb/backup/kubestash/logical/replicaset/index.md @@ -21,7 +21,7 @@ KubeStash v0.1.0+ supports backup and restoration of MongoDB databases. This gui - Install KubeDB in your cluster following the steps [here](/docs/setup/README.md). - Install KubeStash Enterprise in your cluster following the steps [here(link needed)](). - Install KubeStash `kubectl` plugin following the steps [here(link needed)](). -- If you are not familiar with how KubeStash backup and restore MongoDB databases, please check the following guide [here](/docs/guides/mongodb/backup/kubestash/overview/_index.md). +- If you are not familiar with how KubeStash backup and restore MongoDB databases, please check the following guide [here](/docs/guides/mongodb/backup/kubestash/overview/index.md). You have to be familiar with following custom resources: @@ -202,7 +202,7 @@ spec: bucket: kubestash-testing region: us-east-1 prefix: demo-replicaset - secret: s3-secret + secretName: s3-secret usagePolicy: allowedNamespaces: from: All @@ -283,18 +283,20 @@ spec: name: s3-storage-replicaset retentionPolicy: name: backup-rp - namespace: demo + namespace: demo sessions: - name: frequent scheduler: + jobTemplate: + backoffLimit: 1 schedule: "*/3 * * * *" repositories: - name: s3-repo backend: s3-backend directory: /replicaset encryptionSecret: - name: encry-secret - namespace: demo + name: encry-secret + namespace: demo addon: name: mongodb-addon tasks: diff --git a/docs/guides/mongodb/backup/kubestash/logical/sharding/index.md b/docs/guides/mongodb/backup/kubestash/logical/sharding/index.md index 69435b449e..fbfcca36e2 100644 --- a/docs/guides/mongodb/backup/kubestash/logical/sharding/index.md +++ b/docs/guides/mongodb/backup/kubestash/logical/sharding/index.md @@ -21,7 +21,7 @@ KubeStash v0.1.0+ supports backup and restoration of MongoDB databases. This gui - Install KubeDB in your cluster following the steps [here](/docs/setup/README.md). - Install KubeStash Enterprise in your cluster following the steps [here(link needed)](). - Install KubeStash `kubectl` plugin following the steps [here(link needed)](). -- If you are not familiar with how KubeStash backup and restore MongoDB databases, please check the following guide [here](/docs/guides/mongodb/backup/kubestash/overview/_index.md). +- If you are not familiar with how KubeStash backup and restore MongoDB databases, please check the following guide [here](/docs/guides/mongodb/backup/kubestash/overview/index.md). You have to be familiar with following custom resources: @@ -210,7 +210,7 @@ spec: bucket: kubestash-testing region: us-east-1 prefix: demo-sharding - secret: s3-secret + secretName: s3-secret usagePolicy: allowedNamespaces: from: All @@ -291,18 +291,20 @@ spec: name: s3-storage-sharding retentionPolicy: name: backup-rp - namespace: demo + namespace: demo sessions: - name: frequent scheduler: + jobTemplate: + backoffLimit: 1 schedule: "*/3 * * * *" repositories: - name: s3-repo backend: s3-backend directory: /sharding encryptionSecret: - name: encry-secret - namespace: demo + name: encry-secret + namespace: demo addon: name: mongodb-addon tasks: diff --git a/docs/guides/mongodb/backup/kubestash/logical/standalone/index.md b/docs/guides/mongodb/backup/kubestash/logical/standalone/index.md index d364622dd2..13a5f0f4af 100644 --- a/docs/guides/mongodb/backup/kubestash/logical/standalone/index.md +++ b/docs/guides/mongodb/backup/kubestash/logical/standalone/index.md @@ -21,7 +21,7 @@ KubeStash v0.1.0+ supports backup and restoration of MongoDB databases. This gui - Install KubeDB in your cluster following the steps [here](/docs/setup/README.md). - Install KubeStash Enterprise in your cluster following the steps [here(link needed)](). - Install KubeStash `kubectl` plugin following the steps [here(link needed)](). -- If you are not familiar with how KubeStash backup and restore MongoDB databases, please check the following guide [here](/docs/guides/mongodb/backup/kubestash/overview/_index.md). +- If you are not familiar with how KubeStash backup and restore MongoDB databases, please check the following guide [here](/docs/guides/mongodb/backup/kubestash/overview/index.md). You have to be familiar with following custom resources: @@ -196,7 +196,7 @@ spec: bucket: kubestash-testing region: us-east-1 prefix: demo - secret: s3-secret + secretName: s3-secret usagePolicy: allowedNamespaces: from: All @@ -277,18 +277,20 @@ spec: name: s3-storage retentionPolicy: name: backup-rp - namespace: demo + namespace: demo sessions: - name: frequent scheduler: + jobTemplate: + backoffLimit: 1 schedule: "*/3 * * * *" repositories: - name: s3-repo backend: s3-backend directory: /mongodb encryptionSecret: - name: encry-secret - namespace: demo + name: encry-secret + namespace: demo addon: name: mongodb-addon tasks: diff --git a/docs/guides/mongodb/backup/kubestash/overview/index.md b/docs/guides/mongodb/backup/kubestash/overview/index.md index bfde3cd482..498cc659a5 100644 --- a/docs/guides/mongodb/backup/kubestash/overview/index.md +++ b/docs/guides/mongodb/backup/kubestash/overview/index.md @@ -158,8 +158,8 @@ For MongoDB sharded cluster, KubeStash identifies the primary replica of each sh ## Next Steps -- Backup a standalone MongoDB databases using KubeStash following the guide from [here](/docs/guides/mongodb/backup/kubestash/logical/standalone/_index.md). -- Backup a MongoDB Replicaset cluster using Stash following the guide from [here](/docs/guides/mongodb/backup/kubestash/logical/replicaset/_index.md). -- Backup a sharded MongoDB cluster using KubeStash following the guide from [here](/docs/guides/mongodb/backup/kubestash/logical/sharding/_index.md). +- Backup a standalone MongoDB databases using KubeStash following the guide from [here](/docs/guides/mongodb/backup/kubestash/logical/standalone/index.md). +- Backup a MongoDB Replicaset cluster using Stash following the guide from [here](/docs/guides/mongodb/backup/kubestash/logical/replicaset/index.md). +- Backup a sharded MongoDB cluster using KubeStash following the guide from [here](/docs/guides/mongodb/backup/kubestash/logical/sharding/index.md).