Skip to content

Commit 2b461bc

Browse files
author
smiletan
committed
finished test and readme
1 parent bd8bba3 commit 2b461bc

File tree

5 files changed

+67
-3
lines changed

5 files changed

+67
-3
lines changed
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Deploy Doris Storage-Compute Decoupled Cluster
2+
[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/doris)](https://artifacthub.io/packages/search?repo=doris)
3+
4+
## Prepare
5+
1. install doris operator
6+
Deploy the doris operator in your kubernetes cluster. deploy doris operator have two methods: [directly yaml](https://github.com/apache/doris-operator); [doris operator helm chart](https://artifacthub.io/packages/helm/doris/doris-operator).
7+
2. install foundationDB
8+
Doris storage-compute decoupled cluster use the FoundationDB as meta storage component, please prepare a foundationdb cluster before deploy doris storage-compute decoupled cluster. please refer the [foundationdb official doc site](https://apple.github.io/foundationdb/administration.html#starting-and-stopping) to deploy on machine, or you can use the [fdb-kubernetes-operator](https://github.com/FoundationDB/fdb-kubernetes-operator) to deploy on kubernetes. doris operator provide a sample [helm chart](https://artifacthub.io/packages/helm/doris/doris-foundationdb) that integrate the official fdb-kubernetes-operator chart to deploy foundationdb on kubernetes.
9+
10+
## Install
11+
### Add helm-chart repo
12+
1. add the selectdb repository
13+
```Bash
14+
helm repo add selectdb https://charts.selectdb.com
15+
```
16+
2. update the helm chart repo to the latest version
17+
```Bash
18+
helm repo udpate selectdb
19+
```
20+
3. check the helm chart repo is the latest version
21+
```Bash
22+
$ helm search repo selectdb
23+
NAME CHART VERSION APP VERSION DESCRIPTION
24+
selectdb/doris-operator 25.4.0 1.3.1 Doris-operator for doris creat ...
25+
selectdb/doris 25.4.0 2.1.7 Apache Doris is an easy-to-use ...
26+
selectdb/doris-foundationdb 0.2.0 v2.3.0 A Helm chart for foundationDB ...
27+
```
28+
### Install the doris storage-compute decoupled cluster
29+
#### Use default config
30+
- fdb deployed on kubernetes
31+
```Bash
32+
helm install doris-disaggregated --set msSpec.fdb.namespace={namespace} --set msSpec.fdb.fdbClusterName={fdbClusterName}
33+
```
34+
please use the real namespace replace the {namespace} as the foundationdb deployed namespace, if you use the [fdb-kubernetes-operator]() or [doris-foundationdb]() deploy foundationdb.
35+
{fdbClusterName} is the `FoundationDBCluster` resource's name.
36+
- fdb deployed on machine
37+
```Bash
38+
helm install doris-disaggregated --set msSpec.fdb.address={address}
39+
```
40+
{address} is the address of fdb accessed, it is content of [fdb.cluster file](https://apple.github.io/foundationdb/administration.html#cluster-files).
41+
42+
#### Custom deploying
43+
1. use the follow command to download and unpack the chart
44+
```Bash
45+
helm pull --untar selectdb/doris-disaggregated
46+
```
47+
48+
2. helm install doris storage-compute decoupled cluster
49+
when you want to specify resources or different deployment type, please custom the [`values.yaml`](./values.yaml) and use next command for deploying.
50+
```Bash
51+
helm install doris-disaggregated -f values.yaml doris-disaggregated
52+
```
53+
## Uninstall cluster
54+
Please confirm the Doris storage-compute decoupled cluster is not used, when using next command to uninstall `doris-disaggregated`.
55+
```Bash
56+
helm uninstall doris-disaggregated
57+
```

helm-charts/doris-disaggregated/templates/dorisdisaggregatedcluster.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,13 @@ spec:
3737
{{- end }}
3838
replicas: {{ .Values.msSpec.replicas }}
3939
fdb:
40+
{{- if .Values.msSpec.fdb.address }}
41+
address: {{ .Values.msSpec.fdb.address }}
42+
{{- else }}
4043
configMapNamespaceName:
4144
name: {{ include "ms.fdb.configmap.name" . }}
4245
namespace: {{ include "ms.fdb.namespace" . }}
46+
{{- end }}
4347
configMaps:
4448
- name: {{ include "ms.configmap.name" . }}
4549
mountPath: {{ include "ms.configmap.mountpath" . }}

helm-charts/doris-disaggregated/values.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ msSpec:
3636
# the fdb cluster name which deployed by fdb-kubernetes-operator. if use doris-foundationdb, the value default is `test-cluster`,
3737
# if updated or not use doris-foundationdb deployed, should config it by manual.
3838
fdbClusterName: test-cluster
39+
# if the fdb deployed on machine, directly config the address that find from the fdb.cluster file.
40+
#address: ""
3941
# the replicas of ms, 2 are usually enough.
4042
replicas: 2
4143
image:

helm-charts/doris-foundationdb/charts/fdb-operator/Chart.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
apiVersion: v2
22
name: fdb-operator
3-
description: A Helm chart for foundationDB operator
3+
description: A Helm chart for foundationDB and fdb-kubernetes-operator
44
home: https://www.foundationdb.org/
55
sources:
66
- https://github.com/FoundationDB/fdb-kubernetes-operator/tree/main/charts/fdb-operator

helm-charts/doris/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,11 @@ this document and doris-operator installation document are duplicated. you can s
3333
```bash
3434
$ helm install doriscluster selectdb/doris
3535
```
36-
- Custom doris deploying
36+
- Custom doris deploying
3737
when you want to specify resources or different deployment type, please custom the [`values.yaml`](./values.yaml) and use next command for deploying.
3838
```bash
39-
$ helm install -f values.yaml doriscluster selectdb/doris
39+
# helm pull --untar selectdb/doris
40+
$ helm install -f values.yaml doriscluster doris
4041
```
4142

4243
### Validate installation status

0 commit comments

Comments
 (0)