Install and uninstall DataPilot

DataPilot is an AI-driven data analysis agent development platform independently developed by OceanBase.

This topic describes how to install and uninstall DataPilot by using OAT.

Prerequisites

Before you install DataPilot, 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 on which to install DataPilot. For more information, see Add a server.

• You have created the MetaDB component for DataPilot. For more information, see Create MetaDB.

  Notice

  The version of MetaDB used must be V4.3.5 or later.

Install DataPilot

To install DataPilot, 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 DataPilot.

3. On the Install DataPilot page, configure the parameters for Basic Configuration:

   Parameter	Description
   Product Name	The product name, which must be unique.
   Server	The IP address of the server on which to install DataPilot.
   Administrator Password	The password for the DataPilot administrator, used for the initial login to DataPilot. You can enter a password or generate a random one.
   Datapilot Image	Select the DataPilot image.
   Datapilot CPU	Set the number of CPU cores available to Datapilot on each server. Default: 4C.
   Datapilot Memory	Set the memory available to Datapilot on each server. Default: 8G.
   HTTP Port	The port for the product's HTTP service. Default: 8091.
   S3 Port	The built-in S3 storage service port of DataPilot. Default: 3900.

   Note

   DataPilot uses a single-image deployment. The E2B code executor is built into the DataPilot image, so there is no need to configure a separate E2B image.

   Configure External S3:

   Configuring External S3 is optional if only one server is selected; it is required if multiple servers are selected.

   Parameter	Description
   S3 ENDPOINT	The storage endpoint compatible with S3 (such as OSS, MinIO, and SeaweedFS).
   S3 Access Key	The access key (S3_ACCESS_KEY) used for authentication, provided by the S3-compatible storage service.
   S3 Secret Key	The security key (S3_SECRET_KEY) used in conjunction with the Access Key for signing requests to ensure communication security.
   Bucket name	The name of the bucket created in the S3-compatible storage.
   Bucket path prefix	The relative path prefix for storing data within the bucket, default is datus.
   Region	The region identifier (S3_REGION) of the S3-compatible storage service. Default: us-east-1.

4. On the Install DataPilot page, configure the parameters for Prefect Configuration:

   Parameter	Description
   Prefect Port	The Prefect service port. Default: 8092.
   Prefect Administrator Password	The Prefect administrator password. You can enter a password or generate a random one.
   Data Directory	The storage path for data generated during DataPilot runtime. Default: /home/admin/logs/datapilot.

5. On the Install DataPilot page, configure the parameters for MetaDB Configuration:

   DataPilot requires configuring two MetaDB tenants: the DataPilot Meta tenant for storing DataPilot metadata, and the DataPilot Target tenant for multi-dimensional table solidification (COPY mode) writes.

   The MetaDB type has the following two options:

   • Created MetaDB:

     Parameter	Description
     Select Created MetaDB	Select an existing MetaDB for DataPilot.

     DataPilot Meta tenant:

     Parameter	Description
     Tenant Name	The name of the tenant, default is datapilot_meta.
     Tenant Password	The password of the tenant.
     Database Name	The name of the database, default is datapilot.
     Tenant CPU	Sets the number of CPU cores available to the MetaDB tenant. Default: 2C.
     Tenant Memory	Sets the memory available to the MetaDB tenant. Default: 5G.

     DataPilot Target tenant:

     Parameter	Description
     Tenant Name	The name of the target tenant, default is datapilot_target.
     Tenant Password	The password of the target tenant.
     Database Name	The name of the target database, default is datapilot_target.
     Tenant CPU	Sets the number of CPU cores available to the target MetaDB tenant. Default: 2C.
     Tenant Memory	Sets the memory available to the target MetaDB tenant. Default: 5G.

   • Other OB_MySQL:

     DataPilot Meta tenant connection information:

     Parameter	Description
     Host	The host address of the MetaDB.
     Port	The port of the MetaDB.
     Username	The username of the MetaDB.
     Password	The password of the MetaDB.
     Database Name	The name of the database, default is datapilot.

     DataPilot Target connection information:

     Parameter	Description
     Host	The host address of the target MetaDB.
     Port	The port of the target MetaDB.
     Username	The username of the target MetaDB.
     Password	The password of the target MetaDB.
     Database Name	The name of the target database, default is datapilot_target.

6. On the Install DataPilot page, configure the parameters for Load Balancing Configuration:

   The options of load balancing modes are as follows:

   • Created NLB: NLB automatically adds load rules for the actual product HTTP service address based on the VIP and VPORT you entered. Additionally, if you select "Created MetaDB", NLB will also be automatically added to the MetaDB load rules.

     Parameter	Description
     Select Created NLB	Select an existing NLB.
     Select Configured VIP	Select a configured VIP.
     HTTP Service Port (VPORT)	HTTP service port (VPORT).

   • Created OBDNS: OBDNS automatically adds load rules for the actual product HTTP service address based on the domain name and VPORT you entered. Additionally, if you select "Created MetaDB", OBDNS will also automatically add domain name resolution for the MetaDB-related servers.

     Parameter	Description
     Select Created OBDNS	Select an existing OBDNS.
     HTTP Proxy Domain Name	The HTTP proxy domain name for DataPilot.
     HTTP Proxy Port	The HTTP proxy port for DataPilot, default value is 80.

   • Other load balancer: Configure the load balancing algorithm for HTTP protocol proxy to be of the Hash type to avoid session exceptions in the backend service.

     Parameter	Description
     MetaDB TCP Proxy Address	MetaDB TCP proxy address.
     MetaDB TCP Proxy Port	MetaDB TCP proxy port, default value is 3306.
     DataPilot HTTP Proxy Address	Supports entering a VIP or DNS address.
     DataPilot HTTP Proxy Port	DataPilot HTTP proxy port, default value is 80.

   • Do Not Use: Choosing not to use load balancing will result in the loss of high availability capability. By default, the first IP address is used as the connection information.

7. After configuring DataPilot, click Submit.

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

Uninstall DataPilot

To uninstall DataPilot, follow these steps:

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

2. Find the DataPilot service to be uninstalled 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 Uninstall.

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

   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.