For the complete documentation index, see llms.txt. This page is also available as Markdown.

Upgrade to MaxScale 25.01

Follow the specific steps to upgrade MariaDB MaxScale to version 25.01. This guide covers new package structures, removed features, and critical configuration changes for this release.

These instructions detail the upgrade to MariaDB MaxScale 25.01 in a MaxScale Instance configuration on a range of supported Operating Systems.

MariaDB MaxScale is an advanced database proxy and query router.

Term Definitions

Term
Definition

MaxScale instance

upgrade

  • A change from lower-versioned release of MariaDB MaxScale to a higher-versioned release of MariaDB MaxScale.

Backing Up Configuration

Upgrades can move or change configuration files. Before starting an upgrade, always back up your configuration so you can revert to the working system if you encounter any issues during the upgrade.

A complete backup must include both the static configuration and any configuration MaxScale has persisted at runtime:

  • The main configuration file, /etc/maxscale.cnf.

  • Any auxiliary static configuration files in /etc/maxscale.cnf.d/.

  • The persisted configuration directory. Changes made at runtime through MaxCtrl, the REST API, or the GUI are saved here as individual .cnf files and override the static configuration when MaxScale restarts. This directory defaults to /var/lib/maxscale/maxscale.cnf.d/ and is set by the persistdir parameter in the [maxscale] section.

sudo cp /etc/maxscale.cnf /data/backups/config/maxscale.cnf
sudo cp -r /etc/maxscale.cnf.d /data/backups/config/maxscale.cnf.d
sudo cp -r /var/lib/maxscale/maxscale.cnf.d /data/backups/config/persisted.cnf.d

If you set persistdir to a non-default location in /etc/maxscale.cnf, back up that directory instead of /var/lib/maxscale/maxscale.cnf.d/.

Upgrade

MariaDB Corporation provides package repositories for YUM (RHEL, CentOS, Rocky Linux), APT (Debian, Ubuntu), and ZYpp (SLES).

Stop the MaxScale Process

Before upgrading MariaDB MaxScale, first stop the current process.

For distributions that use systemd (most supported OSes), you can manage the Server process using the systemctl command:

Upgrade MaxScale

Upgrade MaxScale following the instructions for your Linux distribution:

Upgrade via DNF (RHEL)

1

Customer Download Token

Retrieve your Customer Download Token at https://customers.mariadb.com/downloads/token/ and substitute for CUSTOMER_DOWNLOAD_TOKEN in the following directions.

2

Configure YUM / DNF package repository

Pass the version you want to install using the --mariadb-maxscale-version flag to the mariadb_es_repo_setup script. The following directions reference 25.01.

To configure YUM package repositories:

3

Upgrade MariaDB MaxScale and package dependencies:

4

Configure MaxScale

The upgrade process only loads MaxScale onto the system. MaxScale requires configuration before MaxScale is ready for use.

Upgrade via APT (Debian, Ubuntu)

1

Customer Download Token

Retrieve your Customer Download Token at https://customers.mariadb.com/downloads/token/ and substitute for CUSTOMER_DOWNLOAD_TOKEN in the following directions.

2

Configure APT package repository

Pass the version you want to install using the --mariadb-maxscale-version flag to the mariadb_es_repo_setup script. The following directions reference 25.01.

To configure APT package repositories:

3

Upgrade MariaDB MaxScale and package dependencies

4

Configure MaxScale

The upgrade process only loads MaxScale onto the system. MaxScale requires configuration before MaxScale is ready for use.

Upgrade via ZYpp (SLES)

1

Customer Download Token

Retrieve your Customer Download Token at https://customers.mariadb.com/downloads/token/ and substitute for CUSTOMER_DOWNLOAD_TOKEN in the following directions.\

2

Configure ZYpp package repository

Pass the version you want to install using the --mariadb-maxscale-version flag to the mariadb_es_repo_setup script. The following directions reference 25.01.

To configure ZYpp package repositories:

3

Upgrade MariaDB MaxScale and package dependencies

4

Configure MaxScale

The upgrade process only loads MaxScale onto the system. MaxScale requires configuration before MaxScale is ready for use.

Configuration

Configuration parameters can change between releases of MariaDB MaxScale, which can have unexpected results.

  1. Determine which parameters have changed by reviewing all the changes made between your current release and the upgrade release.

  2. Change the specific parameters in maxscale.cnf.

Changes in MaxScale Versions

Changes in MaxScale 23.02

When upgrading from MaxScale 22.08 and earlier to MaxScale 25.01, the changes introduced in MaxScale 23.02 must be taken into consideration.

MariaDB MaxScale 22.08 is fully compatible with MariaDB MaxScale 23.02 with the exception that some features have been removed.

Removed Features

  • The csmon monitor has been removed after previously being deprecated in MaxScale 22.08.2.

  • The auroramon monitor has been removed after previously being deprecated in MaxScale 22.08.2.

  • The maxctrl cluster commands have been removed after previously being deprecated in MaxScale 22.08.2

  • The maxctrl drain command has been removed, because it is obsolete.

Removed Deprecated maxctrl Commands

In MariaDB MaxScale 23.02, some deprecated MaxCtrl commands were removed:

  • maxctrl cluster

  • maxctrl drain has been removed and can be replaced with maxctrl set server SERVER_NAME drain

Removed Deprecated maxctrl Options

In MariaDB MaxScale 23.02, several deprecated MaxCtrl command-line options were removed, since MaxScale previously added the ability to specify module parameters to MaxCtrl as key-value pairs.

This change can impact backward compatibility. Some scripts and tools written for previous versions of MaxCtrl will require updates to continue functioning with MaxCtrl from MaxScale 23.02. The old command-line parameters have been deprecated since MaxScale 22.08. The new syntax to specify parameters as key-value pairs has been supported since MariaDB MaxScale 6.2.0.

For example, in previous releases, the following maxctrl create monitor command could be executed:

Starting with MariaDB MaxScale 23.02, some deprecated command-line options have been removed and must be replaced with a key-value pair using the corresponding module parameter:

For maxctrl create listener, the following deprecated command-line options were removed and must be replaced with a key-value pair using the listed parameter:

Command-line Option
Replaced by Parameter

--authenticator

authenticator

--authenticator-options

authenticator_options

--interface

interface

--protocol

protocol

--tls-ca-cert

ssl_ca

--tls-cert

ssl_cert

--tls-cert-verify-depth

ssl_cert_verify_depth

--tls-crl

ssl_crl

--tls-key

ssl_key

--tls-verify-peer-certificate

ssl_verify_peer_certificate

--tls-verify-peer-host

ssl_verify_peer_host

--tls-version

ssl_version

For maxctrl create monitor, the following deprecated command-line options were removed and must be replaced with a key-value pair using the listed parameter:

Command-line Option
Replaced by Parameter

--monitor-password

password

--monitor-user

user

Changes in MaxScale 22.08

When upgrading from MaxScale 6 and earlier to MaxScale 25.01, the changes introduced in MaxScale 22.08 must be taken into consideration.

Database Firewall Filter

  • The dbfwfilter that was deprecated in MaxScale 6 has been removed in MaxScale 22.08.

Deprecated Parameters

  • The server parameter ssl_ca_cert has been renamed to ssl_ca and ssl_ca_cert has been deprecated. ssl_ca_cert is now an alias for ssl_ca and can still be used, but MariaDB recommends using ssl_ca, as support for ssl_ca_cert will be removed in a future release.

  • The server parameter admin_ssl_ca_cert has been renamed to admin_ssl_ca and admin_ssl_ca_cert has been deprecated. admin_ssl_ca_cert is now an alias for admin_ssl_ca and can still be used, but MariaDB recommends using admin_ssl_ca, as support for admin_ssl_ca_cert will be removed in a future release.

Removed Parameters

  • The following MariaDB Monitor (mariadbmon) parameters have been removed:

    • ignore_external_masters

    • detect_replication_lag

    • detect_standalone_master

    • detect_stale_master (replaced by master_conditions)

    • detect_stale_slave (replaced by slave_conditions)

Default Changed for Logging Behavior

  • Prior to MaxScale 22.08.1, by default MaxScale logs to syslog in addition to the MaxScale log.

  • Starting with MaxScale 22.08.1, by default MaxScale only logs to the MaxScale log and no longer logs to syslog.

  • To retain the behavior of prior releases, in your MaxScale configuration, under the [maxscale] section, specify syslog=true:

REST API Endpoint Removed

  • The /v1/maxscale/tasks/ endpoint has been removed from the REST API.

Changes in MaxScale 6

When upgrading from MaxScale 2.5 and earlier to MaxScale 25.01, the changes introduced in MaxScale 6 must be taken into consideration.

TLS/SSL

  • MaxScale's ssl parameter can no longer be set to required or disabled:

    • ssl=true replaces ssl=required

    • ssl=false replaces ssl=disabled

Deprecated Features

  • dbfwfilter is deprecated (but not removed) in MaxScale 6.

  • Multi-line configuration parameters are deprecated (but not removed) in MaxScale 6.

Defaults Changed

  • The default value of threads has changed from 1 to auto

ColumnStore

  • When using MaxScale with ColumnStore 5 and later, MariaDB Monitor (mariadbmon) is used instead of ColumnStore Monitor (csmon).

Changes in MaxScale 2.5

When upgrading from MaxScale 2.4 and earlier to MaxScale 25.01, the changes introduced in MaxScale 2.5 must be taken into consideration.

Passwords

  • MaxScale's password encryption features have been updated to be more secure. Passwords encrypted in old versions will still work, but it is recommended to generate a new encryption key with the maxkeys command and to re-encrypt passwords with the maxpasswd command.

User Account Privileges

MaxScale's user account requires additional privileges in MaxScale 2.5.

Ensure that the user account has the following privileges:

MariaDB Monitor

MaxScale 2.5 includes configuration changes for MariaDB Monitor (mariadbmon):

  • The detect_stale_master and the detect_standalone_master parameters have been deprecated. They can still be used, but they will be removed in a later version of MaxScale. Users should use the master_conditions parameter instead.

    For example:

  • The detect_stale_slave parameter has been deprecated. It can still be used, but it will be removed in a later version of MaxScale. Users should use the slave_conditions parameter instead.

    For example:

ColumnStore Monitor

MaxScale 2.5 includes configuration changes for ColumnStore Monitor (csmon):

  • The version parameter was previously optional, but it is now required.

    For example:

Binlog Router

MaxScale 2.5 includes a completely re-implemented Binlog Router (binlogrouter):

  • Thoroughly test your configuration with the new implementation to ensure that the new version meets your needs.

Starting the MaxScale Instance

MariaDB MaxScale installations includes configuration to start, stop, restart, enable/disable on boot, and check the status of the MaxScale Instance using the operating system default process management system.

For distributions that use systemd (most supported OSes), you can manage the MaxScale process using the systemctl command:

Operation
Command

Start

sudo systemctl start maxscale

Stop

sudo systemctl stop maxscale

Restart

sudo systemctl restart maxscale

Enable during startup

sudo systemctl enable maxscale

Disable during startup

sudo systemctl disable maxscale

Status

sudo systemctl status maxscale

Testing

When you have MariaDB MaxScale up and running, you should test it to ensure that it is working and that weren't any issues during startup.

Checking MaxScale Status

Check that MaxScale is running properly by using the MaxCtrl utility:

This page is licensed: CC BY-SA / Gnu FDL

spinner

Last updated

Was this helpful?