A Deep Dive into the OceanBase Ecosystem Toolchain — OAT / obd / OCP / obshell

Prologue

A while back, Qingtao published an article, Deploying the OceanBase Database in an Ubuntu Virtual Machine, mainly to share his experience with OceanBase learners.

But one reader — a former Snowflake development engineer who used to be based in the United States — highlighted a line in the article and grumbled that OceanBase’s ecosystem tools are “too abundant,” with roles and relationships that are easy to find confusing.

So today, we’ve invited the product owner for these ecosystem tools — the distinguished Zhimin — to walk us through the ecosystem toolchain shown in the OceanBase product-and-tool relationship diagram below.

Feel free to follow the OceanBase community WeChat account “Lao Ji’s Tech Talk,” where we keep publishing technical content related to #databases, #AI, and #OceanBase!

Note:

The primary audience for this article is DBAs.

If you’re an individual developer:

• On Linux, we recommend using the seekdb installation package^[1].
• On Windows / Mac, we recommend using the seekdb^[2] desktop edition directly.

Background

As a leading distributed, cloud-native database, OceanBase’s power lies not only in the high performance and high availability of its kernel and its robust cloud-based management of physical resources, but also in its rich and well-layered ecosystem toolchain. Together, these tools form a complete system spanning deployment, operations, and management.

However, for new community-edition users — or those looking to migrate from the community edition to the enterprise edition — the roles and relationships of tools like OAT, obd, OCP, and obshell / obshell Dashboard are often confusing.

This article aims to take a deep dive into the functions, roles, and interrelationships of these core tools, and to give community-edition users a clear, actionable path for upgrading to the enterprise edition.

A Bit of History

• 2017 — Commercialization phase: OceanBase was officially commercialized, and we provided a commercial deployment solution based on OAT / OCP. As a standalone tool, OAT effectively solved the MetaDB (the metadata database, itself built on OceanBase) dependency problem encountered when deploying products like OCP, OMS, and ODC. Enterprise-edition clusters were then deployed via OCP, which greatly simplified the commercial delivery process and standardized installation and deployment.
• 2021 — Open-source phase: As OceanBase went open source, and given that OAT supported only Dockerized deployment — which struggled to meet community users’ need for a lightweight, simple setup — we chose obd as the official community-edition installation tool and continued to expand its capabilities. obd supports deploying OceanBase (community / enterprise editions), as well as deploying and upgrading OCP (community / enterprise editions), and it offers basic operations and management capabilities. This effectively addressed users’ demand for command-line control and a simpler OCP deployment and upgrade experience.
• 2023 — Evolution toward lightweight solutions: While serving small and medium-sized customers, and in response to some users’ need for command-line and lightweight visual control, we further introduced the kernel-level obshell / obshell Dashboard solution. This solution is designed to let obd / OCP or other third-party products perform OceanBase data operations based on the obshell SDK, ensuring state consistency across all operations and management actions.

Note:

Some obd operations have been adapted to obshell, and OCP (community / enterprise editions) supports obshell start / stop operations.

Overview and Relationships of OceanBase’s Core Operations and Management Tools

OceanBase’s installation, deployment, operations, and management tools can be broadly grouped into three tiers: command-line tools, graphical management platforms, and kernel-level tools. They work together to serve the full lifecycle management of the database.

1. Tool Overview

(1) OAT (OceanBase Administration Tool): An Auxiliary Tool for Enterprise-Edition Deployment

OAT is a relatively specialized tool, used primarily for deploying OceanBase enterprise-edition product tools.

• Core function: OAT’s main function is to support deploying OceanBase enterprise-edition product tools. It is a key link in the enterprise-edition ecosystem, designed to make commercial deployment scenarios more convenient.
• Role and characteristics: OAT’s role is more specialized than obd’s. It serves the installation/deployment, scaling, and upgrading of enterprise-edition product tools such as OCP / ODC / OMS, as well as MetaDB (in Docker form).
• Use case: Commercial delivery scenarios.

(2) obd (OceanBase Deployer): An Out-of-the-Box Deployment and Basic Operations Tool

obd is OceanBase’s most fundamental and core tool for installing and deploying clusters and OCP (enterprise and community editions). It plays the role of the “automated deployment expert.”

• Core function: obd’s main responsibility is to simplify the installation and deployment of OceanBase clusters and OCP. It supports three deployment modes — YAML configuration files, interactive mode, and visual mode (web UI) — and can carry out the entire workflow from package installation, environment pre-checks, environment configuration, and parameter configuration through to cluster startup, greatly reducing deployment complexity.
• Role and characteristics: obd is both an installation/deployment tool and a centralized control tool, with an emphasis on being “out of the box.” It offers users a high degree of flexibility and customizability, making it well suited to those comfortable with the command line or to scenarios requiring integration with automation scripts. obd also supports an RPM-based deployment approach, meeting the needs of customers who are wary of container technology or have strict compliance requirements — ensuring broad applicability and a variety of deployment options.
• Operations capabilities: Beyond installation and deployment, obd also provides a degree of operations capability — for example, obd cluster display to view cluster status, obd cluster restart to restart a cluster, obd cluster destroy to destroy a cluster, as well as tenant management. However, its operations features are relatively basic, focusing mainly on the lifecycle management of clusters and tenants. If you need visual control capabilities, we recommend pairing it with obshell Dashboard.
• Use cases: Multi-cluster management, getting-started experience, test environments, small-to-medium production deployments.

(3) OCP (OceanBase Cloud Platform): An Enterprise-Grade Graphical Management Platform

OCP is OceanBase’s enterprise-grade cloud management platform — the “one-stop center” for database management.

• Core function: OCP provides a powerful, web-based graphical interface. It not only supports deploying and managing OceanBase clusters, but also offers comprehensive cluster monitoring, performance analysis, alert management, backup and recovery, tenant management, SQL diagnosis and optimization, automated operations, and other advanced capabilities. OCP is the go-to tool for enterprise users handling day-to-day operations, troubleshooting, and capacity planning.
• Role and characteristics: OCP’s role is to be “enterprise-grade” and “visual.” It greatly lowers the barrier to database operations, enabling even non-senior DBAs to manage databases efficiently. OCP itself comes in community and enterprise editions, whose features and licensing policies differ; for the specific feature differences, see the OCP official documentation.
• Deployment methods: OCP is usually deployed via one of three paths: first, directly using obd configuration files; second, launching a web installation wizard with the obd web command, which guides users through OCP deployment in a more intuitive, graphical way; and third, performing a visual deployment via OAT.
• Use cases: Multi-cluster management, large-scale production environments, enterprise-grade operations.

(4) obshell / obshell Dashboard: Kernel-Level Command-Line and Visual Tools

obshell / obshell Dashboard are kernel-level operations and management tools deeply integrated with OceanBase. As native components of the OceanBase kernel, they provide the most direct database operation interfaces.

• Core function: obshell is an “installation-free, out-of-the-box local cluster command-line tool.” It is not a standalone external tool; rather, it is provided by the OceanBase Server node (OBServer). obshell is embedded in OceanBase’s RPM package and is installed automatically when a cluster is deployed. It supports cluster operations and exposes an operations and management SDK based on OBServer nodes. obshell Dashboard, meanwhile, is the web-based interactive management interface provided by obshell, used to monitor and manage clusters and tenant resources.
• Role and characteristics: obshell’s role is “kernel-level” and “a lightweight OCP.” It differs from obd: obd is an external deployment tool, whereas obshell is the local operations interface provided by the kernel. When managing a cluster, obd leverages the Python SDK provided by obshell to carry out some operations tasks. You can think of obd as the “commander” and obshell as the “foot soldier.” For a single machine or a single cluster, obshell Dashboard offers a lightweight web interface that can serve as an OCP alternative, and it also provides database operations and management capability in scenarios where OCP is unavailable.
• Use cases: Single-cluster management, development and testing, small production environments.

2. Tool Roles and Feature Matrix

Tool	Main Function	Deployment Target	User Interface	Applicable Scenario
OAT	Enterprise-edition product-tool deployment platform	OCP (enterprise edition)	Web UI	Commercial delivery scenarios
obd	Automated deployment and basic operations	OceanBase (community/enterprise), OCP (community/enterprise)	CLI / Web UI	Small-to-medium scale, cost-sensitive scenarios
Enterprise OCP	Enterprise-grade, full-featured management platform	OceanBase (enterprise edition)	Web UI	Large-scale, enterprise-grade operations
Community OCP	Enterprise-grade, full-featured management platform	OceanBase (community edition)	Web UI	Large-scale, enterprise-grade operations
obshell / obshell Dashboard	Kernel-level operations and management tool	Deployed automatically with OceanBase (community/enterprise standalone editions)	CLI / Web UI	Lightweight local management. Note: obshell being deployed alongside the OceanBase enterprise edition, and enterprise OCP being adapted to obshell, are expected to be completed in the second half of 2026

3. Product-and-Tool Relationship Diagram

Recommendations for Control and Management Approaches

For community users who aren’t comfortable with OAT’s management style, you can choose one of the following two approaches for cluster operations:

(1) Use the obd + obshell / obshell Dashboard combination directly to achieve operations and management that blends the command line with lightweight visual tooling;

(2) Deploy the enterprise OCP via obd, then have OCP manage the enterprise-edition cluster — achieving graphical, centralized operations and control, with obd handling OCP’s own operations, management, and upgrades. In this combination, obd plays the role of the commercial OAT.

Tool Usage Recommendations

Business Stage	User Type	User Profile	Recommended Tool Combination	Advantages	Applicable Scenario
Getting started	Beginners	Database newcomers, students, tech enthusiasts	obd CLI + obshell Dashboard	Low learning curve, simple deployment	Personal learning, test environments
Development and testing	Individual developers	Independent developers, startup teams, leads of small-to-medium projects	obd Web UI + obshell Dashboard	Visual operations, convenient management	Development/testing, small-to-medium projects
Small-to-medium production	Individual developers		obd + OCP	Comprehensive features, fits operational habits
Enterprise-grade	DBA / SRE	Enterprise DBAs, operations engineers, architects	obd + OCP, or OAT + OCP	Complete features, efficient operations	Cluster count ≥ 10 (recommended)

Note:

To avoid management confusion, we recommend choosing only one of these approaches to manage a cluster consistently throughout its entire lifecycle.

From Community Edition to Enterprise Edition — Upgrade Path Recommendations

Many users start with the OceanBase community edition. As their business grows, their need for performance, stability, features, or official technical support increases, and they eventually want to migrate to the enterprise edition. However, a direct “in-place upgrade” from the community edition to the enterprise edition is not feasible.

There are two main reasons:

• OceanBase officially does not support upgrading a community-edition cluster directly to the enterprise edition.
• Enterprise and community editions of OCP are mutually incompatible in cluster management; each can only manage clusters of its corresponding edition.

Recommended Upgrade Path: The Data Migration Method

Given that in-place upgrades are not possible, the most reliable approach is to achieve a smooth transition from the community edition to the enterprise edition via online data migration. The core steps are as follows:

(1) Prepare the Enterprise-Edition Environment

• Obtain the OceanBase enterprise-edition installation package and commercial license.
• Use obd or OAT to deploy a brand-new enterprise-edition OCP on a new server environment.
• Through the newly deployed enterprise OCP, create a brand-new OceanBase enterprise-edition cluster on another set of servers. Make sure the new cluster’s hardware configuration, network environment, and so on meet your business requirements.

(2) Perform the Data Migration

• Use the community edition of OMS (OceanBase Migration Service), the migration tool in the OceanBase ecosystem, to carry out the data migration.
• Create a data migration project for the community-edition cluster and the enterprise-edition cluster, configuring the source (community edition) and target (enterprise edition).
• OMS supports structure migration, full migration, and incremental synchronization, enabling zero-downtime migration for your business. First it performs a full data copy, then it continuously synchronizes incremental data in the background, and finally it does a brief switchover during an off-peak window, switching the application’s connection string from the community edition to the enterprise edition.

(3) Verify and Switch Over

• Once data migration is complete, perform comprehensive functional and performance verification on the new enterprise-edition cluster to ensure data integrity and correct business logic.
• After verification, formally switch application traffic to the enterprise-edition cluster. If you need reverse data synchronization, use the enterprise edition of OMS to create an incremental data sync link from the enterprise-edition OB to the community-edition OB.
• Monitor the new cluster’s operational status to ensure the service runs stably.

Summary and Outlook

• Deployment stage: OCP, obd, and OAT offer flexible deployment options.
• Operations stage: OCP, obd, and obshell / obshell Dashboard provide operations capabilities at different tiers and for different business scenarios.

OceanBase offers community-edition users a clear path for upgrading to the enterprise edition. Through online data migration, users can smoothly upgrade to the more full-featured, better-supported enterprise edition without disrupting their business — meeting needs at different stages of growth. On the operations side, OceanBase has built a collaborative system pairing OCP with obshell / obshell Dashboard; the two complement each other to ensure comprehensive operations support across a wide range of business scenarios. Correctly understanding each tool’s role and applicable scenarios, and choosing a suitable control and management approach, is key to successfully deploying and using OceanBase.

In the future, OCP will be deeply integrated with obshell to build a collaborative, consistent operations system that covers all customers. OCP will keep strengthening its visual control and enterprise-grade capabilities, while obshell focuses on being lightweight and agile. By combining their respective strengths, we will significantly lower the barrier to using databases and make OceanBase operations simpler and more efficient. This innovative “heavy-plus-light” model will strongly drive the broader adoption of OceanBase across an even wider range of business scenarios and accelerate the flourishing of its ecosystem.

References

[1] seekdb installation package: https://www.oceanbase.com/softwarecenter

[2] seekdb: https://www.oceanbase.ai/