diff --git a/docs/guides/mongodb/backup/kubestash/auto-backup/index.md b/docs/guides/mongodb/backup/kubestash/auto-backup/index.md index 523c098d3..63a9d4028 100644 --- a/docs/guides/mongodb/backup/kubestash/auto-backup/index.md +++ b/docs/guides/mongodb/backup/kubestash/auto-backup/index.md @@ -47,7 +47,7 @@ namespace/demo created So we can also take backup any MongoDB database of any namespace just by adding few annotations to our MongoDB CRD. Then, KubeStash will automatically create a `BackupConfiguration` according to the template to backup the database. -We are going to store our backed up data into a S3 bucket. At first, we need to create a secret with S3 credentials then we need to create a `BackupStorage` crd. If you want to use a different backend, please read the respective backend configuration doc from [here](https://stash.run/docs/latest/guides/backends/overview/). +We are going to store our backed up data into a S3 bucket. At first, we need to create a secret with S3 credentials then we need to create a `BackupStorage` crd. If you want to use a different backend, please read the respective backend configuration doc from [here](https://kubestash.com/docs/latest/guides/backends/overview/). ### Create Storage Secret: @@ -181,7 +181,7 @@ Let's create the `BackupBlueprint` we have shown above, backupblueprint.core.kubestash.com/sample-blueprint created ``` -Now, we are ready to backup our MongoDB databases using few annotations. You can check available auto-backup annotations for a databases from [here](https://stash.run/docs/latest/guides/auto-backup/database/#available-auto-backup-annotations-for-database). +Now, we are ready to backup our `MongoDB` databases using few annotations. ### Create Database diff --git a/docs/guides/mongodb/backup/kubestash/customization/index.md b/docs/guides/mongodb/backup/kubestash/customization/index.md index c73eb267f..6741c8f72 100644 --- a/docs/guides/mongodb/backup/kubestash/customization/index.md +++ b/docs/guides/mongodb/backup/kubestash/customization/index.md @@ -208,9 +208,7 @@ demo s3-repo-mg-frequent-1702291682 s3-repo frequent 2023-12-11T demo s3-repo-mg-frequent-1702291685 s3-repo frequent 2023-12-11T10:49:10Z Delete Succeeded 82m ``` ->You can also filter the snapshots as shown in the guide [here](https://stash.run/docs/latest/concepts/crds/snapshot/#working-with-snapshot). - -The below example shows how you can pass a specific snapshot id through the `snapshots` filed of `rules` section. +The below example shows how you can pass a specific snapshot id through the `snapshots` filed of `spec.dataSource` section. ```yaml apiVersion: core.kubestash.com/v1alpha1 diff --git a/docs/guides/mongodb/backup/kubestash/logical/replicaset/index.md b/docs/guides/mongodb/backup/kubestash/logical/replicaset/index.md index 6c19a3e68..b63a6feca 100644 --- a/docs/guides/mongodb/backup/kubestash/logical/replicaset/index.md +++ b/docs/guides/mongodb/backup/kubestash/logical/replicaset/index.md @@ -19,17 +19,17 @@ KubeStash v0.1.0+ supports backup and restoration of MongoDB databases. This gui - 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. - 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)](). +- Install KubeStash Enterprise 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 have to be familiar with following custom resources: - [AppBinding](/docs/guides/mongodb/concepts/appbinding.md) -- [Function](https://stash.run/docs/latest/concepts/crds/function/) -- [Task](https://stash.run/docs/latest/concepts/crds/task/) -- [BackupConfiguration](https://stash.run/docs/latest/concepts/crds/backupconfiguration/) -- [RestoreSession](https://stash.run/docs/latest/concepts/crds/restoresession/) +- [Function](https://kubestash.com/docs/latest/concepts/crds/function/) +- [Addon](https://kubestash.com/docs/latest/concepts/crds/addon/) +- [BackupConfiguration](https://kubestash.com/docs/latest/concepts/crds/backupconfiguration/) +- [RestoreSession](https://kubestash.com/docs/latest/concepts/crds/restoresession/) 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. @@ -169,7 +169,7 @@ Now, we are ready to backup this sample database. ### Prepare Backend -We are going to store our backed up data into a S3 bucket. At first, we need to create a secret with S3 credentials then we need to create a `BackupStorage` crd. If you want to use a different backend, please read the respective backend configuration doc from [here](https://stash.run/docs/latest/guides/backends/overview/). +We are going to store our backed up data into a S3 bucket. At first, we need to create a secret with S3 credentials then we need to create a `BackupStorage` crd. If you want to use a different backend, please read the respective backend configuration doc from [here](https://kubestash.com/docs/latest/guides/backends/overview/). **Create Storage Secret:** diff --git a/docs/guides/mongodb/backup/kubestash/logical/sharding/index.md b/docs/guides/mongodb/backup/kubestash/logical/sharding/index.md index fbfcca36e..b65f6e4c7 100644 --- a/docs/guides/mongodb/backup/kubestash/logical/sharding/index.md +++ b/docs/guides/mongodb/backup/kubestash/logical/sharding/index.md @@ -19,17 +19,17 @@ KubeStash v0.1.0+ supports backup and restoration of MongoDB databases. This gui - 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. - 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)](). +- Install KubeStash Enterprise 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 have to be familiar with following custom resources: - [AppBinding](/docs/guides/mongodb/concepts/appbinding.md) -- [Function](https://stash.run/docs/latest/concepts/crds/function/) -- [Task](https://stash.run/docs/latest/concepts/crds/task/) -- [BackupConfiguration](https://stash.run/docs/latest/concepts/crds/backupconfiguration/) -- [RestoreSession](https://stash.run/docs/latest/concepts/crds/restoresession/) +- [Function](https://kubestash.com/docs/latest/concepts/crds/function/) +- [Addon](https://kubestash.com/docs/latest/concepts/crds/addon/) +- [BackupConfiguration](https://kubestash.com/docs/latest/concepts/crds/backupconfiguration/) +- [RestoreSession](https://kubestash.com/docs/latest/concepts/crds/restoresession/) 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. @@ -177,7 +177,7 @@ Now, we are ready to backup this sample database. ### Prepare Backend -We are going to store our backed up data into a S3 bucket. At first, we need to create a secret with S3 credentials then we need to create a `BackupStorage` crd. If you want to use a different backend, please read the respective backend configuration doc from [here](https://stash.run/docs/latest/guides/backends/overview/). +We are going to store our backed up data into a S3 bucket. At first, we need to create a secret with S3 credentials then we need to create a `BackupStorage` crd. If you want to use a different backend, please read the respective backend configuration doc from [here](https://kubestash.com/docs/latest/guides/backends/overview/). **Create Storage Secret:** diff --git a/docs/guides/mongodb/backup/kubestash/logical/standalone/index.md b/docs/guides/mongodb/backup/kubestash/logical/standalone/index.md index 13a5f0f4a..e9e482b92 100644 --- a/docs/guides/mongodb/backup/kubestash/logical/standalone/index.md +++ b/docs/guides/mongodb/backup/kubestash/logical/standalone/index.md @@ -19,17 +19,17 @@ KubeStash v0.1.0+ supports backup and restoration of MongoDB databases. This gui - 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. - 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)](). +- Install KubeStash Enterprise 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 have to be familiar with following custom resources: - [AppBinding](/docs/guides/mongodb/concepts/appbinding.md) -- [Function](https://stash.run/docs/latest/concepts/crds/function/) -- [Task](https://stash.run/docs/latest/concepts/crds/task/) -- [BackupConfiguration](https://stash.run/docs/latest/concepts/crds/backupconfiguration/) -- [RestoreSession](https://stash.run/docs/latest/concepts/crds/restoresession/) +- [Function](https://kubestash.com/docs/latest/concepts/crds/function/) +- [Addon](https://kubestash.com/docs/latest/concepts/crds/addon/) +- [BackupConfiguration](https://kubestash.com/docs/latest/concepts/crds/backupconfiguration/) +- [RestoreSession](https://kubestash.com/docs/latest/concepts/crds/restoresession/) 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. @@ -163,7 +163,7 @@ Now, we are ready to backup this sample database. ### Prepare Backend -We are going to store our backed up data into a S3 bucket. At first, we need to create a secret with S3 credentials then we need to create a `BackupStorage` crd. If you want to use a different backend, please read the respective backend configuration doc from [here](https://stash.run/docs/latest/guides/backends/overview/). +We are going to store our backed up data into a S3 bucket. At first, we need to create a secret with S3 credentials then we need to create a `BackupStorage` crd. If you want to use a different backend, please read the respective backend configuration doc from [here](https://kubestash.com/docs/latest/guides/backends/overview/). **Create Storage Secret:** diff --git a/docs/guides/mongodb/backup/kubestash/overview/index.md b/docs/guides/mongodb/backup/kubestash/overview/index.md index 498cc659a..949f34965 100644 --- a/docs/guides/mongodb/backup/kubestash/overview/index.md +++ b/docs/guides/mongodb/backup/kubestash/overview/index.md @@ -78,7 +78,7 @@ For MongoDB ReplicaSet cluster, KubeStash takes backup from one of the secondary 4. Unlock the secondary replica.
- MongoDB ReplicaSet Cluster Backup Overview + MongoDB ReplicaSet Cluster Backup Overview
Fig: MongoDB ReplicaSet Cluster Backup
@@ -96,7 +96,7 @@ For MongoDB sharded cluster, KubeStash takes backup of the individual shards as 8. Enable balancer.
- MongoDB Sharded Cluster Backup Overview + MongoDB Sharded Cluster Backup Overview
Fig: MongoDB Sharded Cluster Backup
@@ -105,7 +105,7 @@ For MongoDB sharded cluster, KubeStash takes backup of the individual shards as The following diagram shows how KubeStash restores backed up data into a MongoDB database. Open the image in a new tab to see the enlarged version.
- Database Restore Overview + Database Restore Overview
Fig: MongoDB Restore Process Overview
@@ -134,7 +134,7 @@ This section will show you restore process works for different MongoDB configura For a standalone MongoDB database, the restore job downloads the backed up data from the backend and pipe the downloaded data to `mongorestore` command which inserts the data into the desired MongoDB database.
- Standalone MongoDB Restore Overview + Standalone MongoDB Restore Overview
Fig: Standalone MongoDB Restore
@@ -143,7 +143,7 @@ For a standalone MongoDB database, the restore job downloads the backed up data For MongoDB ReplicaSet cluster, KubeStash identifies the primary replica and restore into it.
- MongoDB ReplicaSet Cluster Restore Overview + MongoDB ReplicaSet Cluster Restore Overview
Fig: MongoDB ReplicaSet Cluster Restore
@@ -152,14 +152,14 @@ For MongoDB ReplicaSet cluster, KubeStash identifies the primary replica and res For MongoDB sharded cluster, KubeStash identifies the primary replica of each shard as well as the config server and restore respective backed up data into them.
- MongoDB Sharded Cluster Restore + MongoDB Sharded Cluster Restore
Fig: MongoDB Sharded Cluster Restore
## 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 MongoDB Replicaset cluster using KubeStash 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).