Deploy ColumnStore Object Storage Topology with MariaDB Enterprise Server 10.6
This page is part of MariaDB's Documentation.
The parent of this page is: Deploy ColumnStore Object Storage Topology
Topics on this page:
Overview
This procedure describes the deployment of the ColumnStore Object Storage topology with MariaDB Enterprise Server 10.6, MariaDB Enterprise ColumnStore 23.10, and MariaDB MaxScale 22.08.
MariaDB Enterprise ColumnStore 23.10 is a columnar storage engine for MariaDB Enterprise Server 10.6. Enterprise ColumnStore is suitable for Online Analytical Processing (OLAP) workloads.
This procedure has 9 steps, which are executed in sequence.
This procedure represents basic product capability and deploys 3 Enterprise ColumnStore nodes and 1 MaxScale node.
This page provides an overview of the topology, requirements, and deployment procedures.
Please read and understand this procedure before executing.
Procedure Steps
Step | Description |
---|---|
Step 1 | |
Step 2 | |
Step 3 | |
Step 4 | |
Step 5 | |
Step 6 | |
Step 7 | |
Step 8 | |
Step 9 |
Support
Customers can obtain support by submitting a support case.
Components
The following components are deployed during this procedure:
Component | Function |
---|---|
Modern SQL RDBMS with high availability, pluggable storage engines, hot online backups, and audit logging. | |
Database proxy that extends the availability, scalability, and security of MariaDB Enterprise Servers |
MariaDB Enterprise Server Components
Component | Description |
---|---|
|
MariaDB MaxScale Components
Component | Description |
---|---|
Listener | Listens for client connections to MaxScale then passes them to the router service |
MariaDB Monitor | Tracks changes in the state of MariaDB Enterprise Servers. |
Read Connection Router | Routes connections from the listener to any available Enterprise ColumnStore node |
Read/Write Split Router | Routes read operations from the listener to any available Enterprise ColumnStore node, and routes write operations from the listener to a specific server that MaxScale uses as the primary server |
Server Module | Connection configuration in MaxScale to an Enterprise ColumnStore node |
Topology
The MariaDB Enterprise ColumnStore topology with Object Storage delivers production analytics with high availability, fault tolerance, and limitless data storage by leveraging S3-compatible storage.
The topology consists of:
One or more MaxScale nodes
An odd number of ColumnStore nodes (minimum of 3) running ES, Enterprise ColumnStore, and CMAPI
The MaxScale nodes:
Monitor the health and availability of each ColumnStore node using the MariaDB Monitor (mariadbmon)
Accept client and application connections
Route queries to ColumnStore nodes using the Read/Write Split Router (readwritesplit)
The ColumnStore nodes:
Receive queries from MaxScale
Execute queries
Use S3-compatible object storage for data
Use shared local storage for the Storage Manager directory
Requirements
These requirements are for the ColumnStore Object Storage topology when deployed with MariaDB Enterprise Server 10.6, MariaDB Enterprise ColumnStore 23.10, and MariaDB MaxScale 22.08.
Node Count
MaxScale nodes, 1 or more are required.
Enterprise ColumnStore nodes, 3 or more are required for high availability. You should always have an odd number of nodes in a multi-node ColumnStore deployment to avoid split brain scenarios.
Operating System
In alignment to the enterprise lifecycle, the ColumnStore Object Storage topology with MariaDB Enterprise Server 10.6, MariaDB Enterprise ColumnStore 23.10, and MariaDB MaxScale 22.08 is provided for:
CentOS Linux 7 (x86_
64) Debian 11 (x86_
64, ARM64) Debian 12 (x86_
64, ARM64) Red Hat Enterprise Linux 7 (x86_
64) Red Hat Enterprise Linux 8 (x86_
64, ARM64) Red Hat Enterprise Linux 9 (x86_
64, ARM64) Rocky Linux 8 (x86_
64, ARM64) Rocky Linux 9 (x86_
64, ARM64) Ubuntu 20.04 LTS (x86_
64, ARM64) Ubuntu 22.04 LTS (x86_
64, ARM64)
Minimum Hardware Requirements
MariaDB Enterprise ColumnStore's minimum hardware requirements are not intended for production environments, but the minimum hardware requirements can be appropriate for development and test environments. For production environments, see the recommended hardware requirements instead.
The minimum hardware requirements are:
Component | CPU | Memory |
---|---|---|
MaxScale node | 4+ cores | 4+ GB |
Enterprise ColumnStore node | 4+ cores | 16+ GB |
MariaDB Enterprise ColumnStore will refuse to start if the system has less than 3 GB of memory.
If Enterprise ColumnStore is started on a system with less memory, the following error message will be written to the ColumnStore system log called crit.log
:
Apr 30 21:54:35 a1ebc96a2519 PrimProc[1004]: 35.668435 |0|0|0| C 28 CAL0000: Error total memory available is less than 3GB.
And the following error message will be raised to the client:
ERROR 1815 (HY000): Internal error: System is not ready yet. Please try again.
Recommended Hardware Requirements
MariaDB Enterprise ColumnStore's recommended hardware requirements are intended for production analytics.
The recommended hardware requirements are:
Component | CPU | Memory |
---|---|---|
MaxScale node | 8+ cores | 16+ GB |
Enterprise ColumnStore node | 64+ cores | 128+ GB |
Storage Requirements
The ColumnStore Object Storage topology requires the following storage types:
Storage Type | Description |
---|---|
The ColumnStore Object Storage topology uses S3-compatible object storage to store data. | |
The ColumnStore Object Storage topology uses shared local storage for the Storage Manager directory to store metadata. |
S3-Compatible Object Storage Requirements
The ColumnStore Object Storage topology uses 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:
The use of non-cloud and non-hardware providers is at your own risk.
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
Cohesity S3
Dell EMC
IBM Cloud Object Storage
Seagate Lyve Rack
Quantum ActiveScale
Recommended Storage Options
For best results, MariaDB Corporation would recommend the following storage options:
Environment | Object Storage
For Data
| Shared Local Storage
For Storage Manager
|
---|---|---|
AWS | Amazon S3 storage | EBS Multi-Attach or EFS |
GCP | Google Object Storage (S3-compatible) | Filestore |
On-premises | Any S3-compatible object storage | NFS |
Enterprise ColumnStore Management with CMAPI
Enterprise ColumnStore's CMAPI (Cluster Management API) is a REST API that can be used to manage a multi-node Enterprise ColumnStore cluster.
Many tools are capable of interacting with REST APIs. For example, the curl
utility could be used to make REST API calls from the command-line.
Many programming languages also have libraries for interacting with REST APIs.
The examples below show how to use the CMAPI with curl
.
URL Endpoint Format for REST API
https://{server}:{port}/cmapi/{version}/{route}/{command}
For example:
https://mcs1:8640/cmapi/0.4.0/cluster/shutdown
https://mcs1:8640/cmapi/0.4.0/cluster/start
https://mcs1:8640/cmapi/0.4.0/cluster/status
https://mcs1:8640/cmapi/0.4.0/cluster/node
Required Request Headers
'x-api-key': '93816fa66cc2d8c224e62275bd4f248234dd4947b68d4af2b29671dd7d5532dd'
'Content-Type': 'application/json'
x-api-key
can be set to any value of your choice during the first call to the server. Subsequent connections will require this same key.
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
$ 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 .
Remove Node
$ 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 .
Quick Reference
MariaDB Enterprise Server Configuration Management
Method | Description |
---|---|
Configuration File | Configuration files (such as |
Command-line | The server can be started with command-line options that set system-variables and options. |
SQL | Users can set system-variables that support dynamic changes on-the-fly using the SET statement. |
MariaDB Enterprise Server packages are configured to read configuration files from different paths, depending on the operating system. Making custom changes to Enterprise Server default configuration files is not recommended because custom changes may be overwritten by other default configuration files that are loaded later.
To ensure that your custom changes will be read last, create a custom configuration file with the z-
prefix in one of the include directories.
Distribution | Example Configuration File Path |
---|---|
|
|
|
|
MariaDB Enterprise Server Service Management
The systemctl
command is used to start and stop the MariaDB Enterprise Server service.
Operation | Command |
Start |
|
Stop |
|
Restart |
|
Enable during startup |
|
Disable during startup |
|
Status |
|
For additional information, see "Start and Stop Services".
MariaDB Enterprise Server Logs
MariaDB Enterprise Server produces log data that can be helpful in problem diagnosis.
Log filenames and locations may be overridden in the server configuration. The default location of logs is the data directory. The data directory is specified by the datadir system variable.
Log | System Variable/Option | Default Filename |
| ||
MariaDB Enterprise Audit Log |
| |
Slow Query Log |
| |
General Query Log |
| |
|
Enterprise ColumnStore Service Management
The systemctl
command is used to start and stop the ColumnStore service.
Operation | Command |
Start |
|
Stop |
|
Restart |
|
Enable during startup |
|
Disable during startup |
|
Status |
|
In the ColumnStore Object Storage topology, the mariadb-columnstore
service should not be enabled. The CMAPI service restarts Enterprise ColumnStore as needed, so it does not need to start automatically upon reboot.
Enterprise ColumnStore CMAPI Service Management
The systemctl
command is used to start and stop the CMAPI service.
Operation | Command |
Start |
|
Stop |
|
Restart |
|
Enable during startup |
|
Disable during startup |
|
Status |
|
For additional information on endpoints, see "CMAPI".
MaxScale Configuration Management
MaxScale can be configured using several methods. These methods make use of MaxScale's REST API.
Method | Benefits |
---|---|
Command-line utility to perform administrative tasks through the REST API. See MaxCtrl Commands. | |
MaxGUI is a graphical utility that can perform administrative tasks through the REST API. | |
The REST API can be used directly. For example, the |
The procedure on these pages configures MaxScale using MaxCtrl.
MaxScale Service Management
The systemctl
command is used to start and stop the MaxScale service.
Operation | Command |
Start |
|
Stop |
|
Restart |
|
Enable during startup |
|
Disable during startup |
|
Status |
|
For additional information, see "Start and Stop Services".
Next Step
Navigation in the procedure "Deploy ColumnStore Object Storage Topology":