2. Home
  4. Docs
  6. ClusterControl
  8. User Guide (GUI v2)
  10. Clusters
  12. Manage

Manage

Configurations

Manages the configuration files of your database, ProxySQL, HAProxy, and Garbd nodes. For MySQL database, changes can be persisted to database variables across one node or a group of nodes at once, dynamic variables are changed directly without a restart.

Note

ClusterControl does not store configuration changes history so there is no versioning at the moment. Only one version exists at one time. It imports the latest configuration files every 30 minutes and overwrites them in the CMON database. This limitation will be improved in the upcoming release where ClusterControl shall support configuration versioning with dynamic import interval.

Field Description
Refresh config
  • Re-import configuration if you have:
    • Performed local configuration changes directly on the configuration files.
    • Restarted the MySQL servers or performed a rolling restart after a configuration change.
Edit params
  • The selected parameter will be changed or created in the specified group option. ClusterControl will attempt to dynamically set the configuration value if the parameter is valid. Then, the change can be persisted in the configuration file.
  • For example, if you want to turn off the read_only which is a dynamic variable, choose it from the parameter list (or filter it from the search box) and specify a new value OFF. ClusterControl will then perform the change using the SET GLOBAL statement and make it persist in the config file accordingly.
Show diff
  • Show the difference between the last save changes of the configuration file and the current version (before you hit the Save button). The configuration can be reverted to the previous version by clicking on Revert changes.
Save
  • Save the changes that you have made and push them to the corresponding node.
Attention

If you change a global system variable, the value is remembered and used ONLY for new connections.

DB Users

Available for: MySQL/MariaDB ReplicationMySQL/MariaDB Galera ClusterPostgreSQLTimescaleDBMariaDB Server

Shows a summary of database users and privileges for the cluster. All of the changes are automatically synced to all database nodes in the cluster.

You can filter the list by Active and Inactive users. Click on Actions → Edit to update the existing user or Actions → Delete to remove the existing user. Click on Create DB User to open the user creation wizard:

Field Description
Configuration
Username
  • Database username.
Password
  • Password for Username. The minimum requirement is 4 characters.
Hostname
  • Hostname or IP address range of the user or client. For the IP address range, use the IP address/subnet format, e.g, 192.168.100.0/24.
Privileges
Privileges
  • Specify the privilege for this user. If the Privileges text box is active, it will list all possible privileges of the server.
  • Specify the database or table name. It can be in *.*,{database_name}, {database_name}.* or {database_name}{table_name} format.
Add Privileges
  • Add another Privileges statement builder entry for this user.
Advanced
Max Queries Per Hour
  • Maximum queries this user can perform in an hour. Default is 0 (unlimited).
Max Updated Per Hour
  • Maximum update operations this user can perform in an hour. Default is 0 (unlimited).
Max Connections Per Hour
  • Maximum connections allowed for this user in an hour. Default is 0 (unlimited).
Max User Connections
  • Maximum connections allowed for this user ever. Default is 0 (unlimited).
Requires SSL
  • On – The user must be authenticated using SSL.
  • Off – This configuration setting will be skipped.

Advisors

Lists of scheduled advisors’ results created in ClusterControl → Manage → Scripts using ClusterControl DSL. You can think of it as a ‘scheduled mini-program’ that executes a script created in Scripts and produces a result containing status, advice, and justification. Each advisor has the following features:

Actions Description
Results
  • Opens a pop-up and shows the results of the advisor script for all related instances under this cluster.
Edit script
  • Opens a pop-up and shows the code of the advisor script. You can make changes to the script and click Save to save the change or Compile & run to see the result. It also shows the Logs of the advisor and can be expanded to see the output of the advisor.
Edit params
  • Edit the advisor arguments (if the script takes any), or schedule the execution of the script in cron format.
Disable/Enable
  • Disables/Enables the advisor script.

When clicking on the Results, you will be presented with a table containing the following information:

Field Description
Advisor
  • The name of the advisor program.
Tags
  • The tag(s) of the advisor program belongs to.
Status
  • Advisor status – Ok, Warning, Critical.
Instance
  • The server the advisor runs on.
Justification
  • The result of advisors’ execution.
Advice
  • The advisor’s decision based on the justification.

Scripts

Provides functionality to create Advisors, Auto Tuners, or Mini Programs right within your web browser based on ClusterControl DSL. The DSL syntax is based on JavaScript, with extensions to provide access to ClusterControl’s internal data structures and functions. The DSL allows you to execute SQL statements, run shell commands/programs across all your cluster hosts, and retrieve results to be processed for advisors/alerts or any other actions. Developer Studio is a development environment to quickly create, edit, compile, run, test, debug, and schedule your JavaScript programs.

Advisors in ClusterControl are powerful constructs; they provide specific advice on how to address issues in areas such as performance, security, log management, configuration, storage space, etc. They can be anything from simple configuration advice, warnings on thresholds, or more complex rules for predictions, or even cluster-wide automation tasks based on the state of your servers or databases.

ClusterControl comes with a set of basic advisors that include rules and alerts on security settings, system checks (NUMA, Disk, CPU), queries, InnoDB, connections, Performance_Schema, configuration, NDB memory usage, and so on. The advisors are open source under MIT license, and publicly available at GitHub. Through the Developer Studio, it is easy to import new advisors as a JS bundle or export your own for others to try out.

Field  Description
Compile
  • Compiles the script.
Compile and run
  • Compile and run the script. The output appears as a pop-up from the right side.
Show diff
  • Show the difference between the last save changes of the configuration file and the current version (before you hit the Save button). The configuration can be reverted to the previous version by clicking on Revert changes.
Save
  • Saves the script.
See also

Introducing ClusterControl Developer Studio and Creating your Advisors in JavaScript.

Was this article helpful to you? Yes No