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 Deployer

V3.2.1Community Edition

  • What is obd
  • Quick Start
    • Install obd
    • Quickly deploy OceanBase Database
    • Quickly deploy OCP
  • obd Command
    • Quick deployment command
    • Cluster commands
    • Mirror and repository commands
    • Testing commands
    • Tool commands
    • obdiag commands
    • Binlog commands
    • Host commands
    • License commands
    • Password commands
    • Telemetry commands
  • User Guide
    • Overview
    • Deploy through GUI
      • GUI operation overview
      • Mode configuration rules
      • Deploy an OceanBase cluster on the GUI
      • Deploy OCP through the GUI
      • Modify components on the GUI
      • Upgrade OCP on the GUI
    • Deploy through CLI
      • Configuration files
      • Deploy Component
        • Deploy OceanBase Database on a single OBServer node
        • Deploy OCP Express by using commands
        • Deploy and use obconfigserver
        • Deploy the obbinlog
        • Deploy oblogproxy by using the CLI
        • Deploy OCP by using commands
      • Manage Cluster
        • Physical Standby Database
          • Deploy primary and standby tenants by using obd
          • Switch the roles of tenants and decouple a standby tenant from the primary tenant
        • Scale out a cluster and change cluster components
        • Performance test
        • Cluster diagnotistics
        • Add GUI-based monitoring for an existing cluster
      • Takeover Cluster
        • Use OCP to take over a cluster deployed by obd
        • Use obd to take over a cluster
      • Upgrade Component
        • Upgrade OceanBase Database
        • Upgrade ODP
        • Upgrade OCP Express
      • Backup and restore
  • Upgrade obd
  • FAQ
  • Error codes
  • Release Notes
    • Version rules
    • V3.2
      • OceanBase Deployer V3.2.2
      • OceanBase Deployer V3.2.1
      • OceanBase Deployer V3.2.0
    • V3.1
      • OceanBase Deployer V3.1.2
      • OceanBase Deployer V3.1.1
      • OceanBase Deployer V3.1.0
    • V3.0
      • OceanBase Deployer V3.0.1
      • OceanBase Deployer V3.0.0
    • V2.10
      • OceanBase Deployer V2.10.1
      • OceanBase Deployer V2.10.0
    • V2.9
      • OceanBase Deployer V2.9.2
      • OceanBase Deployer V2.9.1
      • OceanBase Deployer V2.9.0
    • V2.8
      • OceanBase Deployer V2.8.0
    • V2.7
      • OceanBase Deployer V2.7.0
    • V2.6
      • OceanBase Deployer V2.6.2
      • OceanBase Deployer V2.6.1
      • OceanBase Deployer V2.6.0
    • V2.5
      • OceanBase Deployer V2.5.0
    • V2.4
      • OceanBase Deployer V2.4.0
    • V2.3
      • OceanBase Deployer V2.3.1
      • OceanBase Deployer V2.3.0
    • V2.2
      • OceanBase Deployer V2.2.0
    • V2.1
      • OceanBase Deployer V2.1.1
      • OceanBase Deployer V2.1.0
    • V2.0
      • OceanBase Deployer V2.0.1
      • OceanBase Deployer V2.0.0
    • V1.6
      • OceanBase Deployer V1.6.2
      • OceanBase Deployer V1.6.1
      • OceanBase Deployer V1.6.0
    • V1.5
      • OceanBase Deployer V1.5.0
    • V1.4
      • OceanBase Deployer V1.4.0
    • V1.3
      • OceanBase Deployer V1.3.3
      • OceanBase Deployer V1.3.2
      • OceanBase Deployer V1.3.0
    • V1.2
      • OceanBase Deployer V1.2.1
      • OceanBase Deployer V1.2.0

Download PDF

What is obd Install obd Quickly deploy OceanBase Database Quickly deploy OCP Quick deployment command Cluster commands Mirror and repository commands Testing commands Tool commands obdiag commands Binlog commands Host commands License commands Password commands Telemetry commands Overview GUI operation overview Mode configuration rules Deploy an OceanBase cluster on the GUI Deploy OCP through the GUI Modify components on the GUI Upgrade OCP on the GUI Configuration files Backup and restore Upgrade obd FAQ Error codes Version rules OceanBase Deployer V3.2.2 OceanBase Deployer V3.2.1 OceanBase Deployer V3.2.0 OceanBase Deployer V3.1.2 OceanBase Deployer V3.1.1 OceanBase Deployer V3.1.0 OceanBase Deployer V3.0.1 OceanBase Deployer V3.0.0 OceanBase Deployer V2.10.1 OceanBase Deployer V2.10.0 OceanBase Deployer V2.9.2 OceanBase Deployer V2.9.1 OceanBase Deployer V2.9.0 OceanBase Deployer V2.8.0 OceanBase Deployer V2.7.0 OceanBase Deployer V2.6.2 OceanBase Deployer V2.6.1 OceanBase Deployer V2.6.0 OceanBase Deployer V2.5.0 OceanBase Deployer V2.4.0 OceanBase Deployer V2.3.1 OceanBase Deployer V2.3.0 OceanBase Deployer V2.2.0 OceanBase Deployer V2.1.1 OceanBase Deployer V2.1.0 OceanBase Deployer V2.0.1 OceanBase Deployer V2.0.0 OceanBase Deployer V1.6.2 OceanBase Deployer V1.6.1 OceanBase Deployer V1.6.0 OceanBase Deployer V1.5.0 OceanBase Deployer V1.4.0 OceanBase Deployer V1.3.3 OceanBase Deployer V1.3.2 OceanBase Deployer V1.3.0 OceanBase Deployer V1.2.1 OceanBase Deployer V1.2.0
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 Deployer
  3. V3.2.1
iconOceanBase Deployer
V 3.2.1Community Edition
Community Edition
  • V 3.2.1
  • V 3.2.0
  • V 3.1.0
  • V 3.0.0
  • V 2.10.1
  • V 2.10.0
  • V 2.9.0
  • V 2.8.0
  • V 2.7.0
  • V 2.6.0
  • V 2.5.0
  • V 2.4.0
  • V 2.3.1
  • V 2.3.0
  • V 2.2.0
  • V 2.1.0
  • V 2.0.0
  • V 1.6.1

Upgrade OCP on the GUI

Last Updated:2026-04-10 13:31:02  Updated
share
What is on this page
Prerequisites
Procedure
(Optional) Step 1: Obtain the installation package required for upgrade
Step 2: Upgrade OCP
References

folded

share

This topic describes how to upgrade OceanBase Cloud Platform (OCP) on the GUI of OceanBase Deployer (obd).

Prerequisites

Make sure that the following conditions are met:

  • The current OCP version is Community Edition V4.0.3 or later.

  • You have installed and configured a Java environment on the OCP node. Currently, only JDK 1.8 is supported. For more information, see the How do I configure the Java environment? section in FAQ.

Procedure

(Optional) Step 1: Obtain the installation package required for upgrade

Note

If your server can connect to the Internet and remote image repositories are enabled, skip this step. You can run the obd mirror list command to confirm whether remote image repositories are enabled.

  1. Download the installation package.

    Download the OCP installation package of the desired version from OceanBase Download Center and upload it to any directory on the central control server of obd.

  2. Decompress the installation package.

    In the directory where the installation package is located, run the following command to decompress the package:

    [admin@test001 ~]$ tar -xzf ocp-all-in-one-*.tar.gz
    
  3. (Optional) Uninstall the original obd.

    If obd has been installed on your server by using the All in One package, run the following command to uninstall it:

    [admin@test001 ~]$ cd ocp-all-in-one/bin && bash uninstall.sh
    
  4. Start the installer.

    Run the install.sh script in the bin directory under the ocp-all-in-one installation directory to start the installer of obd.

    [admin@test001 bin]$ bash install.sh
    

    This script will install obd, copy all installation packages stored in the rpms directory under the installation directory to the local image repository of obd, and disable remote image repositories. You can copy and run the source ~/.oceanbase-all-in-one/bin/env.sh command in the following output to apply the environment settings:

    add auto set env logic to profile: /home/admin/.bash_profile
    
    #########################################################################################
     Install Finished
    =========================================================================================
    Setup Environment:              source ~/.oceanbase-all-in-one/bin/env.sh
    Quick Start:                    obd demo
    Use Web Service to install:     obd web
    Use Web Service to upgrade:     obd web upgrade
    More Details:                   obd -h
    =========================================================================================
    

Step 2: Upgrade OCP

  1. Start the upgrade.

    [admin@test001 ~]$ obd web upgrade
    

    Access the URL provided in the output in a browser to go to the upgrade wizard page. Then, click Start Upgrade.

    start OBD WEB in 0.0.0.0:8680
    please open http://10.10.10.1:8680/#/updateWelcome
    

    Note

    • The default port in the URL is 8680. You can use the obd web upgrade -p <PORT> command to specify a port.

    • In Alibaba Cloud or other cloud environments, the program may fail to obtain a public IP address but return an intranet IP address. You must use a correct public IP address to access the GUI.

    • The obd web command is bound to 0.0.0.0. In a deployment where multiple network interface cards (NICs) are used, you can access the GUI through any accessible IP address.

  2. Configure the deployment information.

    On the deployment configuration page, select the OCP cluster to be upgraded and the target version. The system automatically obtains the names of all clusters managed by obd. You can select a cluster from the Cluster Name drop-down list. If the cluster to be upgraded is not managed by the current obd, such as a cluster deployed by using Docker, you can enter the cluster name. After the cluster upgrade is completed, obd automatically takes over the OCP cluster.

    deploy

    Click Next Step to go to the Connectivity Test page.

  3. Verify the connectivity of MetaDB.

    The current page automatically obtains the MetaDB configuration. If found, the information will be populated in the Connection information section. Check whether the information matches the environment you intend to upgrade. If so, enter the access password and click Verification to check whether MetaDB can be connected.

    metadb

  4. Configure an OS user.

    After you verify the connectivity of MetaDB, you need to configure an OS user for the installer to automatically configure settings.

    user

    Parameter Description
    Username The username of the OS user of the host, who has sudo privileges. The installer requires this username to automatically configure settings.
    Password The password of the OS user. If you have enabled password-free login for the host, ignore this parameter. After configuration, you can click Verification to test the user connectivity.

    Click Next Step to go to the Environment pre-check page.

  5. Run an environment precheck.

    The system obtains the configuration information of OCP based on that of MetaDB. To ensure management consistency, OCP Server and OCP Agent are also upgraded.

    Check whether the information in the Installation configuration and Upgrade configuration information sections are as expected. If not, click Previous Step to modify the information. If so, click Pre-check.

    If the precheck is passed, click Next Step to upgrade OCP. If the precheck fails, you can choose to fix or ignore the failed items.

    • If you choose to fix the failed items, wait until all of them are fixed and click Re-check to perform a precheck again.

    • If you choose to ignore the failed items, click Ignore all failed items. This action changes the status of all failed precheck items to Ignored. Then, click Next Step.

    Notice

    If you ignore all failed precheck items, the upgrade may fail. We recommend that you fix the failed precheck items before proceeding to the next step.

  6. Upgrade OCP.

    You can view detailed upgrade logs in the Upgrade logs section during the upgrade process.

    • If the upgrade succeeds, you can view the login information of OCP, such as the URL, username, and password, in the Upgrade logs section.

    • If the upgrade fails, check the logs for the causes and contact OceanBase Technical Support. After you identify the causes and fix the issue, click Upgrade Again to re-execute the failed upgrade steps.

    Note

    The OCP upgrade process may take some time. Please wait patiently.

    upgrade

References

For more information about how to use OCP, see OCP documentation.

Previous topic

Modify components on the GUI
Last

Next topic

Configuration files
Next
What is on this page
Prerequisites
Procedure
(Optional) Step 1: Obtain the installation package required for upgrade
Step 2: Upgrade OCP
References