Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update workload document #1407

Closed
wants to merge 98 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
98 commits
Select commit Hold shift + click to select a range
a665b9d
Update load-manual.md (#1339)
Ruffianjiang Nov 19, 2024
59ffabb
[Refactor](data-partition) Refactor data partition docs (#1364)
zclllyybb Nov 19, 2024
2b574c6
[download] Fix 2.0.15 download link (#1374)
KassieZ Nov 19, 2024
768e146
[docs](typo) Version mgt and fix typo (#1362)
KassieZ Nov 19, 2024
937309d
[Fix] Update remote-storage.md (#1247)
intelligentfu8 Nov 19, 2024
0c17c70
Update install-env.md (#1269)
wangtianyi2004 Nov 19, 2024
817edf4
Update install-env.md (#1270)
wangtianyi2004 Nov 19, 2024
592a5d6
[doc] fix dead link (#1317)
sdhzwc Nov 19, 2024
4d8c7c5
[doc] add datalake tutorial of lakesoul (#1320)
Ceng23333 Nov 19, 2024
b39204b
[Docs] Add doc for variant nested type (#1328)
eldenmoon Nov 19, 2024
5b18007
[blog](update) Update blog and fix typo (#1381)
KassieZ Nov 21, 2024
0d17212
[doc](refactor) update k8s install operator doc (#1369)
intelligentfu8 Nov 21, 2024
8abd63d
[doc](function) support table-function posexplode (#1283)
zhangstar333 Nov 21, 2024
71b86fe
[doc] fix link error of lakesoul tutorial (#1384)
Ceng23333 Nov 21, 2024
7cc3026
[doc](routine load) fix routine load doc error (#1382)
sollhui Nov 22, 2024
5a496a2
Removed useless workflow: deadlink checker (#1394)
yang1666204 Nov 23, 2024
e04f3ee
[community] Update announcement (#1398)
KassieZ Nov 23, 2024
b0e8dff
[fix] fix cron deploy1 (#1400)
KassieZ Nov 23, 2024
a07046f
Update:add event Doris Summit Asia 2024 (#1395)
yang1666204 Nov 25, 2024
99a2a9e
[doc](dbt)add dbt doc example (#1387)
catpineapple Nov 25, 2024
fea6ece
[doc](fixed) selectdb to apache (#1402)
intelligentfu8 Nov 25, 2024
6e7aee7
Update build-check.yml (#1401)
jeffreys-cat Nov 25, 2024
a1f4912
[fix] Update Doris Summit Asia (#1405)
KassieZ Nov 25, 2024
41a58e8
[mod] modify the announcement (#1406)
morningman Nov 25, 2024
1aa0683
Add restore_download_snapshot_batch_size/backup_upload_snapshot_batch…
w41ter Nov 27, 2024
8de4b3a
[blog] Update minimax blog and all release (#1414)
KassieZ Nov 27, 2024
b15ca03
[doc](udf) refactor the java-udf function doc (#1383)
zhangstar333 Nov 27, 2024
7b68672
[doc] add doc of `show backend config` (#1306)
DarvenDuan Nov 27, 2024
5623288
[Enhancement] replace table options to keep original dropped table in…
Vallishp Nov 27, 2024
7d9903a
[web]Update the version selection on the upgrade page (#1326)
yang1666204 Nov 27, 2024
14b6fac
Update high-concurrent-point-query.md (#1329)
wangtianyi2004 Nov 27, 2024
13b4769
[doc](percentile) update percentile/percentile_array doc as now suppo…
zhangstar333 Nov 27, 2024
be32821
[Chinese] update join hint (#1375)
LiBinfeng-01 Nov 28, 2024
c2bc502
[fix] Fix crondeploy by Java UDF Docs Format (#1418)
KassieZ Nov 28, 2024
8fe409f
[improvement] improve docs for ccr (#1419)
dataroaring Nov 28, 2024
55671ec
update row storage docs (#1413)
xiaokang Nov 28, 2024
cc975e0
[opt](show) update show collation sql reference manual (#1410)
morrySnow Nov 28, 2024
0295f70
[update] add collaborators (#1421)
KassieZ Nov 28, 2024
6d51f24
[doc] add trim_in function docs (#1207)
liujiwen-up Nov 28, 2024
1b812a6
Update quick-start.md (#1345)
Ruffianjiang Nov 28, 2024
ce70cda
增加端口规划,客户端需要8040的端口的网络连通。 (#1377)
zyszys-max Nov 28, 2024
ec83e9d
[improvement](ccr) improve overview of ccr (#1427)
dataroaring Dec 2, 2024
41055be
[doc](update) modify the example for UPDATE usage (#1412)
zhannngchen Dec 3, 2024
0380821
[doc]modify wrongly written character in release-2.1.4.md (#1432)
ixzc Dec 3, 2024
3504dc4
[Fix](CI) ignore markdown file suffix changes in deadlink check (#1447)
zclllyybb Dec 4, 2024
11f7c83
[release] Update 3.0.3 release note (#1451)
KassieZ Dec 4, 2024
8671466
[update] update banner link (#1456)
KassieZ Dec 5, 2024
a810f25
[Feature] Add map function docs which implemented for long (#1454)
zclllyybb Dec 5, 2024
d25cd71
[Enhancement](function) Add more detail explanation about approx_coun…
zclllyybb Dec 5, 2024
74de2f7
feat:docs (#1461)
yang1666204 Dec 5, 2024
a31ae20
fix:search load (#1462)
yang1666204 Dec 5, 2024
e15d32b
fix: fix resources url error (#1465)
KassieZ Dec 5, 2024
871a15b
[fix] fix the search cors error (#1466)
jeffreys-cat Dec 6, 2024
a3ed26c
fix: fix the searchbar version (#1467)
yang1666204 Dec 6, 2024
99e243a
fix:change searchbar version to 0.45 (#1468)
yang1666204 Dec 6, 2024
f9cd873
fix:fix search bar (#1469)
yang1666204 Dec 6, 2024
204f988
fix:request when switch version (#1470)
yang1666204 Dec 6, 2024
3949aa9
feat: remove pwa (#1471)
jeffreys-cat Dec 6, 2024
4ebf77d
K8s decoupled doc (#1415)
intelligentfu8 Dec 6, 2024
7c0524f
[improvement](cluster_id) provide a shell generating random cluster_i…
dataroaring Dec 6, 2024
5725a4b
Update what-is-apache-doris.md (#1472)
ssusieee Dec 6, 2024
3f08c80
[opt](encryption) update encryption function docs (#1463)
morrySnow Dec 6, 2024
4888d0c
[update](sql statement) Refactor sql statement of v3.0and v2.1 (#1449)
KassieZ Dec 6, 2024
7e50cc8
[fix] fix format and typo (#1474)
KassieZ Dec 6, 2024
320436c
fix:searchbar style (#1475)
yang1666204 Dec 9, 2024
53ff296
modify the request url of search (#1479)
yang1666204 Dec 9, 2024
cb24992
[fix] release 3.0.3 (#1480)
KassieZ Dec 9, 2024
88010f3
[update] Blog (#1481)
KassieZ Dec 9, 2024
96ddd58
add build check (#1483)
yang1666204 Dec 9, 2024
e2c4201
Update es.md (#1430)
jgq2008303393 Dec 9, 2024
3df0d0d
[auth]change default log level of ranger to warn (#1433)
zddr Dec 9, 2024
13936a4
[doc](update) rewrite update overview doc (#1393)
zhannngchen Dec 9, 2024
a02c784
[update] Update auth docs (#1485)
KassieZ Dec 9, 2024
5ddf2ef
[doc](delete) update the examples of batch delete to reference links …
zhannngchen Dec 10, 2024
fcc63fd
[doc] fix the wrong link in the tpch document (#1486)
tiger3q Dec 10, 2024
e2ae0ff
[doc]Support for IP types in Java UDF (#1444)
Mryange Dec 10, 2024
ee9f8ba
fix name SQL conflict error in point query docs (#1439)
xiaokang Dec 10, 2024
52e1d92
[opt](cte) indicate not support recursive cte (#1388)
morrySnow Dec 10, 2024
00d1873
update subquery document (#1422)
starocean999 Dec 10, 2024
6b30608
Fixed the issue where the search box request took too long (#1495)
yang1666204 Dec 10, 2024
a3bd665
[update] Add file_cache_statistics (#1496)
KassieZ Dec 11, 2024
2f79bbb
[Doc](benchmark) update 2.1 benchmark doc. (#1493)
feifeifeimoon Dec 11, 2024
d43cc31
[community] Add special thanks of community (#1502)
KassieZ Dec 11, 2024
a34d7b6
Update mysql-compatibility.md (#1498)
wm1581066 Dec 11, 2024
5f78d78
[update] Fix typo of MySQL Compatibility (#1504)
KassieZ Dec 11, 2024
fe75658
[Enhancement]:Optimize navbar (#1497)
yang1666204 Dec 11, 2024
107bc40
Remove common docs (#1501)
yang1666204 Dec 11, 2024
2983496
[opt](sql cache) Reorganize the chapter on SQL Cache (#1392)
morrySnow Dec 11, 2024
bd18304
[fix] Fix deadlink of complex data type (#1507)
KassieZ Dec 12, 2024
9b69d94
[fix] add the window-function doc and multi-dimensional-analytics doc…
feiniaofeiafei Dec 12, 2024
2fbf40f
fix:download page (#1514)
yang1666204 Dec 12, 2024
fcb4a82
[feat]:searchbar in mobile (#1517)
yang1666204 Dec 13, 2024
fa45f8c
[doc](update) update concurrent control (#1487)
zhannngchen Dec 16, 2024
43a077a
[doc](update) modify update-of-unique-model.md (#1438)
zhannngchen Dec 16, 2024
92aa6dc
Restore announcementBar (#1525)
yang1666204 Dec 16, 2024
66849d8
[refactor](k8s)K8s coupled refactor arch (#1500)
intelligentfu8 Dec 16, 2024
b2bb98c
[docs](load) restructure broker load docs (#1372)
kaijchen Dec 17, 2024
3a930f8
update workload document
wangbo Nov 25, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
K8s decoupled doc (#1415)
# Versions 

- [x] dev
- [x] 3.0
- [ ] 2.1
- [ ] 2.0

# Languages

- [x] Chinese
- [x] English
  • Loading branch information
intelligentfu8 authored Dec 6, 2024
commit 4ebf77d45aa54c6f2963d87ca8cd9f560059b8b5
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ under the License.
## Cluster planning
In the default DorisCluster resource deployment, the FE and BE images may not be the latest versions, and the default replica count for both FE and BE is set to 3. Additionally, Additionally, the default resource configuration for FE is 6 CPUs and 12Gi of memory, while for BE, it is 8 CPUs and 16Gi of memory. This section describes how to modify these default configurations according to your requirements.

### Image settings
### Image configuration
Doris Operator is decoupled from the Doris version and supports deploying Doris versions 2.0 and above.

**FE image configuration**
Expand All @@ -48,8 +48,8 @@ spec:
```
Replace ${image} with the desired image name, then update the configuration in the target [DorisCluster resource](install-quickstart.md#step-2-deploy-doris-cluster). Official BE images are available at [BE Image](https://hub.docker.com/repository/docker/selectdb/doris.be-ubuntu).

### Replicas settings
**FE Replicas Setting**
### Replicas configuration
**FE replicas configuration**
To modify the default FE replica count of 3 to 5, use the following configuration:
```yaml
spec:
Expand All @@ -58,7 +58,7 @@ spec:
```
Update the configuration in the target [DorisCluster resource](install-quickstart.md#step-2-deploy-doris-cluster).

**BE Replicas Setting**
**BE replicas configuration**
To modify the default FE replica count of 3 to 5, use the following configuration:
```yaml
spec:
Expand All @@ -67,7 +67,7 @@ spec:
```
Update the configuration to the [DorisCluster resource](install-quickstart.md#step-2-deploy-doris-cluster) that needs to be deployed.

### Computing resource settings
### Computing resource configuration
**FE computing resource configuration**
The default compute resource configuration for FE is 6 CPUs and 12Gi of memory. To modify it to 8CPUs and 16Gi, use the following configuration:
```yaml
Expand All @@ -82,7 +82,7 @@ spec:
```
Update the configuration in the target [DorisCluster resource](install-quickstart.md#step-2-deploy-doris-cluster).

**BE computing resource setting**
**BE computing resource configuration**
The default compute resource configuration for BE is 8 CPUs and 16Gi of memory. To modify it to 16 CPUs and 32Gi of memory, use the following configuration:
```yaml
spec:
Expand Down Expand Up @@ -356,7 +356,7 @@ beSpec:
```
In the above configuration, ${your_storageclass} represents the name of the StorageClass you want to use, and ${storageSize} represents the storage size you want to use. The format of ${storageSize} follows the [quantity expression method](https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/quantity/) of K8s, such as: 100Gi. Please replace them as needed when using.

## Access Configuration
## Access configuration
Kubernetes provides the use of Service as VIP (Virtual IP) and load balancer. There are three external exposure modes for Service: ClusterIP, NodePort, and LoadBalancer.

### ClusterIP
Expand Down Expand Up @@ -517,7 +517,7 @@ To access Doris through the LoadBalancer, use the external IP (provided in the E
mysql -h ac4828493dgrftb884g67wg4tb68gyut-1137856348.us-east-1.elb.amazonaws.com -P 31545 -uroot
```

## Configuring the Username and Password for the Management Cluster
## Configuring the username and password for the management cluster
Managing Doris nodes requires connecting to the live FE nodes via the MySQL protocol using a username and password for administrative operations. Doris implements [a permission management mechanism similar to RBAC](../../../../admin-manual/auth/authentication-and-authorization?_highlight=rbac), where the user must have the [Node_priv](../../../../admin-manual/auth/authentication-and-authorization.md#types-of-permissions) permission to perform node management. By default, the Doris Operator deploys the cluster with the root user in passwordless mode.

The process of configuring the username and password can be divided into three scenarios:
Expand All @@ -529,7 +529,7 @@ To secure access, you must configure a username and password with Node_Priv perm
- Using environment variables
- Using a Kubernetes Secret

### Configuring the Root User Password during Cluster Deployment
### Configuring the root user password during cluster deployment
To set the root user's password securely, Doris supports encrypting it in [`fe.conf`](../../../../admin-manual/config/fe-config?_highlight=initial_#initial_root_password) using a two-stage SHA-1 encryption process. Here's how to set up the password.

#### Step 1: Generate the root encrypted password
Expand Down Expand Up @@ -618,7 +618,7 @@ After setting the root password in fe.conf, Doris will automatically apply the p

Here, ${secretName} is the name of the Secret containing the root username and password.

### Automatically Creating Non-Root Management Users and Passwords during Deployment (Recommended)
### Automatically creating non-root management users and passwords during deployment (Recommended)
For enhanced security, it is recommended to create a non-root user for management during the first deployment, rather than using the root user. In this method, the username and password for the non-root user are configured through environment variables or Secrets. The Doris container's auxiliary services will automatically create the user in the database, set the password, and grant the necessary Node_priv permission. After deployment, Doris Operator will use the newly created non-root username and password to manage the cluster nodes.

- Using environment variables:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,11 @@ The deployment operations are as follows:

## Step 1: 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:
1. Add the custom resource (CRD) of Doris Operator using the following command:
```shell
kubectl create -f https://raw.githubusercontent.com/apache/doris-operator/master/config/crd/bases/doris.apache.com_dorisclusters.yaml
```

2. Install Doris Operator
Install Doris Operator using the following command:
2. Install Doris Operator using the following command:
```shell
kubectl apply -f https://raw.githubusercontent.com/apache/doris-operator/master/config/operator/operator.yaml
```
Expand All @@ -50,8 +47,7 @@ Deploying Doris Operator consists of two parts: installing the definition and de
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:
3. Check the deployment status of Doris Operator using the following command:
```shell
kubectl get pods -n doris
```
Expand All @@ -70,8 +66,7 @@ Deploying Doris Operator consists of two parts: installing the definition and de
```shell
kubectl apply -f doriscluster-sample.yaml
```
3. Check the cluster deployment status:
Check the status of the cluster by checking the status of pods:
3. Check the status of the cluster by checking the status of pods:
```shell
kubectl get pods
```
Expand Down
Loading