Skip to content

Commit c4ddd38

Browse files
author
smiletan
committed
update readme
1 parent 528c324 commit c4ddd38

File tree

2 files changed

+32
-2
lines changed

2 files changed

+32
-2
lines changed

README-CN.md

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,22 @@
11
中文 | [English](README.md)
22
# doris-operator
33
Doris-Operator 用于在 Kubernetes 上创建、配置和管理 Doris 集群,能够部署和管理 fe、be、cn、broker 所有组件。
4+
5+
[![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg?color=f5deb3)](https://www.apache.org/licenses/LICENSE-2.0.html)
6+
[![Operator Release](https://img.shields.io/github/v/release/apache/doris-operator?color=00FFFF)](https://github.com/apache/doris-operator/releases)
7+
[![Tags](https://img.shields.io/github/v/tag/apache/doris-operator?label=latest%20tag&color=00FF7F)](https://github.com/apache/doris-operator/tags)
8+
[![docker pull](https://img.shields.io/docker/pulls/apache/doris?color=1E90FF&logo=docker)](https://img.shields.io/docker/pulls/apache/doris)
9+
[![issues](https://img.shields.io/github/issues-search?query=repo%3Aapache%2Fdoris-operator%20is%3Aopen&color=AFEEEE&label=issues)](https://github.com/apache/doris-operator/issues)
10+
[![Go Version](https://img.shields.io/github/go-mod/go-version/apache/doris-operator?color=00FFFF)](https://img.shields.io/github/go-mod/go-version/apache/doris-operator)
11+
[![docs](https://img.shields.io/website?url=https%3A%2F%2Fdoris.apache.org%2Fdocs%2Finstall%2Fdeploy-on-kubernetes%2Finstall-config-cluster&label=docs&color=7FFF00)](https://doris.apache.org/docs/install/deploy-on-kubernetes/install-config-cluster)
12+
413
## 特点
514
- 通过自定义 DorisCluster 资源管控 Doris 集群。
615
- 提供定制化存储。
716
- 实现 Doris 在 Kubernetes 上无感升级。
817
- 提供服务在 crash 情况下,容器内 Debug 能力。
18+
- 支持使用 kerberos 认证服务。
19+
- 支持部署 Doris 存算分离模式。
920

1021
## 环境要求
1122
- Kubernetes 1.19+
@@ -23,7 +34,25 @@ kubectl apply -f https://raw.githubusercontent.com/apache/doris-operator/$(curl
2334
3. 在 Kubernetes 上部署 Doris 集群:
2435
```
2536
kubectl apply -f https://raw.githubusercontent.com/apache/doris-operator/$(curl -s https://api.github.com/repos/apache/doris-operator/releases/latest | grep tag_name | cut -d '"' -f4)/doc/examples/doriscluster-sample.yaml
26-
```
27-
37+
```
2838
>[!WARNING]
2939
>1. 当定制化 FE 启动配置时,请设置 `enable_fqdn_mode=true`。请参考[官方文档](https://doris.apache.org/zh-CN/docs/3.0/install/cluster-deployment/k8s-deploy/compute-storage-coupled/install-quickstart)了解更详细的使用介绍。
40+
41+
## 文档
42+
- 存算一体
43+
- [deploy doris operator on kubernetes](https://doris.apache.org/zh-CN/docs/install/deploy-on-kubernetes/install-doris-operator)
44+
- [config doris to deploy](https://doris.apache.org/zh-CN/docs/install/deploy-on-kubernetes/install-config-cluster)
45+
- [deploy doris on kubernetes](https://doris.apache.org/zh-CN/docs/install/deploy-on-kubernetes/install-doris-cluster)
46+
- [how to access doris cluster in kubernetes](https://doris.apache.org/zh-CN/docs/install/deploy-on-kubernetes/access-cluster)
47+
- [cluster operation](https://doris.apache.org/zh-CN/docs/install/deploy-on-kubernetes/cluster-operation)
48+
- 存算分离
49+
- [quick start](https://doris.apache.org/zh-CN/docs/3.0/install/deploy-on-kubernetes/separating-storage-compute/install-doris-cluster)
50+
- [deploy foundationDB](https://doris.apache.org/zh-CN/docs/3.0/install/deploy-on-kubernetes/separating-storage-compute/install-fdb)
51+
- [config meta service](https://doris.apache.org/zh-CN/docs/3.0/install/deploy-on-kubernetes/separating-storage-compute/config-ms)
52+
- [config fe specification](https://doris.apache.org/zh-CN/docs/3.0/install/deploy-on-kubernetes/separating-storage-compute/config-fe)
53+
- [config compute specification](http://doris.apache.org/zh-CN/docs/3.0/install/deploy-on-kubernetes/separating-storage-compute/config-cg)
54+
55+
## 开源支持
56+
- [CN Forum](https://ask.selectdb.com/)
57+
- [github issues](https://github.com/apache/doris-operator/issues)
58+
- [Slack](https://apachedoriscommunity.slack.com/archives/C08A99F88DP/p1739955284300669)

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,3 +57,4 @@ kubectl apply -f https://raw.githubusercontent.com/apache/doris-operator/$(curl
5757
## Open source support
5858
- [CN Forum](https://ask.selectdb.com/)
5959
- [github issues](https://github.com/apache/doris-operator/issues)
60+
- [Slack](https://apachedoriscommunity.slack.com/archives/C08A99F88DP/p1739955284300669)

0 commit comments

Comments
 (0)