Creating and Managing PostgreSQL Clusters¶
Use the DBaaS workflow to create clusters, view cluster details, manage nodes, and configure database backups.
Getting Started¶
Database as a Service (DBaaS) can be accessed by Navigating to Databases → PostgreSQL from the left navigation menu in the Cloud Portal. This opens the Cluster List page, which serves as the main interface for viewing, creating, and managing PostgreSQL database clusters.
Cluster Management Operations¶
DBaaS provides a comprehensive set of lifecycle management capabilities for PostgreSQL clusters. From the Cluster List and Cluster Details pages, users can perform the following operations:
| Operation | Description |
|---|---|
| Create Cluster | Provision a new PostgreSQL database cluster using the guided configuration workflow. |
| List Cluster | View list of the existing clusters which are already created. |
| View Cluster | View the details of the cluster including the nodes, backups..etc. |
| Edit Cluster | Modify cluster configuration and metadata after deployment. |
| Delete Cluster | Permanently remove a database cluster that is no longer required. |
| Add Nodes | Scale out the cluster by adding additional database nodes. |
| Remove Nodes | Scale in the cluster by removing existing database nodes. |
| Promote to Primary | Designate a selected node as the primary node for the cluster. |
| Manage Backups | View, create, and manage database backups for data protection and recovery. |
| Edit Storage | Increase the allocated storage capacity of a cluster as business requirements grow. |
Creating a PostgreSQL Cluster¶
- From the Cluster List screen, click Create on top right corner
- Choose the PostgreSQL version.
- Click Next.
- Choose the T-shirt size of the cluster nodes.
- Click Next.
- Enter the cluster configuration listed below and then Click Submit.
| Configuration | Description |
|---|---|
| Business Group | The business group for the cluster. |
| Region | The region where the cluster is created. |
| Environment | The target environment. |
| VPC | The target VPC. |
| Subnet | The subnet for the cluster. |
| Cluster Name | The cluster name. |
| Cluster Description | Optional description for the cluster. |
| No. of Nodes | Number of nodes in the cluster. |
| Load Balancer | Selected by default; uncheck if it is not required. |
| Username | Database username. |
| Password | Strong database password. |
| Confirm Password | Password confirmation. |
| Storage | Default storage is provided and can be increased. |
List Clusters¶
Open Databases > PostgreSQL to view the cluster list. Each cluster appears as a row in the table.
Cluster List page serves as the central management interface for all PostgreSQL database clusters. It provides a consolidated view of existing clusters displaying key information such as cluster name, Description, DB version, node count.
Viewing Clusters¶
Open Databases > PostgreSQL to view the cluster list. Each cluster appears as a row in the table.
Click a cluster name to open the cluster details page.
Cluster Details¶
The cluster details page has following tabs:
| Tab | Purpose |
|---|---|
| Details | Shows general cluster information and database details. |
| Nodes | Lists nodes attached to the cluster and provides node actions. |
| Database Backup | Shows existing backups, backup creation options, and restore history. |
| History | Shows manual changes made to the cluster. |
Details Tab¶
| Section | Fields |
|---|---|
| General Information | Cluster name, cluster description, number of nodes, created by, created at, status, and load balancer. |
| Database Details | DB version and replication type. |
Nodes Tab¶
The Nodes tab provides:
- A table of nodes attached to the cluster.
- An option to add a replica node.
- An option to delete an existing node.
- An option to promote a replica to primary.
- A link to the node details page.
Click a node name to open its details page. The node details page is similar to a VM details page. Provide the details and Click Submit
To add a replica, click Add Replica from the top-right corner which open a form sliding from right side.
To delete a node, click the three-dot in the last column in the node table row and click Delete in pop up menu.
To Promote a replica to Primary, click the three-dot in the last column in the node table row and click Make Primar in pop up menu.
Backup Tab¶
The Database Backup tab lists existing backups and provides backup creation options.
View Backups¶
Open the Database Backup tab to list existing backups in a table. The table includes details such as backup date, size, and type.
Create Periodic Backups¶
- Click Manage Backups.
- Select Periodic Backup.
- Enter the required backup details.
- Select a backup regime.
- Save the configuration.
| Field | Description |
|---|---|
| Buckets | Target bucket for backups. |
| Access Key ID | Access key ID used for backup access. |
| Access Key Secret | Access key secret used for backup access. |
| Backup Regime | Disable Backup, Daily Backup, Weekly Backup, or Monthly Backup. |
Selecting Daily Backup, Weekly Backup, or Monthly Backup enables the save action.
Create On-Demand Backup¶
- Click Manage Backups.
- Select Backup Now.
- Enter the bucket and access key details.
- Click Submit.
Restore Backup¶
Backups can be restored from both scheduled backups and on-demand backups, providing flexibility for data recovery and disaster recovery scenarios.
The DBaaS platform supports the following backup restoration options:
Restore Backup¶
Restores the database cluster to the state captured in the selected backup. This option can be used with both scheduled and on-demand backups.
Click three-dots in the last of the backup row and click Restore Backup from pop up menu.
Restore Backup (Point-in-Time Recovery - PITR)¶
Restores the database cluster to a specific point in time within the available recovery window. This option is useful for recovering from accidental data modifications, deletions, or other events that occurred after the last backup was taken.
Click three-dots in the last of the backup row and click Restore Backup PITR from pop up menu.
History¶
The History tab shows manual changes made to the cluster.
Cluster Actions¶
Use the action button in the top-right corner to edit:
- Business Group.
- Name.
- Description.