Step 2: Add an Agent

Prerequisites

• You have purchased a database audit instance and the Status is Running.
• A database has been added.

Scenarios

Determine where to add the agent based on how your database is deployed. Common database deployment modes are as follows:

• Deploy DBSS for databases built on ECS/BMS. For details, see Figure 1 and Figure 2.
  Figure 1 One application connecting to multiple databases built on ECS/BMS
  
  Figure 2 Multiple applications connecting to one database built on ECS/BMS
  
• Deploy DBSS for RDS databases. For details, see Figure 3 and Figure 4.
  Figure 3 One application connecting to multiple RDS databases
  
  Figure 4 Multiple applications connecting to one RDS database
  

Table 1 provides more details.

• If your applications and databases (databases built on ECS/BMS) are deployed on the same node, add the agent on the database side.

Adding an Agent (Self-built Databases on ECS/BMS)

1. Log in to the management console.
2. Select a region, click , and choose Security & Compliance > Database Security Service. The Dashboard page is displayed.
3. In the navigation tree on the left, choose Databases.
4. In the Instance drop-down list, select the instance whose agent is to be added.
5. In the Agent column of the desired database, click Add.
6. In the dialog box displayed, select an add mode, as shown in Figure 5. For details about related parameters, see Table 2.
   Figure 5 Adding an agent to a database
   

   Table 2 Parameters for adding an agent (databases built on ECS/BMS)

   Parameter	Description	Example Value
   Add Mode	Mode for adding an agent Select an existing agent If an agent has been installed on a database connected to the same application as the desired database, select Select an existing agent. Create an agent If no agent is available, select Create an agent to create one.	Create an agent
   Installing Node Type	This parameter is mandatory when Add Mode is set to Create an agent. When auditing user-installed databases on ECS/BMS, select Database for Installing Node Type.	Database
   OS	OS of the database to be audited. Its value can be . Its value can be LINUX64 or WINDOWS64.	LINUX64
   CPU Threshold (%)	Optional. This parameter is configurable if Installing Node Type is set to Application. CPU threshold of the application node to be audited. The default value is 80.	80
   Memory Threshold (%)	Optional. This parameter is configurable if Installing Node Type is set to Application. Memory threshold of the application node to be audited. The default value is 80.	80

7. Click OK.
8. Click on the left of the database to view its details and information about the added agent. See Figure 6.
   Figure 6 Successfully adding an agent
   
   

   After adding the agent, confirm that the agent information is correct. If the agent is incorrectly added, locate the target agent, click More > Delete in the Operation column, and add an agent again.

Adding an Agent (RDS Databases)

After you add a MySQL or GaussDB(for MySQL) database, you can start configuring security group rules. You do not need to install an agent on the database.

If an application connects to multiple RDS databases, be sure to:

• Add an agent to each of the RDS databases.
• Select Select an existing agent if one of the databases already has an agent. Add that agent for the rest of the databases.

1. Log in to the management console.
2. Select a region, click , and choose Security & Compliance > Database Security Service. The Dashboard page is displayed.
3. In the navigation tree on the left, choose Databases.
4. In the Instance drop-down list, select the instance whose agent is to be added.
5. In the Agent column of the desired database, click Add.
6. In the displayed dialog box, select an add mode, as shown in Figure 7 and Figure 8. For details about related parameters, see Table 3.
   • Select Select an existing agent for Add Mode.
     For details about when you should select this option, see When Should I Select an Existing Agent?

     

     If an agent has been installed on the application, you can select it to audit the desired database.

     Figure 7 Selecting an existing agent
     
   • Set Add Mode to Create an agent.

     If no agent is available, select Create an agent to create one.

     Select Installing Node Type to Application, and set Installing Node IP Address to the intranet IP address of the application.

     Figure 8 Adding an agent to an application
     

   Table 3 Parameters for adding an agent (RDS databases)

   Parameter	Description	Example Value
   Add Mode	Mode for adding an agent Selecting an existing agent If an agent has been installed on a database connected to the same application as the desired database, select Select an existing agent. Create an agent If no agent is available, select Create an agent to create one.	Create an agent
   Installing Node Type	This parameter is mandatory when Add Mode is set to Create an agent. To audit the RDS databases, select Application.	Application
   Installing Node IP Address	This parameter is mandatory if Installing Node Type is set to Application. You can enter only one installation node IP address. The IP address of an agent must be unique. The IP address is the intranet IP address of the application. It must be an intranet IPv4 (for example, 192.168.1.1) or intranet IPv6 (for example, fe80:0000:0000:0000:0000:0000:0000:0000) address. NOTICE: To audit an RDS database connected to an off-cloud application, set this parameter to the IP address of the proxy.	192.168.1.1
   Audited NIC Name	Optional. This parameter is configurable if Installing Node Type is set to Application. Name of the network interface card (NIC) of the application node to be audited	-
   CPU Threshold (%)	Optional. This parameter is configurable if Installing Node Type is set to Application. CPU threshold of the application node to be audited. The default value is 80. NOTICE: If the CPU usage of a server exceeds the threshold, the agent on the server will stop running.	80
   Memory Threshold (%)	Optional. This parameter is configurable if Installing Node Type is set to Application. Memory threshold of the application node to be audited. The default value is 80. NOTICE: If the memory usage of your server exceeds the threshold, the agent will stop running.	80
   OS	Optional. This parameter is configurable if Installing Node Type is set to Application. OS of the application node to be audited. The value can be LINUX64 or WINDOWS64.	LINUX64

7. Click OK.
8. Click next to the database to view its details and information about the added agent. See Figure 9.
   Figure 9 Successfully adding an agent
   
   

   After adding the agent, confirm that the agent information is correct. If the agent is incorrectly added, locate the target agent, click More > Delete in the Operation column, and add an agent again.

Follow-Up Procedure

Configure TCP (port 8000) and UDP (ports 7000 to 7100) in the security group inbound rule of the agent node to allow the agent to communicate with the audit instance. For details about how to add a security group rule, see Adding a Security Group Rule.