OceanBase
English日本語简体中文
Docs Home
Products
Integrations
Release Notes

Databases

OceanBase DatabaseOceanBase Cloud OceanBase Best Practices

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog Service

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Databases

OceanBase DatabaseOceanBase Cloud OceanBase Best Practices

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog Service
OceanBase DatabaseOceanBase Cloud ToolsConnectors and MiddlewareLifecycle Support Policy

OceanBase Cloud Platform

V3.1.1Community Edition
  • Document Overview
  • Product Introduction
    • What is OceanBase Cloud Platform?
    • System architecture
    • Features
    • Limits
      • System requirements
      • Dependencies
  • Deployment Guide
    • Overview
    • Installation process
    • Installation planning
      • User planning
      • Host planning
      • Disk and directory planning
      • Port planning
    • Prepare for the installation
    • Prepare MetaDB and MonitorDB
      • Deploy OBD
      • Deploy OceanBase Database
      • Create tenants
    • Deploy OCP
    • Check after installation
    • Appendix
      • Install Docker
      • \*-example.yaml
      • Restart OCP
  • User Guide
    • OCP overview
    • Log on to the OceanBase Cloud Platform console
    • Features
      • Clusters
        • Cluster management
        • Cluster overview
        • Overview of the Cluster Details page
      • Tenants
        • Tenant and resource management
        • Tenant overview
        • Overview of the Tenant Details page
      • Hosts
        • Host overview
        • Host details
      • Packages
      • OBProxy
        • OBProxy management overview
        • OBProxy overview
        • OBProxy cluster overview
      • System management
        • Alert overview
        • View tasks
        • Security overview
        • View system parameters
      • Personal center
        • Specify personal information
        • Change the logon password
        • Configure alert subscription
        • Password box
          • Manage connection credentials of an OceanBase cluster
          • Manage connection credentials of an OBProxy
          • Manage connection credentials of a host
        • Log off the OCP console
    • Manage clusters
      • Cluster management operations
      • Basic cluster operations
        • Take over a cluster
        • Create a cluster
        • Delete a cluster
        • Stop a cluster
        • Restart a cluster
        • Manage zones of a cluster
          • Create a zone
          • Restart a zone
          • Stop a zone
          • Delete a zone
        • Manage OBServers of a cluster
          • Add an OBServer
          • Restart an OBServer
          • Stop an OBServer
          • Replace an OBServer
          • Delete an OBServer
        • Create a tenant
        • Upgrade the version of an OceanBase cluster
        • Change a password
        • Download logs
        • Disable SQL collection
        • View the SQL collection history
      • View the topology of a cluster
      • Cluster tenant management overview
      • Performance monitoring
      • Cluster resource management
      • Major compaction management
        • Modify major freeze configurations
        • Major compaction details
        • Major freeze statistics
        • Perform a major compaction
      • Manage parameters
        • View parameters
        • Modify parameters
        • Parameter types
        • View the history of parameter changes
    • Manage tenants
      • Tenant management operations
      • Basic tenant operations
        • Create a tenant
        • Manage unit types
        • Lock a tenant
        • Copy a tenant
        • Delete a tenant
        • Add a replica
        • Change the password of the sys tenant
        • Edit a tenant replica of a zone
        • Delete a tenant replica from a zone
        • Modify zone priorities
        • Modify the whitelist
      • View a tenant topology
      • Database management
      • User management under a MySQL tenant
      • Performance monitoring
      • Tenant resource management
      • SQL diagnostics
        • TopSQL diagnosis
        • Slow SQL diagnosis
      • Manage sessions
        • View tenant sessions
        • View session statistics
      • Manage parameters
        • View the parameters
        • Modify a parameter
        • View the parameter modification history
    • Manage hosts
      • Host management operations
      • Add a host
      • Modify a host
      • Restart OCP Agent
      • Stop OCP Agent
      • Reinstall OCP Agent
    • Manage software packages
      • Upload a software package
      • Download a software package
      • Delete a software package
    • Manage OBProxies
      • Create an OBProxy cluster
      • Take over an OBProxy
      • Delete an OBProxy
      • Restart an OBProxy
      • Upgrade an OBProxy
      • Add an OBProxy
      • Refresh OBProxy configurations
      • Monitor OBProxy cluster performance
      • OBProxy cluster parameter management
      • Add a connectable OceanBase cluster
      • Delete an OBProxy cluster
      • Upgrade all OBProxies in an OBProxy cluster
      • Restart all OBProxies in an OBProxy cluster
      • Delete a connected OceanBase cluster
    • Manage alerts
      • Alert-related concepts
      • Create an alert item
      • View alert items
      • Copy an alert item
      • Edit an alert item
      • Delete an alert item
      • Alert groups
      • Create an alert channel
      • View alert channels
      • Edit an alert channel
      • Delete an alert channel
      • View an alert event
      • View the alert notification history
      • Create a blocking condition
      • Edit alert blocking conditions
      • Delete a blocking condition
      • Add a filtering keyword
      • Modify the expiration time of a filtering keyword
      • Delete a filtering keyword
      • Create an alert subscription
      • Manage alert subscriptions
    • Use system management
      • Role overview
      • Create a role
      • Manage roles
      • Copy a role
      • Create a user
      • View users
      • Edit a user
      • Copy a user
      • Change a user password
      • Delete a user
      • Logon history
      • Manage system parameters
      • Manage tasks
    • FAQ
    • Appendix
      • OCP configuration parameters
      • SQL performance module
      • OCP resource unit specifications
      • OCP error table
      • OCP alert template variables
      • Call an alert API
      • OCP background tasks
      • Monitoring metrics
      • Examples of alert channel configuration
      • OBProxy startup parameters
      • System privileges in a MySQL tenant
      • Component listening port list
      • OCP-Agent processes
      • Enable the OCP multi-cluster mode
      • Log error PAM Permission Denied
      • Failed to upload the software package
      • Check the sudo permissions of a user
      • Default OCP roles
      • FAQ about multi-zone mode
      • FAQ about OBProxy takeover
      • Install dependent software
  • Alert Reference
    • Overview
    • OceanBase alerts
      • ob_cannot_connected
      • ob_cluster_status_check_failed
      • ob_cluster_exists_inactive_server
      • ob_cluster_exists_index_fail_table
      • ob_cluster_frozen_version_delta_over_threshold
      • ob_cluster_merge_error
      • ob_cluster_merge_timeout
      • ob_cluster_no_frozen
      • ob_cluster_no_merge
      • ob_cluster_operation_info
      • ob_cluster_sync_failed
      • ob_cpu_assigned_percent_over_threshold
      • ob_cpu_percent_over_threshold
      • ob_host_connection_percent_over_threshold
      • ob_host_cpu_percent_over_threshold
      • ob_host_disk_percent_over_threshold
      • ob_host_disk_readonly
      • ob_host_exists_expired_trans
      • ob_host_load1_per_cpu_over_threshold
      • ob_host_mem_percent_over_threshold
      • ob_host_net_recv_percent_over_threshold
      • ob_host_net_send_percent_over_threshold
      • ob_host_partition_count_over_threshold
      • ob_host_tcp_retrans_percent_over_threshold
      • ob_log_alarm
      • ob_mem_assigned_percent_over_threshold
      • ob_server_sstable_percent_over_threshold
      • ob_server_exists_long_lived_trans
      • ob_tenant_operation_info
      • ob_tenant500_mem_hold_over_threshold
      • ob_tenant500_mem_hold_percent_over_threshold
      • ob_zone_sstable_percent_over_threshold
      • tenant_active_memstore_percent_over_threshold
      • tenant_connection_percent_over_threshold
      • tenant_cpu_percent_over_threshold
      • tenant_memstore_percent_over_threshold
      • obproxy_process_dead
      • obproxyd_process_dead
      • obproxy_cannot_connected
      • ob_cluster_sync_delay_time_too_long
      • ob_host_data_disk_percent_over_threshold
      • ob_host_log_disk_percent_over_threshold
      • ob_host_install_disk_percent_over_threshold
    • Application alerts
      • no_enough_exporter
      • no_port_mapping_for_exporter
      • host_unavailable
      • backup_schedule_fail
      • inc_backup_delay
      • base_backup_fail
      • base_backup_too_long_time_no_one_success_task
      • backup_process_dead
      • backup_storage_capacity_over_threshold
      • backup_storage_capacity_retry_times_exceeded
      • backup_storage_capacity_timeout_or_interrupted
      • ocp_remote_server_time_diff_too_large
      • monitor_exporter_unavaliable
      • system_obproxy_unavailable
      • host_ntp_service_not_exist
      • partition_create_failed
      • obagent_dead
      • host_ntp_offset_too_large
    • Appendix
      • Set an alert-blocking condition
      • Modify alert thresholds
      • Exception handling for OceanBase cluster compaction
      • OCP-Agent script
      • Apply throttling to an OceanBase cluster
      • Network troubleshooting
  • API Reference
    • Overview
    • API call description
    • Cluster information
      • Query clusters
      • Create an OceanBase cluster
      • Delete an OceanBase cluster
      • Stop an OceanBase cluster
      • Start an OceanBase cluster
      • Restart an OceanBase cluster
      • Upgrade an OceanBase cluster
      • Query zones of an OceanBase cluster
      • Create a zone for an OceanBase cluster
      • Delete a zone from an OceanBase cluster
      • Stop a zone in an OceanBase cluster
      • Start a zone in an OceanBase cluster
      • Restart a zone in an OceanBase cluster
      • Add an OBServer
      • Delete multiple OBServers at a time
      • Stop an OBServer
      • Start an OBServer
      • Restart an OBServer
      • Replace an OBServer
      • Change the password of an OceanBase cluster
      • Query the parameter metadata of an OceanBase cluster
      • Query parameters of an OceanBase cluster
      • Modify parameters of an OceanBase cluster
      • Query servers
      • Query servers in a zone
    • Tenant information
      • Query tenants of a cluster
      • Query all tenants
      • Query details about a tenant
      • Create a tenant
      • Delete a tenant
      • Lock a tenant
      • Unlock a tenant
      • Query units of a tenant
      • Delete a unit from a tenant
      • Add a replica for a tenant
      • Delete a replica of a tenant
      • Modify a replica of a tenant
      • Modify zone priorities of a tenant
      • Change the administrator password of a tenant
      • Modify the whitelist of a tenant
      • Query parameters of a tenant
      • Modify parameters of a tenant
      • OceanBase database management
        • Query databases
        • Create a database
        • Modify a database
        • Delete a database
    • Hosts
      • Query regions
      • Query details about a region
      • Add a region
      • Delete a region
      • Query IDCs
      • Query details about an IDC
      • Add an IDC
      • Delete an IDC
      • Query host types
      • Query details about a host type
      • Add a host type
      • Delete a host type
      • Query hosts
      • Query details about a host
      • Add multiple hosts at a time
      • Delete a host
      • Delete multiple hosts at a time
    • Software packages
      • Query software packages
      • Upload a software package
      • Delete a software package
    • OBProxy management
      • Create an OBProxy cluster
      • Delete an OBProxy cluster
      • Query OBProxy clusters
      • Query details about an OBProxy cluster
      • Update configurations of an OBProxy cluster
      • Add an OBProxy
      • Take over an OBProxy
      • Delete an OBProxy
      • Restart an OBProxy
      • Upgrade an OBProxy
      • Add a connectable OceanBase cluster for an OBProxy cluster
      • Remove a connectable OceanBase cluster from an OBProxy cluster
      • Query the parameter metadata of an OBProxy
      • Query parameters of an OBProxy cluster
    • Monitoring
      • Query the metadata of a monitoring metric
      • Query monitoring data
      • Query monitoring data and attach a tag to the data
    • Alerts
      • Alert events
        • Query the alert event list
        • Query alert events
      • Alert notifications
        • Query alert notifications
    • Task management
      • Query tasks
      • Query details about a task
      • Retry a task
      • Roll back a task
      • Query logs of a subtask instance
      • Retry a subtask
      • Skip a subtask
      • Cancel a subtask
    • OceanBase user and privilege management
      • Query database user details
      • Query database user details
      • Create a database user
      • Delete a database user
      • Change the password of a database user
      • Lock a database user
      • Unlock a database user
      • Query the database role details
      • Query database role details
      • Create a database role
      • Delete a database role
      • Query database objects
      • Grant global privileges to a user
      • Revoke global privileges of a user
      • Change global privileges of a user
      • Grant global privileges to a role
      • Revoke global privileges of a role
      • Change global privileges of a role
      • Grant roles to a user
      • Revoke roles of a user
      • Change roles of a user
      • Grant roles to a role
      • Revoke roles of a role
      • Change roles of a role
      • Grant database privileges to a user
      • Revoke database privileges of a user
      • Change database privileges of a user
      • Grant object privileges to a user
      • Revoke object privileges of a user
      • Change object privileges of a user
      • Grant object privileges to a role
      • Revoke object privileges of a role
      • Change object privileges of a role
    • OCP Agent management
      • Query OCP Agent details on a host
      • Stop basic OCP Agent processes on a host
      • Batch stop basic OCP Agent processes on a host
      • Restart basic OCP Agent processes on a host
      • Batch restart basic OCP Agent processes on a host
      • Query OCP Agent processes on a host
      • Restart OCP Agent processes on a host
      • Stop OCP Agent processes on a host
    • SQL performance
      • Query performance indicators of an SQL statement
      • Query the performance indicator trend of an SQL statement
      • Query SQL text
      • Query performance indicators of an execution plan
      • Query the performance indicator trend of an execution plan
      • Query the operator structure of an execution plan
    • Others
      • Query the basic information of an OCP application
      • Query OCP server time
      • Query OCP application status
    • Appendix
      • Task information

Download PDF

Document Feedback
  1. Documentation Center
  2. OceanBase Cloud Platform
  3. V3.1.1

Disk and directory planning

Last Updated:2026-09-04 10:28:16

Database disks
MetaDB
MonitorDB
OCP disks

This topic describes the disks and directories required for the deployment of OceanBase Cloud Platform (OCP) Community Edition.

Database disks

MetaDB

The disk space required depends on factors such as the size of the managed cluster and stored files and the data retention period. We recommend that you reserve at least 100 GB of disk space. When the available disk space of a tenant is insufficient, you can scale out the tenant as required.

MonitorDB

If you manage no more than 10 OBServers with a moderate business traffic, we recommend that you reserve at least 150 GB of disk space. If you want to manage a large amount of business traffic, use the following method to estimate the disk space required for MonitorDB:

  • Estimation principles: Monitoring data can be divided into metric data and SQL execution records.

    • Metric data: The storage space used by each OBServer increases by 100 MB to 300 MB daily.

    • SQL execution records: The storage space consumption is related to the business transactions. In general, the space taken up by execution records is about 10 to 50 times of the metric data.

    Based on empirical data, the size of SQL execution records on each OBServer increases by 1 GB to 40 GB per day. It is estimated to be 20 GB. OCP uses partitioned tables to store monitoring data. The retention period of the monitoring data varies with the data type:

    • Metric data: Second-by-second data is retained for 8 days and minute-by-minute data is retained for 31 days.

    • SQL execution records: retained for 8 days.

Most of the storage space is occupied by SQL execution records. You can use SQL execution records to estimate the required disk space.

  • Resource estimation formula: The total number of OBServers (server_count in the following example) in all managed OceanBase clusters is used for the estimation.

    • Estimated daily data increase for OCP MonitorDB = server_count × 20 GB

    • Estimated MonitorDB space requirement = Estimated daily data increase for OCP MonitorDB × 8 days

  • Example: Assume that you have a total of 20 OBServers running in all managed OceanBase clusters. The disk space is estimated in the following two steps:

    • Estimated daily data increase for OCP MonitorDB = 20 × 20 GB = 400 GB

    • Estimated MonitorDB space requirement = 400 GB/day × 8 days = 3200 GB, which is about 3.2 TB

    Note

    The preceding disk space estimation result is a ballpark figure. The actual amount of resources varies with the business transactions of MonitorDB.

The following table describes the minimum space for your reference. You need to create directories with a space greater than or equal to the minimum as required.

Directory
Storage space
Description
/home/admin/observer 20 GB The installation directory of OceanBase Database. You must manually create the directory and make sure that the admin user has the read and write permissions on the directory.
/data/ 250 GB The directory in which the business data of OCP is stored. You must manually create the directory and make sure that the admin user has the read and write permissions on the directory.

OCP disks

OCP is deployed in a Docker container. OCP-Server writes files to disks, and the files consume the disk space. We recommend that you reserve at least 350 GB of disk space for the OCP-Server Docker container to avoid impact on businesses due to exhausted disk space.

The following table describes the disk usage when OCP-Server is running.

Item
Storage path
Space requirement
OCP program
  • /home/admin/ocp-server/
  • /home/admin/ocp-init/
  • The OCP program occupies about 1 GB of disk space after installation. The RPM packages provided with it require about 5 GB of space. Therefore, we recommend that you reserve 10 GB of space.
    OCP main process logs /home/admin/logs/ocp/ The log file size and the number of retained files are configured through OCP system parameters. By default, each log file is 100 MB large and retained for up to 100 days, and 5 to 10 files are generated each day. Therefore, we recommend that you reserve 100 GB of space.
    OCP task logs /home/admin/logs/task/ No capacity limit is set. OCP periodically clears task logs to meet the target of keeping at least 20% of disk space free. Log files updated at earlier dates are cleared first. 100 GB of space needs to be reserved.
    Local cache for OCP files /home/admin/data/files/ No capacity limit is set. Most of the OCP files are installation packages related to targets under OCP management, and they are mostly OceanBase installation packages. The average size of each installation package is about 500 MB. Assume that 100 installation packages are stored. 100 GB of space needs to be reserved.

    Previous topic

    Host planning
    Last

    Next topic

    Port planning
    Next
    on this page
    Database disks
    MetaDB
    MonitorDB
    OCP disks