[MXS-2600] Documentation is inconsistent regarding privileges for MariaDB Monitor Created: 2019-07-12  Updated: 2019-10-01  Resolved: 2019-10-01

Status: Closed
Project: MariaDB MaxScale
Component/s: Documentation, mariadbmon
Affects Version/s: 2.3.9
Fix Version/s: 2.3.13, 2.4.3

Type: Bug Priority: Major
Reporter: Geoff Montee (Inactive) Assignee: Esa Korhonen
Resolution: Fixed Votes: 0
Labels: None

Sprint: MXS-SPRINT-91

 Description   

The documentation is inconsistent regarding the privileges that are needed by the user account used by MariaDB Monitor.

One section says this:

The user requires the REPLICATION CLIENT privilege to successfully monitor the state of the servers. SUPER privilege is required for cluster manipulation features such as failover.

MariaDB [(none)]> grant replication client on . to 'maxscale'@'maxscalehost';
Query OK, 0 rows affected (0.00 sec)

https://mariadb.com/kb/en/mariadb-maxscale-23-mariadb-monitor/#configuration

It mentions that the SUPER privilege may also be needed, but a latter section says that several other privileges may also be needed:

The cluster operations require that the monitor user (user) has the following privileges:

  • SUPER, to modify slave connections and set globals such as read_only
  • REPLICATION CLIENT, to list slave connections
  • RELOAD, to flush binary logs
  • PROCESS, to check if the event_scheduler process is running
  • SHOW DATABASES and EVENTS, to list and modify server events

https://mariadb.com/kb/en/mariadb-maxscale-23-mariadb-monitor/#cluster-manipulation-operations

These sections should be made consistent. I would also suggest adding a GRANT example to the "configuration" section that includes all privileges required for cluster manipulation options. e.g.:

GRANT RELOAD, PROCESS, SHOW DATABASES, REPLICATION CLIENT, EVENT, SUPER ON *.* TO 'maxscale'@'maxscalehost';


Generated at Thu Feb 08 04:15:19 UTC 2024 using Jira 8.20.16#820016-sha1:9d11dbea5f4be3d4cc21f03a88dd11d8c8687422.