| English | [中文](README-CN.md) |
| # doris-operator |
| Doris-Operator for doris creates, configures and manages doris cluster running on kubernetes. Operator provide deploy and manage fe, be, cn，broker components. |
| Users custom `DorisCluster` CRD to deploy doris as demand. |
| |
| [](https://www.apache.org/licenses/LICENSE-2.0.html) |
| [](https://github.com/apache/doris-operator/releases) |
| [](https://github.com/apache/doris-operator/tags) |
| [](https://img.shields.io/docker/pulls/apache/doris) |
| [](https://github.com/apache/doris-operator/issues) |
| [](https://img.shields.io/github/go-mod/go-version/apache/doris-operator) |
| [](https://doris.apache.org/docs/install/deploy-on-kubernetes/install-config-cluster) |
| |
| ## Features |
| - Realized Doris management by custom DorisCluster resource. |
| - Safe Doris cluster configuration & topology changes. |
| - Custom node configuration and attributes. |
| - Provide the debug ability in container when the service crashed. |
| - Support deploy storage-compute separation mode of Doris. |
| |
| ## Requirements |
| - Kubernetes 1.19+ |
| - Doris's components need 8c cpu and 8G memory at least to normal start. |
| |
| ## Installation |
| 1. Install custom resource definitions: |
| ```shell |
| kubectl create -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)/config/crd/bases/doris.apache.com_dorisclusters.yaml |
| ``` |
| 2. Install the operator with its RBAC rules: |
| the default deployed namespace is doris, when deploy on specific namespace, please pull yaml and update `namespace` field. |
| ```shell |
| 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)/config/operator/operator.yaml |
| ``` |
| 3. Install Doris on Kubernetes: |
| ```shell |
| 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 |
| ``` |
| >[!WARNING] |
| >When custom the FE startup configuration, please set `enable_fqdn_mode=true`. Please refer to [the official doc](https://doris.apache.org/docs/3.0/install/cluster-deployment/k8s-deploy/compute-storage-coupled/install-config-cluster) for how to use. |
| |
| ## Documentation |
| - integration of storage and computation |
| - [deploy doris operator on kubernetes](https://doris.apache.org/docs/install/deploy-on-kubernetes/install-doris-operator) |
| - [config doris to deploy](https://doris.apache.org/docs/install/deploy-on-kubernetes/install-config-cluster) |
| - [deploy doris on kubernetes](https://doris.apache.org/docs/install/deploy-on-kubernetes/install-doris-cluster) |
| - [how to access doris cluster in kubernetes](https://doris.apache.org/docs/install/deploy-on-kubernetes/access-cluster) |
| - [cluster operation](https://doris.apache.org/docs/install/deploy-on-kubernetes/cluster-operation) |
| - separation of storage and computation |
| - [quick start](https://doris.apache.org/docs/3.0/install/deploy-on-kubernetes/separating-storage-compute/install-doris-cluster) |
| - [deploy foundationDB](https://doris.apache.org/docs/3.0/install/deploy-on-kubernetes/separating-storage-compute/install-fdb) |
| - [config meta service](https://doris.apache.org/docs/3.0/install/deploy-on-kubernetes/separating-storage-compute/config-ms) |
| - [config fe specification](https://doris.apache.org/docs/3.0/install/deploy-on-kubernetes/separating-storage-compute/config-fe) |
| - [config compute specification](http://doris.apache.org/docs/3.0/install/deploy-on-kubernetes/separating-storage-compute/config-cg) |
| |
| ## Open source support |
| - [CN Forum](https://ask.selectdb.com/) |
| - [github issues](https://github.com/apache/doris-operator/issues) |
| - [Slack](https://apachedoriscommunity.slack.com/archives/C02T886T5AR) |
