MariaDB MaxScale MaxGUI Guide
MariaDB MaxScale MaxGUI Guide
MaxGUI is the new browser based tool for configuring and managing
MaxScale. It is a more user friendly and intuitive to use companion
to the command line tool
To enable MaxGUI in a testing mode, add
admin_secure_gui=false under the
[maxscale] section of the MaxScale
configuration file. Once enabled, MaxGUI will be available on port 8989:
Securing the GUI
To make MaxGUI secure, set
admin_secure_gui=true and configure both the
Check the Configuration Guide for the parameter documentation and read the Configuration and Hardening section of the REST API tutorial for instructions on how to harden your MaxScale installation for production use.
MaxGUI cannot be used without providing credentials. MaxGUI uses
the same credentials as
maxctrl, so by default, the username is
admin and the password is
MaxGUI uses JSON Web Tokens as the authentication method for persisting the user's session. If the Remember me checkbox is ticked, the session will persist for 8 hours, otherwise, as soon as MaxGUI is closed, the session will expire.
To log out, simply click the username section in the top right corner of the page header to access the logout menu.
The dashboard shows three graphs:
Sessions graph illustrates the total number of current sessions updating every 10 seconds.
Connections graph shows servers current connections updating every 10 seconds.
Load graph shows the last second load of thread, which is updated every second.
Under the graphs section, there is a tab navigation allowing to switch table view which contains overview information of the following resources: all servers grouped by monitor, current sessions and all services. The information of these resources are updated every 10 seconds.
The monitor, server and services resources have their own details page. It can be accessed by clicking the resource name on the dashboard page.
In the details page, resource parameters as well as relationships can be modified in the resource's parameters section.
Deletion of a resource or other actions can be done by clicking the setting icon located next to the resource name. For instance, clicking the setting icon in Monitor detail page will popup three icons allowing a monitor to be started, stopped, and deleted.
For Servers, the monitor relationship can be modified by hovering over the rectangular Monitor block section at the top of the page.
A resource can be created by clicking the + Create New button at the top right corner of the dashboard or the detail page.
Note: Resources that depend on a module can be created only if that module has been loaded by MaxScale.
Viewing and modifying Maxscale parameters
MaxScale parameters can be viewed and modified at runtime on the Settings page, which can be accessed by clicking the settings icon in the sidebar navigation.
The global search input located next to the + Create New button can be used for searching for keywords in tables.