> ## Documentation Index
> Fetch the complete documentation index at: https://docs.regatta.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

The Regatta Deployment Tool (RDT) helps you automate the process of setting up a RegattaDB cluster.

## Prerequisites & Dependencies

The RDT will require the following packages on the deployment server (where the RDT is executed):

Linux packages:

* `sshpass`
* `jq`

Python requirements:

* `python3` - version 3.6.8 or above
* `ansible`

These dependencies can be pre-installed manually by the user or left to be installed automatically by the RDT.

<Warning>
  Please note that installing the script dependencies requires an internet connection or having the packages readily available on the server.
</Warning>

### SSH

The RDT utilizes SSH to access all the cluster nodes from the host it is executed on. The SSH connection requires a user with `sudo` permissions to be present on all the cluster nodes. For this document, we will refer to that user as the **deployment\_user**.

<Info>
  The `sudo` permission for the deployment user is required for installing the Regatta RPM packages, configuring the required firewall ports, and ensuring proper storage devices permissions for the `regatta` system-user used by the Regatta modules.
</Info>

## Download

The RDT can be downloaded from a link provided by Regatta Support. The download will include a `tar` archive containing:

1. The Regatta RPM packages for installing Regatta modules and tools
2. A directory containing the RDT and all its components

Downloading the Regatta tar archive can be done directly on one of the cluster nodes (using `wget` or a similar tool) or on an external host and then copied to one of the cluster nodes.

Extract the archive:

```shell theme={null}
tar -zxf regatta-deploy-X.X.X.X.tgz
```

After extracting the archive, a directory named `regatta-deploy` will be created in the location where the `tar` command was executed.