OAgent is an AI Agent management platform independently developed by OceanBase. It supports intelligent operation and maintenance and data analysis capabilities driven by AI.
Currently, OAgent must be deployed and managed through OAT (OceanBase Admin Toolkit). This topic describes how to install, upgrade, modify resources, and uninstall OAgent using OAT.
Note
OAgent is a single-container, self-contained product that does not depend on MetaDB, tenants, or load balancing. It supports only single-node deployment.
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 will be installed. For more information, see Add a server.
You have added the OAgent image file. The OAgent image is identified by the
oceanbase-clawkeyword in the repository. Thea.b.cformat in the image tag serves as the version identifier.You have prepared an accessible Large Language Model (LLM) API service. OAgent does not have a built-in LLM; its inference and tool scheduling capabilities are provided by an external LLM. After deployment, you need to connect it on the Model Configuration page. The model API must support either of the following protocols: OpenAI Compatible Interface (Chat Completions) or OpenAI Responses API. For configuration details, see Manage model services.
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
clone3system call. If this occurs, we recommend that you upgrade Docker to version 20.10.10 or later, or add the--security-opt seccomp=unconfinedstartup parameter.
Install OAgent
To install OAgent, perform the following steps:
In the left navigation bar, click Product Service > Products.
On the Products page, click Install Product in the upper-right corner and select Install OAgent.
On the Install OAgent page, configure the parameters.
The basic configuration parameters for OAgent are as follows:
ParameterDescriptionOAgent Image Select the 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 will be installed. Note
Only one server IP can be selected.
CPU Set the number of CPU cores available to OAgent on the server. Default is 4C. Memory Set the memory available to OAgent on the server. Default is 8G. HTTP Port The port on which OAgent provides HTTP services externally. Data Directory The storage path for data generated during OAgent runtime. Default is /home/admin/logs/oagent.After configuring OAgent, click Submit.
If your configuration is incorrect, click Reset to restore the default configuration with one click.
After a successful submission, you will be redirected to the Product Management page, where you can find the newly created OAgent service. In the corresponding Actions column, click Access Now to access the OAgent console.
Upgrade OAgent
OAgent is 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:
In the left navigation pane, click Product Service > Products.
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.
In the upper-right corner of the details page, click Upgrade.
The system automatically performs an upgrade pre-check to verify whether the current environment meets the upgrade requirements.
If the pre-check passes, enter the relevant information in the pop-up Upgrade dialog box.
The fields are described as follows:
FieldDescriptionUpgrade Method Stop-Service Upgrade: Suitable for products without business continuity requirements. During the upgrade, OAT stops the old version of the product service, which cannot provide external services. Please select the upgrade image file The target upgrade image file. Click Confirm.
Resource changes
OAgent supports adjusting the CPU and memory specifications of a container during runtime.
To change OAgent resources, perform the following steps:
In the left navigation pane, click Product Service > Products.
Find the OAgent service to be changed, and in the corresponding Name column, click the product name to go to its details page.
In the upper-right corner of the details page, click Resource Change.
In the pop-up Resource Change dialog box, adjust the CPU and memory configurations.
ParameterDescriptionCPU 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, lowering resource configuration may affect the running product. Proceed with caution.
Click OK.
Uninstall OAgent
To uninstall OAgent, perform the following steps:
In the left navigation pane, click Product Service > Products.
Find the OAgent service to be uninstalled and click its name in the Name column to go to the details page.
Note
Name search is supported. You can search by product name at the top of the page.
In the upper-right corner of the details page, click Uninstall.
In the confirmation dialog box that appears, click OK.
OAT will indicate that the uninstallation is in progress. Meanwhile, 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.