Skip to main content
This section assumes you’re already familiar with the RegattaDB software modules (SM, SNA, GDD, DCM, Sequencer, RDB) and basic deployment concepts such as a node (a physical or virtual machine in your deployment) and a module (a RegattaDB component running on a node).
RDT (Regatta Deployment Tool) is a command-line tool that automates deploying and managing a self-hosted RegattaDB deployment across one or more nodes. Instead of manually installing packages, configuring storage devices, and issuing SQL management commands on every node yourself (see Manual Deployment), you describe your deployment once in a JSON config file and let RDT drive the whole rollout over SSH: distributing RPMs, installing and configuring modules, starting services, and bringing the database online.

​
What RDT does for you

  • Describes your deployment as config: nodes, storage devices, and modules (SM, SNA, SEQUENCER, GDD, DCM, RDB) all live in a single JSON file that RDT can generate, validate, and edit for you.
  • Connects to your nodes over SSH, in parallel, so setting up a multi-node deployment doesn’t mean repeating the same steps manually on every node.
  • Runs the full deployment pipeline in one command (create-cluster), or step by step if you want more control: distribute RPMs, install packages, configure the node environment, start the System Manager and SNA, register everything with the System Manager, and start RegattaDB.
  • Manages RegattaDB’s lifecycle after deployment: starting and stopping services or RegattaDB itself, resetting its data, cleaning up an installation entirely, and collecting debug information from every node.
  • Probes node hardware (CPU, RAM, NUMA topology, storage devices) over SSH so you don’t have to hand-type it into your config.

​
How this section is organized

  • Prerequisites and Installation: what your control node and RegattaDB nodes need, and how to install the RDT CLI.
  • Command Reference: every RDT command and option in one place, for quick lookup while you work.
  • Configuration: the JSON config schema, and the rdt config commands used to create, edit, validate, and share config files.
  • System Setup: the setup pipeline RDT runs on your nodes, in order, and the commands that create, start, stop, reset, and clean a RegattaDB deployment.
  • Examples: end-to-end walkthroughs, from a single-node QuickStart to a multi-node production topology.
  • Advanced: SSH credentials and global options, running RDT from a container, installing offline, exactly what RDT changes on your nodes’ operating systems, and the NUMA and core-binding details behind module placement.

​
Next steps

New to RDT? Start with Prerequisites and Installation, then follow the Quickstart: Single-Node RegattaDB to deploy RegattaDB end to end.