Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: merge docs/api_docs/install into docs/user_docs/ #8109

Merged
merged 2 commits into from
Sep 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ This tutorial shows how to create and connect to an ApeCloud MySQL cluster.

### Before you start

* [Install KubeBlocks](./../../installation/install-kubeblocks.md).
* Make sure the `apecloud-mysql` cluster definition is installed. If the cluster definition is not available, refer to [this doc](./../../installation/install-addons.md) to enable it first.
* [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).
* Make sure the `apecloud-mysql` cluster definition is installed. If the cluster definition is not available, refer to [this doc](../../../user_docs/installation/install-with-helm/install-addons.md) to enable it first.

```bash
kubectl get clusterdefinition apecloud-mysql
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ But it's also important to note that the dynamic parameter configuration doesn't

## Before you start

1. [Install KubeBlocks](./../../installation/install-kubeblocks.md).
1. [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).
2. [Create an ApeCloud MySQL cluster](./../cluster-management/create-and-connect-an-apecloud-mysql-cluster.md).

## Configure cluster parameters by editing configuration file
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The faults here are all simulated by deleting pods. When there are sufficient re

### Before you start

* [Install KubeBlocks](./../../installation/install-kubeblocks.md).
* [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).
* [Create an ApeCloud MySQL RaftGroup Cluster](./../cluster-management/create-and-connect-an-apecloud-mysql-cluster.md).
* Run `kubectl get cd apecloud-mysql -o yaml` to check whether _rolechangedprobe_ is enabled in the ApeCloud MySQL RaftGroup Cluster (it is enabled by default). If the following configuration exists, it indicates that it is enabled:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import TabItem from '@theme/TabItem';

## Before you start

1. [Install KubeBlocks](./../../installation/install-kubeblocks.md).
1. [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).
2. Prepare an ApeCloud MySQL RaftGroup named `mycluster` for demonstrating how to enable the proxy function for an existing cluster. Refer to [Create a MySQL cluster](./../cluster-management/create-and-connect-an-apecloud-mysql-cluster.md) for details.

## Create a Proxy Cluster
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ KubeBlocks supports the management of Elasticsearch. This tutorial illustrates h

## Before you start

* [Install KubeBlocks](./../installation/install-kubeblocks.md).
* [Install KubeBlocks](../../user_docs/installation/install-with-helm/install-kubeblocks.md).
* View all the database types and versions available for creating a cluster.

Make sure the `elasticsearch` cluster definition is installed. If the cluster definition is not available, refer to [this doc](./../installation/install-addons.md) to enable it first.
Make sure the `elasticsearch` cluster definition is installed. If the cluster definition is not available, refer to [this doc](../../user_docs/installation/install-with-helm/install-addons.md) to enable it first.

```bash
kubectl get clusterdefinition elasticsearch
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ This document shows how to create a Kafka cluster by `kubectl` or a YAML file.

## Before you start

* [Install KubeBlocks](./../../installation/install-kubeblocks.md).
* [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).
* View all the database types and versions available for creating a cluster.

Make sure the `kafka` cluster definition is installed. If the cluster definition is not available, refer to [this doc](./../../installation/install-addons.md) to enable it first.
Make sure the `kafka` cluster definition is installed. If the cluster definition is not available, refer to [this doc](../../../user_docs/installation/install-with-helm/install-addons.md) to enable it first.

```bash
kubectl get clusterdefinition kafka
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This guide shows how to configure cluster parameters.

## Before you start

1. [Install KubeBlocks](./../../installation/install-kubeblocks.md).
1. [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).
2. [Create a Kafka cluster](./../cluster-management/create-a-kafka-cluster.md).

## Configure cluster parameters by editing configuration file
Expand Down
4 changes: 2 additions & 2 deletions docs/api_docs/kubeblocks-for-milvus/manage-milvus.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ This tutorial illustrates how to create and manage a Milvus cluster by `kubectl`

## Before you start

* [Install KubeBlocks](./../installation/install-kubeblocks.md).
* [Install KubeBlocks](../../user_docs/installation/install-with-helm/install-kubeblocks.md).
* View all the database types and versions available for creating a cluster.

Make sure the `milvus` cluster definition is installed. If the cluster definition is not available, refer to [this doc](./../installation/install-addons.md) to enable it first.
Make sure the `milvus` cluster definition is installed. If the cluster definition is not available, refer to [this doc](../../user_docs/installation/install-with-helm/install-addons.md) to enable it first.

```bash
kubectl get clusterdefinition milvus
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ This tutorial shows how to create and connect to a MongoDB cluster.

### Before you start

* [Install KubeBlocks](./../../installation/install-kubeblocks.md).
* [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).

* View all the database types and versions available for creating a cluster.

Make sure the `mongodb` cluster definition is installed. If the cluster definition is not available, refer to [this doc](./../../installation/install-addons.md) to enable it first.
Make sure the `mongodb` cluster definition is installed. If the cluster definition is not available, refer to [this doc](../../../user_docs/installation/install-with-helm/install-addons.md) to enable it first.

```bash
kubectl get clusterdefinition mongodb
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This guide shows how to configure cluster parameters.

## Before you start

1. [Install KubeBlocks](./../../installation/install-kubeblocks.md).
1. [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).
2. [Create a MongoDB cluster](./../cluster-management/create-and-connect-to-a-mongodb-cluster.md).

## Configure cluster parameters by configuration file
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ This tutorial shows how to create and connect to a MySQL cluster.

### Before you start

* [Install KubeBlocks](./../../installation/install-kubeblocks.md).
* [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).
* View all the database types and versions available for creating a cluster.

* Make sure the `mysql` cluster definition is installed. If the cluster definition is not available, refer to [this doc](./../../installation/install-addons.md) to enable it first.
* Make sure the `mysql` cluster definition is installed. If the cluster definition is not available, refer to [this doc](../../../user_docs/installation/install-with-helm/install-addons.md) to enable it first.

```bash
kubectl get clusterdefinition mysql
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ But it's also important to note that the dynamic parameter configuration doesn't

## Before you start

1. [Install KubeBlocks](./../../installation/install-kubeblocks.md).
1. [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).
2. [Create a MySQL cluster](./../cluster-management/create-and-connect-a-mysql-cluster.md).

## Configure cluster parameters by editing configuration file
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The faults here are all simulated by deleting pods. When there are sufficient re

### Before you start

* [Install KubeBlocks](./../../installation/install-kubeblocks.md).
* [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).
* [Create a MySQL Replication Cluster](./../cluster-management/create-and-connect-a-mysql-cluster.md).
* Run `kubectl get cd mysql -o yaml` to check whether _rolechangedprobe_ is enabled in the MySQL Replication Cluster (it is enabled by default). If the following configuration exists, it indicates that it is enabled:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ This tutorial shows how to create and connect to a PostgreSQL cluster.

### Before you start

* [Install KubeBlocks](./../../installation/install-kubeblocks.md).
* [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).
* View all the database types and versions available for creating a cluster.

Make sure the `postgresql` cluster definition is installed. If the cluster definition is not available, refer to [this doc](./../../installation/install-addons.md) to enable it first.
Make sure the `postgresql` cluster definition is installed. If the cluster definition is not available, refer to [this doc](../../../user_docs/installation/install-with-helm/install-addons.md) to enable it first.

```bash
kubectl get clusterdefinition postgresql
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ But it's also important to note that the dynamic parameter configuration doesn't

## Before you start

1. [Install KubeBlocks](./../../installation/install-kubeblocks.md).
1. [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).
2. [Create a PostgreSQL cluster](./../cluster-management/create-and-connect-a-postgresql-cluster.md).

## Configure cluster parameters by editing configuration file
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ KubeBlocks integrates [the open-source Patroni solution](https://patroni.readthe

## Before you start

* [Install KubeBlocks](./../../installation/install-kubeblocks.md).
* [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).
* [Create a PostgreSQL Replication Cluster](./../cluster-management/create-and-connect-a-postgresql-cluster.md#create-a-postgresql-cluster).
* Check whether the following role probe parameters exist to verify the role probe is enabled.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ Refer to the [Pulsar official document](https://pulsar.apache.org/docs/3.1.x/) f

## Before you start

* [Install KubeBlocks](./../../installation/install-kubeblocks.md).
* [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).

* View all the database types and versions available for creating a cluster.

Make sure the `pulsar` cluster definition is installed. If the cluster definition is not available, refer to [this doc](./../../installation/install-addons.md) to enable it first.
Make sure the `pulsar` cluster definition is installed. If the cluster definition is not available, refer to [this doc](../../../user_docs/installation/install-with-helm/install-addons.md) to enable it first.

```bash
kubectl get clusterdefinition redis
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ For Pulsar, there are 3 types of parameters:

## Before you start

1. [Install KubeBlocks](./../../installation/install-kubeblocks.md).
1. [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).
2. [Create a Pulsar cluster](./../cluster-management/create-pulsar-cluster-on-kubeblocks.md).

## Configure cluster parameters by configuration file
Expand Down
4 changes: 2 additions & 2 deletions docs/api_docs/kubeblocks-for-qdrant/manage-qdrant.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ In this chapter, we take Qdrant as an example to show how to manage vector datab

## Before you start

* [Install KubeBlocks](./../installation/install-kubeblocks.md).
* [Install KubeBlocks](../../user_docs/installation/install-with-helm/install-kubeblocks.md).
* View all the database types and versions available for creating a cluster.

Make sure the `qdrant` cluster definition is installed. If the cluster definition is not available, refer to [this doc](./../installation/install-addons.md) to enable it first.
Make sure the `qdrant` cluster definition is installed. If the cluster definition is not available, refer to [this doc](../../user_docs/installation/install-with-helm/install-addons.md) to enable it first.

```bash
kubectl get clusterdefinition qdrant
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ This tutorial shows how to create and connect to a Redis cluster.

### Before you start

* [Install KubeBlocks](./../../installation/install-kubeblocks.md).
* [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).

* View all the database types and versions available for creating a cluster.

Make sure the `redis` cluster definition is installed. If the cluster definition is not available, refer to [this doc](./../../installation/install-addons.md) to enable it first.
Make sure the `redis` cluster definition is installed. If the cluster definition is not available, refer to [this doc](../../../user_docs/installation/install-with-helm/install-addons.md) to enable it first.

```bash
kubectl get clusterdefinition redis
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This guide shows how to configure cluster parameters.

## Before you start

1. [Install KubeBlocks](./../../installation/install-kubeblocks.md).
1. [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).
2. [Create a Redis cluster](./../cluster-management/create-and-connect-a-redis-cluster.md).

## Configure cluster parameters by editing configuration file
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ In the RedisReplication Cluster provided by KubeBlocks, Sentinel is deployed as

## Before you start

* [Install KubeBlocks](./../../installation/install-kubeblocks.md).
* [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).
* [Create a Redis Replication Cluster](./../cluster-management/create-and-connect-a-redis-cluster.md#create-a-redis-cluster).
* Check the role probe.
* Check whether the following role probe parameters exist to verify the role probe is enabled.
Expand Down
2 changes: 1 addition & 1 deletion docs/api_docs/kubeblocks-for-redis/redis-cluster-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Below is a brief introduction to the basic operations of Redis Cluster Mode.

### Before you start

* [Install KubeBlocks](./../installation/install-kubeblocks.md).
* [Install KubeBlocks](../../user_docs/installation/install-with-helm/install-kubeblocks.md).
Make sure your KubeBlocks and addon are version 0.9 or above.
* Make sure the Redis addon is enabled.
* View all the database types and versions available for creating a cluster.
Expand Down
4 changes: 2 additions & 2 deletions docs/api_docs/kubeblocks-for-starrocks/manage-starrocks.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ This tutorial illustrates how to create and manage a StarRocks cluster by `kubec

## Before you start

* [Install KubeBlocks](./../installation/install-kubeblocks.md).
* [Install KubeBlocks](../../user_docs/installation/install-with-helm/install-kubeblocks.md).
* View all the database types and versions available for creating a cluster.

Make sure the `starrocks` cluster definition is installed. If the cluster definition is not available, refer to [this doc](./../installation/install-addons.md) to enable it first.
Make sure the `starrocks` cluster definition is installed. If the cluster definition is not available, refer to [this doc](../../user_docs/installation/install-with-helm/install-addons.md) to enable it first.

```bash
kubectl get clusterdefinition starrocks
Expand Down
4 changes: 2 additions & 2 deletions docs/api_docs/kubeblocks-for-weaviate/manage-weaviate.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ This tutorial illustrates how to create and manage a Weaviate cluster by `kubect

## Before you start

* [Install KubeBlocks](./../installation/install-kubeblocks.md).
* [Install KubeBlocks](../../user_docs/installation/install-with-helm/install-kubeblocks.md).
* View all the database types and versions available for creating a cluster.

Make sure the `weaviate` cluster definition is installed. If the cluster definition is not available, refer to [this doc](./../installation/install-addons.md) to enable it first.
Make sure the `weaviate` cluster definition is installed. If the cluster definition is not available, refer to [this doc](../../user_docs/installation/install-with-helm/install-addons.md) to enable it first.

```bash
kubectl get clusterdefinition weaviate
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ This tutorial illustrates how to create and manage a Xinference cluster by `kube

## Before you start

* [Install KubeBlocks](./../installation/install-kubeblocks.md).
* [Install KubeBlocks](../../user_docs/installation/install-with-helm/install-kubeblocks.md).
* View all the database types and versions available for creating a cluster.

Make sure the `xinference` cluster definition is installed. If the cluster definition is not available, refer to [this doc](./../installation/install-addons.md) to enable it first.
Make sure the `xinference` cluster definition is installed. If the cluster definition is not available, refer to [this doc](../../user_docs/installation/install-with-helm/install-addons.md) to enable it first.

```bash
kubectl get clusterdefinition xinference
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Make sure you have all the following prepared.

* [Install kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl)
* [Install Helm](https://helm.sh/docs/intro/install/)
* [Install KubeBlocks](./../../../installation/install-kubeblocks.md)
* [Install KubeBlocks](../../../../user_docs/installation/install-with-helm/install-kubeblocks.md)

## Install MinIO

Expand Down
Loading
Loading