Skip to content

Commit

Permalink
update links
Browse files Browse the repository at this point in the history
Signed-off-by: sayedppqq <[email protected]>
  • Loading branch information
sayedppqq committed Sep 16, 2024
1 parent ef5f103 commit a3c33f4
Show file tree
Hide file tree
Showing 6 changed files with 31 additions and 33 deletions.
4 changes: 2 additions & 2 deletions docs/guides/mongodb/backup/kubestash/auto-backup/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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

Expand Down
4 changes: 1 addition & 3 deletions docs/guides/mongodb/backup/kubestash/customization/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
14 changes: 7 additions & 7 deletions docs/guides/mongodb/backup/kubestash/logical/replicaset/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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:**

Expand Down
14 changes: 7 additions & 7 deletions docs/guides/mongodb/backup/kubestash/logical/sharding/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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:**

Expand Down
14 changes: 7 additions & 7 deletions docs/guides/mongodb/backup/kubestash/logical/standalone/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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:**

Expand Down
14 changes: 7 additions & 7 deletions docs/guides/mongodb/backup/kubestash/overview/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ For MongoDB ReplicaSet cluster, KubeStash takes backup from one of the secondary
4. Unlock the secondary replica.

<figure align="center">
<img alt="MongoDB ReplicaSet Cluster Backup Overview" src="/docs/guides/mongodb/backup/stash/overview/images/replicaset_backup.svg">
<img alt="MongoDB ReplicaSet Cluster Backup Overview" src="/docs/guides/mongodb/backup/kubestash/overview/images/replicaset_backup.svg">
<figcaption align="center">Fig: MongoDB ReplicaSet Cluster Backup</figcaption>
</figure>

Expand All @@ -96,7 +96,7 @@ For MongoDB sharded cluster, KubeStash takes backup of the individual shards as
8. Enable balancer.

<figure align="center">
<img alt="MongoDB Sharded Cluster Backup Overview" src="/docs/guides/mongodb/backup/stash/overview/images/sharded_backup.svg">
<img alt="MongoDB Sharded Cluster Backup Overview" src="/docs/guides/mongodb/backup/kubestash/overview/images/sharded_backup.svg">
<figcaption align="center">Fig: MongoDB Sharded Cluster Backup</figcaption>
</figure>

Expand All @@ -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.

<figure align="center">
<img alt="Database Restore Overview" src="/docs/guides/mongodb/backup/stash/overview/images/restore_overview.svg">
<img alt="Database Restore Overview" src="/docs/guides/mongodb/backup/kubestash/overview/images/restore_overview.svg">
<figcaption align="center">Fig: MongoDB Restore Process Overview</figcaption>
</figure>

Expand Down Expand Up @@ -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.

<figure align="center">
<img alt="Standalone MongoDB Restore Overview" src="/docs/guides/mongodb/backup/stash/overview/images/standalone_restore.svg">
<img alt="Standalone MongoDB Restore Overview" src="/docs/guides/mongodb/backup/kubestash/overview/images/standalone_restore.svg">
<figcaption align="center">Fig: Standalone MongoDB Restore</figcaption>
</figure>

Expand All @@ -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.

<figure align="center">
<img alt="MongoDB ReplicaSet Cluster Restore Overview" src="/docs/guides/mongodb/backup/stash/overview/images/replicaset_restore.svg">
<img alt="MongoDB ReplicaSet Cluster Restore Overview" src="/docs/guides/mongodb/backup/kubestash/overview/images/replicaset_restore.svg">
<figcaption align="center">Fig: MongoDB ReplicaSet Cluster Restore</figcaption>
</figure>

Expand All @@ -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.

<figure align="center">
<img alt="MongoDB Sharded Cluster Restore" src="/docs/guides/mongodb/backup/stash/overview/images/sharded_restore.svg">
<img alt="MongoDB Sharded Cluster Restore" src="/docs/guides/mongodb/backup/kubestash/overview/images/sharded_restore.svg">
<figcaption align="center">Fig: MongoDB Sharded Cluster Restore</figcaption>
</figure>

## 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).


0 comments on commit a3c33f4

Please sign in to comment.