Upgrade obd

This topic describes how to upgrade obd based on whether the machine where obd is located can connect to an external network, divided into online deployment and offline deployment methods.

Background

There are two common ways to install obd: through OceanBase All in One installation and using RPM package installation. Different installation methods have different upgrade methods:

• If obd was originally installed through OceanBase All in One, we recommend upgrading obd by referring to the Upgrade OceanBase All in One step in Install obd.

• If obd was originally installed using an RPM package, we recommend upgrading through the obd update command. For details, see the operations in this topic.

Online upgrade

When the machine can connect to an external network, you can upgrade obd according to the following operations. Online upgrade automatically upgrades obd to the latest version. If you need to specify a target version for upgrade, download the installation package of the specified version and refer to the Offline upgrade steps below.

1. Enable the remote mirror repository

   obd mirror enable remote
   

   After successful execution, you can run the obd mirror list command to verify whether the remote mirror repository is enabled. If the Enabled column in the row corresponding to Type=remote is True, the remote mirror source is enabled. Example output:

   +-----------------------------------------------------------------------------+
   |                            Mirror Repository List                           |
   +----------------------------+--------+---------+----------+------------------+
   | SectionName                | Type   | Enabled | Avaiable | Update Time      |
   +----------------------------+--------+---------+----------+------------------+
   | local                      | local  | -       | True     | 2025-03-25 13:48 |
   | oceanbase.community.stable | remote | True    | True     | 2025-03-25 13:48 |
   | oceanbase.development-kit  | remote | True    | True     | 2025-03-25 13:48 |
   +----------------------------+--------+---------+----------+------------------+
   

2. Upgrade obd

   obd update
   

3. Verify the obd version

   obd --version
   

   Example output shows that obd has been upgraded to V3.1.2:

   OceanBase Deploy: 3.1.2
   REVISION: 739be300c448342b2850c71087bee01091dd7cb7
   BUILD_BRANCH: HEAD
   BUILD_TIME: Feb 14 2025 14:43:32OURCE
   Copyright (C) 2025 OceanBase
   License Apache 2.0: Apache version 2 or later <https://www.apache.org/licenses/LICENSE-2.0>.
   This is free software: you are free to change and redistribute it.
   There is NO WARRANTY, to the extent permitted by law.
   

Offline upgrade

When the machine cannot connect to an external network, you need to first visit the OceanBase Software Download Center to obtain the obd installation package and upload it to the machine where obd is located. Then you can upgrade obd according to the following steps in the directory where the installation package is located.

1. Upload the installation package to the local mirror repository

   obd mirror clone ob-deploy-*.rpm
   

   After uploading, you can run the obd mirror list local | grep ob-deploy command to view the installation package in the local mirror repository. Example output:

   | ob-deploy  | 3.1.2   | 1.el7   | x86_64 | 75a9be0ab6bd723754febe30970a27fd52c5cdd7 |
   

2. Disable the remote mirror repository

   obd mirror disable remote
   

   After successful execution, you can run the obd mirror list command to confirm whether the remote mirror repository is disabled. If the Enabled column in the row corresponding to Type=remote is False, the remote mirror source is disabled. Example output:

   +-----------------------------------------------------------------------------+
   |                            Mirror Repository List                           |
   +----------------------------+--------+---------+----------+------------------+
   | SectionName                | Type   | Enabled | Avaiable | Update Time      |
   +----------------------------+--------+---------+----------+------------------+
   | local                      | local  | -       | True     | 2025-03-25 14:04 |
   | oceanbase.community.stable | remote | False   | False    | 2025-03-25 13:53 |
   | oceanbase.development-kit  | remote | False   | False    | 2025-03-25 13:53 |
   +----------------------------+--------+---------+----------+------------------+
   

3. Upgrade obd

   obd update
   

4. Verify the obd version

   obd --version
   

   Example output shows that obd has been upgraded to V3.1.2:

   OceanBase Deploy: 3.1.2
   REVISION: 739be300c448342b2850c71087bee01091dd7cb7
   BUILD_BRANCH: HEAD
   BUILD_TIME: Feb 14 2025 14:43:32OURCE
   Copyright (C) 2025 OceanBase
   License Apache 2.0: Apache version 2 or later <https://www.apache.org/licenses/LICENSE-2.0>.
   This is free software: you are free to change and redistribute it.
   There is NO WARRANTY, to the extent permitted by law.