diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 2da3c5a..f9aa00b 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -34,7 +34,7 @@ jobs: - name: Check links run: | - liche -r docs -d $(pwd) -c 10 -p -h -l -x '^(.*/docs/{{<.*>}}/.*|.*github.com.*|.*api.slack.com.*|.*askapache.com.*|.*twitter.com.*|.*dev.mysql.com.*|.*linux.die.net.*|.*helm.sh.*|.*aws.amazon.com.*|.*kind.sigs.k8s.io.*)$' + liche -r docs -d $(pwd) -c 10 -p -h -l -x '^(.*/docs/{{<.*>}}/.*|.*github.com.*|.*api.slack.com.*|.*askapache.com.*|.*twitter.com.*|.*dev.mysql.com.*|.*linux.die.net.*|.*helm.sh.*|.*aws.amazon.com.*|.*kind.sigs.k8s.io.*|.*git.k8s.io.*)$' - name: Create Kubernetes cluster id: kind diff --git a/docs/addons/elasticsearch/logical/index.md b/docs/addons/elasticsearch/logical/index.md index 17a86a6..4685f8a 100644 --- a/docs/addons/elasticsearch/logical/index.md +++ b/docs/addons/elasticsearch/logical/index.md @@ -25,19 +25,19 @@ This guide will give you how you can take backup and restore your externally man - 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-kubestash-catalog` in your cluster following the steps [here](https://github.com/kubedb/installer/tree/master/charts/kubedb-kubestash-catalog). - Install `KubeStash` in your cluster following the steps [here](/docs/setup/install/kubestash/). -- Install KubeStash `kubectl` plugin following the steps [here](https://kubestash.com/docs/latest/setup/install/kubectl-plugin/). +- Install KubeStash `kubectl` plugin following the steps [here](/docs/setup/install/kubectl-plugin/). - If you are not familiar with how KubeStash backup and restore Elasticsearch databases, please check the following guide [here](/docs/addons/elasticsearch/overview/index.md). You should be familiar with the following `KubeStash` concepts: -- [BackupStorage](https://kubestash.com/docs/latest/concepts/crds/backupstorage/) -- [BackupConfiguration](https://kubestash.com/docs/latest/concepts/crds/backupconfiguration/) +- [BackupStorage](/docs/concepts/crds/backupstorage/) +- [BackupConfiguration](/docs/concepts/crds/backupconfiguration/) - [AppBinding](https://kubedb.com/docs/v2024.9.30/guides/elasticsearch/concepts/appbinding/) -- [BackupSession](https://kubestash.com/docs/latest/concepts/crds/backupsession/) -- [RestoreSession](https://kubestash.com/docs/latest/concepts/crds/restoresession/) -- [Addon](https://kubestash.com/docs/latest/concepts/crds/addon/) -- [Function](https://kubestash.com/docs/latest/concepts/crds/function/) -- [Task](https://kubestash.com/docs/latest/concepts/crds/addon/#task-specification) +- [BackupSession](/docs/concepts/crds/backupsession/) +- [RestoreSession](/docs/concepts/crds/restoresession/) +- [Addon](/docs/concepts/crds/addon/) +- [Function](/docs/concepts/crds/function/) +- [Task](/docs/concepts/crds/addon/#task-specification) To keep everything isolated, we are going to use a separate namespace called `demo` throughout this tutorial. @@ -142,7 +142,7 @@ Now, we are ready to backup the database. ### Prepare Backend -We are going to store our backed up data into a GCS bucket. We have to create a Secret with necessary credentials and a `BackupStorage` CR to use this backend. 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/). +We are going to store our backed up data into a GCS bucket. We have to create a Secret with necessary credentials and a `BackupStorage` CR to use this backend. If you want to use a different backend, please read the respective backend configuration doc from [here](/docs/guides/backends/overview/). **Create Secret:** diff --git a/docs/addons/mariadb/logical/index.md b/docs/addons/mariadb/logical/index.md index b94124a..5007dd5 100644 --- a/docs/addons/mariadb/logical/index.md +++ b/docs/addons/mariadb/logical/index.md @@ -25,19 +25,19 @@ This guide will give you how you can take backup and restore your externally man - 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-kubestash-catalog` in your cluster following the steps [here](https://github.com/kubedb/installer/tree/master/charts/kubedb-kubestash-catalog). - Install `KubeStash` in your cluster following the steps [here](/docs/setup/install/kubestash/). -- Install KubeStash `kubectl` plugin following the steps [here](https://kubestash.com/docs/latest/setup/install/kubectl-plugin/). +- Install KubeStash `kubectl` plugin following the steps [here](/docs/setup/install/kubectl-plugin/). - If you are not familiar with how KubeStash backup and restore MariaDB databases, please check the following guide [here](/docs/addons/mariadb/overview/index.md). You should be familiar with the following `KubeStash` concepts: -- [BackupStorage](https://kubestash.com/docs/latest/concepts/crds/backupstorage/) -- [BackupConfiguration](https://kubestash.com/docs/latest/concepts/crds/backupconfiguration/) +- [BackupStorage](/docs/concepts/crds/backupstorage/) +- [BackupConfiguration](/docs/concepts/crds/backupconfiguration/) - [AppBinding](https://kubedb.com/docs/v2024.9.30/guides/mariadb/concepts/appbinding/) -- [BackupSession](https://kubestash.com/docs/latest/concepts/crds/backupsession/) -- [RestoreSession](https://kubestash.com/docs/latest/concepts/crds/restoresession/) -- [Addon](https://kubestash.com/docs/latest/concepts/crds/addon/) -- [Function](https://kubestash.com/docs/latest/concepts/crds/function/) -- [Task](https://kubestash.com/docs/latest/concepts/crds/addon/#task-specification) +- [BackupSession](/docs/concepts/crds/backupsession/) +- [RestoreSession](/docs/concepts/crds/restoresession/) +- [Addon](/docs/concepts/crds/addon/) +- [Function](/docs/concepts/crds/function/) +- [Task](/docs/concepts/crds/addon/#task-specification) To keep everything isolated, we are going to use a separate namespace called `demo` throughout this tutorial. @@ -232,7 +232,7 @@ Now, we are ready to backup the database. ### Prepare Backend -We are going to store our backed up data into a GCS bucket. We have to create a Secret with necessary credentials and a `BackupStorage` CR to use this backend. 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/). +We are going to store our backed up data into a GCS bucket. We have to create a Secret with necessary credentials and a `BackupStorage` CR to use this backend. If you want to use a different backend, please read the respective backend configuration doc from [here](/docs/guides/backends/overview/). **Create Secret:** diff --git a/docs/addons/mysql/logical/index.md b/docs/addons/mysql/logical/index.md index 3381a86..00a0298 100644 --- a/docs/addons/mysql/logical/index.md +++ b/docs/addons/mysql/logical/index.md @@ -25,19 +25,19 @@ This guide will give you how you can take backup and restore your externally man - 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-kubestash-catalog` in your cluster following the steps [here](https://github.com/kubedb/installer/tree/master/charts/kubedb-kubestash-catalog). - Install `KubeStash` in your cluster following the steps [here](/docs/setup/install/kubestash/). -- Install KubeStash `kubectl` plugin following the steps [here](https://kubestash.com/docs/latest/setup/install/kubectl-plugin/). +- Install KubeStash `kubectl` plugin following the steps [here](/docs/setup/install/kubectl-plugin/). - If you are not familiar with how KubeStash backup and restore MySQL databases, please check the following guide [here](/docs/addons/mysql/overview/index.md). You should be familiar with the following `KubeStash` concepts: -- [BackupStorage](https://kubestash.com/docs/latest/concepts/crds/backupstorage/) -- [BackupConfiguration](https://kubestash.com/docs/latest/concepts/crds/backupconfiguration/) +- [BackupStorage](/docs/concepts/crds/backupstorage/) +- [BackupConfiguration](/docs/concepts/crds/backupconfiguration/) - [AppBinding](https://kubedb.com/docs/v2024.9.30/guides/mysql/concepts/appbinding/) -- [BackupSession](https://kubestash.com/docs/latest/concepts/crds/backupsession/) -- [RestoreSession](https://kubestash.com/docs/latest/concepts/crds/restoresession/) -- [Addon](https://kubestash.com/docs/latest/concepts/crds/addon/) -- [Function](https://kubestash.com/docs/latest/concepts/crds/function/) -- [Task](https://kubestash.com/docs/latest/concepts/crds/addon/#task-specification) +- [BackupSession](/docs/concepts/crds/backupsession/) +- [RestoreSession](/docs/concepts/crds/restoresession/) +- [Addon](/docs/concepts/crds/addon/) +- [Function](/docs/concepts/crds/function/) +- [Task](/docs/concepts/crds/addon/#task-specification) To keep everything isolated, we are going to use a separate namespace called `demo` throughout this tutorial. @@ -173,7 +173,7 @@ Now, we are ready to backup the database. ### Prepare Backend -We are going to store our backed up data into a GCS bucket. We have to create a Secret with necessary credentials and a `BackupStorage` CR to use this backend. 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/). +We are going to store our backed up data into a GCS bucket. We have to create a Secret with necessary credentials and a `BackupStorage` CR to use this backend. If you want to use a different backend, please read the respective backend configuration doc from [here](/docs/guides/backends/overview/). **Create Secret:** diff --git a/docs/addons/postgres/logical/index.md b/docs/addons/postgres/logical/index.md index 052520f..6877143 100644 --- a/docs/addons/postgres/logical/index.md +++ b/docs/addons/postgres/logical/index.md @@ -26,19 +26,19 @@ This guide will give you how you can take backup and restore your externally man - 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-kubestash-catalog` in your cluster following the steps [here](https://github.com/kubedb/installer/tree/master/charts/kubedb-kubestash-catalog). - Install `KubeStash` in your cluster following the steps [here](/docs/setup/install/kubestash/). -- Install KubeStash `kubectl` plugin following the steps [here](https://kubestash.com/docs/latest/setup/install/kubectl-plugin/). +- Install KubeStash `kubectl` plugin following the steps [here](/docs/setup/install/kubectl-plugin/). - If you are not familiar with how KubeStash backup and restore PostgreSQL databases, please check the following guide [here](/docs/addons/postgres/overview/index.md). You should be familiar with the following `KubeStash` concepts: -- [BackupStorage](https://kubestash.com/docs/latest/concepts/crds/backupstorage/) -- [BackupConfiguration](https://kubestash.com/docs/latest/concepts/crds/backupconfiguration/) +- [BackupStorage](/docs/concepts/crds/backupstorage/) +- [BackupConfiguration](/docs/concepts/crds/backupconfiguration/) - [AppBinding](https://kubedb.com/docs/v2024.9.30/guides/postgres/concepts/appbinding/) -- [BackupSession](https://kubestash.com/docs/latest/concepts/crds/backupsession/) -- [RestoreSession](https://kubestash.com/docs/latest/concepts/crds/restoresession/) -- [Addon](https://kubestash.com/docs/latest/concepts/crds/addon/) -- [Function](https://kubestash.com/docs/latest/concepts/crds/function/) -- [Task](https://kubestash.com/docs/latest/concepts/crds/addon/#task-specification) +- [BackupSession](/docs/concepts/crds/backupsession/) +- [RestoreSession](/docs/concepts/crds/restoresession/) +- [Addon](/docs/concepts/crds/addon/) +- [Function](/docs/concepts/crds/function/) +- [Task](/docs/concepts/crds/addon/#task-specification) To keep everything isolated, we are going to use a separate namespace called `demo` throughout this tutorial. @@ -194,7 +194,7 @@ Now, we are ready to backup the database. ### Prepare Backend -We are going to store our backed up data into a GCS bucket. We have to create a Secret with necessary credentials and a `BackupStorage` CR to use this backend. 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/). +We are going to store our backed up data into a GCS bucket. We have to create a Secret with necessary credentials and a `BackupStorage` CR to use this backend. If you want to use a different backend, please read the respective backend configuration doc from [here](/docs/guides/backends/overview/). **Create Secret:** diff --git a/docs/guides/use-cases/customize-backup-restore/index.md b/docs/guides/use-cases/customize-backup-restore/index.md index f482506..c6aba4f 100644 --- a/docs/guides/use-cases/customize-backup-restore/index.md +++ b/docs/guides/use-cases/customize-backup-restore/index.md @@ -489,4 +489,4 @@ spec: - name: logical-backup-restore ``` -> Note: You can configure additional runtime settings for restore jobs within the `addon.jobTemplate.spec` sections. For further details, please refer to the [reference](https://kubestash.com/docs/v2025.3.24/concepts/crds/restoresession/#podtemplate-spec). \ No newline at end of file +> Note: You can configure additional runtime settings for restore jobs within the `addon.jobTemplate.spec` sections. For further details, please refer to the [reference](/docs/concepts/crds/restoresession/#podtemplate-spec). \ No newline at end of file