This is an automated email from the ASF dual-hosted git repository.
morningman pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/doris-website.git
The following commit(s) were added to refs/heads/master by this push:
new 59989d6520 [docs](k8s) add k8s operator quickstart (#1119)
59989d6520 is described below
commit 59989d6520a79ec37eb7276d08891b31fe546a4c
Author: catpineapple <[email protected]>
AuthorDate: Thu Sep 19 14:19:00 2024 +0800
[docs](k8s) add k8s operator quickstart (#1119)
# Versions
- [x] dev
- [x] 3.0
- [x] 2.1
- [ ] 2.0
# Languages
- [x] Chinese
- [x] English
---
.../compute-storage-coupled/install-quickstart.md | 157 +++++++++++++++++++++
.../compute-storage-coupled/install-quickstart.md | 155 ++++++++++++++++++++
.../k8s-deploy/install-quickstart.md | 155 ++++++++++++++++++++
.../compute-storage-coupled/install-quickstart.md | 155 ++++++++++++++++++++
sidebars.json | 1 +
.../k8s-deploy/install-quickstart.md | 157 +++++++++++++++++++++
.../compute-storage-coupled/install-quickstart.md | 157 +++++++++++++++++++++
versioned_sidebars/version-2.1-sidebars.json | 1 +
versioned_sidebars/version-3.0-sidebars.json | 1 +
9 files changed, 939 insertions(+)
diff --git
a/docs/install/cluster-deployment/k8s-deploy/compute-storage-coupled/install-quickstart.md
b/docs/install/cluster-deployment/k8s-deploy/compute-storage-coupled/install-quickstart.md
new file mode 100644
index 0000000000..f32eeb4191
--- /dev/null
+++
b/docs/install/cluster-deployment/k8s-deploy/compute-storage-coupled/install-quickstart.md
@@ -0,0 +1,157 @@
+---
+{
+"title": "Quick Start",
+"language": "en"
+}
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+This section describes how to deploy Doris Operator and Doris cluster in the
test Kubernetes cluster.
+The deployment operations are as follows:
+1. Create a Kubernetes test cluster
+2. Deploy Doris Operator
+3. Deploy Doris cluster
+4. Connect to Doris cluster
+
+## Step 1: Create a Kubernetes test cluster
+This step briefly describes how to quickly build a single-node k8s cluster
without a k8s cluster. If you already have a k8s cluster, please skip this step.
+Kind is currently a common solution for creating a local Kubernetes test
environment. Kind uses Docker containers as nodes to create and run Kubernetes
clusters locally.
+
+1. Deployment prerequisites
+ Before deployment, you need to ensure that the following components are
available in the environment:
+
+| Components | Version requirements |
+|------------|----------------------|
+| Docker | \>= 18.09 |
+| kubectl | \>=1.19 |
+| kind | \>=0.8.0 |
+
+2. Deploy Kubernetes cluster using kind
+ In this example, kind 0.10.0 is used to install the Kubernetes cluster. The
command is as follows:
+
+ ```
+ kind create cluster --image kindest/node:v1.20.2 --name test-doris
+ ```
+ Expected output:
+ ```
+ Creating cluster "test-doris" ...
+ ✓ Ensuring node image (kindest/node:v1.20.2)
+ ✓ Preparing nodes
+ ✓ Writing configuration
+ ✓ Starting control-plane
+ ✓ Installing CNI
+ ✓ Installing StorageClass
+ Set kubectl context to "kind-test-doris"
+ You can now use your cluster with:
+ ```
+3. Check the Kubernetes cluster status Use the following command to check the
Kubernetes cluster status:
+ ```
+ kubectl cluster-info --context kind-test-doris
+ ```
+ Expected output:
+ ```
+ Kubernetes control plane is running at https://127.0.0.1:40075
+ KubeDNS is running at
https://127.0.0.1:40075/api/v1/namespaces/kube-system/services/kube-dns:dns/proxy
+ To further debug and diagnose cluster problems, use 'kubectl cluster-info
dump'.
+ ```
+## Step 2: Deploy Doris Operator
+Deploying Doris Operator consists of two parts: installing the definition and
deploying the operator service:
+1. Installing Doris Operator CRD
+ Add the custom resource (CRD) of Doris Operator using the following command:
+ ```
+ kubectl apply -f
https://raw.githubusercontent.com/selectdb/doris-operator/master/config/crd/bases/doris.selectdb.com_dorisclusters.yaml
+ ```
+ Expected output:
+ ```
+
customresourcedefinition.apiextensions.k8s.io/dorisclusters.doris.selectdb.com
created
+ ```
+2. Install Doris Operator
+ Install Doris Operator using the following command:
+ ```
+ kubectl apply -f
https://raw.githubusercontent.com/selectdb/doris-operator/master/config/operator/operator.yaml
+ ```
+ Expected output:
+ ```
+ namespace/doris created
+ role.rbac.authorization.k8s.io/leader-election-role created
+ rolebinding.rbac.authorization.k8s.io/leader-election-rolebinding created
+ clusterrole.rbac.authorization.k8s.io/doris-operator created
+ clusterrolebinding.rbac.authorization.k8s.io/doris-operator-rolebinding
created
+ serviceaccount/doris-operator created
+ deployment.apps/doris-operator created
+ ```
+3. Check the Doris Operator status
+ Check the deployment status of Doris Operator using the following command:
+ ```
+ kubectl get pods -n doris
+ ```
+ Expected output:
+ ```
+ NAME READY STATUS RESTARTS AGE
+ doris-operator-7f578c86cb-nz6jn 1/1 Running 0 19m
+ ```
+For Doris Operator related configuration and other deployment methods, please
refer to [Deploying Doris Operator](./install-operator.md).
+## Step 3: Deploy Doris cluster
+1. Download the template Doris deployment template:
+ ```
+ curl -O
https://raw.githubusercontent.com/apache/doris-operator/master/doc/examples/doriscluster-sample.yaml
+ ```
+2. Perform customized configuration as needed according to the [Deploying
Doris Cluster](./install-doris-cluster.md). After the configuration is
completed, deploy it with the following command:
+ ```
+ kubectl apply -f doriscluster-sample.yaml
+ ```
+3. Check the cluster deployment status:
+ Check the status of the cluster by checking the status of pods:
+ ```
+ kubectl get pods
+ ```
+ Expected output:
+ ```
+ NAME READY STATUS RESTARTS AGE
+ doriscluster-sample-fe-0 1/1 Running 0 2m
+ doriscluster-sample-be-0 1/1 Running 0 3m
+ ```
+ Check the status of the deployed resources:
+ ```
+ kubectl get dcr -n doris
+ ```
+ Expected output:
+ ```
+ NAME FESTATUS BESTATUS CNSTATUS BROKERSTATUS
+ doriscluster-sample available available
+ ```
+
+## Step 4: Connect and access the Doris cluster
+
+The Doris cluster is quickly deployed in the test environment. You can enter
the container FE and use the MySQL Client to connect to Doris for test
operations. For other access methods, refer to [Accessing Doris
Cluster](./install-access-cluster.md) for configuration.
+1. Get the FE container name:
+ ```
+ kubectl get pod -n doris | grep fe
+ doriscluster-sample-fe-0 1/1 Running 0 16m
+ ```
+ In this example, the FE container is named doriscluster-sample-fe-0.
+
+2. Enter the FE container:
+ ```
+ kubectl -n doris exec -it doriscluster-sample-fe-0 /bin/bash
+ ```
+
+3. Use MySQL Client to connect to the Doris cluster in the FE container:
+ ```
+ mysql -uroot -P9030 -h127.0.0.1
+ ```
\ No newline at end of file
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/install/cluster-deployment/k8s-deploy/compute-storage-coupled/install-quickstart.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/install/cluster-deployment/k8s-deploy/compute-storage-coupled/install-quickstart.md
new file mode 100644
index 0000000000..b6b0b1d004
--- /dev/null
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/install/cluster-deployment/k8s-deploy/compute-storage-coupled/install-quickstart.md
@@ -0,0 +1,155 @@
+---
+{
+"title": "快速部署",
+"language": "zh-CN"
+}
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+本章节介绍如何在测试 Kubernetes 集群中部署 Doris Operator 与 Doris 集群。
+部署操作如下：
+1. 创建 Kubernetes 测试集群
+2. 部署 Doris Operator
+3. 部署 Doris 集群
+4. 连接访问 Doris 集群
+
+## 第 1 步：创建 Kubernetes 测试集群
+此步骤简述在没有 k8s 集群的情况下如何快速搭建一套单节点 k8s 集群，如果已有 k8s 集群，此步骤请跳过。
+Kind 是目前比较通用的创建本地 Kubernetes 测试环境的方案。Kind 使用 Docker 容器作为节点，在本地创建和运行 Kubernetes
集群。
+1. 部署前置条件
+ 部署前需要确保环境中具有以下组件：
+
+| 组件 | 版本要求 |
+|---------|-----------|
+| Docker | \>= 18.09 |
+| kubectl | \>=1.19 |
+| kind | \>=0.8.0 |
+
+2. 使用 kind 部署 Kubernetes 集群
+ 本例中使用 kind 0.10.0 版本安装 Kubernetes 集群，命令如下：
+ ```
+ kind create cluster --image kindest/node:v1.20.2 --name test-doris
+ ```
+ 期望输出结果：
+ ```
+ Creating cluster "test-doris" ...
+ ✓ Ensuring node image (kindest/node:v1.20.2)
+ ✓ Preparing nodes
+ ✓ Writing configuration
+ ✓ Starting control-plane
+ ✓ Installing CNI
+ ✓ Installing StorageClass
+ Set kubectl context to "kind-test-doris"
+ You can now use your cluster with:
+ ```
+3. 检查 Kubernetes 集群状态
+ 使用以下命令检查 Kubernete 集群状态:
+ ```
+ kubectl cluster-info --context kind-test-doris
+ ```
+ 以下是期望输出结果：
+ ```
+ Kubernetes control plane is running at https://127.0.0.1:40075
+ KubeDNS is running at
https://127.0.0.1:40075/api/v1/namespaces/kube-system/services/kube-dns:dns/proxy
+ To further debug and diagnose cluster problems, use 'kubectl cluster-info
dump'.
+ ```
+## 第 2 步：部署 Doris Operator
+部署 Doris Operator 分成安装定义和部署 operator 服务两部分：
+1. 安装 Doris Operator CRD
+ 通过以下命令添加 Doris Operator 的自定义资源（CRD）：
+ ```
+ kubectl apply -f
https://raw.githubusercontent.com/selectdb/doris-operator/master/config/crd/bases/doris.selectdb.com_dorisclusters.yaml
+ ```
+ 期望输出结果:
+ ```
+
customresourcedefinition.apiextensions.k8s.io/dorisclusters.doris.selectdb.com
created
+ ```
+2. 安装 Doris Operator
+ 通过以下命令安装 Doris Operator ：
+ ```
+ kubectl apply -f
https://raw.githubusercontent.com/selectdb/doris-operator/master/config/operator/operator.yaml
+ ```
+ 期望输出结果：
+ ```
+ namespace/doris created
+ role.rbac.authorization.k8s.io/leader-election-role created
+ rolebinding.rbac.authorization.k8s.io/leader-election-rolebinding created
+ clusterrole.rbac.authorization.k8s.io/doris-operator created
+ clusterrolebinding.rbac.authorization.k8s.io/doris-operator-rolebinding
created
+ serviceaccount/doris-operator created
+ deployment.apps/doris-operator created
+ ```
+3. 检查 Doris Operator 状态
+ 通过以下命令检查 Doris Operator 的部署状态：
+ ```
+ kubectl get pods -n doris
+ ```
+ 期望输出结果:
+ ```
+ NAME READY STATUS RESTARTS AGE
+ doris-operator-7f578c86cb-nz6jn 1/1 Running 0 19m
+ ```
+ Doris Operator 相关配置以及其他部署方式可参考[部署 operator 部分](./install-operator.md)。
+## 第 3 步：部署 Doris 集群
+1. 下载模板 Doris 部署模板：
+ ```
+ curl -O
https://raw.githubusercontent.com/apache/doris-operator/master/doc/examples/doriscluster-sample.yaml
+ ```
+2. 根据[集群配置章节](./install-doris-cluster.md)按需进行定制化配置，配置完成后通过如下命令部署：
+ ```
+ kubectl apply -f doriscluster-sample.yaml
+ ```
+3. 检查集群部署状态：
+ 通过查看 pods 的状态检查集群的状态：
+ ```
+ kubectl get pods
+ ```
+ 期望结果：
+ ```
+ NAME READY STATUS RESTARTS AGE
+ doriscluster-sample-fe-0 1/1 Running 0 2m
+ doriscluster-sample-be-0 1/1 Running 0 3m
+ ```
+ 检查部署资源的状态：
+ ```
+ kubectl get dcr -n doris
+ ```
+ 期望结果：
+ ```
+ NAME FESTATUS BESTATUS CNSTATUS BROKERSTATUS
+ doriscluster-sample available available
+ ```
+## 第 4 步：连接访问 Doris 集群
+在测试环境中快速部署的 Doris 集群，可以进入容器 FE 内部使用 MySQL Client 链接 Doris
进行测试操作。其他访问方式可参考[集群访问章节](./install-access-cluster.md)配置使用。
+1. 获取 FE 容器名称:
+ ```
+ kubectl get pod -n doris | grep fe
+ doriscluster-sample-fe-0 1/1 Running 0 16m
+ ```
+ 在本例中，FE 容器名为 doriscluster-sample-fe-0。
+
+
+2. 进入 FE 容器内部:
+ ```
+ kubectl -n doris exec -it doriscluster-sample-fe-0 /bin/bash
+ ```
+
+3. 在 FE 容器内部使用 MySQL Client 链接 Doris 集群：
+ ```
+ mysql -uroot -P9030 -h127.0.0.1
+ ```
\ No newline at end of file
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/install/cluster-deployment/k8s-deploy/install-quickstart.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/install/cluster-deployment/k8s-deploy/install-quickstart.md
new file mode 100644
index 0000000000..d33c52005d
--- /dev/null
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/install/cluster-deployment/k8s-deploy/install-quickstart.md
@@ -0,0 +1,155 @@
+---
+{
+"title": "快速部署",
+"language": "zh-CN"
+}
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+本章节介绍如何在测试 Kubernetes 集群中部署 Doris Operator 与 Doris 集群。
+部署操作如下：
+1. 创建 Kubernetes 测试集群
+2. 部署 Doris Operator
+3. 部署 Doris 集群
+4. 连接访问 Doris 集群
+
+## 第 1 步：创建 Kubernetes 测试集群
+此步骤简述在没有 k8s 集群的情况下如何快速搭建一套单节点 k8s 集群，如果已有 k8s 集群，此步骤请跳过。
+Kind 是目前比较通用的创建本地 Kubernetes 测试环境的方案。Kind 使用 Docker 容器作为节点，在本地创建和运行 Kubernetes
集群。
+1. 部署前置条件
+ 部署前需要确保环境中具有以下组件：
+
+| 组件 | 版本要求 |
+|---------|-----------|
+| Docker | \>= 18.09 |
+| kubectl | \>=1.19 |
+| kind | \>=0.8.0 |
+
+2. 使用 kind 部署 Kubernetes 集群
+ 本例中使用 kind 0.10.0 版本安装 Kubernetes 集群，命令如下：
+ ```
+ kind create cluster --image kindest/node:v1.20.2 --name test-doris
+ ```
+ 期望输出结果：
+ ```
+ Creating cluster "test-doris" ...
+ ✓ Ensuring node image (kindest/node:v1.20.2)
+ ✓ Preparing nodes
+ ✓ Writing configuration
+ ✓ Starting control-plane
+ ✓ Installing CNI
+ ✓ Installing StorageClass
+ Set kubectl context to "kind-test-doris"
+ You can now use your cluster with:
+ ```
+3. 检查 Kubernetes 集群状态
+ 使用以下命令检查 Kubernete 集群状态:
+ ```
+ kubectl cluster-info --context kind-test-doris
+ ```
+ 以下是期望输出结果：
+ ```
+ Kubernetes control plane is running at https://127.0.0.1:40075
+ KubeDNS is running at
https://127.0.0.1:40075/api/v1/namespaces/kube-system/services/kube-dns:dns/proxy
+ To further debug and diagnose cluster problems, use 'kubectl cluster-info
dump'.
+ ```
+## 第 2 步：部署 Doris Operator
+部署 Doris Operator 分成安装定义和部署 operator 服务两部分：
+1. 安装 Doris Operator CRD
+ 通过以下命令添加 Doris Operator 的自定义资源（CRD）：
+ ```
+ kubectl apply -f
https://raw.githubusercontent.com/selectdb/doris-operator/master/config/crd/bases/doris.selectdb.com_dorisclusters.yaml
+ ```
+ 期望输出结果:
+ ```
+
customresourcedefinition.apiextensions.k8s.io/dorisclusters.doris.selectdb.com
created
+ ```
+2. 安装 Doris Operator
+ 通过以下命令安装 Doris Operator ：
+ ```
+ kubectl apply -f
https://raw.githubusercontent.com/selectdb/doris-operator/master/config/operator/operator.yaml
+ ```
+ 期望输出结果：
+ ```
+ namespace/doris created
+ role.rbac.authorization.k8s.io/leader-election-role created
+ rolebinding.rbac.authorization.k8s.io/leader-election-rolebinding created
+ clusterrole.rbac.authorization.k8s.io/doris-operator created
+ clusterrolebinding.rbac.authorization.k8s.io/doris-operator-rolebinding
created
+ serviceaccount/doris-operator created
+ deployment.apps/doris-operator created
+ ```
+3. 检查 Doris Operator 状态
+ 通过以下命令检查 Doris Operator 的部署状态：
+ ```
+ kubectl get pods -n doris
+ ```
+ 期望输出结果:
+ ```
+ NAME READY STATUS RESTARTS AGE
+ doris-operator-7f578c86cb-nz6jn 1/1 Running 0 19m
+ ```
+ Doris Operator 相关配置以及其他部署方式可参考[部署 operator 部分](./install-operator.md)。
+## 第 3 步：部署 Doris 集群
+1. 下载模板 Doris 部署模板：
+ ```
+ curl -O
https://raw.githubusercontent.com/apache/doris-operator/master/doc/examples/doriscluster-sample.yaml
+ ```
+2. 根据[集群配置章节](./install-doris-cluster.md)按需进行定制化配置，配置完成后通过如下命令部署：
+ ```
+ kubectl apply -f doriscluster-sample.yaml
+ ```
+3. 检查集群部署状态：
+ 通过查看 pods 的状态检查集群的状态：
+ ```
+ kubectl get pods
+ ```
+ 期望结果：
+ ```
+ NAME READY STATUS RESTARTS AGE
+ doriscluster-sample-fe-0 1/1 Running 0 2m
+ doriscluster-sample-be-0 1/1 Running 0 3m
+ ```
+ 检查部署资源的状态：
+ ```
+ kubectl get dcr -n doris
+ ```
+ 期望结果：
+ ```
+ NAME FESTATUS BESTATUS CNSTATUS BROKERSTATUS
+ doriscluster-sample available available
+ ```
+## 第 4 步：连接访问 Doris 集群
+在测试环境中快速部署的 Doris 集群，可以进入容器 FE 内部使用 MySQL Client 链接 Doris
进行测试操作。其他访问方式可参考[集群访问章节](./install-access-cluster.md)配置使用。
+1. 获取 FE 容器名称:
+ ```
+ kubectl get pod -n doris | grep fe
+ doriscluster-sample-fe-0 1/1 Running 0 16m
+ ```
+ 在本例中，FE 容器名为 doriscluster-sample-fe-0。
+
+
+2. 进入 FE 容器内部:
+ ```
+ kubectl -n doris exec -it doriscluster-sample-fe-0 /bin/bash
+ ```
+
+3. 在 FE 容器内部使用 MySQL Client 链接 Doris 集群：
+ ```
+ mysql -uroot -P9030 -h127.0.0.1
+ ```
\ No newline at end of file
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/install/cluster-deployment/k8s-deploy/compute-storage-coupled/install-quickstart.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/install/cluster-deployment/k8s-deploy/compute-storage-coupled/install-quickstart.md
new file mode 100644
index 0000000000..d33c52005d
--- /dev/null
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/install/cluster-deployment/k8s-deploy/compute-storage-coupled/install-quickstart.md
@@ -0,0 +1,155 @@
+---
+{
+"title": "快速部署",
+"language": "zh-CN"
+}
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+本章节介绍如何在测试 Kubernetes 集群中部署 Doris Operator 与 Doris 集群。
+部署操作如下：
+1. 创建 Kubernetes 测试集群
+2. 部署 Doris Operator
+3. 部署 Doris 集群
+4. 连接访问 Doris 集群
+
+## 第 1 步：创建 Kubernetes 测试集群
+此步骤简述在没有 k8s 集群的情况下如何快速搭建一套单节点 k8s 集群，如果已有 k8s 集群，此步骤请跳过。
+Kind 是目前比较通用的创建本地 Kubernetes 测试环境的方案。Kind 使用 Docker 容器作为节点，在本地创建和运行 Kubernetes
集群。
+1. 部署前置条件
+ 部署前需要确保环境中具有以下组件：
+
+| 组件 | 版本要求 |
+|---------|-----------|
+| Docker | \>= 18.09 |
+| kubectl | \>=1.19 |
+| kind | \>=0.8.0 |
+
+2. 使用 kind 部署 Kubernetes 集群
+ 本例中使用 kind 0.10.0 版本安装 Kubernetes 集群，命令如下：
+ ```
+ kind create cluster --image kindest/node:v1.20.2 --name test-doris
+ ```
+ 期望输出结果：
+ ```
+ Creating cluster "test-doris" ...
+ ✓ Ensuring node image (kindest/node:v1.20.2)
+ ✓ Preparing nodes
+ ✓ Writing configuration
+ ✓ Starting control-plane
+ ✓ Installing CNI
+ ✓ Installing StorageClass
+ Set kubectl context to "kind-test-doris"
+ You can now use your cluster with:
+ ```
+3. 检查 Kubernetes 集群状态
+ 使用以下命令检查 Kubernete 集群状态:
+ ```
+ kubectl cluster-info --context kind-test-doris
+ ```
+ 以下是期望输出结果：
+ ```
+ Kubernetes control plane is running at https://127.0.0.1:40075
+ KubeDNS is running at
https://127.0.0.1:40075/api/v1/namespaces/kube-system/services/kube-dns:dns/proxy
+ To further debug and diagnose cluster problems, use 'kubectl cluster-info
dump'.
+ ```
+## 第 2 步：部署 Doris Operator
+部署 Doris Operator 分成安装定义和部署 operator 服务两部分：
+1. 安装 Doris Operator CRD
+ 通过以下命令添加 Doris Operator 的自定义资源（CRD）：
+ ```
+ kubectl apply -f
https://raw.githubusercontent.com/selectdb/doris-operator/master/config/crd/bases/doris.selectdb.com_dorisclusters.yaml
+ ```
+ 期望输出结果:
+ ```
+
customresourcedefinition.apiextensions.k8s.io/dorisclusters.doris.selectdb.com
created
+ ```
+2. 安装 Doris Operator
+ 通过以下命令安装 Doris Operator ：
+ ```
+ kubectl apply -f
https://raw.githubusercontent.com/selectdb/doris-operator/master/config/operator/operator.yaml
+ ```
+ 期望输出结果：
+ ```
+ namespace/doris created
+ role.rbac.authorization.k8s.io/leader-election-role created
+ rolebinding.rbac.authorization.k8s.io/leader-election-rolebinding created
+ clusterrole.rbac.authorization.k8s.io/doris-operator created
+ clusterrolebinding.rbac.authorization.k8s.io/doris-operator-rolebinding
created
+ serviceaccount/doris-operator created
+ deployment.apps/doris-operator created
+ ```
+3. 检查 Doris Operator 状态
+ 通过以下命令检查 Doris Operator 的部署状态：
+ ```
+ kubectl get pods -n doris
+ ```
+ 期望输出结果:
+ ```
+ NAME READY STATUS RESTARTS AGE
+ doris-operator-7f578c86cb-nz6jn 1/1 Running 0 19m
+ ```
+ Doris Operator 相关配置以及其他部署方式可参考[部署 operator 部分](./install-operator.md)。
+## 第 3 步：部署 Doris 集群
+1. 下载模板 Doris 部署模板：
+ ```
+ curl -O
https://raw.githubusercontent.com/apache/doris-operator/master/doc/examples/doriscluster-sample.yaml
+ ```
+2. 根据[集群配置章节](./install-doris-cluster.md)按需进行定制化配置，配置完成后通过如下命令部署：
+ ```
+ kubectl apply -f doriscluster-sample.yaml
+ ```
+3. 检查集群部署状态：
+ 通过查看 pods 的状态检查集群的状态：
+ ```
+ kubectl get pods
+ ```
+ 期望结果：
+ ```
+ NAME READY STATUS RESTARTS AGE
+ doriscluster-sample-fe-0 1/1 Running 0 2m
+ doriscluster-sample-be-0 1/1 Running 0 3m
+ ```
+ 检查部署资源的状态：
+ ```
+ kubectl get dcr -n doris
+ ```
+ 期望结果：
+ ```
+ NAME FESTATUS BESTATUS CNSTATUS BROKERSTATUS
+ doriscluster-sample available available
+ ```
+## 第 4 步：连接访问 Doris 集群
+在测试环境中快速部署的 Doris 集群，可以进入容器 FE 内部使用 MySQL Client 链接 Doris
进行测试操作。其他访问方式可参考[集群访问章节](./install-access-cluster.md)配置使用。
+1. 获取 FE 容器名称:
+ ```
+ kubectl get pod -n doris | grep fe
+ doriscluster-sample-fe-0 1/1 Running 0 16m
+ ```
+ 在本例中，FE 容器名为 doriscluster-sample-fe-0。
+
+
+2. 进入 FE 容器内部:
+ ```
+ kubectl -n doris exec -it doriscluster-sample-fe-0 /bin/bash
+ ```
+
+3. 在 FE 容器内部使用 MySQL Client 链接 Doris 集群：
+ ```
+ mysql -uroot -P9030 -h127.0.0.1
+ ```
\ No newline at end of file
diff --git a/sidebars.json b/sidebars.json
index 1e6092b444..ffeeb98e9c 100644
--- a/sidebars.json
+++ b/sidebars.json
@@ -32,6 +32,7 @@
"label": "Compute-storage coupled",
"items": [
"install/cluster-deployment/k8s-deploy/compute-storage-coupled/install-operator",
+
"install/cluster-deployment/k8s-deploy/compute-storage-coupled/install-quickstart",
"install/cluster-deployment/k8s-deploy/compute-storage-coupled/install-config-cluster",
"install/cluster-deployment/k8s-deploy/compute-storage-coupled/install-doris-cluster",
"install/cluster-deployment/k8s-deploy/compute-storage-coupled/install-access-cluster",
diff --git
a/versioned_docs/version-2.1/install/cluster-deployment/k8s-deploy/install-quickstart.md
b/versioned_docs/version-2.1/install/cluster-deployment/k8s-deploy/install-quickstart.md
new file mode 100644
index 0000000000..f32eeb4191
--- /dev/null
+++
b/versioned_docs/version-2.1/install/cluster-deployment/k8s-deploy/install-quickstart.md
@@ -0,0 +1,157 @@
+---
+{
+"title": "Quick Start",
+"language": "en"
+}
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+This section describes how to deploy Doris Operator and Doris cluster in the
test Kubernetes cluster.
+The deployment operations are as follows:
+1. Create a Kubernetes test cluster
+2. Deploy Doris Operator
+3. Deploy Doris cluster
+4. Connect to Doris cluster
+
+## Step 1: Create a Kubernetes test cluster
+This step briefly describes how to quickly build a single-node k8s cluster
without a k8s cluster. If you already have a k8s cluster, please skip this step.
+Kind is currently a common solution for creating a local Kubernetes test
environment. Kind uses Docker containers as nodes to create and run Kubernetes
clusters locally.
+
+1. Deployment prerequisites
+ Before deployment, you need to ensure that the following components are
available in the environment:
+
+| Components | Version requirements |
+|------------|----------------------|
+| Docker | \>= 18.09 |
+| kubectl | \>=1.19 |
+| kind | \>=0.8.0 |
+
+2. Deploy Kubernetes cluster using kind
+ In this example, kind 0.10.0 is used to install the Kubernetes cluster. The
command is as follows:
+
+ ```
+ kind create cluster --image kindest/node:v1.20.2 --name test-doris
+ ```
+ Expected output:
+ ```
+ Creating cluster "test-doris" ...
+ ✓ Ensuring node image (kindest/node:v1.20.2)
+ ✓ Preparing nodes
+ ✓ Writing configuration
+ ✓ Starting control-plane
+ ✓ Installing CNI
+ ✓ Installing StorageClass
+ Set kubectl context to "kind-test-doris"
+ You can now use your cluster with:
+ ```
+3. Check the Kubernetes cluster status Use the following command to check the
Kubernetes cluster status:
+ ```
+ kubectl cluster-info --context kind-test-doris
+ ```
+ Expected output:
+ ```
+ Kubernetes control plane is running at https://127.0.0.1:40075
+ KubeDNS is running at
https://127.0.0.1:40075/api/v1/namespaces/kube-system/services/kube-dns:dns/proxy
+ To further debug and diagnose cluster problems, use 'kubectl cluster-info
dump'.
+ ```
+## Step 2: Deploy Doris Operator
+Deploying Doris Operator consists of two parts: installing the definition and
deploying the operator service:
+1. Installing Doris Operator CRD
+ Add the custom resource (CRD) of Doris Operator using the following command:
+ ```
+ kubectl apply -f
https://raw.githubusercontent.com/selectdb/doris-operator/master/config/crd/bases/doris.selectdb.com_dorisclusters.yaml
+ ```
+ Expected output:
+ ```
+
customresourcedefinition.apiextensions.k8s.io/dorisclusters.doris.selectdb.com
created
+ ```
+2. Install Doris Operator
+ Install Doris Operator using the following command:
+ ```
+ kubectl apply -f
https://raw.githubusercontent.com/selectdb/doris-operator/master/config/operator/operator.yaml
+ ```
+ Expected output:
+ ```
+ namespace/doris created
+ role.rbac.authorization.k8s.io/leader-election-role created
+ rolebinding.rbac.authorization.k8s.io/leader-election-rolebinding created
+ clusterrole.rbac.authorization.k8s.io/doris-operator created
+ clusterrolebinding.rbac.authorization.k8s.io/doris-operator-rolebinding
created
+ serviceaccount/doris-operator created
+ deployment.apps/doris-operator created
+ ```
+3. Check the Doris Operator status
+ Check the deployment status of Doris Operator using the following command:
+ ```
+ kubectl get pods -n doris
+ ```
+ Expected output:
+ ```
+ NAME READY STATUS RESTARTS AGE
+ doris-operator-7f578c86cb-nz6jn 1/1 Running 0 19m
+ ```
+For Doris Operator related configuration and other deployment methods, please
refer to [Deploying Doris Operator](./install-operator.md).
+## Step 3: Deploy Doris cluster
+1. Download the template Doris deployment template:
+ ```
+ curl -O
https://raw.githubusercontent.com/apache/doris-operator/master/doc/examples/doriscluster-sample.yaml
+ ```
+2. Perform customized configuration as needed according to the [Deploying
Doris Cluster](./install-doris-cluster.md). After the configuration is
completed, deploy it with the following command:
+ ```
+ kubectl apply -f doriscluster-sample.yaml
+ ```
+3. Check the cluster deployment status:
+ Check the status of the cluster by checking the status of pods:
+ ```
+ kubectl get pods
+ ```
+ Expected output:
+ ```
+ NAME READY STATUS RESTARTS AGE
+ doriscluster-sample-fe-0 1/1 Running 0 2m
+ doriscluster-sample-be-0 1/1 Running 0 3m
+ ```
+ Check the status of the deployed resources:
+ ```
+ kubectl get dcr -n doris
+ ```
+ Expected output:
+ ```
+ NAME FESTATUS BESTATUS CNSTATUS BROKERSTATUS
+ doriscluster-sample available available
+ ```
+
+## Step 4: Connect and access the Doris cluster
+
+The Doris cluster is quickly deployed in the test environment. You can enter
the container FE and use the MySQL Client to connect to Doris for test
operations. For other access methods, refer to [Accessing Doris
Cluster](./install-access-cluster.md) for configuration.
+1. Get the FE container name:
+ ```
+ kubectl get pod -n doris | grep fe
+ doriscluster-sample-fe-0 1/1 Running 0 16m
+ ```
+ In this example, the FE container is named doriscluster-sample-fe-0.
+
+2. Enter the FE container:
+ ```
+ kubectl -n doris exec -it doriscluster-sample-fe-0 /bin/bash
+ ```
+
+3. Use MySQL Client to connect to the Doris cluster in the FE container:
+ ```
+ mysql -uroot -P9030 -h127.0.0.1
+ ```
\ No newline at end of file
diff --git
a/versioned_docs/version-3.0/install/cluster-deployment/k8s-deploy/compute-storage-coupled/install-quickstart.md
b/versioned_docs/version-3.0/install/cluster-deployment/k8s-deploy/compute-storage-coupled/install-quickstart.md
new file mode 100644
index 0000000000..f32eeb4191
--- /dev/null
+++
b/versioned_docs/version-3.0/install/cluster-deployment/k8s-deploy/compute-storage-coupled/install-quickstart.md
@@ -0,0 +1,157 @@
+---
+{
+"title": "Quick Start",
+"language": "en"
+}
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+This section describes how to deploy Doris Operator and Doris cluster in the
test Kubernetes cluster.
+The deployment operations are as follows:
+1. Create a Kubernetes test cluster
+2. Deploy Doris Operator
+3. Deploy Doris cluster
+4. Connect to Doris cluster
+
+## Step 1: Create a Kubernetes test cluster
+This step briefly describes how to quickly build a single-node k8s cluster
without a k8s cluster. If you already have a k8s cluster, please skip this step.
+Kind is currently a common solution for creating a local Kubernetes test
environment. Kind uses Docker containers as nodes to create and run Kubernetes
clusters locally.
+
+1. Deployment prerequisites
+ Before deployment, you need to ensure that the following components are
available in the environment:
+
+| Components | Version requirements |
+|------------|----------------------|
+| Docker | \>= 18.09 |
+| kubectl | \>=1.19 |
+| kind | \>=0.8.0 |
+
+2. Deploy Kubernetes cluster using kind
+ In this example, kind 0.10.0 is used to install the Kubernetes cluster. The
command is as follows:
+
+ ```
+ kind create cluster --image kindest/node:v1.20.2 --name test-doris
+ ```
+ Expected output:
+ ```
+ Creating cluster "test-doris" ...
+ ✓ Ensuring node image (kindest/node:v1.20.2)
+ ✓ Preparing nodes
+ ✓ Writing configuration
+ ✓ Starting control-plane
+ ✓ Installing CNI
+ ✓ Installing StorageClass
+ Set kubectl context to "kind-test-doris"
+ You can now use your cluster with:
+ ```
+3. Check the Kubernetes cluster status Use the following command to check the
Kubernetes cluster status:
+ ```
+ kubectl cluster-info --context kind-test-doris
+ ```
+ Expected output:
+ ```
+ Kubernetes control plane is running at https://127.0.0.1:40075
+ KubeDNS is running at
https://127.0.0.1:40075/api/v1/namespaces/kube-system/services/kube-dns:dns/proxy
+ To further debug and diagnose cluster problems, use 'kubectl cluster-info
dump'.
+ ```
+## Step 2: Deploy Doris Operator
+Deploying Doris Operator consists of two parts: installing the definition and
deploying the operator service:
+1. Installing Doris Operator CRD
+ Add the custom resource (CRD) of Doris Operator using the following command:
+ ```
+ kubectl apply -f
https://raw.githubusercontent.com/selectdb/doris-operator/master/config/crd/bases/doris.selectdb.com_dorisclusters.yaml
+ ```
+ Expected output:
+ ```
+
customresourcedefinition.apiextensions.k8s.io/dorisclusters.doris.selectdb.com
created
+ ```
+2. Install Doris Operator
+ Install Doris Operator using the following command:
+ ```
+ kubectl apply -f
https://raw.githubusercontent.com/selectdb/doris-operator/master/config/operator/operator.yaml
+ ```
+ Expected output:
+ ```
+ namespace/doris created
+ role.rbac.authorization.k8s.io/leader-election-role created
+ rolebinding.rbac.authorization.k8s.io/leader-election-rolebinding created
+ clusterrole.rbac.authorization.k8s.io/doris-operator created
+ clusterrolebinding.rbac.authorization.k8s.io/doris-operator-rolebinding
created
+ serviceaccount/doris-operator created
+ deployment.apps/doris-operator created
+ ```
+3. Check the Doris Operator status
+ Check the deployment status of Doris Operator using the following command:
+ ```
+ kubectl get pods -n doris
+ ```
+ Expected output:
+ ```
+ NAME READY STATUS RESTARTS AGE
+ doris-operator-7f578c86cb-nz6jn 1/1 Running 0 19m
+ ```
+For Doris Operator related configuration and other deployment methods, please
refer to [Deploying Doris Operator](./install-operator.md).
+## Step 3: Deploy Doris cluster
+1. Download the template Doris deployment template:
+ ```
+ curl -O
https://raw.githubusercontent.com/apache/doris-operator/master/doc/examples/doriscluster-sample.yaml
+ ```
+2. Perform customized configuration as needed according to the [Deploying
Doris Cluster](./install-doris-cluster.md). After the configuration is
completed, deploy it with the following command:
+ ```
+ kubectl apply -f doriscluster-sample.yaml
+ ```
+3. Check the cluster deployment status:
+ Check the status of the cluster by checking the status of pods:
+ ```
+ kubectl get pods
+ ```
+ Expected output:
+ ```
+ NAME READY STATUS RESTARTS AGE
+ doriscluster-sample-fe-0 1/1 Running 0 2m
+ doriscluster-sample-be-0 1/1 Running 0 3m
+ ```
+ Check the status of the deployed resources:
+ ```
+ kubectl get dcr -n doris
+ ```
+ Expected output:
+ ```
+ NAME FESTATUS BESTATUS CNSTATUS BROKERSTATUS
+ doriscluster-sample available available
+ ```
+
+## Step 4: Connect and access the Doris cluster
+
+The Doris cluster is quickly deployed in the test environment. You can enter
the container FE and use the MySQL Client to connect to Doris for test
operations. For other access methods, refer to [Accessing Doris
Cluster](./install-access-cluster.md) for configuration.
+1. Get the FE container name:
+ ```
+ kubectl get pod -n doris | grep fe
+ doriscluster-sample-fe-0 1/1 Running 0 16m
+ ```
+ In this example, the FE container is named doriscluster-sample-fe-0.
+
+2. Enter the FE container:
+ ```
+ kubectl -n doris exec -it doriscluster-sample-fe-0 /bin/bash
+ ```
+
+3. Use MySQL Client to connect to the Doris cluster in the FE container:
+ ```
+ mysql -uroot -P9030 -h127.0.0.1
+ ```
\ No newline at end of file
diff --git a/versioned_sidebars/version-2.1-sidebars.json
b/versioned_sidebars/version-2.1-sidebars.json
index e56109a0e5..dfa52bc5d0 100644
--- a/versioned_sidebars/version-2.1-sidebars.json
+++ b/versioned_sidebars/version-2.1-sidebars.json
@@ -27,6 +27,7 @@
"label": "Deploying on Kubernetes",
"items": [
"install/cluster-deployment/k8s-deploy/install-env",
+
"install/cluster-deployment/k8s-deploy/install-quickstart",
"install/cluster-deployment/k8s-deploy/install-operator",
"install/cluster-deployment/k8s-deploy/install-config-cluster",
"install/cluster-deployment/k8s-deploy/install-doris-cluster",
diff --git a/versioned_sidebars/version-3.0-sidebars.json
b/versioned_sidebars/version-3.0-sidebars.json
index 2db8760bff..499c5e3af2 100644
--- a/versioned_sidebars/version-3.0-sidebars.json
+++ b/versioned_sidebars/version-3.0-sidebars.json
@@ -32,6 +32,7 @@
"label": "Compute-storage coupled",
"items": [
"install/cluster-deployment/k8s-deploy/compute-storage-coupled/install-operator",
+
"install/cluster-deployment/k8s-deploy/compute-storage-coupled/install-quickstart",
"install/cluster-deployment/k8s-deploy/compute-storage-coupled/install-config-cluster",
"install/cluster-deployment/k8s-deploy/compute-storage-coupled/install-doris-cluster",
"install/cluster-deployment/k8s-deploy/compute-storage-coupled/install-access-cluster",
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
