OceanBase Database Community Edition supports multiple deployment methods:
If you want to quickly deploy a standalone version of OceanBase for functional experience, refer to the Quick Deployment section.
If you want to perform standardized deployment in a production environment, refer to the Standard Deployment section.
If you want to experience it online, refer to the Online Experience section.
Quick Deployment
Quick Deployment is suitable when only one machine is available, allowing you to quickly set up a usable OceanBase database environment. The deployed OceanBase database environment provides basic database functionality and helps you understand OceanBase Database effectively; however, it lacks distributed capabilities and high availability features, so long-term use is not recommended.
For operating systems that are not natively supported (such as macOS and Windows), it is recommended to use Docker images for deployment. For specific operations, see Deploy an OceanBase Database container environment.
For natively supported operating systems (Linux series, see the list of supported operating systems), it is recommended to use obd for deployment. For specific operations, see the Quick Start/Quick Deploy OceanBase Database section in the official OceanBase Installation and Deployment Tools documentation.
Standard Deployment
Standard Deployment is suitable for users who need to gain an in-depth understanding of the principles and features of the OceanBase distributed database architecture. The deployed OceanBase cluster provides full database capabilities and distributed high availability. You must prepare at least three hosts with available resources of 4 vCPU, 16 GB of memory, and 100 GB SSD or higher-performance disks.
(Recommended) Graphical management of OceanBase clusters
If you plan to deploy multiple OceanBase clusters, it is recommended to deploy OCP (OceanBase Cloud Platform). OCP can help you better operate, maintain, and manage OceanBase Database, significantly reducing operational work.
You must first deploy OCP and its MetaDB using three machines. For specific operations, see the User Guide/Graphical Interface/Deploy OCP through the graphical interface section in the official OceanBase Installation and Deployment Tools documentation. After successfully deploying OCP, you can create new OceanBase clusters through OCP to serve your business. For specific operations, see the Cluster Management chapter in the official OceanBase Cloud Platform documentation.
Note
The MetaDB is only used as the metadata database for OCP. Do not use it for your production clusters.
Command-line management of OceanBase clusters
If you initially plan to deploy only one OceanBase cluster, you can deploy it using obd and then manage it using obd commands. For specific deployment operations, see the Deploy an OceanBase cluster through the obd graphical interface section in the official OceanBase Database documentation. For introductions to obd commands, see the obd commands/Cluster commands section in the official OceanBase Installation and Deployment Tools documentation.
Deploy an OceanBase cluster in a Kubernetes environment
This method is suitable for users who have already deployed Kubernetes on a large scale in their production environment and have some understanding and experience with OceanBase Database. The deployed OceanBase cluster provides full database capabilities and distributed high availability.
Before you begin, ensure the following conditions are met:
You have a usable Kubernetes cluster with at least 9 available CPUs, 33 GB of available memory, and 360 GB of available storage space.
ob-operator depends on cert-manager. Ensure cert-manager is installed. For installation instructions, refer to the corresponding Installation document.
For specific steps to deploy an OceanBase cluster, see the Deploy an OceanBase cluster in a Kubernetes environment section in the official OceanBase Database documentation.
Online experience
For users who need to experience the features online, you can log in to the OceanBase Experience Center to try out the features.