Skip to content

Commit

Permalink
[doc](fix) k8s operator docs fix
Browse files Browse the repository at this point in the history
  • Loading branch information
catpineapple committed Nov 23, 2023
1 parent ca7dbc3 commit df23237
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 26 deletions.
18 changes: 9 additions & 9 deletions docs/en/docs/install/k8s-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,14 @@ kubectl apply -f https://raw.githubusercontent.com/selectdb/doris-operator/maste
```
**2. Install Doris-Operator**
If you want to use the defaults operator resource:
```shell
kubectl apply -f https://raw.githubusercontent.com/selectdb/doris-operator/master/config/operator/operator.yaml
```
```shell
kubectl apply -f https://raw.githubusercontent.com/selectdb/doris-operator/master/config/operator/operator.yaml
```
The user defined deployment in github repo are simply:
Instead of using the command below, apply your local version of the Operator manifest to the cluster when you custom operator resource.
```shell
kubectl apply -f operator.yaml
```
```shell
kubectl apply -f operator.yaml
```
**3. Validate The Operator is Running**
Using the command `kubectl -n {namespace} get pods` get the status of deployed operator.
```shell
Expand All @@ -77,7 +77,7 @@ User can directly deploy Doris by [examples](https://github.com/selectdb/doris-o
```shell
kubectl apply -f https://raw.githubusercontent.com/selectdb/doris-operator/master/doc/examples/doriscluster-sample.yaml
```
Or download [doriscluster-sample](https://github.com/selectdb/doris-operator/master/doc/examples/doriscluster-sample.yaml) a custom resource that tells the Operator how to configure the Kubernetes cluster, and custom resource as [api.md](https://github.com/selectdb/doris-operator/blob/master/doc/api.md) and
Or download [doriscluster-sample](https://github.com/selectdb/doris-operator/tree/master/doc/examples/doriscluster-sample.yaml) a custom resource that tells the Operator how to configure the Kubernetes cluster, and custom resource as [api.md](https://github.com/selectdb/doris-operator/blob/master/doc/api.md) and
[how_to_use](https://github.com/selectdb/doris-operator/tree/master/doc/how_to_use.md) docs. Instead of using the command below, apply the customized resource.
```shell
kubeectl apply -f doriscluster-sample.yaml
Expand Down Expand Up @@ -107,7 +107,7 @@ doriscluster-sample-be-service ClusterIP 10.152.183.141 <none>
Service created by Doris-Operator have two types, suffix is `-internal` or `-service`. Service have the `-internal` suffix for communicating in Doris components, Service have `-service` suffix for user to access.

- In Kubernetes
In kubernetes, Using `CLUSTER-IP` is recommended. For example, the fe service's `CLUSTER-IP` is `10.152.183.37` that displayed by above command. Using below command to access fe service.
In kubernetes, Using `CLUSTER-IP` is recommended. For example, the fe service's `CLUSTER-IP` is `10.152.183.37` that displayed by above command. Using below command to access fe service.

```shell
mysql -h 10.152.183.37 -uroot -P9030
Expand All @@ -117,5 +117,5 @@ In kubernetes, Using `CLUSTER-IP` is recommended. For example, the fe service's
Using `EXTERNAL-IP` to access fe from Kubernetes external. In default, Doris-Operator not provided `EXTERNAL-IP` mode. If you want to use `EXTERNAL-IP`, should custom resource `Service` field, reference the doc [api.md](https://github.com/selectdb/doris-operator/blob/master/doc/api.md) to deploy.

:::tip
If the doc not cover your requirements, Pleaser reference the docs [Doris-Operator](https://github.com/selectdb/doris-operator/tree/master/doc/how_to_use.md) and the api document to custom [DorisCluster](https://github.com/selectdb/doris-operator/blob/master/doc/api.md) resource to deploy.
If the doc not cover your requirements, Pleaser reference the docs [how_to_use.md](https://github.com/selectdb/doris-operator/tree/master/doc/how_to_use.md) and [api.md](https://github.com/selectdb/doris-operator/blob/master/doc/api.md) to custom `DorisCluster` resource to deploy.
:::
34 changes: 17 additions & 17 deletions docs/zh-CN/docs/install/k8s-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,19 +47,19 @@ Doris-Operator 是按照 Kubernetes 原则构建的在 Kubernetes 平台之上
kubectl apply -f https://raw.githubusercontent.com/selectdb/doris-operator/master/config/crd/bases/doris.selectdb.com_dorisclusters.yaml
```
**2. 部署 Doris-Operator**
**方式一:默认部署模式**
直接通过仓库中 Operator 的定义进行部署
```shell
kubectl apply -f https://raw.githubusercontent.com/selectdb/doris-operator/master/config/operator/operator.yaml
```
**方式二:自定义部署**
[operator.yaml](https://github.com/selectdb/doris-operator/blob/master/config/operator/operator.yaml) 中各个配置是部署 Operator 服务的最低要求。为提高管理效率或者有定制化的需求,下载 operator.yaml 进行自定义部署。
- 下载 Operator 的部署范例 [operator.yaml](https://raw.githubusercontent.com/selectdb/doris-operator/master/config/operator/operator.yaml),可直接通过 wget 进行下载。
- 按期望更新 operator.yaml 中各种配置信息。
- 通过如下命令部署 Doris-Operator 服务。
```shell
kubectl apply -f operator.yaml
```
**方式一:默认部署模式**
直接通过仓库中 Operator 的定义进行部署
```shell
kubectl apply -f https://raw.githubusercontent.com/selectdb/doris-operator/master/config/operator/operator.yaml
```
**方式二:自定义部署**
[operator.yaml](https://github.com/selectdb/doris-operator/blob/master/config/operator/operator.yaml) 中各个配置是部署 Operator 服务的最低要求。为提高管理效率或者有定制化的需求,下载 operator.yaml 进行自定义部署。
- 下载 Operator 的部署范例 [operator.yaml](https://raw.githubusercontent.com/selectdb/doris-operator/master/config/operator/operator.yaml),可直接通过 wget 进行下载。
- 按期望更新 operator.yaml 中各种配置信息。
- 通过如下命令部署 Doris-Operator 服务。
```shell
kubectl apply -f operator.yaml
```
**3. 检查 Doris-Operator 服务部署状态**
Operator 服务部署后,可通过如下命令查看服务的状态。当`STATUS``Running`状态,且 pod 中所有容器都为`Ready`状态时服务部署成功。
```
Expand All @@ -70,15 +70,15 @@ Operator 服务部署后,可通过如下命令查看服务的状态。当`STAT
operator.yaml 中 namespace 默认为 Doris,如果更改了 namespace,在查询服务状态的时候请替换正确的 namespace 名称。
### 部署 Doris 集群
**1. 部署集群**
`Doris-Operator`仓库的 [doc/examples ](https://github.com/selectdb/doris-operator/tree/master/doc/examples)目录提供众多场景的使用范例,可直接使用范例进行部署。以最基础的范例为例:
`Doris-Operator`仓库的 [doc/examples](https://github.com/selectdb/doris-operator/tree/master/doc/examples) 目录提供众多场景的使用范例,可直接使用范例进行部署。以最基础的范例为例:
```
kubectl apply -f https://raw.githubusercontent.com/selectdb/doris-operator/master/doc/examples/doriscluster-sample.yaml
```
在 Doris-Operator 仓库中,[how_to_use.md](https://github.com/selectdb/doris-operator/tree/master/doc/how_to_use.md) 梳理了 Operator 管理运维 Doris 集群的主要能力,[DorisCluster](https://github.com/selectdb/doris-operator/blob/master/api/doris/v1/types.go) 展示了资源定义和从属结构,[api.md](https://github.com/selectdb/doris-operator/tree/master/doc/api.md) 可读性展示了资源定义和从属结构。可根据相关文档规划部署 Doris 集群。
在 Doris-Operator 仓库中,[how_to_use.md](https://github.com/selectdb/doris-operator/tree/master/doc/how_to_use_cn.md) 梳理了 Operator 管理运维 Doris 集群的主要能力,[DorisCluster](https://github.com/selectdb/doris-operator/blob/master/api/doris/v1/types.go) 展示了资源定义和从属结构,[api.md](https://github.com/selectdb/doris-operator/tree/master/doc/api.md) 可读性展示了资源定义和从属结构。可根据相关文档规划部署 Doris 集群。

**2. 检测集群状态**
- 检查所有 pod 的状态
集群部署资源下发后,通过如下命令检查集群状态。当所有 pod 的`STATUS`都是`Running`状态, 且所有组件的 pod 中所有容器都`READY`表示整个集群部署正常。
集群部署资源下发后,通过如下命令检查集群状态。当所有 pod 的`STATUS`都是`Running`状态, 且所有组件的 pod 中所有容器都`READY`表示整个集群部署正常。
```shell
kubectl get pods
NAME READY STATUS RESTARTS AGE
Expand Down Expand Up @@ -118,5 +118,5 @@ Doris 集群部署默认不提供 K8S 外部访问,如果集群需要被集群
mysql -h a7509284bf3784983a596c6eec7fc212-618xxxxxx.com -uroot -P9030
```
### 后记
本文简述 Doris 在 Kubernetes 的部署使用,提供的其他能力请参看 [Doris-Operator](https://github.com/selectdb/doris-operator/tree/master/doc/how_to_use.md) 提供的主要能力介绍,[DorisCluster](https://github.com/selectdb/doris-operator/blob/master/doc/api.md) 资源的 api 可读性文档定制化部署 Doris 集群。
本文简述 Doris 在 Kubernetes 的部署使用,Doris-Operator 提供的其他能力请参看[主要能力介绍](https://github.com/selectdb/doris-operator/tree/master/doc/how_to_use_cn.md)DorisCluster 资源的 [api](https://github.com/selectdb/doris-operator/blob/master/doc/api.md) 可读性文档定制化部署 Doris 集群。

0 comments on commit df23237

Please sign in to comment.