Cluster parameter templates preconfigure cluster parameters. In scenarios where you need to create a series of clusters with similar configurations, you can directly apply a parameter template when creating each cluster, eliminating the need to repeatedly configure parameters.
Note
For AI clusters (with shared storage), the semantics of some parameters change (for example, datafile_size now indicates cache space size), and parameters such as datafile_next and datafile_maxsize are no longer supported. When creating or editing a parameter template for a shared storage cluster, pay attention to the applicability of related parameters. For details, see [Parameter types](1300.manage-cluster-parameters/100.cluster-parameters-type.md).
Prerequisites
To view cluster parameter template information, ensure the current OCP user has the following permissions:
- Cluster Read-Only resource permission.
- Permission to access the cluster Overview menu.
To create, edit, copy, or delete a parameter template, ensure the current OCP user has the following permissions:
- Cluster Maintenance resource permission.
- Permission to access the cluster Overview menu.
Procedure
Log in to OCP.
In the left navigation bar, click Cluster. The system goes to the Clusters tab by default.
Click the Parameter Templates tab to go to the Cluster Parameter Template List page.
On the Cluster Parameter Template List page, you can perform management operations on cluster parameter templates, such as querying, creating, editing, copying, deleting, importing, and exporting.
Notice
System-built cluster parameter templates cannot be edited or deleted.
Create a parameter template
You can configure common parameters into a parameter template to avoid repeated configuration later.
On the Cluster Parameter Template List page, click Create Parameter Template. Or, in the Parameter Management section of the Create Cluster page, select Create Cluster Parameter Template.
In the Create Parameter Template panel, define the template name and set related parameters.
You can click + Add Parameter to add multiple parameter items and configure their values.
Click Submit.
Edit a parameter template
You can update the information of a parameter template as needed.
On the Cluster Parameter Template List page, find the parameter template you want to edit and select ... > Edit in the Actions column.
In the Edit Cluster Parameter Template panel, modify the Template Name, Remarks, and Template Parameter Settings fields.
Click Submit.
Copy a parameter template
This operation allows you to copy an existing complex template A and rename it to B. The content of template B only requires simple modifications based on A, eliminating the need to reconfigure a large number of parameters.
On the Cluster Parameter Template List page, find the parameter template you want to copy and select ... > Copy in the Actions column.
On the Copy Cluster Parameter Template page, rename the Template Name, Remarks, and Template Parameter Settings fields.
Click Submit.
Delete a parameter template
If a cluster parameter template is no longer applicable, you can delete it.
On the Cluster Parameter Template List page, find the parameter template you want to delete and select ... > Delete in the Actions column.
In the pop-up window, click OK.
Export a parameter template
If you want to use the same parameter template across different OCP instances, you can export the template file locally and then import it for use in another OCP instance.
On the Cluster Parameter Template List page, find the parameter template you want to export and select ... > Export in the Actions column.
In your browser, choose a location to save the file, and the parameter template is exported to your local device.
Import a parameter template
Import a locally saved tenant parameter template to avoid reconfiguring the same parameter information.
On the Cluster Parameter Template List page, click Create Parameter Template. Or, in the Parameter Management section of the Create Cluster page, select Create Cluster Parameter Template.
In the Create Parameter Template panel, click Import, select the YAML template file you want to import. Each parameter value in the template file must comply with the product specifications of OceanBase/OBProxy/Binlog and be unique.
Click Submit.