MySQL Operator user guide

Prerequisites

• You have deployed MySQL Operator on the RDS Custom container cluster with one click and configured the logon username and password. For more information, see Manage RDS Custom container clusters.

• You have verified the network conditions for accessing the MySQL Operator dashboard.

  • If the client and the cluster are in the same virtual private cloud (VPC), you can directly access the MySQL Operator dashboard.

  • If the client and the cluster are not in the same VPC, you must first enable public access. For more information, see Configure public access for MySQL Operator.

Create an instance

Pod MySQL instances run in primary-standby pairs. Perform the following steps to create an instance.

1. Log on to the MySQL Operator dashboard.

   Log on to the ApsaraDB RDS console. In the left-side navigation pane, choose RDS Custom > Custom Container Clusters. In the ACK Pro Cluster List, find the target cluster, and then click Access Dashboard in the MySQL Operator column.

2. In the left-side navigation pane, click Instance Management, and then click Create Instance to open the creation wizard.

   The creation wizard consists of six steps: Basic Information, Account and Security, Specifications and Storage, MySQL Parameters, Advanced Scheduling, and Confirm Configuration. During configuration, you can click Previous to go back and modify settings, or click Back to Instance List to cancel the creation.

3. In the Basic Information step, configure the following parameters, and then click Next.

   Parameter	Description
   Instance Name	The name of the instance. The name can be up to 63 characters in length.
   Resource Space	The resource space to which the instance belongs, which corresponds to a namespace in the ACK cluster. You can search in the drop-down list. The default value is default.
   MySQL Version	The MySQL version of the instance, such as MySQL 8.0.
   High Availability Topology	The node topology of the instance, such as 1 Primary + 1 Standby.
   Replication Mode	The data replication mode between the primary and standby nodes. Valid values: Asynchronous Replication (Default): The primary node does not wait for acknowledgment from the standby node, resulting in lower write latency. If the primary node fails, data that has not been transmitted to the standby node may be lost. Semi-synchronous Replication: The primary node waits for the standby node to acknowledge receipt before returning, providing higher data reliability at the cost of slightly higher write latency compared to asynchronous replication.

4. In the Account and Security step, configure the privileged account used for business MySQL logon, and then click Next.

   Note

   Internal platform accounts are managed independently by the system and do not require your configuration.

   Parameter	Description
   Privileged Account	The name of the privileged account used for business logon. The name can be up to 32 characters in length.
   Password	The password of the privileged account. The password must be 8 to 32 characters in length and must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.
   Confirm Password	Enter the password again.

   Important

   Keep your password in a safe place. After the instance is created, the instance details page displays only the account name but does not allow you to view or copy the password.

5. In the Specifications and Storage step, configure the following parameters, and then click Next.

   Parameter	Description
   Disk Performance Level	The disk type and performance level for the instance, such as Standard Disk - PL0 (starting from 1 GB).
   Capacity per Node	The disk capacity of a single node. Unit: GB.
   CPU Request	The number of CPU cores reserved for a single node.
   CPU Limit	The maximum number of CPU cores that a single node can use.
   Memory Request	The amount of memory reserved for a single node. Unit: GB.
   Memory Limit	The maximum amount of memory that a single node can use. Unit: GB.

   Note

   The primary and standby nodes use independent disks. The capacity is calculated per node.

6. In the MySQL Parameters step, configure the following parameters, and then click Next.

   Parameter	Description
   Parameter Template	Select a previously created parameter template from the drop-down list. If no template is selected, the platform default parameters are used. For more information about how to create a parameter template, see the Parameter templates section in this topic.
   Binary Log Retention	The retention period of binary logs (binlogs), such as 6 hours.

   The parameter template provides base values. To override individual parameters from the template, click + Add Custom Parameter. Custom parameters take precedence over template values.

7. In the Advanced Scheduling step, confirm the scheduling rules, and then click Check Configuration.

   The default rules are already adapted to the current runtime environment. To customize, expand Custom Scheduling and configure Node Selector Labels and Tolerations. You can click + Add Label and + Add Toleration to add entries.

   Note

   If you do not have specific requirements, keep the default values.

8. In the Confirm Configuration step, review the configuration. After Configuration Check Passed is displayed, click Create Instance.

   The summary area displays information such as the instance name, resource space, privileged account, password, topology, replication mode, version, disk, compute specifications, parameter source, and custom parameters. The password is displayed as Password Set. To view more configurations, expand Advanced Fields.

9. In the left-side navigation pane, click Task Center to view the creation progress. When the task status shows Completed, the instance is created.

Task center

In the left-side navigation pane, click Task Center to view the task status, current phase, and failure information. Click Refresh to update the data. The following statistics are displayed at the top of the page.

The task list supports filtering by Search task or instance, task type, and task status. Each task displays the Task, Status, Current Phase, Resource Space, Start Time, and Duration.

Operation records

In the left-side navigation pane, click Operation Records to track instance operations and results. You can filter by Instance Name, operation type, operation result, and time range. After configuring the filter conditions, click Query. For additional filter options, click Advanced Filter. Operation records are grouped by instance. Each record contains the Operation, Result, Initiator, Summary, and Start Time. The Summary field indicates the number of resource changes involved in the operation. In the Actions column of a target record, click View Task to go to the corresponding task details, or click Record Details to view the detailed information of the operation record.

Parameter templates

Parameter templates are used to maintain and reuse MySQL parameter configurations. After creation, a template can be applied to one or more instances. In the left-side navigation pane, click Parameter Templates to view the template list.

The top of the page displays four statistics: Template Count, Parameter Configurations, Associated Instances, and Applicable Versions. The template list displays the Template, Resource Space, Applicable Version, Parameter Count, Associated Instances, and Created At for each template. You can also search by using the Search template name or description field.

Related topics

• Manage RDS Custom container clusters

• Create an RDS Custom instance

• Manage RDS Custom instances

• Configure public access for MySQL Operator

• Introduction to RDS Custom