KassieZ commented on code in PR #1543:
URL: https://github.com/apache/doris-website/pull/1543#discussion_r1897144117
##########
docs/install/deploy-manually/storage-compute-coupled-deploy-manually.md:
##########
@@ -0,0 +1,317 @@
+---
+{
+ "title": "Deploy Storage Compute Coupled Manually",
+ "language": "en"
+}
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+After completing preliminary checks and planning, such as environment checks,
cluster planning, and operating system inspections, you can begin deploying the
cluster. Deploying the cluster is divided into four steps:
+
+1. Deploy FE Master Node: Deploy the first FE node as the Master node;
+
+2. Deploy FE Cluster: Deploy the FE cluster by adding Follower or Observer FE
nodes;
+
+3. eploy BE Nodes: Register BE nodes to the FE cluster;
+
+4. Verify Cluster Correctness: After deployment, connect to and verify the
cluster's correctness.
+
+## Step 1: Deploy FE Master Node
+
+1. Create Metadata Path
+
+ When deploying FE, it is recommended to store metadata on a different hard
drive from the BE node data storage.
+
+ When extracting the installation package, a doris-meta directory is
included by default. It is recommended to create an independent metadata
directory and create a symbolic link to doris-meta. In a production
environment, it is strongly advised to specify a separate directory outside the
Doris installation directory, preferably on a dedicated SSD. For testing and
development environments, you can use the default configuration.
+
+ ```SQL
Review Comment:
sql ， lowercase
##########
docs/install/deploy-manually/storage-compute-coupled-deploy-manually.md:
##########
@@ -0,0 +1,317 @@
+---
+{
+ "title": "Deploy Storage Compute Coupled Manually",
+ "language": "en"
+}
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+After completing preliminary checks and planning, such as environment checks,
cluster planning, and operating system inspections, you can begin deploying the
cluster. Deploying the cluster is divided into four steps:
+
+1. Deploy FE Master Node: Deploy the first FE node as the Master node;
+
+2. Deploy FE Cluster: Deploy the FE cluster by adding Follower or Observer FE
nodes;
+
+3. eploy BE Nodes: Register BE nodes to the FE cluster;
+
+4. Verify Cluster Correctness: After deployment, connect to and verify the
cluster's correctness.
+
+## Step 1: Deploy FE Master Node
+
+1. Create Metadata Path
+
+ When deploying FE, it is recommended to store metadata on a different hard
drive from the BE node data storage.
+
+ When extracting the installation package, a doris-meta directory is
included by default. It is recommended to create an independent metadata
directory and create a symbolic link to doris-meta. In a production
environment, it is strongly advised to specify a separate directory outside the
Doris installation directory, preferably on a dedicated SSD. For testing and
development environments, you can use the default configuration.
+
+ ```SQL
+ ## Use a separate disk for FE metadata
+ mkdir -p <doris_meta_created>
+
+ ## Create FE metadata directory symlink
+ ln -s <doris_meta_original> <doris_meta_created>
+ ```
+
+2. Modify FE Configuration File
+
+ The FE configuration file is located in the conf directory under the FE
deployment path. Before starting the FE node, you need to modify conf/fe.conf.
+
+ Before deploying the FE node, it is recommended to modify the following
parameters:
+
+ ```Bash
+ ## modify Java Heap
+ JAVA_OPTS="-Xmx16384m -XX:+UseMembar -XX:SurvivorRatio=8
-XX:MaxTenuringThreshold=7 -XX:+PrintGCDateStamps -XX:+PrintGCDetails
-XX:+UseConcMarkSweepGC -XX:+UseParNewGC -XX:+CMSClassUnloadingEnabled
-XX:-CMSParallelRemarkEnabled -XX:CMSInitiatingOccupancyFraction=80
-XX:SoftRefLRUPolicyMSPerMB=0 -Xloggc:$DORIS_HOME/log/fe.gc.log.$DATE"
+
+ ## modify case sensitivity
+ lower_case_table_names = 1
+
+ ## modify network CIDR
+ priority_networks = 10.1.3.0/24
+
+ ## modify Java Home
+ JAVA_HOME = <your-java-home-path>
+ ```
+
+ Parameter Descriptions: For more detailed parameters, refer to the
documentation. [FE Configuration](../../admin-manual/config/fe-config)：
+
+ | 参数 | 修改建议
|
Review Comment:
Parameters Suggestions
##########
i18n/zh-CN/docusaurus-plugin-content-docs/current/install/deploy-manually/storage-compute-coupled-deploy-manually.md:
##########
@@ -0,0 +1,317 @@
+---
+{
+ "title": "手动部署存算一体集群",
+ "language": "zh-CN"
+}
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+在完成前置检查及规划后，如环境检查、集群规划、操作系统检查后，可以开始部署集群。部署集群分为四步：
+1. 部署 FE Master 节点：部署第一个 FE 节点作为 Master 节点；
+
+2. 部署 FE 集群：部署 FE 集群，添加 Follower 或 Observer FE 节点；
+
+3. 部署 BE 节点：向 FE 集群中注册 BE 节点；
+
+4. 验证集群正确性：部署完成后连接并验证集群正确性。
+
+## 第 1 步：部署 FE Master 节点
+
+1. 创建元数据路径
+
+ 在部署 FE 时，建议与 BE 节点数据存储在不同的硬盘上。
+
+ 在解压安装包时，会默认附带 doris-meta 目录，建议可以创建独立的元数据目录并创建该目录到 `doris-meta`
的软连接。生产环境强烈建议单独指定目录不要放在 Doris 安装目录下，最好是单独的 SSD 硬盘，测试开发环境可以使用默认配置。
+
+ ```SQL
Review Comment:
sql
##########
docs/install/deploy-manually/storage-compute-coupled-deploy-manually.md:
##########
@@ -0,0 +1,317 @@
+---
+{
+ "title": "Deploy Storage Compute Coupled Manually",
+ "language": "en"
+}
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+After completing preliminary checks and planning, such as environment checks,
cluster planning, and operating system inspections, you can begin deploying the
cluster. Deploying the cluster is divided into four steps:
+
+1. Deploy FE Master Node: Deploy the first FE node as the Master node;
+
+2. Deploy FE Cluster: Deploy the FE cluster by adding Follower or Observer FE
nodes;
+
+3. eploy BE Nodes: Register BE nodes to the FE cluster;
+
+4. Verify Cluster Correctness: After deployment, connect to and verify the
cluster's correctness.
+
+## Step 1: Deploy FE Master Node
+
+1. Create Metadata Path
+
+ When deploying FE, it is recommended to store metadata on a different hard
drive from the BE node data storage.
+
+ When extracting the installation package, a doris-meta directory is
included by default. It is recommended to create an independent metadata
directory and create a symbolic link to doris-meta. In a production
environment, it is strongly advised to specify a separate directory outside the
Doris installation directory, preferably on a dedicated SSD. For testing and
development environments, you can use the default configuration.
+
+ ```SQL
+ ## Use a separate disk for FE metadata
+ mkdir -p <doris_meta_created>
+
+ ## Create FE metadata directory symlink
+ ln -s <doris_meta_original> <doris_meta_created>
+ ```
+
+2. Modify FE Configuration File
+
+ The FE configuration file is located in the conf directory under the FE
deployment path. Before starting the FE node, you need to modify conf/fe.conf.
+
+ Before deploying the FE node, it is recommended to modify the following
parameters:
+
+ ```Bash
+ ## modify Java Heap
+ JAVA_OPTS="-Xmx16384m -XX:+UseMembar -XX:SurvivorRatio=8
-XX:MaxTenuringThreshold=7 -XX:+PrintGCDateStamps -XX:+PrintGCDetails
-XX:+UseConcMarkSweepGC -XX:+UseParNewGC -XX:+CMSClassUnloadingEnabled
-XX:-CMSParallelRemarkEnabled -XX:CMSInitiatingOccupancyFraction=80
-XX:SoftRefLRUPolicyMSPerMB=0 -Xloggc:$DORIS_HOME/log/fe.gc.log.$DATE"
+
+ ## modify case sensitivity
+ lower_case_table_names = 1
+
+ ## modify network CIDR
+ priority_networks = 10.1.3.0/24
+
+ ## modify Java Home
+ JAVA_HOME = <your-java-home-path>
+ ```
+
+ Parameter Descriptions: For more detailed parameters, refer to the
documentation. [FE Configuration](../../admin-manual/config/fe-config)：
+
+ | 参数 | 修改建议
|
+ | ------------------------------------------------------------ |
--------------------------------------------------------- |
+ | JAVA_OPTS | Specify
the `-Xmx` parameter to adjust the Java Heap. It is recommended to set it to
above 16G in production environments. |
+ | [lower_case_table_names
](../../admin-manual/config/fe-config#lower_case_table_names) | Set case
sensitivity. It is recommended to adjust it to 1, meaning case-insensitive.
|
+ | [priority_networks
](../../admin-manual/config/fe-config#priority_networks) | Network CIDR is
specified based on the network IP address. It can be ignored in an FQDN
environment. |
+ | JAVA_HOME | It is
recommended to use a JDK environment independent of the operating system for
Doris. |
+
+3. Start FE Process
+
+ You can start the FE process using the following command:
+ ```Shell
+ bin/start_fe.sh --daemon
+ ```
+
+ The FE process will start and run in the background. By default, logs are
stored in the log/ directory. If the startup fails, you can check the
log/fe.log or log/fe.out files for error information.
+
+4. Check FE Startup Status
+
+ You can connect to the Doris cluster using MySQL Client. The default user
is root, and the password is empty.
+
+ ```SQL
+ mysql -uroot -P<fe_query_port> -h<fe_ip_address>
+ ```
+
+ After connecting to the Doris cluster, you can use the show frontends
command to check the status of FE nodes. Typically, you should verify the
following:
+
+ - Alive: If true, it indicates the node is alive.
+ - Join: If true, it indicates the node has joined the cluster, but it
doesn't necessarily mean the node is still active in the cluster (it may have
lost connection).
+ - IsMaster: If true, it indicates the current node is the Master node.
+
+## Step 2: Deploy FE Cluster (Optional)
+
+In a production cluster, it is recommended to deploy at least 3 Follower
nodes. After deploying the FE Master node, you should deploy two additional FE
Follower nodes.
+
+1. Create Metadata Directory
+
+ Follow the same steps as for deploying the FE Master node to create the
`doris-meta` directory.
+
+2. Modify FE Follower Node Configuration
+
+ Modify the FE configuration file for the Follower node, following the same
steps as for the FE Master node. Typically, you can simply copy the
configuration file from the FE Master node.
+
+3. Register New FE Follower Node in the Doris Cluster
+
+ Before starting a new FE node, you need to register the new FE node in the
FE cluster.
+
+ ```Bash
+ ## connect a alive FE node
+ mysql -uroot -P<fe_query_port> -h<fe_ip_address>
+
+ ## registe a new FE follower node
+ ALTER SYSTEM ADD FOLLOWER "<fe_ip_address>:<fe_edit_log_port>"
+ ```
+
+ If you want to add an observer node, you can use the `ADD OBSERVER` command:
+
+ ```Bash
+ ## register a new FE observer node
+ ALTER SYSTEM ADD OBSERVER "<fe_ip_address>:<fe_edit_log_port>"
+ ```
+
+ :::caution Note
+ - The number of FE Follower nodes (including Master) should be odd. It is
recommended to deploy 3 nodes for high availability.
+
+ - When FE is deployed in high availability mode (1 Master, 2 Followers), we
recommend adding Observer FE nodes to extend the FE read service capacity.
+
+ - Typically, one FE node can handle 10-20 BE nodes. It is recommended that
the total number of FE nodes be kept below 10.
+ :::
+4. Start FE Follower Node
+
+ The FE Follower node can be started with the following command, which will
automatically synchronize metadata.
+
+ ```Shell
+ bin/start_fe.sh --helper <helper_fe_ip>:<fe_edit_log_port> --daemon
+ ```
+
+ Here, helper_fe_ip refers to any live node in the current FE cluster. The
--helper parameter is only used for the initial startup of FE to synchronize
metadata. It is not required for subsequent restarts of the FE node.
+
+5. Check Follower Node Status
+
+ The method to check the FE Follower node status is the same as checking the
FE Master node status. After adding and registering the FE Follower node, you
need to use the `show frontends` command to check the FE node status. Unlike
the Master status, the `IsMaster` state should be false.
+
+## Step 3: Deploy BE Node
+
+1. Create Data Directory
+
+ The BE process is responsible for data computation and storage. The data
directory is by default located under `be/storage`. In a production
environment, it is common to use a separate disk for data storage and place BE
data on a different disk from the BE deployment files. BE supports distributing
data across multiple disks to better utilize the I/O capabilities of multiple
hard drives.
+
+ ```Bash
+ ## Create a BE data storage directory on each data disk
+ mkdir -p <be_storage_root_path>
+ ```
+
+2. Modify BE Configuration File
+
+ The BE configuration file is located in the conf directory under the BE
deployment path. Before starting the BE node, you need to modify the
`conf/be.conf` file.
+
+ ```Bash
+ ## modify storage path for BE node
+
+ storage_root_path=/home/disk1/doris,medium:HDD;/home/disk2/doris,medium:SSD
+
+ ## modify network CIDR
+
+ priority_networks = 10.1.3.0/24
+
+ ## modify Java Home in be/conf/be.conf
+
+ JAVA_HOME = <your-java-home-path>
+ ```
+
+ Parameter explanations are as follows:
+
+ | 参数 | 修改建议
|
Review Comment:
parameters Suggestion
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscr...@doris.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@doris.apache.org
For additional commands, e-mail: commits-h...@doris.apache.org
