Upgrade Multi-Node MariaDB Enterprise ColumnStore from 1.2 to 5 on Ubuntu 18.04 LTS

Stop ColumnStore

Before the old version can be uninstalled, stop the current MariaDB ColumnStore 1.2 process.

1. Stop MariaDB ColumnStore with mcsadmin shutdownSystem:

   $ mcsadmin shutdownSystem y
   

Uninstall ColumnStore 1.2 via APT (Debian, Ubuntu)

1. Remove all MariaDB ColumnStore 1.2 packages with the following command:

   $ sudo apt remove "mariadb-columnstore-*"
   

   Note that a wildcard character used in the command to ensure that all MariaDB ColumnStore 1.2 packages are uninstalled. Confirm that this wildcard does not unintentionally refer to any of your custom applications.

2. Verify that all MariaDB 1.2 ColumnStore packages are uninstalled with the following command:

   $ apt list --installed | grep -i -E "mariadb-columnstore"
   

   Note that the command should not return any results. If it does, remove the remaining packages individually.

AppArmor (Debian, Ubuntu, SLES)

AppArmor must be disabled before installing MariaDB Enterprise ColumnStore.

1. Disable AppArmor:

   $ sudo systemctl disable apparmor
   

2. Reboot the system.

3. Confirm that no AppArmor profiles are loaded using aa-status:

   $ sudo aa-status
   

   Example output:

   apparmor module is loaded.
   0 profiles are loaded.
   0 profiles are in enforce mode.
   0 profiles are in complain mode.
   0 processes have profiles defined.
   0 processes are in enforce mode.
   0 processes are in complain mode.
   0 processes are unconfined but have a profile defined.
   

Stop UFW (Ubuntu)

1. Check if the UFW service is running:

   $ sudo ufw status verbose
   

2. If the UFW service is running, stop it:

   $ sudo ufw disable
   

Configure the AWS Security Group

If your Enterprise ColumnStore cluster is in Amazon Web Services, you will need to modify the cluster's security group prior to installation.

Enterprise ColumnStore requires all internal communications to be open between cluster nodes. Therefore, the security group should allow all protocols and all ports to be open between the Enterprise ColumnStore nodes and the MaxScale proxy.

Recommended Storage Options

For best results, MariaDB Corporation would recommend the following storage options:

S3-Compatible Object Storage

MariaDB Enterprise ColumnStore can use S3-compatible object storage to store data.

Many S3-compatible object storage services exist. MariaDB Corporation cannot make guarantees about all S3-compatible object storage services, because different services provide different functionality.

For the preferred S3-compatible object storage providers that provide cloud and hardware solutions, see the following sections:

• Cloud

• Hardware

The use of non-cloud and non-hardware providers is at your own risk.

For S3-compatible object storage recommendations for different types of environments, see "Recommended Storage Options".

If you have any questions about using specific S3-compatible object storage with MariaDB Enterprise Columnstore, contact us.

Preferred Object Storage Providers: Cloud

• Amazon Web Services (AWS) S3

• Google Cloud Storage

• Azure Storage

• Alibaba Cloud Object Storage Service

Preferred Object Storage Providers: Hardware

• Cloudian HyperStore

• Dell EMC

• Seagate Lyve Rack

• Quantum ActiveScale

• IBM Cloud Object Storage

Create an S3 Bucket

If you want to use S3-compatible storage, it is important to create the S3 bucket before you start ColumnStore. All cluster nodes access data from the same bucket.

If you already have an S3 bucket, confirm that the bucket is empty.

We will configure Enterprise ColumnStore to use the S3 bucket later in the Configure the S3 Storage Manager section.

Shared Local Storage Options

The most common options for shared local storage are:

Directories Requiring Shared Local Storage for HA

Multi-node MariaDB Enterprise ColumnStore requires some directories to use shared local storage for high availability. The specific requirements depend on if MariaDB Enterprise ColumnStore is configured to use S3-compatible object storage:

Install Enterprise ColumnStore via APT (Debian, Ubuntu)

On each cluster node, perform the following steps to install Enterprise ColumnStore.

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

2. Configure the APT package repository.

   MariaDB Enterprise ColumnStore 5 is available on MariaDB Enterprise Server 10.5.

   To configure APT package repositories:

   $ sudo apt install wget
   

   $ wget https://dlm.mariadb.com/enterprise-release-helpers/mariadb_es_repo_setup
   

   $ echo "cfcd35671125d657a212d92b93be7b1f4ad2fda58dfa8b5ab4b601bf3afa4eae  mariadb_es_repo_setup" \
       | sha256sum -c -
   

   $ chmod +x mariadb_es_repo_setup
   

   $ sudo ./mariadb_es_repo_setup --token="CUSTOMER_DOWNLOAD_TOKEN" --apply \
      --mariadb-server-version="10.5" --mariadb-maxscale-version=6 \
      --skip-tools
   

   $ sudo apt update
   

3. Install additional dependencies for Enterprise ColumnStore's CMAPI Server.

   On Debian 9 and Ubuntu 18.04, install the following:

   $ sudo apt install python python-apt python-pymysql python-pip \
      python3 python3-apt python3-pymysql python3-pip \
      aptitude libjemalloc1 jq curl
   

4. Install MariaDB Enterprise ColumnStore and package dependencies:

   $ sudo apt install mariadb-server \
      mariadb-backup \
      libmariadb3 \
      mariadb-client \
      mariadb-plugin-columnstore \
      mariadb-columnstore-cmapi
   

   Installation of additional packages may be required for some plugins.

5. Configure MariaDB Enterprise ColumnStore.

   Installation only loads MariaDB Enterprise ColumnStore to the system. MariaDB Enterprise ColumnStore requires configuration and additional post-installation steps before the database server is ready for use.

Configuration Compatibility

MariaDB Enterprise ColumnStore 5 changes the prefix used in system variables. The infinidb_ prefix used in MariaDB ColumnStore 1.2 has been replaced with the columnstore_ prefix.

MariaDB ColumnStore 1.2 configuration files are not compatible with MariaDB Enterprise ColumnStore 5.

Enterprise Server Configuration

MariaDB Enterprise Server can be configured in the following ways:

• System variables and options can be set in a configuration file (such as /etc/my.cnf). MariaDB Enterprise Server must be restarted to apply changes made to the configuration file.

• System variables and options can be set on the command-line.

• If a system variable supports dynamic changes, it can be set on-the-fly using the SET statement.

Configuration Files

MariaDB's packages include several bundled configuration files. It is also possible to create custom configuration files.

On Debian and Ubuntu, MariaDB's packages bundle the following configuration files:

• /etc/mysql/my.cnf

• /etc/mysql/mariadb.cnf

• /etc/mysql/mariadb.conf.d/50-client.cnf

• /etc/mysql/mariadb.conf.d/50-mysql-clients.cnf

• /etc/mysql/mariadb.conf.d/50-mysqld_safe.cnf

• /etc/mysql/mariadb.conf.d/50-server.cnf

• /etc/mysql/mariadb.conf.d/60-galera.cnf

• /etc/mysql/mariadb.conf.d/mariadb-enterprise.cnf

And on Debian and Ubuntu, custom configuration files from the following directories are read by default:

• /etc/mysql/conf.d/

• /etc/mysql/mariadb.conf.d/

Configure MariaDB for Multi-node Enterprise ColumnStore

Configure MariaDB Enterprise Server by performing the following process on all cluster nodes.

1. Determine which system variables and options you need to configure.

   Mandatory system variables and options for multi-node Enterprise ColumnStore include:

   System Variable/Option	Description
   character_set_server	Set this system variable to utf8
   collation_server	Set this system variable to utf8_general_ci
   columnstore_use_import_for_batchinsert	Set this system variable to ALWAYS to always use cpimport for LOAD DATA INFILE and INSERT...SELECT statements.
   gtid_strict_mode	Set this system variable to ON.
   log_bin	Set this option to enable the Binary Log. This is a file path.
   log_bin_index	Set this option to track the names of the Binary Log files. This is a file path.
   log_slave_updates	Set this system variable to ON.
   relay_log	Set this option to enable Relay Logs. This is a file path.
   relay_log_index	Set this option to track the names of the Relay Log files. This is a file path.
   server_id	Sets the numeric Server ID for this MariaDB Enterprise Server. Must be unique for each cluster node in the deployment.

2. Choose a configuration file in which to configure your system variables and options.

   We recommend not making custom changes to one of the bundled configuration files. Instead, create a custom configuration file in one of the included directories. Configuration files in included directories are read in alphabetical order. If you want your custom configuration file to override the bundled configuration files, it is a good idea to prefix the custom configuration file's name with a string that will be sorted last, such as z-.

   • On Debian and Ubuntu, a good custom configuration file would be: /etc/mysql/mariadb.conf.d/z-custom-my.cnf

3. Set your system variables and options in the configuration file.

   They need to be set in a group that will be read by mariadbd, such as [mariadb] or [server].

   For example:

   [mariadb]
   log_error                              = mariadbd.err
   character_set_server                   = utf8
   collation_server                       = utf8_general_ci
   log_bin                                = mariadb-bin
   log_bin_index                          = mariadb-bin.index
   relay_log                              = mariadb-relay
   relay_log_index                        = mariadb-relay.index
   log_slave_updates                      = ON
   gtid_strict_mode                       = ON
   columnstore_use_import_for_batchinsert = ALWAYS
   
   # This must be unique on each cluster node
   server_id                              = 1
   

4. In Debian and Ubuntu, a bundled configuration file must be modified for multi-node Enterprise ColumnStore.

   In /etc/mysql/mariadb.conf.d/50-server.cnf, comment out the line that sets the bind_address system variable to 127.0.0.1:

   # Commented out for multi-node Enterprise ColumnStore
   # bind-address            = 127.0.0.1
   

Configure the Mandatory Utility User Account

Multi-node Enterprise ColumnStore requires a mandatory utility user account. By default, it connects to the server using the root user with no password. MariaDB Enterprise Server 10.5 will reject this login attempt by default, so you will need to configure Enterprise ColumnStore to use a different user account and password.

The following directions are for configuring Enterprise ColumnStore to use a different user account and password using the mcsSetConfig command. Directions for creating the user account are in the Create the Mandatory Utility User Account section.

For example, to configure Enterprise ColumnStore to use the cross_engine user account to connect to the server at 127.0.0.1:

$ sudo mcsSetConfig CrossEngineSupport Host 127.0.0.1

$ sudo mcsSetConfig CrossEngineSupport Port 3306

$ sudo mcsSetConfig CrossEngineSupport User cross_engine

$ sudo mcsSetConfig CrossEngineSupport Password cross_engine_passwd

Configure the S3 Storage Manager

When you want to use S3-compatible storage for Enterprise ColumnStore, you must configure Enterprise ColumnStore's S3 Storage Manager to use S3-compatible storage.

To configure Enterprise ColumnStore to use S3-compatible storage, edit /etc/columnstore/storagemanager.cnf:

[ObjectStorage]
…
service = S3
…
[S3]
bucket = your_columnstore_bucket_name
endpoint = your_s3_endpoint
aws_access_key_id = your_s3_access_key_id
aws_secret_access_key = your_s3_secret_key
# iam_role_name = your_iam_role
# sts_region = your_sts_region
# sts_endpoint = your_sts_endpoint
# ec2_iam_mode=enabled

[Cache]
cache_size = your_local_cache_size
path = your_local_cache_path

The S3-compatible object storage options are configured under [S3]:

• The bucket option must be set to the name of the bucket that you created in the Create an S3 Bucket step.

• The endpoint option must be set to the endpoint for the S3-compatible object storage.

• The aws_access_key_id and aws_secret_access_key options must be set to the access key ID and secret access key for the S3-compatible object storage.

• To use a specific IAM role, you must uncomment and set iam_role_name, sts_region, and sts_endpoint.

• To use the IAM role assigned to an EC2 instance, you must uncomment ec2_iam_mode=enabled.

The local cache options are configured under [Cache]:

• The cache_size option is set to 2 GB by default.

• The path option is set to /var/lib/columnstore/storagemanager/cache by default.

Ensure that the specified path has sufficient storage space for the specified cache size.

Update the Bash Profile

MariaDB ColumnStore 1.2 shipped with a columnstoreAlias.sh script, which created a set of aliases for various commands. References to this script should be removed to ensure that the commands below call the MariaDB Enterprise ColumnStore 5 binaries in /usr/bin and not the MariaDB ColumnStore 1.2 aliases.

Check the following locations:

• ~/.bash_profile

• /etc/profile.d/

Start the Enterprise ColumnStore Services

The Enterprise Server. Enterprise ColumnStore, and CMAPI services can be started using the systemctl command. In case the services were started during the installation process, use the restart command to ensure that the services pick up the new configuration.

Perform the following procedure on all nodes:

1. Start and enable the MariaDB Enterprise Server service, so that it starts automatically upon reboot:

   $ sudo systemctl restart mariadb
   

   $ sudo systemctl enable mariadb
   

2. Start and disable the MariaDB Enterprise ColumnStore service, so that it does not start automatically upon reboot:

   $ sudo systemctl restart mariadb-columnstore
   

   $ sudo systemctl disable mariadb-columnstore
   

   Note

   The Enterprise ColumnStore service should not be enabled in a multi-node deployment. The Enterprise ColumnStore service will be started as-needed by the CMAPI service, so it does not need to start automatically upon reboot.

3. Start and enable the CMAPI service, so that it starts automatically upon reboot:

   $ sudo systemctl restart mariadb-columnstore-cmapi
   

   $ sudo systemctl enable mariadb-columnstore-cmapi
   

Create the Mandatory Utility User Account

The credentials for the mandatory utility user account were previously configured in the Configure the Mandatory Utility User Account section. The user account must also be created and granted the necessary privileges to access data.

The user account only needs to be created on the primary server. It will be replicated to the replica servers.

1. Connect to the primary server using MariaDB Client using the root@localhost user account:

   $ sudo mariadb
   

2. Create the user account with the CREATE USER statement:

   CREATE USER 'cross_engine'@'127.0.0.1'
      IDENTIFIED BY "cross_engine_passwd";
   

   Note

   Please choose the same user name and password that was configured in the Configure the Mandatory Utility User Account section.

3. Grant the user account SELECT privileges on all databases with the GRANT statement:

   GRANT SELECT, PROCESS ON *.*
      TO 'cross_engine'@'127.0.0.1';
   

Create the Replication User

The deployment requires MariaDB Replication, so a replication user account must be created and granted sufficient privileges to perform replication.

The user account only needs to be created on the primary server. It will be replicated to the replica servers.

1. Connect to the primary server using MariaDB Client using the root@localhost user account:

   $ sudo mariadb
   

2. Create the user account with the CREATE USER statement:

   CREATE USER 'repl'@'192.0.2.%'
      IDENTIFIED BY 'passwd';
   

   Replace the referenced IP address with the relevant address for your environment.

   Ensure that the user account can connect from the IP address of all replicas.

   Note

   Please choose a password that meets your organization's password policies. If your MariaDB Enterprise Server instance has a password validation plugin installed, then the password should also meet the configured requirements.

   By default, MariaDB Enterprise Server installs the simple_password_check plugin. Its requirements are configured by the simple_password_check_digits, simple_password_check_letters_same_case, simple_password_check_minimal_length, and simple_password_check_other_characters system variables.

3. Grant the user account several global privileges with the GRANT statement.

   The required permissions depend on the version of MariaDB Enterprise Server that is being used.

   In ES 10.5.8-5 and later, the following privileges are required:

   GRANT REPLICA MONITOR,
      REPLICATION REPLICA,
      REPLICATION REPLICA ADMIN,
      REPLICATION MASTER ADMIN
      ON *.*
      TO 'repl'@'192.0.2.%';
   

   In ES 10.5.6-4 and before, the following privileges are required:

   GRANT BINLOG MONITOR,
      REPLICATION REPLICA,
      REPLICATION REPLICA ADMIN,
      REPLICATION MASTER ADMIN
      ON *.*
      TO 'repl'@'192.0.2.%';
   

4. This user account will be used to configure replication in the Configure MariaDB Replication section.

Create the MaxScale User

The deployment requires MariaDB MaxScale, so a MaxScale user account must be created and granted sufficient privileges to manage and monitor the cluster.

The user account only needs to be created on the primary server. It will be replicated to the replica servers.

1. Connect to the primary server using MariaDB Client using the root@localhost user account:

   $ sudo mariadb
   

2. Create the user account with the CREATE USER statement:

   CREATE USER 'mxs'@'192.0.2.%'
      IDENTIFIED BY 'passwd';
   

   Replace the referenced IP address with the relevant address for your environment.

   Ensure that the user account can connect from the IP address of the MaxScale instance.

   Note

   Please choose a password that meets your organization's password policies. If your MariaDB Enterprise Server instance has a password validation plugin installed, then the password should also meet the configured requirements.

   By default, MariaDB Enterprise Server installs the simple_password_check plugin. Its requirements are configured by the simple_password_check_digits, simple_password_check_letters_same_case, simple_password_check_minimal_length, and simple_password_check_other_characters system variables.

3. Grant the user account several global privileges and the SELECT privilege on the system database with the GRANT statement.

   The required permissions depend on the version of MariaDB Enterprise Server that is being used.

   In ES 10.5.8-5 and later, the following privileges are required:

   GRANT BINLOG ADMIN,
      READ_ONLY ADMIN,
      RELOAD,
      REPLICA MONITOR,
      REPLICATION MASTER ADMIN,
      REPLICATION REPLICA ADMIN,
      REPLICATION REPLICA,
      SHOW DATABASES
      ON *.*
      TO 'mxs'@'192.0.2.%';
   

   GRANT SELECT
      ON *.*
      TO 'mxs'@'192.0.2.%';
   

   In ES 10.5.6-4 and before, the following privileges are required:

   GRANT BINLOG ADMIN,
      BINLOG MONITOR,
      READ_ONLY ADMIN,
      RELOAD,
      REPLICATION MASTER ADMIN,
      REPLICATION REPLICA ADMIN,
      REPLICATION REPLICA,
      SHOW DATABASES
      ON *.*
      TO 'mxs'@'192.0.2.%';
   

   GRANT SELECT
      ON *.*
      TO 'mxs'@'192.0.2.%';
   

4. This user account will be used to configure MaxScale in the Configure MaxScale section.

Configure MariaDB Replication

Multi-node Enterprise ColumnStore requires MariaDB Replication, which must be configured. Perform the following steps on each replica server.

1. Connect to the replica server using MariaDB Client using the root@localhost user account:

   $ sudo mariadb
   

2. Use the CHANGE MASTER TO statement to configure the replica server to replicate from the primary server:

   CHANGE MASTER TO
      MASTER_HOST='192.0.2.1',
      MASTER_USER='repl',
      MASTER_PASSWORD='passwd',
      MASTER_USE_GTID=slave_pos;
   

3. Start replication using the START REPLICA statement:

   START REPLICA;
   

4. Confirm that replication is working using the SHOW REPLICA STATUS statement:

   SHOW REPLICA STATUS;
   

5. Ensure that the replica server cannot accept local writes by setting the read_only system variable to ON using the SET GLOBAL statement:

   SET GLOBAL read_only=ON;
   

Initiate Primary Server using CMAPI

The primary server needs to be initiated using the CMAPI. For more information about the CMAPI, see Working with CMAPI.

1. Create an API key for the cluster.

   This API key should be stored securely and kept confidential, because it can be used to add cluster nodes to the multi-node Enterprise ColumnStore deployment.

   For example, to create a random 256-bit API key using openssl rand:

   $ openssl rand -hex 32
   93816fa66cc2d8c224e62275bd4f248234dd4947b68d4af2b29671dd7d5532dd
   

   This document will use the following API key in further examples, but users should create their own instead: 93816fa66cc2d8c224e62275bd4f248234dd4947b68d4af2b29671dd7d5532dd

2. Add the primary server to the cluster and set the API key using curl to send the command to the CMAPI Server.

   The new API key needs to be provided as part of the X-API-key HTML header.

   The output can be piped to jq, so that the JSON results are pretty-printed.

   For example, if the primary server's host name is mcs1 and its IP address is 192.0.2.1:

   • With CMAPI 1.4 and later, send the node command:

     $ curl -k -s -X PUT https://mcs1:8640/cmapi/0.4.0/cluster/node \
        --header 'Content-Type:application/json' \
        --header 'x-api-key:93816fa66cc2d8c224e62275bd4f248234dd4947b68d4af2b29671dd7d5532dd' \
        --data '{"timeout":120, "node": "192.0.2.1"}' \
        | jq .
     

   • With CMAPI 1.3 and earlier, send the add-node command:

     $ curl -k -s -X PUT https://mcs1:8640/cmapi/0.4.0/cluster/add-node \
        --header 'Content-Type:application/json' \
        --header 'x-api-key:93816fa66cc2d8c224e62275bd4f248234dd4947b68d4af2b29671dd7d5532dd' \
        --data '{"timeout":120, "node": "192.0.2.1"}' \
        | jq .
     

   Example output:

   {
     "timestamp": "2020-10-28 00:39:14.672142",
     "node_id": "192.0.2.1"
   }
   

3. Check the status of the new cluster node by using curl to send the status command to the CMAPI Server:

   $ curl -k -s https://mcs1:8640/cmapi/0.4.0/cluster/status \
      --header 'Content-Type:application/json' \
      --header 'x-api-key:93816fa66cc2d8c224e62275bd4f248234dd4947b68d4af2b29671dd7d5532dd' \
      | jq .
   

   Example output:

   {
     "timestamp": "2020-12-15 00:40:34.353574",
     "192.0.2.1": {
       "timestamp": "2020-12-15 00:40:34.362374",
       "uptime": 11467,
       "dbrm_mode": "master",
       "cluster_mode": "readwrite",
       "dbroots": [
         "1"
       ],
       "module_id": 1,
       "services": [
         {
           "name": "workernode",
           "pid": 19202
         },
         {
           "name": "controllernode",
           "pid": 19232
         },
         {
           "name": "PrimProc",
           "pid": 19254
         },
         {
           "name": "ExeMgr",
           "pid": 19292
         },
         {
           "name": "WriteEngine",
           "pid": 19316
         },
         {
           "name": "DMLProc",
           "pid": 19332
         },
         {
           "name": "DDLProc",
           "pid": 19366
         }
       ]
     }
   

Initiate Replica Servers using CMAPI

The replica servers need to be initiated using the CMAPI. For more information about the CMAPI, see Working with CMAPI.

1. For each replica server, use curl to send the command to the primary server's CMAPI Server.

   The previously set API key needs to be provided as part of the X-API-key HTML header.

   The output can be piped to jq, so that the JSON results are pretty-printed.

   For example, if the primary server's host name is mcs1 and the replica server's IP address is 192.0.2.2:

   • With CMAPI 1.4 and later, send the node command:

     $ curl -k -s -X PUT https://mcs1:8640/cmapi/0.4.0/cluster/node \
        --header 'Content-Type:application/json' \
        --header 'x-api-key:93816fa66cc2d8c224e62275bd4f248234dd4947b68d4af2b29671dd7d5532dd' \
        --data '{"timeout":120, "node": "192.0.2.2"}' \
        | jq .
     

   • With CMAPI 1.3 and earlier, send the add-node command:

     $ curl -k -s -X PUT https://mcs1:8640/cmapi/0.4.0/cluster/add-node \
        --header 'Content-Type:application/json' \
        --header 'x-api-key:93816fa66cc2d8c224e62275bd4f248234dd4947b68d4af2b29671dd7d5532dd' \
        --data '{"timeout":120, "node": "192.0.2.2"}' \
        | jq .
     

   Example output:

   {
     "timestamp": "2020-10-28 00:42:42.796050",
     "node_id": "192.0.2.2"
   }
   

2. After all replica servers have been added, use curl to send the status command to the CMAPI Server.

   The previously set API key needs to be provided as part of the X-API-key HTML header.

   The output can be piped to jq, so that the JSON results are pretty-printed.

   For example, if the primary server's host name is mcs1:

   $ curl -k -s https://mcs1:8640/cmapi/0.4.0/cluster/status \
      --header 'Content-Type:application/json' \
      --header 'x-api-key:93816fa66cc2d8c224e62275bd4f248234dd4947b68d4af2b29671dd7d5532dd' \
      | jq .
   

   Use the output to confirm that all cluster nodes have been successfully added.

   Example output:

   {
     "timestamp": "2020-12-15 00:40:34.353574",
     "192.0.2.1": {
       "timestamp": "2020-12-15 00:40:34.362374",
       "uptime": 11467,
       "dbrm_mode": "master",
       "cluster_mode": "readwrite",
       "dbroots": [
         "1"
       ],
       "module_id": 1,
       "services": [
         {
           "name": "workernode",
           "pid": 19202
         },
         {
           "name": "controllernode",
           "pid": 19232
         },
         {
           "name": "PrimProc",
           "pid": 19254
         },
         {
           "name": "ExeMgr",
           "pid": 19292
         },
         {
           "name": "WriteEngine",
           "pid": 19316
         },
         {
           "name": "DMLProc",
           "pid": 19332
         },
         {
           "name": "DDLProc",
           "pid": 19366
         }
       ]
     },
     "192.0.2.2": {
       "timestamp": "2020-12-15 00:40:34.428554",
       "uptime": 11437,
       "dbrm_mode": "slave",
       "cluster_mode": "readonly",
       "dbroots": [
         "2"
       ],
       "module_id": 2,
       "services": [
         {
           "name": "workernode",
           "pid": 17789
         },
         {
           "name": "PrimProc",
           "pid": 17813
         },
         {
           "name": "ExeMgr",
           "pid": 17854
         },
         {
           "name": "WriteEngine",
           "pid": 17877
         }
       ]
     },
     "192.0.2.3": {
       "timestamp": "2020-12-15 00:40:34.428554",
       "uptime": 11437,
       "dbrm_mode": "slave",
       "cluster_mode": "readonly",
       "dbroots": [
         "2"
       ],
       "module_id": 2,
       "services": [
         {
           "name": "workernode",
           "pid": 17789
         },
         {
           "name": "PrimProc",
           "pid": 17813
         },
         {
           "name": "ExeMgr",
           "pid": 17854
         },
         {
           "name": "WriteEngine",
           "pid": 17877
         }
       ]
     },
     "num_nodes": 3
   }
   

Install MaxScale via APT (Debian, Ubuntu)

On the MaxScale instance, perform the following steps to install MaxScale.

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

2. Configure the APT package repository.

   Enterprise ColumnStore 5 requires MaxScale 6. Pass the version to install using the --mariadb-maxscale-version flag to the mariadb_es_repo_setup script.

   To configure APT package repositories:

   $ sudo apt install wget
   
   $ wget https://dlm.mariadb.com/enterprise-release-helpers/mariadb_es_repo_setup
   
   $ echo "cfcd35671125d657a212d92b93be7b1f4ad2fda58dfa8b5ab4b601bf3afa4eae  mariadb_es_repo_setup" \
       | sha256sum -c -
   
   $ chmod +x mariadb_es_repo_setup
   
   $ sudo ./mariadb_es_repo_setup --token="CUSTOMER_DOWNLOAD_TOKEN" --apply \
      --mariadb-maxscale-version="6"
   
   $ sudo apt update
   

3. Install MariaDB MaxScale and package dependencies:

   $ sudo apt install maxscale
   

4. Configure MaxScale.

   Installation only loads MariaDB MaxScale to the system. MariaDB MaxScale requires configuration before MaxScale is ready for use.

Replace Default Configuration

The default /etc/maxscale.cnf must be replaced.

Replace the default /etc/maxscale.cnf with the following configuration:

[maxscale]
threads=auto
admin_host=0.0.0.0
admin_secure_gui=false

Start the MaxScale Service

The MaxScale service must be started.

In case the service was started during the installation process, use the restart command to ensure that it picks up the new configuration:

$ sudo systemctl restart maxscale

Configure MaxScale with the REST API

The following sections will use MaxScale's REST API to configure MaxScale.

MaxScale provides several methods to use the REST API:

The examples in the sections below will use MaxCtrl.

Configure Servers with REST API

MaxScale needs to be configured to recognize the cluster nodes. We can use the REST API to create the servers in MaxScale.

1. Determine which server parameters you need to configure.

   Mandatory parameters for Server objects:

   Parameter	Description
   type	Set the module type to server.
   address	Set the IP address for the MariaDB Enterprise Server.
   port	Set the port the MariaDB Enterprise Server listens on.
   protocol	Set the protocol to MariaDBBackend to connect the Server.

2. Configure MaxScale to recognize each server using MaxCtrl or another supported REST API access method.

   With MaxCtrl, we can use the create server command.

   $ maxctrl create server mcs1 192.0.2.1
   $ maxctrl create server mcs2 192.0.2.2
   $ maxctrl create server mcs3 192.0.2.3
   

   As the first argument, provide a name for the server.

   As the second argument, provide the IP address for the server. Replace the referenced IP addresses and host names with the relevant values for your environment.

Configure MariaDB Monitor with REST API

MaxScale can use MariaDB Monitor (mariadbmon) to monitor the cluster nodes. We can use the REST API to configure the monitor.

1. Determine which parameters for MariaDB Monitor (mariadbmon) you need to configure.

   Mandatory parameters for MariaDB Monitor (mariadbmon) to obtain high availability:

   Parameter	Description
   type	Set the type to monitor.
   module	Set to mariadbmon for MariaDB Replication.
   servers	Set to a comma-separated list of the Server object names. Set to the names of the servers created in the Configure Servers with the REST API section.
   user	Set to the user MariaDB MaxScale uses to connect to the Servers. In the Create the MaxScale User section, we called this user mxs.
   password	Set to the password MariaDB MaxScale uses to authenticate on the Servers.
   replication_user	Set to the user that is used for replication. In the Create the Replication User section, we called this user repl.
   replication_password	Set to the password used to authenticate for replication.
   auto_failover	Enables Automatic Failover for MariaDB Replication deployments, allowing the monitor to respond to a master server failure by reconfiguring a replica server to operate as the new master server. Set to true.
   auto_rejoin	Enables Automatic Rejoin for MariaDB Replication deployments, allowing the monitor to reconfigure replica servers that were down during Automatic Failover to use the new master server. Set to true.
   enforce_read_only_slaves	Ensures that replicas are read-only. Set to true.
   monitor_interval	Sets the frequency that MaxScale checks the back-end servers. A good value is 1000.
   detect_replication_lag	Enables replication lag detection. Set to true.

2. Configure MaxScale to start the monitor using MaxCtrl or another supported REST API access method.

   With MaxCtrl, we can use the create monitor command:

   $ maxctrl create monitor mcs_monitor mariadbmon \
      --servers mcs1 mcs2 mcs3 \
      --monitor-user=mxs \
      --monitor-password=passwd \
      replication_user=repl \
      replication_password=passwd \
      auto_failover=true \
      auto_rejoin=true \
      enforce_read_only_slaves=true \
      monitor_interval=1000 \
      detect_replication_lag=true
   

   The name of the monitor is provided as the first argument.

   The module parameter is provided as the second argument.

   The servers parameter can be set with the --servers option.

   The user parameter can be set with the --monitor-user option.

   The password parameter can be set with the --monitor-password option.

   The rest of the parameters are provided as key=value pairs.

Configure Read/Write Split Router with REST API

Use MaxScale's Read/Write Split Router (readwritesplit) to load-balance traffic between the cluster nodes.

1. Determine which parameters for Read/Write Split Router (readwritesplit) you need to configure.

   Mandatory parameters for Read/Write Split Router (readwritesplit):

   Parameter	Description
   type	Set the module type as service.
   router	Use to set the type of router you want to use for the service. For the Read/Write Split router, set to readwritesplit.
   servers	Set as a comma-separated list of the Server object names. Set to the names of the servers created in the Configure Servers with the REST API section.
   user	Set the user for MaxScale to use when connecting to Servers. In the Create the MaxScale User section, we called this user mxs.
   password	Set the password for MaxScale to use authentication when connecting to Servers.

2. Configure MaxScale to start the router using MaxCtrl or another supported REST API access method.

   With MaxCtrl, we can use the create service command:

   $ maxctrl create service mcs_service readwritesplit \
      user=mxs \
      password=passwd \
      --servers mcs1 mcs2 mcs3
   

   The name of the new service is provided as the first argument.

   The router parameter is provided as the second argument.

   The servers parameter can be set with the --servers option.

   The rest of the parameters are provided as key=value pairs.

Configure the Router's Listener with the REST API

The Read/Write Split Router (readwritesplit) needs to have an associated listener, so that it can accept client traffic.

1. Determine which parameters for the listener you need to configure.

   Mandatory parameters for the listener:

   Parameter	Description
   type	Set the module type as a listener.
   service	Use this parameter to connect the listener to a configured routing service.
   protocol	Set this parameter to MariaDBClient to handle incoming client connections.
   port	Set this parameter to specify the port for the MaxScale instance to listen on.

2. Configure MaxScale to start the router's listener using MaxCtrl or another supported REST API access method.

   With MaxCtrl, we can use the create listener command:

   $ maxctrl create listener mcs_service mcs_listener 3306 \
      --protocol=MariaDBClient
   

   The service parameter is provided as the first argument.

   The name of the new listener is provided as the second argument.

   The port parameter is provided as the third argument.

   The protocol parameter can be set with the --protocol option.

Import the Schema

Before data can be imported into the tables, the schema needs to be created.

1. Connect to the primary server using MariaDB Client using the root@localhost user account:

   $ sudo mariadb
   

2. For each database that you are importing, create the database with the CREATE DATABASE statement:

   CREATE DATABASE inventory;
   

3. For each table that you are importing, create the table with the CREATE TABLE statement:

   CREATE TABLE inventory.products (
      product_name varchar(11) NOT NULL DEFAULT '',
      supplier varchar(128) NOT NULL DEFAULT '',
      quantity varchar(128) NOT NULL DEFAULT '',
      unit_cost varchar(128) NOT NULL DEFAULT ''
   ) ENGINE=Columnstore DEFAULT CHARSET=utf8;
   

cpimport

MariaDB Enterprise ColumnStore includes cpimport, which is a command-line utility that is designed to efficiently load data in bulk.

If you dumped your ColumnStore tables into files in the Dump ColumnStore Tables section, then you can import those files.

To import your data from a TSV (tab-separated values) file with cpimport:

$ sudo cpimport -s '\t' inventory products /tmp/inventory-products.tsv

LOAD DATA INFILE

When data is loaded with the LOAD DATA INFILE statement, MariaDB Enterprise ColumnStore loads the data using cpimport, which is a command-line utility that is designed to efficiently load data in bulk.

To import your data from a TSV (tab-separated values) file with LOAD DATA INFILE statement:

LOAD DATA INFILE '/tmp/inventory-products.tsv'
INTO TABLE inventory.products;

Import from Remote Database

MariaDB Enterprise ColumnStore can also import data directly from a remote database. A simple method is to query the table using the SELECT statement, and then pipe the results into cpimport, which is a command-line utility that is designed to efficiently load data in bulk.

To import your data from a remote MariaDB database:

$ mariadb --quick \
   --skip-column-names \
   --execute="SELECT * FROM inventory.products" \
   | cpimport -s '\t' inventory products

Configure AppArmor (Debian, Ubuntu, SLES)

We disabled AppArmor in the AppArmor section, but we have to create an AppArmor profile for Enterprise ColumnStore before re-enabling it. This will ensure that AppArmor does not interfere with Enterprise ColumnStore's functionality.

For information on how to create a profile, see How to create an AppArmor Profile on ubuntu.com.

Configure UFW (Ubuntu)

We disabled UFW in the Stop UFW section. Now we can restart it and configure it.

1. Check if the UFW service is running:

   $ sudo ufw status verbose
   

2. If the UFW service was stopped to perform the installation, start it now:

   $ sudo ufw enable
   

3. Open up the relevant ports using ufw.

   For example, if your cluster nodes are in the 192.0.2.0/24 subnet in the range 192.0.2.1 - 192.0.2.3:

   $ sudo ufw allow from 192.0.2.0/24 to 192.0.2.3 port 3306 proto tcp
   

   $ sudo ufw allow from 192.0.2.0/24 to 192.0.2.3 port 8600:8630 proto tcp
   

   $ sudo ufw allow from 192.0.2.0/24 to 192.0.2.3 port 8640 proto tcp
   

   $ sudo ufw allow from 192.0.2.0/24 to 192.0.2.3 port 8700 proto tcp
   

   $ sudo ufw allow from 192.0.2.0/24 to 192.0.2.3 port 8800 proto tcp
   

4. Reload the runtime configuration:

   $ sudo ufw reload
   

Enterprise Server Service Administration

MariaDB Enterprise Server uses systemctl to administer its service:

Enterprise ColumnStore Service Administration

In a multi-node deployment, the Enterprise ColumnStore service should not be manually started or enabled, because the service will be managed by the CMAPI service.

MariaDB Enterprise ColumnStore uses systemctl to check the status of the Enterprise ColumnStore service:

CMAPI Service Administration

MariaDB Enterprise ColumnStore uses systemctl to administer its CMAPI service:

MaxScale Service Administration

MariaDB MaxScale uses systemctl to administer its service:

Checking Server Status

1. Connect to the server using MariaDB Client using the root@localhost user account:

   $ sudo mariadb
   

   Welcome to the MariaDB monitor.  Commands end with ; or \g.
   Your MariaDB connection id is 38
   Server version: 10.5.16-11-MariaDB-Enterprise MariaDB Enterprise Server
   
   Copyright (c) 2000, 2018, Oracle, MariaDB Corporation Ab and others.
   
   Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
   
   MariaDB [(none)]>
   

Checking System Status

1. Use curl to send the status command to the CMAPI Server using your deployment's API key.

   $ curl -k -s https://mcs1:8640/cmapi/0.4.0/cluster/status \
      --header 'Content-Type:application/json' \
      --header 'x-api-key:93816fa66cc2d8c224e62275bd4f248234dd4947b68d4af2b29671dd7d5532dd' \
      | jq .
   

   Example output:

   {
     "timestamp": "2020-12-15 00:40:34.353574",
     "192.0.2.1": {
       "timestamp": "2020-12-15 00:40:34.362374",
       "uptime": 11467,
       "dbrm_mode": "master",
       "cluster_mode": "readwrite",
       "dbroots": [
         "1"
       ],
       "module_id": 1,
       "services": [
         {
           "name": "workernode",
           "pid": 19202
         },
         {
           "name": "controllernode",
           "pid": 19232
         },
         {
           "name": "PrimProc",
           "pid": 19254
         },
         {
           "name": "ExeMgr",
           "pid": 19292
         },
         {
           "name": "WriteEngine",
           "pid": 19316
         },
         {
           "name": "DMLProc",
           "pid": 19332
         },
         {
           "name": "DDLProc",
           "pid": 19366
         }
       ]
     },
     "192.0.2.2": {
       "timestamp": "2020-12-15 00:40:34.428554",
       "uptime": 11437,
       "dbrm_mode": "slave",
       "cluster_mode": "readonly",
       "dbroots": [
         "2"
       ],
       "module_id": 2,
       "services": [
         {
           "name": "workernode",
           "pid": 17789
         },
         {
           "name": "PrimProc",
           "pid": 17813
         },
         {
           "name": "ExeMgr",
           "pid": 17854
         },
         {
           "name": "WriteEngine",
           "pid": 17877
         }
       ]
     },
     "192.0.2.3": {
       "timestamp": "2020-12-15 00:40:34.428554",
       "uptime": 11437,
       "dbrm_mode": "slave",
       "cluster_mode": "readonly",
       "dbroots": [
         "2"
       ],
       "module_id": 2,
       "services": [
         {
           "name": "workernode",
           "pid": 17789
         },
         {
           "name": "PrimProc",
           "pid": 17813
         },
         {
           "name": "ExeMgr",
           "pid": 17854
         },
         {
           "name": "WriteEngine",
           "pid": 17877
         }
       ]
     },
     "num_nodes": 3
   }
   

Format of URL endpoints for REST API

https://{server}:{port}/cmapi/{version}/{route}/{command}

Example URLs for available endpoints

• https://mcs1:8640/cmapi/0.4.0/cluster/status

• https://mcs1:8640/cmapi/0.4.0/cluster/start

• https://mcs1:8640/cmapi/0.4.0/cluster/shutdown

• https://mcs1:8640/cmapi/0.4.0/cluster/add-node

• https://mcs1:8640/cmapi/0.4.0/cluster/remove-node

Required Request Headers

• 'x-api-key': '93816fa66cc2d8c224e62275bd4f248234dd4947b68d4af2b29671dd7d5532dd'

• 'Content-Type': 'application/json'

Get Status

$ curl -k -s https://mcs1:8640/cmapi/0.4.0/cluster/status \
   --header 'Content-Type:application/json' \
   --header 'x-api-key:93816fa66cc2d8c224e62275bd4f248234dd4947b68d4af2b29671dd7d5532dd' \
   | jq .

Start Cluster

curl -k -s -X PUT https://mcs1:8640/cmapi/0.4.0/cluster/start \
   --header 'Content-Type:application/json' \
   --header 'x-api-key:93816fa66cc2d8c224e62275bd4f248234dd4947b68d4af2b29671dd7d5532dd' \
   --data '{"timeout":20}' \
   | jq .

Stop Cluster

curl -k -s -X PUT https://mcs1:8640/cmapi/0.4.0/cluster/shutdown \
   --header 'Content-Type:application/json' \
   --header 'x-api-key:93816fa66cc2d8c224e62275bd4f248234dd4947b68d4af2b29671dd7d5532dd' \
   --data '{"timeout":20}' \
   | jq .

Add Node

• With CMAPI 1.4 and later:

  $ curl -k -s -X PUT https://mcs1:8640/cmapi/0.4.0/cluster/node \
     --header 'Content-Type:application/json' \
     --header 'x-api-key:93816fa66cc2d8c224e62275bd4f248234dd4947b68d4af2b29671dd7d5532dd' \
     --data '{"timeout":20, "node": "192.0.2.2"}' \
     | jq .
  

• With CMAPI 1.3 and earlier:

  $ curl -k -s -X PUT https://mcs1:8640/cmapi/0.4.0/cluster/add-node \
     --header 'Content-Type:application/json' \
     --header 'x-api-key:93816fa66cc2d8c224e62275bd4f248234dd4947b68d4af2b29671dd7d5532dd' \
     --data '{"timeout":20, "node": "192.0.2.2"}' \
     | jq .
  

Remove Node

• With CMAPI 1.4 and later:

  $ curl -k -s -X DELETE https://mcs1:8640/cmapi/0.4.0/cluster/node \
     --header 'Content-Type:application/json' \
     --header 'x-api-key:93816fa66cc2d8c224e62275bd4f248234dd4947b68d4af2b29671dd7d5532dd' \
     --data '{"timeout":20, "node": "192.0.2.2"}' \
     | jq .
  

• With CMAPI 1.3 and earlier:

  $ curl -k -s -X PUT https://mcs1:8640/cmapi/0.4.0/cluster/remove-node \
     --header 'Content-Type:application/json' \
     --header 'x-api-key:93816fa66cc2d8c224e62275bd4f248234dd4947b68d4af2b29671dd7d5532dd' \
     --data '{"timeout":20, "node": "192.0.2.2"}' \
     | jq .