--- title: "使用命令行部署 OCP | OceanBase 文档中心" description: 使用命令行部署 OCP 前提条件 您已安装配置大于 1.8.0_161 版本的 Java 环境，且 Java 需放在 /usr/bin 目录下面。详细操作可参考 常见问题 中 部署 OCP Express 前如何配置 Java 环境 。 您已安装 clockdiff 命令。 您所用用户已拥有免密执行 sudo 的权限… --- 切换语言 - 中文站 - 简体中文 - International - English - 日本站 - 日本語 文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*Qq8pT6yBPTcAAAAAAAAAAAAADiGDAQ/original) 安装部署工具 OBDV 2.9.0 社区版 # 使用命令行部署 OCP 更新时间：2026-04-14 17:55:47 [编辑](https://github.com/oceanbase/obd-doc/edit/V2.9.0/zh-CN/400.user-guide/300.command-line-operations/370.deploy-ocp.md) ## 前提条件 - 您已安装配置大于 1.8.0_161 版本的 Java 环境，且 Java 需放在 `/usr/bin` 目录下面。详细操作可参考 [常见问题](https://www.oceanbase.com/docs/community-obd-cn-1000000000955342) 中 **部署 OCP Express 前如何配置 Java 环境**。 - 您已安装 clockdiff 命令。 - 您所用用户已拥有免密执行 sudo 的权限。 #### 说明 本文默认所使用的机器可以连接公网，或者已配置好所需软件（OceanBase、ODP、OCP 等）。配置所需软件的详细操作可参考 [安装并配置 obd](https://www.oceanbase.com/docs/community-obd-cn-1000000000955368) 中 **配置 obd**。 ## 配置文件 obd 提供了部署 OCP 所需的配置文件示例，您可根据自身机器资源情况进行修改。 - 若您机器中的 obd 是通过直接下载的方式安装，则可在 `/usr/obd/example` 目录下查看 obd 提供的配置文件示例。 - 若您机器中的 obd 是通过解压 all-in-one 安装包的方式安装，则可在 `~/.oceanbase-all-in-one/obd/usr/obd/example` 目录下查看 obd 提供的配置文件示例。 - 您也可在 obd 的 [GitHub 仓库](https://github.com/oceanbase/obdeploy/tree/master/example) 中查看配置文件示例。 obd 提供的和部署 OCP 相关的配置文件示例有如下几个。 - 单独部署 OCP：ocp-only-example.yaml - 分布式部署 + ODP + OCP：distributed-with-obproxy-and-ocp-example.yaml ## 操作步骤 本节分为 **单独部署 OCP** 和 **依赖 OceanBase 数据库部署 OCP** 两种方法介绍如何部署 OCP： - 单独部署 OCP 时，您需先创建 OCP 所用的元数据库，以及对应租户（`ocp_meta` 和 `ocp_monitor`）。创建数据库的详细操作可参见 [单机部署 OceanBase 数据库](https://www.oceanbase.com/docs/community-obd-cn-1000000000955381) 或 [通过白屏部署 OceanBase 集群](https://www.oceanbase.com/docs/community-obd-cn-1000000000955369)。创建租户时可根据实际情况手动创建或通过 obd 命令创建。手动创建租户的详细操作可参见 [创建租户](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000639951)，使用 obd 命令创建租户的详细介绍可参见 [集群命令组](https://www.oceanbase.com/docs/community-obd-cn-1000000000955364) 中的 **obd cluster tenant create** 命令。 - 依赖 OceanBase 数据库部署 OCP 时，可在配置文件中同时配置 OceanBase 数据库和 OCP 信息，启动 OCP 时，会根据配置的 OceanBase 数据库信息启动 OCP 的元数据库。 单独部署 OCP 依赖 OceanBase 数据库部署 OCP 1. 创建配置文件 执行如下命令创建配置文件，此处以 ocp-only-example.yaml 为例，您可自定义配置文件名。 ```shell vim ocp-only-example.yaml ``` 2. 修改用户信息 您可复制如下内容，根据自身实际场景进行修改。 ```yaml ## Only need to configure when remote login is required user: username: admin # password: your password if need key_file: /home/admin/.ssh/id_rsa # port: your ssh port, default 22 # timeout: ssh connection timeout (second), default 30 ``` `username` 为登录到目标机器的用户名，确保您的用户名有家目录的写权限。`password` 和 `key_file` 均用于验证用户，通常情况下只需要填写一个。 #### 注意 在配置秘钥路径后，如果您的秘钥不需要口令，请注释或者删除 `password`，以免 `password` 被视为秘钥口令用于登录，导致校验失败。 3. 修改 OCP 配置 您可复制如下内容，根据自身实际场景进行修改。配置项的具体含义可参见 [配置文件说明](https://www.oceanbase.com/docs/community-obd-cn-1000000000955340) 中 **配置项说明**。 ```yaml ocp-server-ce: # version: 4.2.2 # package_hash: 84a65bf0ec004e73b772938696b2b896a0ef2b2f # release: 20240315150922.el7 servers: - 10.10.10.1 global: home_path: /home/admin/ocp soft_dir: /home/admin/ocp/software log_dir: /home/admin/ocp/logs ocp_site_url: http://10.10.10.1:8080 port: 8080 admin_password: ******** memory_size: 4G jdbc_url: jdbc:oceanbase://10.10.10.2:2881/test jdbc_username: root@sys jdbc_password: ******** ocp_meta_tenant: tenant_name: ocp_meta max_cpu: 2.0 memory_size: 4G ocp_meta_username: root ocp_meta_password: ******** ocp_meta_db: meta_database ocp_monitor_tenant: tenant_name: ocp_monitor max_cpu: 2.0 memory_size: 4G ocp_monitor_username: root ocp_monitor_password: ******** ocp_monitor_db: monitor_database ``` 4. 部署 OCP ```shell obd cluster deploy ocp -c ocp-only-example.yaml ``` 命令里的 `ocp` 为集群名，您可根据实际情况自定义集群名。部署成功后命令行会输出对应的启动命令，输出如下： ```shell ocp deployed Please execute ` obd cluster start ocp ` to start Trace ID: 4e444844-0211-11ef-8e69-00163e0808cc If you want to view detailed obd logs, please run: obd display-trace 4e444844-0211-11ef-8e69-00163e0808cc ``` 5. 启动 OCP ```shell obd cluster start ocp ``` 启动成功后会输出 OCP 的登录信息，输出如下： ```shell +----------------------------------------------------------+ | ocp-server-ce | +---------------------------+----------+----------+--------+ | url | username | password | status | +---------------------------+----------+----------+--------+ | http://10.10.10.1:8080 | admin | ******** | active | +---------------------------+----------+----------+--------+ ocp running Trace ID: ed5a1f4c-0218-11ef-bda1-00163e0808cc If you want to view detailed obd logs, please run: obd display-trace ed5a1f4c-0218-11ef-bda1-00163e0808cc ``` ### 步骤一：创建配置文件 执行如下命令创建配置文件，此处以 `distributed-ocp.yaml` 为例，您可自定义配置文件名。 ```shell vim distributed-ocp.yaml ``` ### 步骤二：修改配置文件 1. 修改用户信息 ``` #### 注意 在配置秘钥路径后，如果您的秘钥不需要口令，请注释或者删除 `password`，以免 `password` 被视为秘钥口令用于登录，导致校验失败。 2. 修改 OceanBase 数据库配置 ```yaml oceanbase-ce: version: 4.2.1.8 # release: 100000242024032211.el7 # package_hash: c4a03c83614f50c99ddb1c37dda858fa5d9b14b7 servers: - name: server1 ip: 10.10.10.1 - name: server2 ip: 10.10.10.2 - name: server3 ip: 10.10.10.3 global: appname: obcluster cluster_id: 1711955629 mysql_port: 2881 rpc_port: 2882 home_path: /home/admin/oceanbase data_dir: /home/admin/oceanbase/data redo_dir: /home/admin/oceanbase/redo obshell_port: 2886 scenario: htap memory_limit: 64G system_memory: 30G log_disk_size: 192G datafile_size: 192GB ocp_meta_tenant: tenant_name: ocp_meta max_cpu: 2.0 memory_size: 4G ocp_meta_username: root ocp_meta_password: ******** ocp_meta_db: meta_database ocp_monitor_tenant: tenant_name: ocp_monitor max_cpu: 2.0 memory_size: 8G ocp_monitor_username: root ocp_monitor_password: ******** ocp_monitor_db: monitor_database proxyro_password: ******** root_password: ******** enable_syslog_recycle: true enable_syslog_wf: false max_syslog_file_count: 4 cpu_count: 20 server1: zone: zone1 server2: zone: zone2 server3: zone: zone3 ``` OceanBase 数据库的配置项详细介绍可参见 [配置文件说明](https://www.oceanbase.com/docs/community-obd-cn-1000000000955340) 中 **配置项说明**，OCP 相关的配置项如下： | 配置项 | 是否必选 | 默认值 | 修改后生效方式 | 说明 | | --- | --- | --- | --- | --- | | ocp_meta_tenant | 必选 | tenant_name: meta_tenant max_cpu: 1 memory_size: 2147483648 | 重新部署 | OCP 元信息租户信息。 - tenant_name：设置 OCP 元信息租户的租户名。 - max_cpu：为 OCP 元信息租户分配的最大 CPU。 - memory_size：为 OCP 元信息租户分配的内存容量。 | | ocp_meta_username | 可选 | meta | 重启进程 | 连接 OCP 元信息租户的用户名。 | | ocp_meta_password | 必选 | oceanbase | 重启进程 | `ocp_meta_username` 对应用户名的密码。 | | ocp_meta_db | 可选 | meta_database | 重新部署 | 存放 OCP 元信息的 database 名。 | | ocp_monitor_tenant | 必选 | tenant_name: monitor_tenant max_cpu: 1 memory_size: 2147483648 | 重新部署 | OCP 监控数据租户信息。 - tenant_name：设置 OCP 监控数据租户的租户名。 - max_cpu：为 OCP 监控数据租户分配的最大 CPU。 - memory_size：为 OCP 监控数据租户分配的内存容量。 | | ocp_monitor_username | 可选 | monitor_user | 重启进程 | 连接 OCP 监控数据租户的用户名。 | | ocp_monitor_password | 必选 | oceanbase | 重启进程 | `ocp_monitor_username` 对应用户名的密码。 | | ocp_monitor_db | 可选 | monitor_database | 重新部署 | 存放 OCP 监控数据的 database 名。 | 3. 修改 ODP 配置 ```yaml obproxy-ce: # version: 4.2.3.0 # package_hash: 7ca6c000887b90db111093180e6984bf4cf8f7380a948870f3eb2ac30be38f37 # release: 3.el7 depends: - oceanbase-ce servers: - 10.10.10.1 global: home_path: /home/admin/obproxy prometheus_listen_port: 2884 listen_port: 2883 obproxy_sys_password: ******** skip_proxy_sys_private_check: true enable_strict_kernel_release: false enable_cluster_checkout: false proxy_id: 5150 client_session_id_version: 2 ``` 4. 修改 OCP 配置 #### 注意 依赖 OceanBase 数据库部署 OCP 时，obd 会依赖 OceanBase 数据库组件下的配置获取 OCP 元数据库的信息，此时配置 `jdbc_xxx` 这三个配置项会报错。 ```yaml ocp-server-ce: # version: 4.2.2 # package_hash: 84a65bf0ec004e73b772938696b2b896a0ef2b2f # release: 20240315150922.el7 depends: - oceanbase-ce - obproxy-ce servers: - 10.10.10.1 global: home_path: /home/admin/ocp soft_dir: /home/admin/ocp/software log_dir: /home/admin/ocp/logs ocp_site_url: http://10.10.10.1:8080 port: 8080 admin_password: ******** memory_size: 8G ``` ### 步骤三：部署 OCP 1. 部署 OCP ```shell obd cluster deploy ocp -c distributed-ocp.yaml ``` ```shell ocp deployed Please execute ` obd cluster start ocp ` to start Trace ID: 990e7dba-0223-11ef-ab25-00163e0808cc If you want to view detailed obd logs, please run: obd display-trace 990e7dba-0223-11ef-ab25-00163e0808cc ``` 2. 启动 OCP ``` 启动成功后会输出集群的相关信息，输出如下： ```shell +-------------------------------------------------+ | observer | +---------------+---------+------+-------+--------+ | ip | version | port | zone | status | +---------------+---------+------+-------+--------+ | 10.10.10.1 | 4.2.1.8 | 2881 | zone1 | ACTIVE | | 10.10.10.2 | 4.2.1.8 | 2881 | zone2 | ACTIVE | | 10.10.10.3 | 4.2.1.8 | 2881 | zone3 | ACTIVE | +---------------+---------+------+-------+--------+ obclient -h10.10.10.1 -P2881 -uroot -p'********' -Doceanbase -A +-------------------------------------------------+ | obproxy | +---------------+------+-----------------+--------+ | ip | port | prometheus_port | status | +---------------+------+-----------------+--------+ | 10.10.10.1 | 2883 | 2884 | active | +---------------+------+-----------------+--------+ obclient -h10.10.10.1 -P2883 -uroot@proxysys -p'********' -Doceanbase -A +----------------------------------------------------------+ | ocp-server-ce | +---------------------------+----------+----------+--------+ | url | username | password | status | +---------------------------+----------+----------+--------+ | http://10.10.10.1:8080 | admin | ******** | active | +---------------------------+----------+----------+--------+ ocp running ``` ## 相关文档 - 使用 obd 部署集群后，您可通过 obd 命令管理集群，包括重启（restart/reload）、停止（stop）、卸载（destroy）等，详细命令介绍可参见 [集群命令组](https://www.oceanbase.com/docs/community-obd-cn-1000000000955364)。 - 部署 OCP 成功后，OCP 的使用可参见 [OceanBase 云平台](https://www.oceanbase.com/docs/ocp) 文档。 上一篇 下一篇 ![有帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*y6ocSqN8cqsAAAAAAAAAAAAAARQnAQ)![无帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*BG9IQJyLHF8AAAAAAAAAAAAAARQnAQ)![反馈](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*eTWdQKCRKHwAAAAAAAAAAAAAARQnAQ)[AI](https://www.oceanbase.com/obi) 咨询热线