1. Home
  2. Docs
  3. ClusterControl
  4. User Guide (GUI)
  5. Dashboard
  6. Deploy a Database Cluster
  7. TimeScaleDB

TimeScaleDB

Deploys a new TimeScaleDB standalone or streaming replication cluster. Only TimeScaleDB 9.6 and later are supported. A minimum of two nodes is required for TimeScaleDB streaming replication.

General & SSH Settings

Field Description
SSH User
  • Specify root if you have root credentials.
  • If you use sudo to execute system commands, specify the name that you wish to use here. The user must exist on all nodes. See Operating System User
SSH Key Path
  • Specify the full path of the SSH key (the key must exist in the ClusterControl node) that will be used by SSH User to perform passwordless SSH. See Passwordless SSH.
Sudo Password
  • If you use sudo with a password, specify it here. Ignore this if SSH User is root or sudoer does not need a sudo password.
SSH Port
  • Specify the SSH port for target nodes. ClusterControl assumes SSH is running on the same port on all nodes.
Cluster Name
  • Specify a name for the database.
Install Software
  • Check the box if you use clean and minimal VMs. Existing PostgreSQL dependencies will be removed. New packages will be installed and existing packages will be uninstalled when provisioning the node with the required software. – If unchecked, existing packages will not be uninstalled, and nothing will be installed. This requires that the instances have already provisioned the necessary software
Disable Firewall
  • Check the box to disable the firewall (recommended).
Disable AppArmor/SELinux
  • Check the box to let ClusterControl disable AppArmor (Ubuntu) or SELinux (RedHat/CentOS) if enabled (recommended).

Define PostgreSQL Servers

Field Description
Server Port
  • PostgreSQL server port. Default is 5432.
User
  • Specify the PostgreSQL super user, for example, Postgres.
Password
  • Specify the password for the User.
Version
  • Supported versions are 9.6, 10, 11, and 12.
Repository
  • Use Vendor Repositories – Provision software by setting up and using the database vendor’s preferred software repository. ClusterControl will always install the latest version of what is provided by the database vendor repository.
  • Do Not Setup Vendor Repositories – Provision software by using repositories already set up on the nodes. The User has to set up the software repository manually on each database node and ClusterControl will use this repository for deployment. This is good if the database nodes are running without internet connections.
  • Create New Repositories – Create and mirror the current database vendor’s repository and then deploy using the local mirrored repository. This is a preferred option when you have to scale the PostgreSQL in the future, to ensure the newly provisioned node will always have the same version as the rest of the members.

Define Topology

Field Description
Master A – IP/Hostname
  • Specify the IP address of the TimeScaleDB master node. Press ‘Enter’ once specified so ClusterControl can verify the node reachability via passwordless SSH.
Add slaves to master A
  • Add a slave node connected to master A. Press ‘Enter’ to add more slaves.

Deployment Summary

Field Description
Synchronous Replication
  • Toggle if you would like to use synchronous streaming replication between the master and the chosen slave. Synchronous replication can be enabled per individual slave node with a considerable performance overhead.
Deploy
  • Starts the TimeScaleDB standalone or replication deployment.
Was this article helpful to you? Yes No