Documentation — Administrator's guide

Prerequisites

Machines

A cluster is made of:

  • one or more SQL brokers: Linux servers that run the synsqld program, with the same Linux user on all of them (the examples use synsql);
  • one or more master brokers: MariaDB servers that keep the dictionary. Two are recommended; do not use more than ten;
  • data brokers: MariaDB servers that store the data. One is the minimum. A table with several copies needs a datacenter with several racks of data brokers.

A machine can play several roles, which is practical for a trial cluster.

On each machine

  • Linux x86-64. The program is built on Rocky Linux 9.
  • On the SQL brokers: the Linux user, a home directory with bin and etc, a backup directory writable by this user, and openssl.
  • On master and data brokers: MariaDB with an empty database and a user that has all privileges on it.
  • Synchronised clocks (NTP, chrony) on all the SQL brokers: the brokers sign their messages with the time, and refuse a signature that is more than two minutes old or new.

Network

  • Between the SQL brokers: their ports (11000 in the sample file, 8888 by default), in both directions, and SSH from the machine where you install.
  • From the SQL brokers to every MariaDB (port 3306 by default).
  • From the clients to the SQL brokers only.
  • The SQL brokers need to reach https://api.synsql.com to download the license, unless you install it by hand (see download).

What you need from us

  • Your license file (license.txt), tied to the identifier of your cluster.
  • The installation kit (synsql, synsqld, install.sh, check_conf.sh, createMasterTables.sql...).

← Limits  |  Create a trial cluster →