OceanBase logo

OceanBase

A unified distributed database ready for your transactional, analytical, and AI workloads.

DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Resources

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

View All
PRODUCTS

OceanBase Cloud

OceanBase Database

Tools

Connectors and Middleware

QUICK START

OceanBase Cloud

OceanBase Database

BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Company

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

International - English
中国站 - 简体中文
日本 - 日本語
Sign In
Start on Cloud

A unified distributed database ready for your transactional, analytical, and AI workloads.

DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

View All
PRODUCTS
OceanBase CloudOceanBase Database
ToolsConnectors and Middleware
QUICK START
OceanBase CloudOceanBase Database
BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

Start on Cloud
编组
All Products
    • Databases
    • iconOceanBase Database
    • iconOceanBase Cloud
    • iconOceanBase Tugraph
    • iconInteractive Tutorials
    • iconOceanBase Best Practices
    • Tools
    • iconOceanBase Cloud Platform
    • iconOceanBase Migration Service
    • iconOceanBase Developer Center
    • iconOceanBase Migration Assessment
    • iconOceanBase Admin Tool
    • iconOceanBase Loader and Dumper
    • iconOceanBase Deployer
    • iconKubernetes operator for OceanBase
    • iconOceanBase Diagnostic Tool
    • iconOceanBase Binlog Service
    • Connectors and Middleware
    • iconOceanBase Database Proxy
    • iconEmbedded SQL in C for OceanBase
    • iconOceanBase Call Interface
    • iconOceanBase Connector/C
    • iconOceanBase Connector/J
    • iconOceanBase Connector/ODBC
    • iconOceanBase Connector/NET
icon

OceanBase Cloud Platform

V3.1.1Community Edition

  • Document Overview
  • Product Introduction
    • System architecture
    • Features
    • What is OceanBase Cloud Platform?
    • Limits
      • System requirements
      • Dependencies
  • Deployment Guide
    • Overview
    • Prepare for the installation
    • Deploy OCP
    • Check after installation
    • Installation process
    • Prepare MetaDB and MonitorDB
      • Deploy OBD
      • Deploy OceanBase Database
      • Create tenants
    • Installation planning
      • User planning
      • Host planning
      • Disk and directory planning
      • Port planning
    • Appendix
      • Install Docker
      • \*-example.yaml
      • Restart OCP
  • User Guide
    • OCP overview
    • Log on to the OceanBase Cloud Platform console
    • FAQ
    • 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
    • Manage clusters
      • View the topology of a cluster
      • Cluster tenant management overview
      • Performance monitoring
      • Cluster resource management
      • Cluster management operations
      • Basic cluster operations
        • Disable SQL collection
        • View the SQL collection history
        • Take over a cluster
        • Create a cluster
        • Delete a cluster
        • Stop a cluster
        • Restart a cluster
        • Create a tenant
        • Upgrade the version of an OceanBase cluster
        • Change a password
        • Download logs
        • Manage OBServers of a cluster
          • Add an OBServer
          • Restart an OBServer
          • Stop an OBServer
          • Replace an OBServer
          • Delete an OBServer
        • Manage zones of a cluster
          • Create a zone
          • Restart a zone
          • Stop a zone
          • Delete a zone
      • Manage parameters
        • View parameters
        • Modify parameters
        • Parameter types
        • View the history of parameter changes
      • Major compaction management
        • Modify major freeze configurations
        • Major compaction details
        • Major freeze statistics
        • Perform a major compaction
    • 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
    • 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
    • Manage OBProxies
      • 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
      • Create an OBProxy cluster
      • Take over an OBProxy
    • Features
      • Packages
      • System management
        • Alert overview
        • View tasks
        • Security overview
        • View system parameters
      • Tenants
        • Tenant and resource management
        • Tenant overview
        • Overview of the Tenant Details page
      • Hosts
        • Host overview
        • Host details
      • OBProxy
        • OBProxy overview
        • OBProxy management overview
        • OBProxy cluster overview
      • Personal center
        • Specify personal information
        • Change the logon password
        • Configure alert subscription
        • Log off the OCP console
        • Password box
          • Manage connection credentials of an OceanBase cluster
          • Manage connection credentials of an OBProxy
          • Manage connection credentials of a host
      • Clusters
        • Cluster management
        • Overview of the Cluster Details page
        • Cluster overview
    • Manage software packages
      • Upload a software package
      • Download a software package
      • Delete a software package
    • Manage tenants
      • View a tenant topology
      • Database management
      • User management under a MySQL tenant
      • Performance monitoring
      • Tenant resource management
      • Tenant management operations
      • Basic tenant operations
        • Create a tenant
        • Manage unit types
        • Lock a tenant
        • Copy 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
        • Delete a tenant
      • Manage parameters
        • View the parameters
        • Modify a parameter
        • View the parameter modification history
      • SQL diagnostics
        • TopSQL diagnosis
        • Slow SQL diagnosis
      • Manage sessions
        • View tenant sessions
        • View session statistics
    • Manage hosts
      • Add a host
      • Modify a host
      • Restart OCP Agent
      • Stop OCP Agent
      • Reinstall OCP Agent
      • Host management operations
  • 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
    • 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
    • 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_offset_too_large
      • host_ntp_service_not_exist
      • partition_create_failed
      • obagent_dead
  • API Reference
    • API call description
    • Overview
    • 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
    • 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
    • Software packages
      • Query software packages
      • Upload a software package
      • Delete a software package
    • 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
    • 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
    • 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
    • Monitoring
      • Query the metadata of a monitoring metric
      • Query monitoring data
      • Query monitoring data and attach a tag to the data
    • 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
    • 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
    • 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
    • Others
      • Query the basic information of an OCP application
      • Query OCP server time
      • Query OCP application status
    • Appendix
      • Task information

Download PDF

Document Overview System architecture Features What is OceanBase Cloud Platform?System requirementsDependencies Overview Prepare for the installation Deploy OCP Check after installation Installation process Deploy OBD Deploy OceanBase DatabaseCreate tenants User planning Host planning Disk and directory planning Port planning Install Docker \*-example.yaml Restart OCPOCP overview Log on to the OceanBase Cloud Platform console FAQAlert-related conceptsCreate 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 View the topology of a cluster Cluster tenant management overviewPerformance monitoring Cluster resource management Cluster management operations Role overview Create a role Manage rolesCopy 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 OCP configuration parameters SQL performance module OCP resource unit specifications OCP error table OCP alert template variablesCall 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 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 Create an OBProxy cluster Take over an OBProxy Packages Upload a software package
OceanBase logo

The Unified Distributed Database for the AI Era.

Follow Us
Products
OceanBase CloudOceanBase EnterpriseOceanBase Community EditionOceanBase seekdb
Resources
DocsBlogLive DemosTraining & Certification
Company
About OceanBaseTrust CenterLegalPartnerContact Us
Follow Us

© OceanBase 2026. All rights reserved

Cloud Service AgreementPrivacy PolicySecurity
Contact Us
Document Feedback
  1. Documentation Center
  2. OceanBase Cloud Platform
  3. V3.1.1
iconOceanBase Cloud Platform
V 3.1.1Community Edition
  • V 4.3.6
  • V 4.3.5
  • V 4.3.4
  • V 4.3.3
  • V 4.3.2
  • V 4.3.1
  • V 4.3.0
  • V 4.2.2
  • V 4.0.0 and earlier
Community Edition
  • V 4.0.0
  • V 3.1.1
Enterprise Edition
  • V 4.0.0
  • V 3.3.1

Host planning

Last Updated:2026-04-14 03:56:05  Updated
share
What is on this page
Requirements for hosts and resources
MetaDB
MonitorDB
OCP
Example
Requirements for operating systems

folded

share

This topic describes the number of hosts, and the CPU and memory resources that are required to deploy OceanBase Cloud Platform (OCP) Community Edition.

Requirements for hosts and resources

MetaDB

MetaDB stores persistent data other than monitoring data, and requires less resources. We recommend that you create a separate OceanBase Database tenant for MetaDB and allocate at least 4 CPU cores and 8 GB of memory to the tenant.

We recommend that you allocate CPU and memory resources to each replica of the MetaDB tenant based on the number of OBServers managed by OCP.

Number of managed OBServers CPU (core) Memory (GB)
≤ 10 4 8
≤ 50 8 16
≤ 100 16 32
≤ 200 32 64
≤ 400 64 128

MonitorDB

MonitorDB stores the performance data collected by OCP from managed objects, mainly OceanBase Database clusters. We recommend that you create an OceanBase Database tenant dedicated for MonitorDB and allocate at least 4 CPU cores and 16 GB of memory to the tenant.

We recommend that you allocate CPU and memory resources to each replica of the MonitorDB tenant based on the number of OBServers managed by OCP.

Number of managed OBServers CPU (core) Memory (GB)
≤ 10 4 16
≤ 50 16 64
≤ 100 32 128
≤ 200 64 256
≤ 400 128 512

OCP

The following table describes the CPU and memory resources required for OCP-Server on the premises that each managed OBServer runs 10 tenants. You must calculate the required CPU and memory resources based on your business requirements.

Number of managed OBServers CPU (core) Memory (GB)
≤ 10 4 8
≤ 50 8 16
≤ 100 16 32
≤ 200 32 64
≤ 400 64 128

Note

OCP-Server requires a minimum of 4 CPU cores, 8 GB of memory, and 500 GB of available disk space. This configuration still applies when you need to manage only one host that runs less than or equal to 10 tenants.

Example

OCP is deployed in a Docker container. You can deploy OCP-Server, OCP-MetaDB, and OCP-MonitorDB on the same physical server. You can create different tenants in an OceanBase cluster for OCP-MetaDB and OCP-MonitorDB. The following table describes the resources required when you use OCP to manage 10 OBServers.

Deployment item CPU (core) Memory (GB)
OCP-Server 4 8
OCP-MetaDB tenant 4 8
OCP-MonitorDB tenant 4 16
SYS tenant 5 28

The physical server requires 24 CPU cores and 64 GB of memory.

Requirements for operating systems

Server type Operating system Supported version
x86_64 RHEL 7.2 and later
x86_64 CentOS 7.2 and later
x86_64 AliOS 7.2 and later
x86_64 openSUSE 12 SP3 and later
ARM AArch64 AliOS 7.2 and later
ARM AArch64 NeoKylin 7.6
ARM AArch64 Huawei EulerOS 2.0 SP8

Previous topic

User planning
Last

Next topic

Disk and directory planning
Next
What is on this page
Requirements for hosts and resources
MetaDB
MonitorDB
OCP
Example
Requirements for operating systems