Skip to content

Commit

Permalink
docs: Change kind 'Cluster' to 'MysqlCluster'. radondb#249
Browse files Browse the repository at this point in the history
  • Loading branch information
runkecheng committed Oct 20, 2021
1 parent 7151b79 commit 49edd1a
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 14 deletions.
10 changes: 5 additions & 5 deletions docs/deploy_backup_restore_s3.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ then, create the secret in k8s.
```
kubectl create -f config/samples/backup_secret.yaml
```
Please add the backupSecretName in mysql_v1apha1_cluster.yaml, name as secret file:
Please add the backupSecretName in mysql_v1apha1_mysqlcluster.yaml, name as secret file:
```yaml
spec:
replicas: 3
Expand Down Expand Up @@ -62,7 +62,7 @@ spec:
### start cluster

```shell
kubectl apply -f config/samples/mysql_v1alpha1_cluster.yaml
kubectl apply -f config/samples/mysql_v1alpha1_mysqlcluster.yaml
```
### start backup
After run cluster success
Expand All @@ -75,7 +75,7 @@ kubectl apply -f config/samples/mysql_v1alpha1_backup.yaml
Uninstall the cluster named `sample`:

```shell
kubectl delete clusters.mysql.radondb.com sample
kubectl delete mysqlclusters.mysql.radondb.com sample
```

Uninstall the operator name `test`:
Expand All @@ -88,7 +88,7 @@ kubectl delete -f config/samples/mysql_v1alpha1_backup.yaml
Uninstall the crd:

```shell
kubectl delete customresourcedefinitions.apiextensions.k8s.io clusters.mysql.radondb.com
kubectl delete customresourcedefinitions.apiextensions.k8s.io mysqlclusters.mysql.radondb.com
```


Expand All @@ -106,7 +106,7 @@ spec:
```
Then you use:
```shell
kubectl apply -f config/samples/mysql_v1alpha1_cluster.yaml
kubectl apply -f config/samples/mysql_v1alpha1_mysqlcluster.yaml
```
could restore a cluster from the `backup_2021720827 ` copy in the S3 bucket.

Expand Down
4 changes: 2 additions & 2 deletions docs/deploy_monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ serviceMonitor:

### 步骤 2: 配置 metricsOpts

`metricsOpts` 是 CRD `clusters.mysql.radondb.com` 中定义 RadonDB MySQL 集群监控的参数,可通过配置`mysql_v1alpha1_cluster.yaml` 文件中参数值开启监控服务。
`metricsOpts` 是 CRD `mysqlclusters.mysql.radondb.com` 中定义 RadonDB MySQL 集群监控的参数,可通过配置`mysql_v1alpha1_mysqlcluster.yaml` 文件中参数值开启监控服务。

`metricsOpts` 参数包含如下字段:

Expand All @@ -89,7 +89,7 @@ metricsOpts:
文件参数修改完成后,使用如下指令应用配置,部署/更新集群回显信息如下:

```bash
$ kubectl apply -f config/sample/mysql_v1alpha1_cluster.yaml
$ kubectl apply -f config/sample/mysql_v1alpha1_mysqlcluster.yaml
cluster.mysql.radondb.com/sample created/configured
```

Expand Down
14 changes: 7 additions & 7 deletions docs/kubernetes/deploy_radondb-mysql_operator_on_k8s.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,14 +60,14 @@ helm install [NAME] [CHART] [flags]
helm install demo radondb-mysql-kubernetes/charts/mysql-operator
```

> 说明:在这一步骤中默认将同时创建一个名为 `clusters.mysql.radondb.com`[CRD](#8-CRD)
> 说明:在这一步骤中默认将同时创建一个名为 `mysqlclusters.mysql.radondb.com`[CRD](#8-CRD)
### 步骤 3: 部署 RadonDB MySQL 集群

执行以下指令,以默认参数为 CRD `clusters.mysql.radondb.com` 创建一个实例,即创建 RadonDB MySQL 集群。您可以参照[配置](#配置)自定义集群部署参数。
执行以下指令,以默认参数为 CRD `mysqlclusters.mysql.radondb.com` 创建一个实例,即创建 RadonDB MySQL 集群。您可以参照[配置](#配置)自定义集群部署参数。

```kubectl
kubectl apply -f radondb-mysql-kubernetes/config/samples/mysql_v1alpha1_cluster.yaml
kubectl apply -f radondb-mysql-kubernetes/config/samples/mysql_v1alpha1_mysqlcluster.yaml
```

## 部署校验
Expand All @@ -88,12 +88,12 @@ service/mysql-operator-metrics ClusterIP 10.96.142.22 <none> 8443/

### 校验 RadonDB MySQL 集群

执行如下命令,将查看到名为 `clusters.mysql.radondb.com` 的 CRD。
执行如下命令,将查看到名为 `mysqlclusters.mysql.radondb.com` 的 CRD。

```shell
kubectl get crd
NAME CREATED AT
clusters.mysql.radondb.com 2021-06-29T02:28:36Z
mysqlclusters.mysql.radondb.com 2021-06-29T02:28:36Z
```

以默认部署为例,执行如下命令将查看到名为 `sample-mysql` 的三节点 RadonDB MySQL 集群及用于访问节点的服务。
Expand Down Expand Up @@ -187,13 +187,13 @@ helm delete demo
卸载 release 名为 `sample` RadonDB MySQL 集群。

```shell
kubectl delete clusters.mysql.radondb.com sample
kubectl delete mysqlclusters.mysql.radondb.com sample
```

### 卸载自定义资源

```shell
kubectl delete customresourcedefinitions.apiextensions.k8s.io clusters.mysql.radondb.com
kubectl delete customresourcedefinitions.apiextensions.k8s.io mysqlclusters.mysql.radondb.com
```

## 配置
Expand Down

0 comments on commit 49edd1a

Please sign in to comment.