V2.4.1 (#185)

Author: frf12

README-CN.md

@@ -68,7 +68,7 @@ source /etc/profile.d/obd.sh
 
 ## 快速启动 OceanBase 数据库
 
-安装 OBD 后，您可执行 `obd demo` 命令快速启动本地单节点 OceanBase 数据库。在此之前您需要确认以下信息：
+[安装 OBD](./docs/zh-CN/200.quick-start/100.install-obd.md) 后，您可执行 `obd demo` 命令快速启动本地单节点 OceanBase 数据库。在此之前您需要确认以下信息：
 
 * `2881` 和 `2882` 端口没有被占用。
 
@@ -78,10 +78,6 @@ source /etc/profile.d/obd.sh
 
 * 机器可用磁盘空间不小于 `54 G`。
 
-> **说明**
->
-> 如果以上条件不满足，您可参考文档 [使用 OBD 启动 OceanBase 数据库集群](../3.user-guide/400.user-guide/200.start-the-oceanbase-cluster-by-using-obd.md)。
-
 ```shell
 # 部署并启动 OceanBase 数据库
 obd demo
@@ -91,7 +87,7 @@ obclient -h127.0.0.1 -uroot -P2881
 
 ## 使用 OBD 启动 OceanBase 数据库集群
 
-如何使用 OBD 启动 OceanBase 数据库集群，请参考文档[使用 OBD 启动 OceanBase 数据库集群](./docs/zh-CN/400.user-guide/200.start-the-oceanbase-cluster-by-using-obd.md)。
+如何使用 OBD 启动 OceanBase 数据库集群，请参考文档[使用 OBD 启动 OceanBase 数据库集群](./docs/zh-CN/400.user-guide/300.command-line-operations/200.start-the-oceanbase-cluster-by-using-obd.md)。
 
 ## 其他 OBD 命令
 

README.md

@@ -60,7 +60,7 @@ source /etc/profile.d/obd.sh
 
 ## Start an OceanBase cluster
 
-After you deploy OceanBase Deployer (OBD), you can run the `obd demo` command to deploy and start OceanBase Database on a single local server. Make sure the following prerequisites are met:
+After you [deploy OceanBase Deployer (OBD)](./docs/en-US/200.quick-start/100.install-obd.md), you can run the `obd demo` command to deploy and start OceanBase Database on a single local server. Make sure the following prerequisites are met:
 
 - Ports `2881` and `2882` are not occupied.
 
@@ -70,10 +70,6 @@ After you deploy OceanBase Deployer (OBD), you can run the `obd demo` command to
 
 - At least 54 GB of disk space is available on the server.
 
-> **Note**
->
-> If the foregoing prerequisites are not met, see [Use OBD to start an OceanBase cluster](./docs/en-US/400.user-guide/200.start-the-oceanbase-cluster-by-using-obd.md).
-
 ```shell
 # Deploy and start OceanBase Database.
 obd demo
@@ -83,7 +79,7 @@ obclient -h127.0.0.1 -uroot -P2881
 
 ## Use OBD to start an OceanBase cluster
 
-If you want to know how to use OBD to start an OceanBase cluster, please see [Use OBD to start an OceanBase cluster](./docs/en-US/400.user-guide/200.start-the-oceanbase-cluster-by-using-obd.md).
+If you want to know how to use OBD to start an OceanBase cluster, please see [Use OBD to start an OceanBase cluster](./docs/en-US/400.user-guide/300.command-line-operations/200.start-the-oceanbase-cluster-by-using-obd.md).
 
 ## Other OBD commands
 

docs/en-US/400.user-guide/100.configuration-file-description.md

@@ -33,7 +33,6 @@ oceanbase-ce:  # The name of the component that is configured as follows.
     datafile_disk_percentage: 20
     syslog_level: INFO
     enable_syslog_wf: false
-    enable_syslog_recycle: true
     max_syslog_file_count: 4
     cluster_id: 1
     # observer cluster name, consistent with obproxy's cluster_name    

docs/en-US/400.user-guide/400.OCP-takeover-OBD-deployment-cluster.md

@@ -68,7 +68,6 @@ oceanbase-ce:
     datafile_disk_percentage: 20
     syslog_level: INFO
     enable_syslog_wf: false
-    enable_syslog_recycle: true
     max_syslog_file_count: 4
     skip_proxy_sys_private_check: true
     enable_strict_kernel_release: false

docs/zh-CN/100.what-is-obd.md

@@ -1,6 +1,6 @@
 # 什么是 OBD
 
-OBD 全称为 OceanBase Deployer，是 OceanBase 安装部署工具，通过命令行部署或白屏界面部署的方式，将复杂配置流程标准化，降低集群部署难度。详细操作请参考 [单机部署 OceanBase 数据库](400.user-guide/200.start-the-oceanbase-cluster-by-using-obd.md) 和 [通过白屏部署 OceanBase 集群](200.quick-start/300.use-ui-deploy-oceanbase.md)。
+OBD 全称为 OceanBase Deployer，是 OceanBase 安装部署工具，通过命令行部署或白屏界面部署的方式，将复杂配置流程标准化，降低集群部署难度。详细操作请参考 [单机部署 OceanBase 数据库](400.user-guide/300.command-line-operations/200.start-the-oceanbase-cluster-by-using-obd.md) 和 [通过白屏部署 OceanBase 集群](200.quick-start/300.use-ui-deploy-oceanbase.md)。
 
 其中，命令行支持编辑配置文件，可以更加灵活的进行配置调整，适用于需要深度了解 OceanBase 的用户，有一定的使用门槛；白屏界面配置简单，通过页面的引导配置即可完成集群部署，适用于需要快速体验，构建标准环境的用户。
 

docs/zh-CN/1000.configure-rules.md

@@ -56,10 +56,12 @@ df --output=size,avail,target
 | datafile_size | 固定为 2G   | 根据 `memory_limit` 配置的大小调整，其对应关系为：`datafile_size` = `memory_limit`*3 |
 | log_disk_size | 固定为 13G   | 根据 `memory_limit` 配置的大小调整，其对应关系为：`log_disk_size` = `memory_limit`*3 |
 
-需要注意如下两点：
+需要注意如下三点：
 
 * 当磁盘空间不足时将调整 `memory_limit` 以保证存储安全。
 
+* 最大占用模式下，当磁盘空间充足时，OceanBase 集群会在满足 `memory_limit`*3 的情况下尽可能安全地占满磁盘。
+
 * OBServer 日志也会占用一定的磁盘空间，在计算前会根据挂载扣除对应磁盘的空间空间。
 
   * 如未开启日志轮转则按照 1G 进行保留。

docs/zh-CN/1100.error-messages-in-obd.md

@@ -252,6 +252,24 @@ obd cluster edit-config <deploy_name>
 
 - 当前集群或租户不存在备租户，或您可以接受备租户不可用的风险，可重新执行命令，并加上 `--ignore-standb` 选项来跳过检查。
 
+## OBD-1016：xx.xx.xx.xx failed to get kernel parameter using command "sysctl -a"
+
+错误原因：连接异常或使用的操作系统暂不支持 `sysctl -a` 命令。
+
+解决方法：您可重新操作，或到官网 [问答区](https://ask.oceanbase.com/) 进行提问，会有专业人员为您解答。
+
+## OBD-1017：xx.xx.xx.xx [kernel] xxx must be xxx
+
+错误原因：操作系统的内核参数不在推荐的范围之内。
+
+为确保 OceanBase 数据库在生产环境中的稳定性，OBD 在启动 OceanBase 数据库前将对系统环境及内核参数做一次检查，此项检查旨在确保系统配置符合 OceanBase 推荐的参数设定。在配置项未满足推荐标准的情况下，若 `production_mode` 配置为 `true` 或者执行命令时开启了 `--strict-check` 选项，实例将被识别为生产环境，此时会触发错误报告并终止启动，反之则仅会发出告警而不会终止启动流程。
+
+解决方法：根据使用的环境不同有如下两种解决方法。
+
+- 若您所用环境为生产环境，可通过 `sysctl -w {内核参数名}="建议值"` 命令或 `echo "内核参数名=建议值" >> /etc/sysctl.conf; sysctl -p` 命令修改参数配置，使其满足条件。
+
+- 若您所用环境为测试环境，且没有权限修改内核参数，可通过 `obd cluster edit-config {deployname}` 命令修改配置文件，将配置项 `production_mode` 配置为 `false` 来跳过系统参数阻塞检查。
+
 ## OceanBase 部署相关报错
 
 ### OBD-2000：x.x.x.x not enough memory
@@ -348,18 +366,16 @@ obd cluster edit-config <deploy_name>
 
 对于情况 2，可在白屏界面 **集群配置** -> **更多配置** 中设置 devname。
 
-### OBD-2007：x.x.x.x xxx fail to ping x.x.x.x. Please check configuration `devname`
+### OBD-2007：x.x.x.x xxx fail to ping x.x.x.x
 
 错误原因：机器之间相互 ping 不通。
 
 解决办法：
 
-1. 执行 `obd cluster edit-config` 命令查看配置文件中的网卡配置（`devname`）是否与实际匹配，通过 `ip addr` 命令可以查看 IP 和网卡对应关系。
+1. 执行 `obd cluster edit-config` 命令查看配置文件中的网络配置（`devname`/`local_ip`）是否与实际匹配，可通过 `ip addr` 命令可以查看 IP 和网卡对应关系。
 
 2. 检查各个节点网络是否畅通。
 
-3. 如果出现的错误为 `operation not permitted`，请检查 ping 文件权限，您可以尝试执行 `sudo chmod u+s /usr/bin/ping` 命令修改 ping 文件权限。
-
 ### OBD-2008：Cluster clocks are out of sync
 
 错误原因：集群之间时钟超时。
@@ -482,6 +498,12 @@ obd cluster edit-config <deploy_name>
 
 - 登陆到目标机器，为当前账号赋予对应目录的写权限。
 
+### OBD-4002: xxxx: Failed to obtain the configuration of the OceanBase database component
+
+错误原因：使用 OBAgent 监控 OceanBase 数据库时，OBAgent 和 OceanBase 数据库的服务器配置（配置文件中 `servers` 部分）需保持一致，未配置一致的情况下 OBAgent 无法获取 OceanBase 数据库配置。
+
+解决方法：您可执行 `obd cluster edit-config` 命令修改配置文件中 OBAgent 组件的 `servers` 模块信息，修改后执行黑屏输出命令重启集群。
+
 ## ODP 相关报错
 
 ### OBD-4100：x.x.x.x need config "rs_list" or "obproxy_config_server_url"
@@ -591,6 +613,139 @@ obd cluster edit-config <deploy_name>
   <p>该配置项修改后需执行 <code>obd cluster redeploy</code> 命令重启生效，该命令会销毁集群，重新部署，您集群中的数据会丢失，请先做好备份。</p>
 </main>
 
+## OCP 相关报错
+
+### OBD-4350: The Server have running task
+
+错误原因：升级 OCP 时，OCP 中存在运行中的任务。
+
+解决方法：为避免因升级 OCP 导致任务中断，请等待任务执行完成后，再重新进行检查。
+
+### OBD-4351: The Server have gone
+
+错误原因：升级 OCP 时，OCP 中主机不处于在线状态。
+
+解决方法：查询当前 OCP 管理主机的状态，详细操作可参见《OCP 云平台》文档 [管理主机操作列表](https://www.oceanbase.com/docs/common-ocp-1000000000348005)。
+
+- 如果主机状态为 **新提交**，该主机是新添加的主机，请等添加主机任务完成后，重新进行检查。
+
+- 如果主机状态为 **离线**，可以尝试重装 OCP Agent，详细操作可参见《OCP 云平台》文档 [重装 OCP Agent](https://www.oceanbase.com/docs/common-ocp-1000000000348006)。
+
+### OBD-4352: Metadb version not fewer than V2.2.50
+
+错误原因：OCP 的 MetaDB 版本低于 2.2.50。
+
+解决方法：您可升级 OCP 的 MetaDB 至最新的 LTS 版本。
+
+### OBD-4353:  {server}: Excessive deviation between machine time and ob time
+
+错误原因: 主机时间和 MetaDB 时间不一致。
+
+解决方法：您可参照如下步骤进行排查处理。
+
+1. 在对应主机上执行如下命令确认服务器是否安装时钟同步服务（Chrony 或 NTP）。
+
+   ```shell
+   rpm -qa | grep chrony   # 检查是否安装了 Chrony 服务
+   rpm -qa | grep ntp      # 检查是否安装了 NTP 服务
+   ```
+
+   根据输出结果有如下两种处理方式。
+
+   - 若返回相关版本信息，说明已安装对应时钟同步服务，请继续执行步骤 2。
+
+   - 若无返回信息，说明未安装对应时钟同步服务。若 Chrony 和 NTP 服务均未安装，请先安装时钟同步服务。Chrony 和 NTP 服务的安装与配置可参考互联网上分享的案例。此处只做简要说明。
+
+     - 执行如下命令安装时钟同步服务，Chrony 或 NTP 中任选一个安装即可。
+
+       ```shell
+       sudo yum install -y chrony    # 安装 Chrony 服务
+       sudo yum install -y ntp       # 安装 NTP 服务
+       ```
+
+     - 执行如下命令启动时钟同步服务。
+
+       ```shell
+       systemctl start chronyd     # 启动 Chrony 服务
+       systemctl start ntpd        # 启动 NTP 服务
+       ```
+
+     - 重新执行部署操作，若仍然报错，您可到官网 [问答区](https://ask.oceanbase.com/) 进行提问，会有专业人员为您解决。
+
+2. 执行如下命令检查时钟同步进程（chronyd 或 ntpd）是否异常退出。
+
+   ```shell
+   systemctl status chronyd      # 检查 Chrony 服务状态
+   systemctl status ntpd         # 检查 NTP 服务状态
+   ```
+
+   根据返回结果有如下两种处理方式。
+
+   - 若返回值信息中 Active 信息为 active（running），您可到官网 [问答区](https://ask.oceanbase.com/) 进行提问，会有专业人员为您解决。
+
+   - 若返回值信息中 Active 信息为 inactive（dead），则时钟同步服务异常。尝试执行如下命令重启服务。
+  
+     ```shell
+     systemctl restart chronyd      # 重启 Chrony 服务
+     systemctl restart ntpd         # 重启 NTP 服务
+     ```
+
+     重启服务后，可再次执行部署操作，若仍然报错，您可到官网 [问答区](https://ask.oceanbase.com/) 进行提问，会有专业人员为您解决。
+
+### OBD-4354:  {user}@{server}: Not exist
+
+错误原因: OCP 启动用户不存在。
+
+解决方法：使用其他启动用户或者在 OCP 所在主机上创建启动用户，创建用户的操作可参见《OCP 云平台》文档 [用户规划](https://www.oceanbase.com/docs/common-ocp-1000000000368844)。
+
+### OBD-4355:  {user}@{ip}: user xxx not in sudoers or sudoers file not exist
+
+错误原因: 用户不能免密执行 sudo 命令。
+
+解决方法: 为用户配置 sudo 免密或者使用其他有免密 sudo 权限的用户。设置 sudo 权限的步骤可参见《OCP 云平台》文档 [用户规划](https://www.oceanbase.com/docs/common-ocp-1000000000368844)。
+
+### OBD-4356:  failed to connect meta db
+
+错误原因: MetaDB 无法连接。
+
+解决方法: 检查 MetaDB 的连接串是否正确。
+
+### OBD-4357:  database in jdbc_url is not exist
+
+错误原因: JDBC 连接中的 database 不存在。
+
+解决方法: 在 MetaDB 中创建对应的 database。
+
+### OBD-4358:  unmatched jdbc url, skip meta db connection check
+
+错误原因: JDBC URL 格式错误。
+
+解决方法: 检查 `jdbc_url` 的配置，确认满足示例形式：`"^jdbc:\S+://(\S+?)(|:\d+)/(\S+)"`。
+
+### OBD-4359:  {server}: ocp-server need java with version xxx and update release must greater than 161
+
+错误原因: Java 版本不满足 OCP 要求。
+
+解决方法: 升级 Java 版本到 OCP 要求的最小版本 `1.8.0_161` 或以上。
+
+### OBD-4360:  {server}: clockdiff not exists. Please install clockdiff manually
+
+错误原因: 主机上没有 clockdiff 命令。
+
+解决方法: 安装 clockdiff。
+
+### OBD-4361:  tenant(xxx) alread exist
+
+错误原因: 租户已存在。
+
+解决方法: 您可登录 MetaDB 删除同名租户，或使用其他租户名。
+
+### OBD-4362:  {server}:{path} access failed for current user, {server}:{cur_path} access succeed, please run `chmod -R 755 {cur_path}`
+
+错误原因: 用户没有操作涉及目录的权限。
+
+解决方法: 您可执行输出的 chmod 命令为用户增加对应目录的权限。
+
 ## Config Server 相关报错
 
 ### OBD-4401：Failed to start x.x.x.x ob-configserver
@@ -631,7 +786,7 @@ ps -ef | grep $home_path/bin/ob-configserver
 
 - 在使用 sqlite3 数据库类型的情况下，`connection_url` 是否配置为绝对路径。
 
-### OBD-4403：x.x.x.x: /xxxx/xxxx/xxxx: permission denied
+### OBD-4403：ob-configserver connect to sqlite failed: x.x.x.x: /xxx/xxx/xxx: permission denied
 
 错误原因：Config Server 在使用 sqlite3 作为数据库的情况，配置文件中的 user 用户（未配置的情况下默认为当前用户）没有 `connection_url` 配置中目录的写权限。
 
@@ -647,7 +802,7 @@ ps -ef | grep $home_path/bin/ob-configserver
 
 - 登录到目标机器，为当前账号赋予对应目录的写权限
 
-### OBD-4404：xxxxx: failed to connect to database: xxxx
+### OBD-4404：ob-configserver connect to mysql failed: xxx: failed url to connect to database: xxx
 
 错误原因：`database_type` 设置为 `mysql` 时，`connection_url` 中配置的数据库无法连接。
 

docs/zh-CN/200.quick-start/200.quickly-start-the-oceanbase-database.md

@@ -18,7 +18,7 @@
   <h4>说明</h4>
   <ul>
   <li>
-  <p>如果以上条件不满足，您可参见文档 <a href="../400.user-guide/200.start-the-oceanbase-cluster-by-using-obd.md">单机部署 OceanBase 数据库</a>。</p>
+  <p>如果以上条件不满足，您可参见文档 <a href="../400.user-guide/300.command-line-operations/200.start-the-oceanbase-cluster-by-using-obd.md">单机部署 OceanBase 数据库</a>。</p>
   </li>
   <li>
   <p><code>obd demo</code> 命令的详细介绍可参见文档 <a href="../300.obd-command/000.obd-demo.md">快速部署命令</a>。</p>

docs/zh-CN/200.quick-start/300.use-ui-deploy-oceanbase.md

@@ -57,7 +57,7 @@ OBD 自 V2.0.0 起支持白屏部署 OceanBase 数据库及相关组件，如 OB
 
 1. 启动白屏界面
 
-   命令行执行 `obd web` 命令启动白屏界面，单击输出的地址访问白屏界面，在白屏界面中单击 **开启体验之旅** 即可进入到 OceanBase 数据库的配置界面。
+   命令行执行 `obd web` 命令启动白屏界面，单击输出的地址访问白屏界面，在白屏界面中单击 **开启体验之旅** 即可进入到 **欢迎使用 OceanBase 部署向导** 界面。在 **欢迎使用 OceanBase 部署向导** 界面选择 **OceanBase 及配套工具** 模块，单击 **确定** 后进入 OceanBase 数据库部署界面
 
    ```shell
    [admin@test001 ~]$ obd web
@@ -75,14 +75,14 @@ OBD 自 V2.0.0 起支持白屏部署 OceanBase 数据库及相关组件，如 OB
      <p>在阿里云或其他云环境下，可能出现程序无法获取公网 IP，从而输出内网地址的情况，此 IP 非公网地址，您需要使用正确的地址访问白屏界面。</p>
      </li>
      <li>
-     <p><code>obd web</code> 命令绑定在 0.0.0.0 上，在多网卡部署的情况下，您可通过任一一个可访问的 IP 访问白屏界面。</p>
+     <p><code>obd web</code> 命令绑定在 0.0.0.0 上，在多网卡部署的情况下，您可通过任意一个可访问的 IP 访问白屏界面。</p>
      </li>
      </ul>
    </main>
 
-   将鼠标放置到白屏页面右上角 **中文** 字符处可根据显示的语种单击切换中英文页面。
+   鼠标放置到图形化操作界面右上角的 **中文** 字符处可根据显示的语种单击切换中英文界面。
 
-   <img width="852" height="173.4" src="https://obbusiness-private.oss-cn-shanghai.aliyuncs.com/doc/img/obd/V2.2.0/zh-CN/2.quick-start/3.use-ui-deploy-oceanbase-01.png" alt="中英文">
+   ![语种切换](https://obbusiness-private.oss-cn-shanghai.aliyuncs.com/doc/img/obd/V2.4.0/zh-CN/200.quick-start/300.deploy-ocp-by-ui-01.png)
 
 2. 部署配置
 
@@ -138,7 +138,7 @@ OBD 自 V2.0.0 起支持白屏部署 OceanBase 数据库及相关组件，如 OB
 
    * 数据库和各组件的端口均为默认值，可自定义设置（仅支持 1024~65535 范围），需确保设置的端口未被占用。
 
-   * 单击打开 **更多配置** 按钮查看对应的集群或组件参数，可使用自动分配的配置，也可自定义各个参数。
+   * 单击打开 **更多配置** 按钮查看对应的集群或组件参数，可使用自动分配的值进行配置，也可自定义各个参数。
 
    全部配置完成后，单击 **下一步** 即可进入到 **预检查** 页面。
 

docs/zh-CN/2000.release-notes/1000.V2.3/1002.V2.3.0.md

@@ -8,8 +8,8 @@
 
 ## 发版目的
 
-* 支持 OceanBase 4.2 版本基于网络直通的主备库方案，详细信息可参见 [主备租户](../../400.user-guide/800.physical-standby-database/100.deploy-physical-standby-database.md) 章节。
+* 支持 OceanBase 4.2 版本基于网络直通的主备库方案，详细信息可参见 [主备租户](../../400.user-guide/300.command-line-operations/800.physical-standby-database/100.deploy-physical-standby-database.md) 章节。
 
-* 支持部署 Config Server，详细信息可参见 [通过 OBD 部署 Config Server](../../400.user-guide/900.deploy-ob-configserver.md)。
+* 支持部署 Config Server，详细信息可参见 [使用命令行部署 Config Server](../../400.user-guide/300.command-line-operations/350.deploy-ob-configserver.md)。
 
 * 支持白屏部署时选择容量类型参数的单位。