update (#55)

* Add files via upload

* Update README-CN.md

* Update README-CN.md

* Update README.md

* Update README-CN.md

* Update README.md

* Update README.md

README-CN.md

@@ -50,7 +50,7 @@ source /etc/profile.d/obd.sh
 - xz-devel
 - mysql-devel
   
-Python2 使用以下命令安装：
+Python2.7 使用以下命令安装：
 
 ```shell
 pip install -r requirements.txt
@@ -58,7 +58,7 @@ sh build.sh
 source /etc/profile.d/obd.sh
 ```
 
-Python3 使用以下命令安装：
+Python3.8 使用以下命令安装：
 
 ```shell
 pip install -r requirements3.txt
@@ -78,7 +78,8 @@ source /etc/profile.d/obd.sh
 
 > **说明：** 如果以上条件不满足，请参考[使用 OBD 启动 OceanBase 数据库集群](#使用-obd-启动-oceanbase-数据库集群)。
 
-> **注意：** 此处为了方便使用root，OBD和OceanBase数据库没有对运行用户做出任何限制，我们不建议生产中直接使用root。
+> **注意：** 此处为了方便使用 root，OBD 和 OceanBase 数据库没有对运行用户做出任何限制，我们不建议生产中直接使用 root。
+
 ```shell
 obd cluster deploy c1 -c ./example/mini-local-example.yaml
 obd cluster start c1
@@ -437,7 +438,7 @@ obd cluster tenant create <deploy name> [-n <tenant name>] [flags]
 --max-cpu | 否 | float | 0 | 租户可用最大 CPU 数。为 0 时使用集群剩余全部可用 CPU。
 --min-cpu | 否 | float | 0 | 租户可用最小 CPU 数。为 0 时等于 --max-cpu。
 --max-memory | 否 | int | 0 | 租户可用最大内存。为 0 时使用集群剩余全部可用内存。实际值低于 1G 时报错。
---min-memory | 否 | int | 0 | 租户可用最大内存。为 0 时等于 --max-memory。
+--min-memory | 否 | int | 0 | 租户可用最小内存。为 0 时等于 --max-memory。
 --max-disk-size | 否 | int | 0 | 租户可用最大磁盘空间。为0时使用集群全部可用空间。实际值低于 512M 时报错。
 --max-iops | 否 | int | 128 | 租户 IOPS 最多数量，取值范围为 [128,+∞)。
 --min-iops | 否 | int | 0 | 租户 IOPS 最少数量。取值范围为 [128,+∞)。为 0 时等于 --max-iops 。
@@ -529,7 +530,7 @@ obd test sysbench <deploy name> [flags]
 --time | 否 | int | 60 | 运行时间。设置为 0 时表示不限制时间。
 --interval | 否 | int | 10 | 运行期间日志，单位为秒。
 --events | 否 | int | 0 | 最大请求数量，定义数量后可以不需要 --time 选项。
---rand-type | 否 | string | 访问数据时使用的随机生成函数。取值可以为 special、uniform、gaussian 或 pareto。 默认值为 special， 早期值为 uniform。
+--rand-type | 否 | string | 空 | 访问数据时使用的随机生成函数。取值可以为 special、uniform、gaussian 或 pareto。 默认值为 special， 早期值为 uniform。
 ---skip-trx | 否 | string | 空 | 在只读测试中打开或关闭事务。
 -O/--optimization | 否 | int | 1 | 自动调优等级。为 0 时关闭。
 

README.md

@@ -50,7 +50,7 @@ Before you install OBD by using the source code, make sure that you have install
 - xz-devel
 - mysql-devel
 
-To install OBD on Python2, run these commands:
+To install OBD on Python2.7, run these commands:
 
 ```shell
 pip install -r requirements.txt
@@ -58,7 +58,7 @@ sh build.sh
 source /etc/profile.d/obd.sh
 ```
 
-To install OBD on Python3, run these commands:
+To install OBD on Python3.8, run these commands:
 
 ```shell
 pip install -r requirements3.txt
@@ -271,7 +271,7 @@ The following table describes the corresponding options.
 | -f/--force | No | bool | false | Specifies whether to forcibly clear the working directory. <br>When the component requires an empty working directory but this option is disabled, an error will be returned if the working directory is not empty.  |
 | -U/--ulp/--unuselibrepo | No | bool | false | Specifies whether to prevent OBD from automatically taking actions when dependencies are missing. If this option is disabled and OBD detects that some dependencies are missing, OBD will automatically search for the corresponding libs mirrors and install them. If this option is enabled, the **unuse_lib_repository: true** field will be added to the corresponding configuration file. You can also add the **unuse_lib_repository: true** field to the configuration file to enable this option.  |
 | -A/--act/--auto-create-tenant | No | bool | false | Specifies whether to enable OBD to create the `test` tenant during the bootstrap by using all available resources of the cluster. If this option is enabled, the **auto_create_tenant: true** field will be added to the corresponding configuration file. You can also add the **auto_create_tenant: true** field to the configuration file to enable this option.  |
-| -s/--strict-check | No | bool | false | Specifies whether to return an error and directly exit the process when the component pre-check fails. If this option is disabled, OBD will return an error but not forcibly end the process when pre-check fails. We recommend that you enable this option to avoid startup failures due to insufficient resources.  |
+| -s/--strict-check | No | bool | false | Some components will do relevant checks before starting. It will issue an alarm when the check fails, but it will not force the process to stop. Using this option can return an error and directly exit the process when the component pre-check fails. We recommend that you enable this option to avoid startup failures due to insufficient resources.  |
 
 #### `obd cluster edit-config`
 
@@ -310,12 +310,19 @@ The following table describes the corresponding options.
 Starts a deployed cluster. If the cluster is started, OBD will return its status.
 
 ```shell
-obd cluster start <deploy name> [-s]
+obd cluster start <deploy name> [flags]
 ```
 
 `deploy name` specifies the name of the deployment configuration file.
 
-`-s` is `--strict-check`. `-s` specifies whether to return an error and directly exit the process when the component pre-check fails. If this option is disabled, OBD will return an error but not forcibly end the process when pre-check fails. We recommend that you enable this option to avoid startup failures due to insufficient resources. `-s` is optional. Its data type is `bool`. This option is disabled by default.
+This table describes the corresponding options.
+
+| Option | Required | Data type | Default value | Description |
+--- | --- | --- |--- | ---
+| -s/--servers | No | string |   | A list of machines, separated by `,`. Be used for specifying the start-up machines. If this option is disabled, all machines under the component will start without executing bootstrap.  |
+| -c/--components | No | string |   | A list of components, separated by `,`. Be used for specifying the start-up components. If this option is disabled, all machines under the component will start without entering the running state.  |
+| --wop/--without-parameter | No | bool | false | Start without parameters. The node does not respond to this option when this node is starting for the first time.  |
+| -S/--strict-check | No | bool | false | Some components will do relevant checks before starting. OBD will throw an error when the check fails, but OBD will not force the process to stop. Using this option can return an error and directly exit the process when the component pre-check fails. We recommend that you enable this option to avoid startup failures due to insufficient resources.  |
 
 #### `obd cluster list`
 
@@ -362,6 +369,14 @@ obd cluster restart <deploy name>
 
 `deploy name` specifies the name of the deployment configuration file.
 
+This table describes the corresponding options.
+
+| Option | Required | Data type | Default value | Description |
+--- | --- | --- |--- | ---
+| -s/--servers | No | string |   | A list of machines, separated by `,`.  |
+| -c/--components | No | string |   | A list of components, separated by `,`. Be used for specifying the start-up components. If this option is disabled, all machines under the component will start without entering the running state.  |
+| --wop/--without-parameter | No | bool | false | Start without parameters. It is without parameters when starting. The node does not respond to this option when it is starting for the first time.  |
+
 #### `obd cluster redeploy`
 
 Redeploys a running cluster. After you run the `edit-config` command to modify the configuration information of a running cluster, you can run the `redeploy` command to let your modification take effect.
@@ -384,9 +399,16 @@ obd cluster stop <deploy name>
 
 `deploy name` specifies the name of the deployment configuration file.
 
+This table describes the corresponding options.
+
+| Option | Required | Data type | Default value | Description |
+--- | --- | --- |--- | ---
+| -s/--servers | No | string |   | A list of machines, separated by `,`. Be used for specifying the start-up machines.  |
+| -c/--components | No | string |   | A list of components, separated by `,`. Be used for specifying the start-up components. If not all components under the configuration start, this configuration will not enter the stopped state.  |
+
 #### `obd cluster destroy`
 
-Destroys a deployed cluster. If the cluster is running, this command stops the cluster before destroying it.
+Destroys a deployed cluster. If the cluster is running state, this command will first try to execute `stop` and then `destroy` after success.
 
 ```shell
 obd cluster destroy <deploy name> [-f]
@@ -460,7 +482,6 @@ This table describes the corresponding options.
 --- | --- | --- |--- | ---
 | -c/--component | No | string |   | The name of the component to be tested. Valid values: oceanbase-ce and obproxy. If this option is not specified, OBD will search for obproxy and oceanbase-ce in sequence. If obproxy is found, OBD will stop the search and use obproxy for the subsequent tests. If obproxy is not found, OBD will continue to search for oceanbase-ce.  |
 | --test-server | No | string | The first node of the specified component.  | It must be the name of a node of the specified component.  |
-| --mode | No | string | both | The test mode. Valid values: mysql and both.  |
 | --user | No | string | root | The username for running the test.  |
 | --password | No | string |   | The password for running the test.  |
 | --mysqltest-bin | No | string | mysqltest | The path of the mysqltest binary file.  |
@@ -496,7 +517,7 @@ obd test sysbench <deploy name> [flags]
 | --user | No | string | root | The username for running the test.  |
 | --password | No | string |   | The password for running the test.  |
 | --tenant | No | string | test | The tenant name for running the test.  |
-| --database | No | string | test | The cluster for performing the test.  |
+| --database | No | string | test | The database for performing the test.  |
 | --obclient-bin | No | string | obclient | The path of the OBClient binary file.  |
 | --sysbench-bin | No | string | sysbench | The path of the Sysbench binary file.  |
 | --script-name | No | string | point_select.lua | The name of the Sysbench script to be run.  |
@@ -507,8 +528,42 @@ obd test sysbench <deploy name> [flags]
 | --time | No | int | 60 | The running duration. When this option is set to 0, the running duration is not limited.  |
 | --interval | No | int | 10 | The logging interval, in seconds.  |
 | --events | No | int | 0 | The maximum number of requests. If this option is specified, the --time option is not needed.  |
-| --rand-type | No | string | The random number generation function used for data access. Valid values: special, uniform, gaussian, and pareto.  Default value: special.  |
+| --rand-type | No | string |   | The random number generation function used for data access. Valid values: special, uniform, gaussian, and pareto.  Default value: special, early value: uniform.  |
 | ---skip-trx | No | string |   | Specifies whether to enable or disable a transaction in a read-only test.  |
+| -O/--optimization | No | int | 1 | Auto tuning level. Off when 0.  |
+
+#### `obd test tpch`
+
+This section describes how to run the TPC-H test on the specified node of an OcecanBase cluster or ODP. To run the TPC-H test, you must install OBClient and obtpch.
+TPC-H needs to specify an OceanBase target server as the execution target. Before executing the TPC-H test, OBD will transfer the data files required for the test to the specified directory of the specified machine. Please make sure that you have enough disk space on this machine because these files may be relatively large.
+Of course, you can prepare the data files on the target machine in advance and then turn off the transfer by using the `-dt/--disable-transfer` option.
+
+```shell
+obd test tpch <deploy name> [flags]
+```
+
+`deploy name` specifies the name of the deployment configuration file.
+
+| Option | Required | Data type | Default value | Description |
+--- | --- | --- |--- | ---
+| --test-server | No | string | The first node of the specified component.  | It must be the name of a node of the specified component.  |
+| --user | No | string | root | The username for running the test.  |
+| --password | No | string |   | The password for running the test.  |
+| --tenant | No | string | test | The tenant name for running the test.  |
+| --database | No | string | test | The database for performing the test.  |
+| --obclient-bin | No | string | obclient | The path of the OBClient binary file.  |
+| --dbgen-bin | No | string | /usr/local/tpc-h-tools/bin/dbgen | The path of the dbgen binary file.  |
+| --dss-config | No | string | /usr/local/tpc-h-tools/ | The directory that stores the dists.dss files.  |
+| -s/--scale-factor | No | int | 1 | Automatically generate the scale of test data, the data is measured in Gigabytes.  |
+| -tmp-dir | No | string | ./tmp | Temporary directory when executing tpch. When enabled, this option will automatically generate test data, auto-tuned SQL files, log files for executing test SQL, and so on.  |
+| --ddl-path | No | string |   | The path or directory of the ddl file. If it is empty, OBD will use the ddl file that comes with it.  |
+| --tbl-path | No | string |   | The path or directory of the tbl file. If it is empty, use dbgen to generate test data.  |
+| --sql-path | No | string |   | The path or directory of the sql file. If it is empty, OBD will use the sql file that comes with it.  |
+| --remote-tbl-dir | No | string |   | The directory where the tbl is stored on the target observer, it is the absolute path. Please make sure that you have the read and write permissions to this directory when you start the server. This option is required when  `--test-only` is not enabled.  |
+| --test-only | No | bool | false | When you enable this option, initialization will not be done, only the test SQL is exectued.  |
+| --dt/--disable-transfer | No | bool | false | Disable transfer. When you enable this option, OBD will not transfer the local tbl to the remote remote-tbl-dir, and OBD will directly use the tbl file under the target machine remote-tbl-dir.  |
+| -O/--optimization | No | int | 1 | Auto tuning level. Off when 0.  |
+
 
 ## Q&A