---
title: "修改配置文件 | OceanBase 文档中心"
description: 修改配置文件 在进行安装 OCP 之前，您需对配置文件进行修改。 前提条件 已参见 安装准备 获取 ocp-4.0.0-ce.tar.gz 软件包。 文件中的地址信息不可以使用 127.0.0.1、localhost 或者主机名。 当宿主机同时具有公网 IP 和私网 IP 时，若私网 IP 可访问，建议配置私网 IP…
---
切换语言

- 中文站 - 简体中文
- International - English
- 日本站 - 日本語

文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*lJTmRZ61jSUAAAAAAAAAAAAADiGDAQ/original) 云平台 OCPV 4.0.0 社区版

# 修改配置文件

更新时间：2026-04-14 15:15:53

[编辑](https://github.com/oceanbase/ocp-doc/edit/V4.0.0/zh-CN/300.deployment-guide/500.modify-conf-file.md)  

在进行安装 OCP 之前，您需对配置文件进行修改。

## 前提条件

- 已参见 [安装准备](https://www.oceanbase.com/docs/community-ocp-cn-10000000000866612) 获取 `ocp-4.0.0-ce.tar.gz` 软件包。
 - 文件中的地址信息不可以使用 127.0.0.1、localhost 或者主机名。
 - 当宿主机同时具有公网 IP 和私网 IP 时，若私网 IP 可访问，建议配置私网 IP 以提高传输文件的速度。
 - 如果配置了 VIP，需要提前完成申请和绑定，部署程序不会做 VIP 相关的部署工作，只是使用配置的 VIP 地址来进行访问。

## 操作步骤

1. 将 `ocp-4.0.0-ce.tar.gz` 上传到宿主机任一目录，并进行解压。解压后获得以下文件：

      - `ocp_installer.sh`：OCP 安装脚本
      - `ocp.tar.gz`：OCP 镜像文件
      - `ocp-installer.tar.gz`：OCP 安装程序镜像文件
      - `config.yaml`：OCP 配置文件
 2. 根据实际部署情况，修改 `config.yaml` 配置文件。 配置文件主要包括以下几个部分，您需要根据实际环境情况进行配置：

      - MetaDB 集群配置
      - SSH 认证
      - OCP 相关配置
      - 其他配置

   ```Java
   # precheck 会对部署主机的资源和环境进行检查判断，来查看宿主机是否满足一般情况下的部署需求，一般不建议忽略 precheck。如果受限于机器资源，或者仅作为测试使用，可以选择忽略
   precheck_ignore: false

   # METADB 集群相关配置
   # 当 create_metadb_cluster 设置为 true 时，会单独创建一个 OB 集群作为 OCP 的 metadb
   create_metadb_cluster: false

   # 当卸载 OCP 时是否删除 meta obcluster，当这个配置项没有配置的时候，会根据 create_metadb_cluster 来判断
   clean_metadb_cluster: false

   # metadb ob 集群的配置
   ob_cluster:
     name: obcluster
     home_path: /home/admin/oceanbase
     root_password: '******'
     # 数据存放目录，建议单独设置
     data_path: /data/1
     # clog, ilog 和 slog 的目录，建议单独设置
     redo_path: /data/log1
     sql_port: 2881
     rpc_port: 2882
     # ob 集群的所有zone
     zones:
         # zone 名字
       - name: zone1
         # zone 下的所有 server
         servers:
           - xxx.xxx.xxx.xxx

       ## 部署 OceanBase 集群的其他自定义参数，下面列举了常用的几个参数，如需添加其他参数，可以增加对应的 `key` 和 `value` 配置
        # custom_config:
        #   - key: devname
        #     value: eth0
        #   - key: cpu_count
        #     value: 0
        #   - key: memory_limit
        #     value: 0G
        #   - key: system_memory
        #     value: 30G
        #   - key: __min_full_resource_pool_memory
        #     value: 5368709120
        #   - key: datafile_maxsize
        #     value: 0
        #   - key: datafile_next
        #     value: 0

     # meta 用户相关配置
     # 请勿将系统租户配置为 meta 租户，建议使用系统默认配置或其他非系统租户。
     meta:
       # 租户名
       tenant: meta_tenant
       # 用户名
       user: meta_user
       # 用户密码
       password: ******
       # meta database 名
       database: meta_database
       # 租户的 CPU
       cpu: 2
       # 租户的内存，单位是 GB
       memory: 4

     # monitor 用户相关配置
     # 请勿将系统租户配置为 monitor 租户，建议使用系统默认配置或其他非系统租户。
     monitor:
       # 租户名
       tenant: monitor_tenant
       # 用户名
       user: monitor_user
       # 用户密码
       password: ******
       # monitor database 名
       database: monitor_database
       # 租户的 CPU
       cpu: 4
       # 租户的内存，单位是 GB
       memory: 8

   # metadb obproxy 的配置
   obproxy:
     # obproxy 的安装路径
     home_path: /home/admin/obproxy
     # obproxy 的监听端口
     port: 2883
     # obproxy 部署的 server
     servers:
       - xxx.xxx.xxx.xxx
     # VIP 地址，如果有多个obproxy，一般需要一个vip来做负载均衡，如果不配置，会选择一个obproxy的地址
     # vip:
     #   address: xxx.xxx.xxx.xxx
     #   port: 2883

   ## SSH 认证相关配置
   ssh:
     port: 22
     user: root
     # 认证方式，支持 password 或者 pubkey
     auth_method: password
     timeout: 10
     password: ******

   # OCP 相关配置
   ocp:
     # OCP 容器的名字
     name: 'ocp'

     # OCP 进程相关配置，包括端口号和日志路径
     process:
         # OCP 进程监听端口
         port: 8080
         # OCP 日志文件在宿主机上的路径
         log_dir: /tmp/ocp/log
     # OCP 部署的主机
     servers:
       - xxx.xxx.xxx.xxx
     # OCP 容器的资源限制
     resource:
         cpu: 4
         # 内存资源限制，单位是 GB
         memory: 8
     # OCP VIP 配置，如果不配置，会选择一个 OCP 主机的地址
     # vip:
     #   address: xxx.xxx.xxx.xxx
     #   port: 8080
     # OCP 认证配置，在升级场景下会使用
     auth:
       user: admin
       password: ******
     options:
     # 是否开启前端埋点，开启后将采集系统信息、用户行为、前端异常等非业务敏感数据，用于改善产品使用体验和稳定性
       enable_web_tracking: true
     # OCP metadb 的配置信息，如果在上面配置了创建一个单独的 metadb 集群，会使用创建的集群的信息
     metadb:
       host: xxx.xxx.xxx.xxx
       port: 2883
       meta_user: meta_user@meta_tenant#obcluster
       meta_password: ******
       meta_database: meta_database
       monitor_user: monitor_user@monitor_tenant#obcluster
       monitor_password: ******
       monitor_database: monitor_database

   ```

 上一篇 下一篇 ![有帮助](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) 咨询热线