Skip to content

Commit 4675dc9

Browse files
authored
Merge branch 'master' into patch-1
2 parents 89a1fe9 + 9afab74 commit 4675dc9

File tree

22 files changed

+114
-326
lines changed

22 files changed

+114
-326
lines changed

docs/user_manual/quick_starts/en-US/chapter_01_overview_of_the_oceanbase_database/00_introduction.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ You can contact us in the following ways:
2121

2222
* GitHub page for reporting issues of OceanBase Database Community Edition: [https://github.com/oceanbase/oceanbase/issues](https://github.com/oceanbase/oceanbase/issues)
2323

24-
* DingTalk group ID: 33254054
2524

2625
> **Note**
2726
>

docs/user_manual/quick_starts/en-US/chapter_01_overview_of_the_oceanbase_database/01_overview.md

Lines changed: 102 additions & 316 deletions
Large diffs are not rendered by default.

docs/user_manual/quick_starts/en-US/chapter_02_deploy_oceanbase_database/01_preparation_before_deployment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ OceanBase Database has been systematically tested and verified. We recommend tha
1212

1313
| Item | Requirement | Description |
1414
|---------|-------|-------|
15-
| Server | Mainstream servers that adapt to common software from Chinese manufacturers are supported. | The support details are as follows: <ul><li>Physical servers: Suma H620 series, Huawei TaiShan 200 series, and Great Wall Qingtian DF720 </li><li>CPUs: Hygon 7185/7280, Kunpeng 920, and FeiTeng 2000+ </li><li>Operating systems: Kylin V4, Kylin V10, and UOS V20; upper-layer middleware: TongWeb V7.0 and Apusic Application Server V9.0 </li></ul> |
15+
| Server | Mainstream servers are supported. | The support details are as follows: <ul><li>Physical servers: Suma H620 series, Huawei TaiShan 200 series, and Great Wall Qingtian DF720 </li><li>CPUs: Hygon 7185/7280, Kunpeng 920, and FeiTeng 2000+ </li><li>Operating systems: Kylin V4, Kylin V10, and UOS V20; upper-layer middleware: TongWeb V7.0 and Apusic Application Server V9.0 </li></ul> |
1616
| Operating system | x86 and Arm architectures are supported. | The following operating systems are supported: <ul><li>Alibaba Cloud Linux 2/3 (kernel: Linux 3.10.0 and later)</li><li>Anolis OS 8.X (kernel: Linux 3.10.0 and later)</li><li>Red Hat Enterprise Linux Server 7.X and 8.X (kernel: Linux 3.10.0 and later)</li><li>CentOS Linux 7.X and 8.X (kernel: Linux 3.10.0 and later)</li><li>Debian 9.X and later (kernel: Linux 3.10.0 and later)</li><li>Ubuntu 20.X and later (kernel: Linux 3.10.0 and later)</li><li>SUSE/openSUSE 15.X and later (kernel: Linux 3.10.0 and later)</li><li>Kylin V10</li><li>UOS V20 </li><li>NFSChina 4.0 and later</li><li>Inspur KOS 5.8</li></ul> |
1717
| CPU | <ul><li>For a test environment, at least 2 cores are required. </li><li>For a production environment, at least 4 cores are required and 32 cores or more are recommended. </li><li>For a performance test environment, 24 cores or more are recommended. </li></ul> | The values provided here are the minimum number of cores allocated to OceanBase Database, not the total number of cores on servers. |
1818
| Memory | <ul><li>For a test environment, at least 6 GB is required. </li><li>For a production environment, at least 16 GB is required. For long-term use, at least 32 GB is required, and a value in the range from 256 GB to 1024 GB is recommended. </li><li>For a performance test environment, a value in the range from 128 GB to 1024 GB is recommended. </li></ul> | The values provided here are the minimum size of memory allocated to OceanBase Database, not the total size of memory on servers. <blockquote><b>Note</b><br></br>If multiple clusters are deployed, we recommend that you use OceanBase Cloud Platform (OCP) for unified O&M management. If a small number of clusters are deployed, we recommend that you use OceanBase Deployer (OBD) for installation and deployment. </blockquote> |

docs/user_manual/quick_starts/en-US/chapter_02_deploy_oceanbase_database/03_deploy_personal_environment.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -440,7 +440,7 @@ If you have multiple servers available, you can run the `obd web` command to sta
440440

441441
![Precheck](/img/user_manual/quick_starts/en-US/chapter_02_deploy_oceanbase_database/03_deploy_personal_environment/007.png)
442442

443-
If an error code is returned, you can click **Automatic Repair** to automatically repair the error, or click **Learn more** to go to the error code document and correct the error based on the reference document. After all the errors are corrected, click **Re-check** to perform a precheck again.
443+
If an error code is returned, you can click **Automatic Repair** to automatically repair the error, or click **Learn more** to go to the error code document and correct the error based on the reference document. After all the errors are corrected, click **Re-check** to perform a precheck again. If you need to modify the content in the installation configuration file, you can usually find and edit the configuration file under ~/.obd/cluster/myoceanbase.
444444

445445
8. After the precheck is passed, click **Deploy** to start the deployment.
446446

@@ -460,7 +460,7 @@ If you have multiple servers available, you can run the `obd web` command to sta
460460
# View the cluster list.
461461
obd cluster list
462462

463-
# View the details of the myoceanbase cluster.
463+
# View the details of the myoceanbase cluster.(Prior to operation, terminate the OBD web process; otherwise, an error will occur: "Another app is currently holding the obd lock.")
464464
obd cluster display myoceanbase
465465
```
466466

docs/user_manual/quick_starts/en-US/chapter_02_deploy_oceanbase_database/06_create-tenant.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ For more information about the `obd cluster tenant create` command, see the **ob
5656
* `test2` is a sample tenant name.
5757

5858
* The resource unit and resource pool used by a tenant created by using the OBD command are respectively named `${tenant_name}_unit` and `${tenant_name}_pool`.
59+
* Note: When creating a tenant using OBD, the maximum occupancy mode is used by default. If resources are tight or you want to create a tenant in the minimum availability mode, it is recommended to use OCP or SQL first.
5960

6061
The output is as follows:
6162

docs/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/03_sysbench_test.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,15 @@ weight: 4
55

66
# 3.3 Run the Sysbench benchmark
77

8-
Sysbench is a LuaJIT-based multi-thread benchmark tool that allows you to write scripts to test the CPU, memory, thread, I/O, and database performance. It is often used to evaluate and test the database workload under various system parameter configurations. You can run the Sysbench benchmark to test a variety of database businesses by customizing Lua scripts without modifying the source code.
9-
108
This topic describes two methods to run the Sysbench benchmark on OceanBase Database in a CentOS Linux 7.9 environment based on the x86 architecture.
119

1210
* Use OceanBase Deployer (OBD) to run the benchmark.
1311

14-
* Use the official Sysbench tool to manually run the Sysbench benchmark step by step.
12+
* Use the official Sysbench tool to manually run the Sysbench benchmark step by step.
13+
14+
## Sysbench Overview
15+
16+
Sysbench is a LuaJIT-based multi-thread benchmark tool that allows you to write scripts to test the CPU, memory, thread, I/O, and database performance. It is often used to evaluate and test the database workload under various system parameter configurations. You can run the Sysbench benchmark to test a variety of database businesses by customizing Lua scripts without modifying the source code.
1517

1618
## Use obdiag to inspect the cluster before running the benchmark
1719

@@ -37,15 +39,15 @@ OceanBase Database is a native distributed database system. Root cause analysis
3739

3840
* OceanBase Client (OBClient): For information about OBClient, see the [GitHub repository](https://github.com/oceanbase/obclient).
3941

40-
> **Notice**
42+
> **Note**
4143
>
4244
> In OBClient V2.2.0 or later, the OceanBase 2.0 protocol and end-to-end tracing are enabled by default, which will affect the performance in the Sysbench benchmark. We recommend that you set the `export ENABLE_PROTOCOL_OB20` environment variable to `0` to disable the protocol.
4345
4446
## Test plan
4547

4648
The Sysbench benchmark requires five servers, one for deploying Sysbench and OBD, one for deploying OceanBase Database Proxy (ODP) separately, and three for deploying an OceanBase cluster that has three zones, with each containing one OBServer node.
4749

48-
> **Notice**
50+
> **Note**
4951
>
5052
> * We recommend that you deploy ODP on a separate server to avoid resource contention with OceanBase Database.
5153
>
421 KB
Loading
586 KB
Loading
542 KB
Loading
596 KB
Loading

0 commit comments

Comments
 (0)