Upgrades for MariaDB Xpand

Overview

This page describes how to upgrade Xpand. If you have any questions, please contact MariaDB Support.

Prerequisites

  • All nodes must be online. The output of clx stat should indicate a cluster status of OK

  • Confirm that the upgrade package you have is compatible with your current version of Xpand, including the OS version

  • Review the list of Upgrade Alerts included in the Release Notes

  • All upgrades should be run as the Xpand daemon user (xpand). For additional information, see "Operating System User Accounts for MariaDB Xpand".

  • Passwordless SSH authentication must be configured for the Xpand daemon user (xpand). To verify this, confirm that the clx command returns successfully with no passwords requested:

    /opt/clustrix/bin/clx cmd date
    

    For additional information, see "SSH Configuration".

  • Ensure that the clocks are synchronized between nodes. For additional information, see "Chronyd for Clock Synchronization with MariaDB Xpand".

Download MariaDB Xpand

MariaDB Xpand is distributed as a binary tarball.

Download the MariaDB Xpand binary tarball and the corresponding upgrade script from the page that matches your use case:

  • If you are participating in a 45-day Xpand trial, access the Xpand downloads link on the Xpand Trial page.

  • MariaDB Enterprise customers with an Xpand license for production use can download MariaDB Xpand from the MariaDB Downloads page. Login is required.

To upgrade

The Xpand upgrade packages will upgrade the database and XpandGUI. The upgrade should be run from a single node and will upgrade all nodes in the cluster.

Performing an upgrade will incur a short period of downtime.

Note

Xpand does not support downgrades.

To perform the upgrade:

  1. Copy the binary tarball and the upgrade script for the new Xpand version to a single Xpand node.

  2. (Optional) if you are using a non-default SSH port, set an environment variable. In the following example, the alternate port is 1234:

    export CLX_SSH_PORT=1234
    
  3. Run the upgrade as the database daemon user (e.g., xpand). If the database has been installed with root user only, then run the upgrade as root. In the following example, the version being installed is 6.0.3:

    $ sudo su xpand
    $ ./xpand-xpdnode-6.0.3-upgrade.sh install
    

    This will upgrade every node in the cluster. While the upgrade is in progress, there is a brief period during which the database is unavailable.

    Note

    Because of an issue with the mariadb/mysql client, the command sudo -u xpand COMMAND does not use the correct user for sql logins and the upgrade will fail with an error. To upgrade successfully you must sudo to the xpand user with sudo su xpand or log in as that user directly.

  4. Once the database portion of the upgrade is complete, the cluster is online. The UI portion of the upgrade will continue but the database is available. To verify that the upgrade has succeeded successfully, examine the value for clustrix_version:

    SELECT @@clustrix_version;
    
    +--------------------+
    | @@clustrix_version |
    +--------------------+
    | Xpand-6.0.3        |
    +--------------------+
    

Special Cases for Upgrades

Upgrades cannot be run on clusters in read-only mode