OceanBase
English日本語简体中文
Docs Home
Products
Integrations
Release Notes

Databases

OceanBase DatabaseOceanBase AI DatabaseOceanBase Cloud OceanBase Best Practices

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog ServiceOceanBase DataPilotOceanBase OAgent

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Databases

OceanBase DatabaseOceanBase AI DatabaseOceanBase Cloud OceanBase Best Practices

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog ServiceOceanBase DataPilotOceanBase OAgent
OceanBase DatabaseOceanBase Cloud ToolsConnectors and MiddlewareLifecycle Support Policy

OceanBase OAgent

V2.2.0
  • Product overview
    • What is OAgent?
    • Key features
    • System architecture
    • Use cases
  • Quick start
  • Deployment
  • Overview
  • Sessions and diagnosis
    • Manage sessions
    • Switch dialogue models
    • Use @ to mention the analysis target
    • View the tool invocation process
    • Upload an attachment
    • Data visualization
    • FAQ
    • Export a report
  • Tools
  • Skill Management
  • Channel management
  • Knowledge base
    • Built-in knowledge base
    • Custom knowledge base
  • Scheduled tasks
    • Overview of scheduled tasks
    • Create a scheduled task
  • View usage
  • Model configuration
    • Manage model services
    • Model scoring
  • Settings and security
    • Product management
    • Experimental features
  • Best practices
    • Perform a cluster health inspection
    • Query cluster and topology information
    • Query resource metrics and task status
    • Read-only queries
    • Alert query and troubleshooting guide
    • Root cause analysis of exceptions
    • ASH diagnostic report
    • Analyze slow SQL, TopSQL, and abnormal SQL
    • SQL pre-analysis and tuning recommendations
    • Interpret execution plans
    • Diagnostic information statistics
    • Parameter check and change governance
    • Database change ticket
  • Appendix
    • Feature list
    • Built-in Skills
  • Release notes
    • OAgent V2.2.0 Release note
    • OAgent V2.1.0 Release note
    • OAgent V2.0.0 Release note
    • OAgent V1.8.0 Release note

Download PDF

Document Feedback
  1. Documentation Center
  2. OceanBase OAgent
  3. V2.2.0

Deployment

Last Updated:2026-11-20 07:25:11

Prerequisites
Install OAgent
Upgrade OAgent
Resource changes
Uninstall OAgent
References

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-claw keyword in the repository. The a.b.c format 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 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 navigation bar, click Product Service > Products.

  2. On the Products 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 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.
  4. 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:

  1. In the left navigation pane, 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 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 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.
  6. 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:

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

  2. Find the OAgent service to be changed, 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, lowering resource configuration may affect the running product. Proceed with caution.

  5. Click OK.

Uninstall OAgent

To uninstall OAgent, perform the following steps:

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

  2. 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.

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

  4. 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.

References

  • Container operations
  • Product and component resource changes

Previous topic

Quick start
Last

Next topic

Overview
Next
on this page
Prerequisites
Install OAgent
Upgrade OAgent
Resource changes
Uninstall OAgent
References