Install, upgrade, modify resources, and uninstall OAgent

OAgent is an AI Agent management platform independently developed by OceanBase. It supports intelligent operation and maintenance and data analysis capabilities driven by AI.

This topic describes how to install, upgrade, modify resources, and uninstall OAgent by using OAT.

Prerequisites

Before you install OAgent, confirm the following information:

• You have installed OAT and logged in as a super administrator or an O&M engineer. For more information, see Install OAT.

• You have added the server where OAgent is to be installed. For more information, see Add a server.

• You have added the OAgent image file. The OAgent image is identified by the oceanbase-claw keyword in the repo. The a.b.c format in the image tag serves as the version identifier.

  Notice

  In some Docker versions (such as 18.x and earlier), the OAgent container may fail to start because the seccomp security policy intercepts the clone3 system call. If this occurs, we recommend that you upgrade Docker to version 20.10.10 or later, or add the --security-opt seccomp=unconfined startup parameter.

Install OAgent

To install OAgent, perform the following steps:

1. In the left-side navigation pane, click Product Service > Products.

2. On the Product management page, click Install product in the upper-right corner and select Install OAgent.

3. On the Install OAgent page, configure the parameters.

   The basic configuration parameters for OAgent are as follows:

   Parameter	Description
   OAgent Image	Select an OAgent image. You can also click Manage image files in the drop-down menu to add a new image.
   Product Name	The product name, which must be unique.
   Administrator Password	The initial password for the OAgent administrator, used for the first login to OAgent.
   Server	Select the IP address of the server where OAgent is to be installed. Note Only one server IP can be selected.
   CPU	Set the number of CPU cores available to OAgent on the server. Default: 4C.
   Memory	Set the memory available to OAgent on the server. Default: 8G.
   HTTP Port	The port on which OAgent provides HTTP services externally.
   Data Directory	The storage path for data generated during OAgent runtime. Default: /home/admin/logs/oagent.

4. After configuring OAgent, click Submit.

   If your configuration is incorrect, click Reset to restore the default configuration with one click.

   After the submission is successful, you will be redirected to the Product management page. Here, you can find the newly created OAgent service. In the corresponding Operation column, click Access now to access the OAgent console.

Upgrade OAgent

OAgent can be upgraded by using the same mount path and replacing the container version. During the upgrade, the old version of the service is stopped first and cannot provide external services.

To upgrade OAgent, perform the following steps:

1. In the left navigation bar, click Product Service > Products.

2. Find the OAgent service to be upgraded, and in the corresponding Name column, click the product name to go to its details page.

   Note

   Name search is supported. You can search by product name at the top of the page.

3. In the upper-right corner of the details page, click Upgrade.

4. The system automatically performs an upgrade pre-check first to verify whether the current environment meets the upgrade requirements.

5. If the pre-check passes, enter the relevant information in the pop-up Upgrade dialog box.

   The fields are described as follows:

   Field	Description
   Upgrade Method	Downtime Upgrade: Suitable for products without business continuity requirements. During the upgrade, OAT stops the old version of the product service first, which cannot provide external services.
   Please select the upgrade image file	The target upgrade image file.

6. Click Confirm.

Resource modification

OAgent supports adjusting the CPU and memory specifications of a container while it is running.

To modify the resources of OAgent, perform the following steps:

1. In the left navigation bar, click Product Service > Products.

2. Find the OAgent service whose resources you want to modify, and in the corresponding Name column, click the product name to go to its details page.

3. In the upper-right corner of the details page, click Resource change.

4. In the pop-up Resource change dialog box, adjust the CPU and memory configurations.

   Parameter	Description
   CPU	Displays the configured number of CPU cores by default. Supports adjustment.
   Memory	Displays the configured memory value by default. Supports adjustment.

   Notice

   When reducing CPU or memory resources, the lowered configuration may affect the running product. Proceed with caution.

5. Click Confirm.

Uninstall OAgent

To uninstall OAgent, perform the following steps:

1. In the left-side navigation pane, click Product Service > Products.

2. Find the OAgent service you want to uninstall and click its name in the Name column to go to the details page.

   Note

   You can search for products by name at the top of the page.

3. In the upper-right corner of the details page, click After uninstalling.

4. In the confirmation dialog box that appears, click Confirm.

   OAT displays a message indicating that the uninstallation is in progress. OAT also creates an uninstallation task. You can click the task ID in the confirmation dialog box to view the execution progress of the current uninstallation task.

References

• Container operations
• Product and component resource changes