How to Quickly Set Up and Manage OceanBase with the New Desktop Client
This guide walks developers through downloading, installing, and using OceanBase Desktop on macOS, covering dependency setup with OrbStack, GUI features, cluster startup, tenant management, and how the tool simplifies local OceanBase cluster deployment.
1. OceanBase Desktop Release
Developers can normally experience OceanBase via Docker+ODB on mac or a free OB Cloud trial, both requiring command‑line setup. At OceanBase DevCon 2025 the vendor introduced OceanBase Desktop, a GUI with OCP shrink‑cluster feature.
2. Download and Try OceanBase Desktop
3. Install OceanBase Desktop
3.1 Install Dependencies
On macOS OceanBase Desktop depends on OrbStack, a lightweight VM manager similar to Docker Desktop. OrbStack is optimized for macOS.
Comparison of OrbStack and Docker Desktop:
Target : OrbStack – lightweight Docker and Linux VM tool for macOS; Docker Desktop – full‑featured cross‑platform container manager.
Performance : OrbStack offers fast container start and network optimization; Docker Desktop has slower start/build and higher resource usage.
Resource Usage : OrbStack uses low idle CPU and dynamic memory; Docker Desktop consumes higher CPU and memory.
Features : OrbStack supports Docker containers, full Linux VM, custom domain binding (e.g., web.orb.local ), host network mode, built‑in SSH agent and file transfer; Docker Desktop includes the full Docker ecosystem, GUI, and enterprise features.
Platform : OrbStack only macOS; Docker Desktop macOS, Windows, Linux.
Kubernetes : OrbStack integrates K3s manually; Docker Desktop provides built‑in Kubernetes.
3.2 Install OceanBase Desktop
Download the appropriate macOS dmg (Apple M‑chip or Intel). After installation, opening OceanBase Desktop starts the OBD service. If OrbStack is not installed, the UI will wait while the underlying Ubuntu VM boots.
Once OrbStack and the Ubuntu VM are ready, the OBD UI shows an unstarted OB cluster.
4. Basic Usage
Click “Start Cluster” to launch a local cluster with one OB server, two tenants (sys/test), and one zone. The UI opens a terminal and runs ob client to connect to the test tenant, allowing basic SQL commands.
The cluster management page lets you manage tenants, upload OB packages for upgrades, and use the task center to stop clusters.
5. Conclusion
OceanBase Desktop provides an easy‑to‑use graphical interface that lets developers quickly set up and control a local OceanBase cluster, lowering the barrier for installation, deployment, and management.
Xiaolei Talks DB
Sharing daily database operations insights, from distributed databases to cloud migration. Author: Dai Xiaolei, with 10+ years of DB ops and development experience. Your support is appreciated.
How this landed with the community
Was this worth your time?
0 Comments
Thoughtful readers leave field notes, pushback, and hard-won operational detail here.