diff --git a/DISAGGREGATED-README-CN.md b/DISAGGREGATED-README-CN.md index dd4b1715..c875a453 100644 --- a/DISAGGREGATED-README-CN.md +++ b/DISAGGREGATED-README-CN.md @@ -14,17 +14,20 @@ Doris 存算分离包括以下组件：fdb, ms, recycler, fe, be 。 Doris-Opera ## 安装 Operator 1. 下发资源定义： ``` -kubectl create -f https://raw.githubusercontent.com/selectdb/doris-operator/master/config/crd/bases/crds.yaml +kubectl create -f https://raw.githubusercontent.com/selectdb/doris-operator/$(curl -s https://api.github.com/repos/selectdb/doris-operator/releases/latest | grep tag_name | cut -d '"' -f4)/config/crd/bases/crds.yaml ``` 预期结果： ``` customresourcedefinition.apiextensions.k8s.io/foundationdbclusters.apps.foundationdb.org created +customresourcedefinition.apiextensions.k8s.io/foundationdbbackups.apps.foundationdb.org created +customresourcedefinition.apiextensions.k8s.io/foundationdbrestores.apps.foundationdb.org created +customresourcedefinition.apiextensions.k8s.io/dorisclusters.doris.selectdb.com created customresourcedefinition.apiextensions.k8s.io/dorisdisaggregatedclusters.disaggregated.cluster.doris.com created customresourcedefinition.apiextensions.k8s.io/dorisdisaggregatedmetaservices.disaggregated.metaservice.doris.com created ``` 2. 部署 Operator 以及依赖的 RBAC 规则： ``` -kubectl apply -f https://raw.githubusercontent.com/selectdb/doris-operator/master/config/operator/disaggregated-operator.yaml +kubectl apply -f https://raw.githubusercontent.com/selectdb/doris-operator/$(curl -s https://api.github.com/repos/selectdb/doris-operator/releases/latest | grep tag_name | cut -d '"' -f4)/config/operator/disaggregated-operator.yaml ``` 预期结果： ``` @@ -37,7 +40,7 @@ doris-operator-5b667b4954-d674k 1/1 Running 0 11s [部署案例](./doc/examples/disaggregated/cluster) 中提供了常见配置的部署样例。以下使用最简单模式快速搭建拥有 1 套计算集群的 Doris 存算分离数据仓库： 1. 下发 `DorisDisaggregatedMetaService` 资源: ``` -kubectl apply -f https://raw.githubusercontent.com/selectdb/doris-operator/master/doc/examples/disaggregated/metaservice/ddm-sample.yaml +kubectl apply -f https://raw.githubusercontent.com/selectdb/doris-operator/$(curl -s https://api.github.com/repos/selectdb/doris-operator/releases/latest | grep tag_name | cut -d '"' -f4)/doc/examples/disaggregated/metaservice/ddm-sample.yaml ``` 预期结果： ``` @@ -48,7 +51,7 @@ meta-service-release Available Ready Ready 2. 下发包含对象存储信息的 ConfigMap 资源： 存算分离以对象存储作为后端存储，需要提前规划好使用的对象存储。按照 [Doris 存算分离接口](https://doris.apache.org/zh-CN/docs/dev/compute-storage-decoupled/creating-cluster#%E5%86%85%E7%BD%AE%E5%AD%98%E5%82%A8%E5%90%8E%E7%AB%AF)接口格式将对象存储信息配置成 json 格式，以 `instance.conf` 为 key ， json 格式的对象存储信息作为 value 配置到 ConfigMap 的 data 中。 ``` -kubectl apply -f https://raw.githubusercontent.com/selectdb/doris-operator/master/doc/examples/disaggregated/cluster/object-store-info.yaml +kubectl apply -f https://raw.githubusercontent.com/selectdb/doris-operator/$(curl -s https://api.github.com/repos/selectdb/doris-operator/releases/latest | grep tag_name | cut -d '"' -f4)/doc/examples/disaggregated/cluster/object-store-info.yaml ``` 预期结果： ``` @@ -60,7 +63,7 @@ configmap/vault-test created 3. 下发 `DorisDisaggregatedCluster` 资源部署集群： ``` -kubectl apply -f https://raw.githubusercontent.com/selectdb/doris-operator/master/doc/examples/disaggregated/cluster/ddc-sample.yaml +kubectl apply -f https://raw.githubusercontent.com/selectdb/doris-operator/$(curl -s https://api.github.com/repos/selectdb/doris-operator/releases/latest | grep tag_name | cut -d '"' -f4)/doc/examples/disaggregated/cluster/ddc-sample.yaml ``` 预期结果： ``` diff --git a/DISAGGREGATED-README.md b/DISAGGREGATED-README.md index f74441f0..580c5d87 100644 --- a/DISAGGREGATED-README.md +++ b/DISAGGREGATED-README.md @@ -15,17 +15,20 @@ In separation of storage and compute architecture, cluster contains the followin ## Install Operator 1. deploy CustomResourceDefinitions ``` -kubectl create -f https://raw.githubusercontent.com/selectdb/doris-operator/master/config/crd/bases/crds.yaml +kubectl create -f https://raw.githubusercontent.com/selectdb/doris-operator/$(curl -s https://api.github.com/repos/selectdb/doris-operator/releases/latest | grep tag_name | cut -d '"' -f4)/config/crd/bases/crds.yaml ``` Expected result: ``` customresourcedefinition.apiextensions.k8s.io/foundationdbclusters.apps.foundationdb.org created +customresourcedefinition.apiextensions.k8s.io/foundationdbbackups.apps.foundationdb.org created +customresourcedefinition.apiextensions.k8s.io/foundationdbrestores.apps.foundationdb.org created +customresourcedefinition.apiextensions.k8s.io/dorisclusters.doris.selectdb.com created customresourcedefinition.apiextensions.k8s.io/dorisdisaggregatedclusters.disaggregated.cluster.doris.com created customresourcedefinition.apiextensions.k8s.io/dorisdisaggregatedmetaservices.disaggregated.metaservice.doris.com created ``` 2. Install the operator with its RBAC rules: ``` -kubectl apply -f https://raw.githubusercontent.com/selectdb/doris-operator/master/config/operator/disaggregated-operator.yaml +kubectl apply -f https://raw.githubusercontent.com/selectdb/doris-operator/$(curl -s https://api.github.com/repos/selectdb/doris-operator/releases/latest | grep tag_name | cut -d '"' -f4)/config/operator/disaggregated-operator.yaml ``` Expected result: ``` @@ -38,7 +41,7 @@ doris-operator-5b667b4954-d674k 1/1 Running 0 11s [examples](./doc/examples/disaggregated/cluster) contains deployment examples for common configurations. The simple example deployment as follows: 1. Deploy `DorisDisaggregatedMetaService` resource: ``` -kubectl apply -f https://raw.githubusercontent.com/selectdb/doris-operator/master/doc/examples/disaggregated/metaservice/ddm-sample.yaml +kubectl apply -f https://raw.githubusercontent.com/selectdb/doris-operator/$(curl -s https://api.github.com/repos/selectdb/doris-operator/releases/latest | grep tag_name | cut -d '"' -f4)/doc/examples/disaggregated/metaservice/ddm-sample.yaml ``` Expected result: ``` @@ -49,7 +52,7 @@ meta-service-release Available Ready Ready 2. Deploy `ConfigMap` that contains object information for cluster: Separation of storage and compute uses object storage as the backend storage, requiring prior planning of the object storage to be used. Configure object storage information in JSON format according to the [Storage and computation separation interface](https://doris.apache.org/docs/dev/compute-storage-decoupled/creating-cluster/#built-in-storage-vault) format. ``` -kubectl apply -f https://raw.githubusercontent.com/selectdb/doris-operator/master/doc/examples/disaggregated/cluster/object-store-info.yaml +kubectl apply -f https://raw.githubusercontent.com/selectdb/doris-operator/$(curl -s https://api.github.com/repos/selectdb/doris-operator/releases/latest | grep tag_name | cut -d '"' -f4)/doc/examples/disaggregated/cluster/object-store-info.yaml ``` Expected result: ``` @@ -61,7 +64,7 @@ configmap/vault-test created 3. Deploy `DorisDisaggregatedCluster` resource: ``` -kubectl apply -f https://raw.githubusercontent.com/selectdb/doris-operator/master/doc/examples/disaggregated/cluster/ddc-sample.yaml +kubectl apply -f https://raw.githubusercontent.com/selectdb/doris-operator/$(curl -s https://api.github.com/repos/selectdb/doris-operator/releases/latest | grep tag_name | cut -d '"' -f4)/doc/examples/disaggregated/cluster/ddc-sample.yaml ``` Expected result: ``` diff --git a/README-CN.md b/README-CN.md index bdddd73e..13471b77 100644 --- a/README-CN.md +++ b/README-CN.md @@ -15,18 +15,18 @@ Doris-Operator 用于在 Kubernetes 上创建、配置和管理 Doris 集群， ## 安装 1. 安装 DorisCluster 资源定义： ``` -kubectl create -f https://raw.githubusercontent.com/selectdb/doris-operator/$(curl -s https://api.github.com/repos/selectdb/doris-operator/releases/latest | grep tag_name | cut -d '"' -f4)/config/crd/bases/doris.selectdb.com_dorisclusters.yaml +kubectl create -f https://raw.githubusercontent.com/selectdb/doris-operator/$(curl -s https://api.github.com/repos/selectdb/doris-operator/releases/latest | grep tag_name | cut -d '"' -f4)/config/crd/bases/doris.selectdb.com_dorisclusters.yaml ``` 2. 安装 Doris-Operator 服务以及所依赖的 RBAC 权限等相关资源 ``` -kubectl apply -f https://raw.githubusercontent.com/selectdb/doris-operator/$(curl -s https://api.github.com/repos/selectdb/doris-operator/releases/latest | grep tag_name | cut -d '"' -f4)/config/operator/operator.yaml +kubectl apply -f https://raw.githubusercontent.com/selectdb/doris-operator/$(curl -s https://api.github.com/repos/selectdb/doris-operator/releases/latest | grep tag_name | cut -d '"' -f4)/config/operator/operator.yaml ``` ## 部署 Doris [部署范例](./doc/examples)中提供了一些使用Kubernetes特性部署 Doris 的范例。 默认的部署样例中，每个 fe 和 be 最少需要8核和16G的内存，且每个服务部署3个实例。 在使用默认部署之前，确保 K8s 集群有足够的资源能够部署成功。 部署使用容器自身存储(重启丢失数据属易失性介质)包含 fe,be 服务的 Doris 集群，命令如下： ``` -kubectl apply -f https://raw.githubusercontent.com/selectdb/doris-operator/$(curl -s https://api.github.com/repos/selectdb/doris-operator/releases/latest | grep tag_name | cut -d '"' -f4)/doc/examples/doriscluster-sample.yaml +kubectl apply -f https://raw.githubusercontent.com/selectdb/doris-operator/$(curl -s https://api.github.com/repos/selectdb/doris-operator/releases/latest | grep tag_name | cut -d '"' -f4)/doc/examples/doriscluster-sample.yaml ``` [doriscluster-sample-storageclass.yaml](./doc/examples/doriscluster-sample-storageclass.yaml) 展示使用 [StorageClass](https://kubernetes.io/docs/concepts/storage/storage-classes/) 模式提供存储卷部署 doris 的样例。 diff --git a/README.md b/README.md index d039f3b6..732a53e2 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ Users custom `DorisCluster` CRD to deploy doris as demand. ## Installation 1. Install custom resource definitions: ``` -kubectl create -f https://raw.githubusercontent.com/selectdb/doris-operator/$(curl -s https://api.github.com/repos/selectdb/doris-operator/releases/latest | grep tag_name | cut -d '"' -f4)/config/crd/bases/doris.selectdb.com_dorisclusters.yaml +kubectl create -f https://raw.githubusercontent.com/selectdb/doris-operator/$(curl -s https://api.github.com/repos/selectdb/doris-operator/releases/latest | grep tag_name | cut -d '"' -f4)/config/crd/bases/doris.selectdb.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. @@ -32,7 +32,7 @@ The [Quick Start Guide](./doc/examples) have some examples to deploy doris on ku Example specify 8 cores and 16GB of memory for every fe or be, and deployed 3 fe and 3 be. Please confirm the K8s cluster have enough resources. for only deploy fe and be without persistentVolume: ``` -kubectl apply -f https://raw.githubusercontent.com/selectdb/doris-operator/$(curl -s https://api.github.com/repos/selectdb/doris-operator/releases/latest | grep tag_name | cut -d '"' -f4)/doc/examples/doriscluster-sample.yaml +kubectl apply -f https://raw.githubusercontent.com/selectdb/doris-operator/$(curl -s https://api.github.com/repos/selectdb/doris-operator/releases/latest | grep tag_name | cut -d '"' -f4)/doc/examples/doriscluster-sample.yaml ``` This [doriscluster-sample-storageclass.yaml](./doc/examples/doriscluster-sample-storageclass.yaml) displayed to deploy doris with [StorageClass](https://kubernetes.io/docs/concepts/storage/storage-classes/) mode to provide persistent Volume.