A Binlog cluster is a unified external service composed of one or more Binlog Servers. In scenarios where multiple Binlog Servers exist within the cluster, when a tenant's Binlog service starts, it will select an appropriate Binlog Server based on load balancing logic. If any Binlog Server fails, its Binlog service will be taken over by another healthy Binlog Server.
You can create a new Binlog cluster for management based on your business needs.
Prerequisites
The current user logged in to OCP has the ADMIN or ORG_ADMIN role.
Procedure
Log in to OCP and click Binlog Service in the left navigation bar.
On the Binlog Clusters page, click Create Binlog Cluster in the upper-right corner.
On the Create Binlog Cluster page, configure the basic cluster information.
ParameterDescriptionBinlog Cluster Name The name of the Binlog cluster to be managed. The cluster name must start with a letter and end with a letter or number, can contain letters, numbers, and underscores, and be 2 to 32 characters long. Software Version Select the software package version for the Binlog cluster. If no packages are available, you can click Upload Software Package at the bottom of the list to upload one. Access Address Enter the access address of the Binlog cluster. This address is used for request forwarding and load balancing when OBProxy communicates with the current Binlog cluster. Access Port The access port of the Binlog cluster. The default is 2983, which can be customized. Configure MetaDB information.
You need to enter the relevant information of a MySQL tenant to store the metadata of the Binlog Service. It is recommended not to use a production cluster.
ParameterDescriptionAccess Method The access method for the Binlog MetaDB. Choose based on the actual connection method of the cluster. Cluster Name Select an existing OceanBase cluster as the MetaDB for the Binlog Service. The version of the selected cluster must be V2.2.77 (Built Feb 14 2022 18:11:59) or later. Tenant Name Select a specific MySQL tenant within the cluster. Database Username Select a specific user from the MySQL tenant. If using a non-root user, go to Security management > Credential Management to add credentials for the current user and grant it sufficient permissions. Database Name Enter the name of the MetaDB database. The default is binlog_database. Supports a custom name, 2 to 64 characters long, containing digits (0-9), uppercase letters (A-Z), lowercase letters (a-z), underscores (_), and hyphens (-).Access Address The access address of the Binlog MetaDB. It is recommended to configure the access address of the Binlog MetaDB as the access address of the OBProxy cluster, or apply for a VIP address from the load balancing device and bind it to the OBProxy Server to improve access stability and security. Access Port The access port of the Binlog MetaDB. Deploy the Binlog cluster.
Each Binlog cluster consists of multiple Binlog Servers. The information required for each Binlog Server and its description are as follows.
ParameterDescriptionIDC The data center where the Binlog Server is located. A Binlog Server can only exist in one data center. Model Optional. If a host type is selected, the host list will be filtered accordingly. Host You can select multiple hosts or add new hosts. Configure startup parameters for the Binlog cluster.
You can add startup parameter items one by one and configure values for them as shown in position ① in the figure.
Alternatively, as shown in position ② in the figure, click Parameter Templates to select a parameter template. The system will automatically fill in the parameters and configurations from the template here. If no cluster parameter template has been created, you can click Create Binlog Parameter Template to create one for the Binlog cluster. For details, see Manage Binlog parameter templates.
The system provides the following five built-in templates, which contain common parameter settings. You can directly apply these templates to initialize your Binlog cluster.
TemplateDescriptionTop-Level Performance Parameters Template Estimated resource usage: 16C 10GiB, estimated RPS: 200,000~250,000. Applicable only to version 4.2.0 and later. Super Performance Parameters Template Estimated resource usage: 12C 9GiB, estimated RPS: 150,000~200,000. Applicable only to version 4.2.0 and later. Advanced Performance Parameters Template Estimated resource usage: 8C 9GiB, estimated RPS: 100,000~150,000. Applicable only to version 4.2.0 and later. Medium Performance Parameters Template Estimated resource usage: 4C 8256MiB, estimated RPS: 80,000~100,000. Applicable only to version 4.2.0 and later. Default Performance Parameters Template Estimated resource usage: 2C 8224MiB, estimated RPS: 50,000~60,000. Applicable only to version 4.2.0 and later. In the Custom Settings section, you can customize the software installation path. The default path is
/home/admin/binlogservice, which supports customization.Click Create.
Perform a pre-check before creation. The system verifies whether your environment meets the minimum requirements for creating a Binlog cluster. If a check item fails, you can perform the following operations as prompted:
- Skip: This skips the current check item (designed for special scenarios). Ensure the related check items meet product specification requirements; otherwise, subsequent process execution may fail. After skipping, the status of that check item changes to Warning.
- Retry: Troubleshoot and fix the issue based on the failure reason and optimization suggestions. After fixing it, click Retry to rerun the failed check item.
- Retry All: After all issues are troubleshooted and fixed, click Retry All to rerun all failed check items.
When no check items fail, click Create. After submitting the new Binlog cluster task, you can view its execution progress in Task Center.
Overview of the cluster list
After a cluster is created, you can view its information in the Clusters list. The information includes the Binlog Cluster Name, Status, Allocated CPU, Memory, Data Disk Used, Version, Created At, and Modified At.
- Click a cluster name to go to its overview page. For more information, see View the overview of a Binlog cluster.
- You can filter Binlog clusters by Status.
Related operations
To enable the Binlog service for a tenant, see Manage tenant Binlog services.