This is the multi-page printable view of this section. Click here to print.
PostgreSQL(DBaaS)
- 1: Overview
- 1.1: Server Type
- 1.2: Monitoring Metrics
- 2: How-to guides
- 2.1: Managing DB Service
- 2.2: DB Backup and Restore
- 2.3: Configuring Read Replica
- 2.4: Connecting to DB Server
- 2.5: Using Extensions
- 3: API Reference
- 4: CLI Reference
- 5: Release Note
1 - Overview
Service Overview
PostgreSQL(DBaaS) is an open-source relational database management system (RDBMS). Samsung Cloud Platform provides an environment that automates PostgreSQL installation and performs management functions for operation through a web-based Console.
PostgreSQL(DBaaS) is designed as a high availability architecture considering storage-based data replication and failover time minimization. To prevent data loss, when the content of the Active server changes, it is synchronously replicated to the Standby server. Read-only servers called Replica for read load distribution and disaster recovery (DR) are provided up to 5. Additionally, in preparation for problems with the DB server or data, it provides automatic backup at a time specified by the user, supporting data recovery at a desired point in time.
Provided Features
PostgreSQL(DBaaS) provides the following features.
- Auto Provisioning: Database (DB) installation and configuration via UI, providing Active-Standby redundancy configuration based on storage replication. Automatic failover to Standby when Active server fails.
- Operation Control Management: Provides function to control running server status. Start, stop, and restart possible for DB issues or to reflect configuration values. For HA configuration, users can directly perform Active-Standby node switching through Switch-over.
- Backup and Recovery: Provides data backup function based on own backup commands. Backup time period and retention period can be set by user, and additional charges are incurred depending on backup capacity. Also provides recovery function for backed up data, where user performs recovery and separate DB is created, recovery proceeds to point in time selected by user (backup storage point, user-specified point). When recovering to user-specified point, recovery point can be set up to 5 minutes/10 minutes/30 minutes/1 hour before current time based on stored backup files and archive files.
- Version Management: Provides version upgrade (Minor) function for some feature improvements and security patches. User can select whether to perform backup according to version upgrade, and if performing backup, backs up data before patch execution then performs DB engine update.
- Replica Configuration: Can configure up to 5 Read Replicas in same/different regions for read load distribution and disaster recovery (DR).
- Audit Settings: Supports audit function for major activities in database.
- Parameter Management: Can modify DB configuration parameters for performance improvement and security.
- Service Status Check: Checks final status of current DB service.
- Monitoring: Can check CPU, memory, DB performance monitoring information through Cloud Monitoring service.
- DB User Management: Manages DB account (user) information registered in DB.
- DB Access Control Management: Can register and cancel access-allowed IPs based on DB accounts registered in DB.
- Archive Management: Can set Archive file retention period (1~35 days) and Archive mode (On/Off) in DB server.
- DB Log Export: Can export logs stored through Audit settings to user’s Object Storage.
- Migration: Supports migration using replication method by synchronizing data with operating database in real time without service interruption.
- OS Kernel Upgrade: Can upgrade OS Kernel for some feature improvements and security patch application.
Components
PostgreSQL(DBaaS) provides pre-verified engine versions and various server types according to open source support policy. Users can select and use according to the service scale they want to configure.
Engine Versions
Engine versions supported by PostgreSQL(DBaaS) are as follows.
Technical support can be used until the supplier’s EoTS (End of Technical Service) date, and the EOS date when new creation stops is set to 6 months before the EoTS date.
EOS and EoTS dates may change according to supplier policy, so please refer to the supplier’s license management policy page for details.
- PostgreSQL: https://www.postgresql.org/support/versioning/
| Provided Version | EOS Date (Samsung Cloud Platform New Creation Stop Date) | EoTS Date (Community Technical Support End Date) |
|---|---|---|
| 14.17 | 2026-07 (Scheduled) | 2026-11-12 |
| 14.18 | 2026-07 (Scheduled) | 2026-11-12 |
| 15.12 | 2027-06 (Scheduled) | 2027-11-11 |
| 15.13 | 2027-06 (Scheduled) | 2027-11-11 |
| 15.14 | 2027-06 (Scheduled) | 2027-11-11 |
| 16.8 | 2028-06 (Scheduled) | 2028-11-09 |
| 16.9 | 2028-06 (Scheduled) | 2028-11-09 |
| 16.10 | 2028-06 (Scheduled) | 2028-11-09 |
| 17.6 | 2029-06 (Scheduled) | 2029-11-08 |
Server Type
Server types supported by PostgreSQL(DBaaS) are as follows.
For details on server types provided by PostgreSQL(DBaaS), see PostgreSQL(DBaaS) Server Type.
Standard db1v2m4
| Category | Example | Detailed Description |
|---|---|---|
| Server Type | Standard | Provided server types
|
| Server Specification | db1 | Provided server specifications
|
| Server Specification | v2 | vCore count
|
| Server Specification | m4 | Memory capacity
|
Prerequisite Services
List of services that must be configured in advance before creating this service. For details, please prepare in advance by referring to the guide provided for each service.
| Service Category | Service | Detailed Description |
|---|---|---|
| Networking | VPC | Service that provides independent virtual network in cloud environment |
1.1 - Server Type
PostgreSQL(DBaaS) server type
PostgreSQL(DBaaS) provides a server type composed of various combinations such as CPU, Memory, Network Bandwidth. When creating PostgreSQL(DBaaS), the Database Engine is installed according to the server type selected for the purpose of use.
The server types supported by PostgreSQL(DBaaS) are as follows.
Standard db1v2m4
Classification | Example | Detailed Description |
|---|---|---|
| Server Type | Standard | Provided server type distinction
|
| Server specification | db1 | Provided server type distinction and generation
|
| Server specification | v2 | Number of vCores
|
| Server specification | m4 | Memory capacity
|
| Fig. PostgreSQL(DBaaS) server type format |
db1 server type
The db1 server type of PostgreSQL(DBaaS) is provided with standard specifications(vCPU, Memory) and is suitable for various database workloads.
Up to 3.3Ghz Intel 3rd generation (Ice Lake) Xeon Gold 6342 Processor Supports up to 16 vCPUs and 256 GB of memory Up to 12.5 Gbps of networking speed
| Classification | Server Type | vCPU | Memory | Network Bandwidth |
|---|---|---|---|---|
| Standard | db1v2m4 | 2 vCore | 4 GB | Up to 10 Gbps |
| Standard | db1v2m8 | 2 vCore | 8 GB | Up to 10 Gbps |
| Standard | db1v2m16 | 2 vCore | 16 GB | Up to 10 Gbps |
| Standard | db1v2m24 | 2 vCore | 24 GB | Up to 10 Gbps |
| Standard | db1v2m32 | 2 vCore | 32 GB | Up to 10 Gbps |
| Standard | db1v4m8 | 4 vCore | 8 GB | Up to 10 Gbps |
| Standard | db1v4m16 | 4 vCore | 16 GB | Up to 10 Gbps |
| Standard | db1v4m32 | 4 vCore | 32 GB | Up to 10 Gbps |
| Standard | db1v4m48 | 4 vCore | 48 GB | Up to 10 Gbps |
| Standard | db1v4m64 | 4 vCore | 64 GB | Up to 10 Gbps |
| Standard | db1v6m12 | 6 vCore | 12 GB | Up to 10 Gbps |
| Standard | db1v6m24 | 6 vCore | 24 GB | Up to 10 Gbps |
| Standard | db1v6m48 | 6 vCore | 48 GB | Up to 10 Gbps |
| Standard | db1v6m72 | 6 vCore | 72 GB | Up to 10 Gbps |
| Standard | db1v6m96 | 6 vCore | 96 GB | Up to 10 Gbps |
| Standard | db1v8m16 | 8 vCore | 16 GB | Up to 10 Gbps |
| Standard | db1v8m32 | 8 vCore | 32 GB | Up to 10 Gbps |
| Standard | db1v8m64 | 8 vCore | 64 GB | Up to 10 Gbps |
| Standard | db1v8m96 | 8 vCore | 96 GB | Up to 10 Gbps |
| Standard | db1v8m128 | 8 vCore | 128 GB | Up to 10 Gbps |
| Standard | db1v10m20 | 10 vCore | 20 GB | Up to 10 Gbps |
| Standard | db1v10m40 | 10 vCore | 40 GB | Up to 10 Gbps |
| Standard | db1v10m80 | 10 vCore | 80 GB | Up to 10 Gbps |
| Standard | db1v10m120 | 10 vCore | 120 GB | Up to 10 Gbps |
| Standard | db1v10m160 | 10 vCore | 160 GB | Up to 10 Gbps |
| Standard | db1v12m24 | 12 vCore | 24 GB | Up to 12.5 Gbps |
| Standard | db1v12m48 | 12 vCore | 48 GB | Up to 12.5 Gbps |
| Standard | db1v12m96 | 12 vCore | 96 GB | Up to 12.5 Gbps |
| Standard | db1v12m144 | 12 vCore | 144 GB | Up to 12.5 Gbps |
| Standard | db1v12m192 | 12 vCore | 192 GB | Up to 12.5 Gbps |
| Standard | db1v14m28 | 14 vCore | 28 GB | Up to 12.5 Gbps |
| Standard | db1v14m56 | 14 vCore | 56 GB | Up to 12.5 Gbps |
| Standard | db1v14m112 | 14 vCore | 112 GB | Up to 12.5 Gbps |
| Standard | db1v14m168 | 14 vCore | 168 GB | Up to 12.5 Gbps |
| Standard | db1v14m224 | 14 vCore | 224 GB | Up to 12.5 Gbps |
| Standard | db1v16m32 | 16 vCore | 32 GB | Up to 12.5 Gbps |
| Standard | db1v16m64 | 16 vCore | 64 GB | Up to 12.5 Gbps |
| Standard | db1v16m128 | 16 vCore | 128 GB | Up to 12.5 Gbps |
| Standard | db1v16m192 | 16 vCore | 192 GB | Up to 12.5 Gbps |
| Standard | db1v16m256 | 16 vCore | 256 GB | Up to 12.5 Gbps |
dbh2 server type
The dbh2 server type of PostgreSQL(DBaaS) is provided with large-capacity server specifications and is suitable for database workloads for large-scale data processing.
Up to 3.2GHz Intel 4th generation (Sapphire Rapids) Xeon Gold 6448H Processor Supports up to 128 vCPUs and 1,536 GB of memory Up to 25Gbps of networking speed
| Classification | Server Type | vCPU | Memory | Network Bandwidth |
|---|---|---|---|---|
| High Capacity | dbh2v24m48 | 24 vCore | 48 GB | Up to 25 Gbps |
| High Capacity | dbh2v24m96 | 24 vCore | 96 GB | Up to 25 Gbps |
| High Capacity | dbh2v24m192 | 24 vCore | 192 GB | Up to 25 Gbps |
| High Capacity | dbh2v24m288 | 24 vCore | 288 GB | Up to 25 Gbps |
| High Capacity | dbh2v32m64 | 32 vCore | 64 GB | Up to 25 Gbps |
| High Capacity | dbh2v32m128 | 32 vCore | 128 GB | Up to 25 Gbps |
| High Capacity | dbh2v32m256 | 32 vCore | 256 GB | Up to 25 Gbps |
| High Capacity | dbh2v32m384 | 32 vCore | 384 GB | Up to 25 Gbps |
| High Capacity | dbh2v48m192 | 48 vCore | 192 GB | Up to 25 Gbps |
| High Capacity | dbh2v48m576 | 48 vCore | 576 GB | Up to 25 Gbps |
| High Capacity | dbh2v64m256 | 64 vCore | 256 GB | Up to 25 Gbps |
| High Capacity | dbh2v64m768 | 64 vCore | 768 GB | Up to 25 Gbps |
| High Capacity | dbh2v72m288 | 72 vCore | 288 GB | Up to 25 Gbps |
| High Capacity | dbh2v72m864 | 72 vCore | 864 GB | Up to 25 Gbps |
| High Capacity | dbh2v96m384 | 96 vCore | 384 GB | Up to 25 Gbps |
| High Capacity | dbh2v96m1152 | 96 vCore | 1152 GB | Up to 25 Gbps |
| High Capacity | dbh2v128m512 | 128 vCore | 512 GB | Up to 25 Gbps |
| High Capacity | dbh2v128m1536 | 128 vCore | 1536 GB | Up to 25 Gbps |
1.2 - Monitoring Metrics
PostgreSQL(DBaaS) Monitoring Metrics
The following table shows the performance monitoring metrics of PostgreSQL(DBaaS) that can be checked through Cloud Monitoring. For detailed instructions on using Cloud Monitoring, refer to the Cloud Monitoring guide.
For server monitoring metrics of PostgreSQL(DBaaS), refer to the Virtual Server Monitoring Metrics guide.
| Performance Item | Detailed Description | Unit |
|---|---|---|
| Active Locks | Number of Active Locks | cnt |
| Active Locks [Access Exclusive] | Number of Access Exclusive Locks | cnt |
| Active Locks [Access Share] | Number of Access Share Locks | cnt |
| Active Locks [Total] | Total Number of Active Locks | cnt |
| Active Sessions | Number of Active Sessions | cnt |
| Active Sessions [Total] | Total Number of Active Sessions | cnt |
| Apply Lag Time | Apply Lag Time | min |
| Check No Replication | Check No Replication Value | cnt |
| Check Replication | Check Replication Status Value | status |
| Connection Usage | DB Connection Usage Rate (%) | % |
| Connection Usage [Total] | DB Connection Usage Rate (%) | % |
| DB Age Max | Database Age (Frozen XID) Value | age |
| Exclusive Locks | Number of Exclusive Locks | cnt |
| Idle In Transaction Sessions | Number of Idle In Transaction Sessions | cnt |
| Idle In Transaction Sessions [Total] | Total Number of Idle In Transaction Sessions | cnt |
| Idle Sessions | Number of Idle Sessions | cnt |
| Idle Sessions [Total] | Total Number of Idle Sessions | cnt |
| Row Exclusive Locks | Number of Row Exclusive Locks | cnt |
| Row Share Locks | Number of Row Share Locks | cnt |
| Share Locks | Number of Share Locks | cnt |
| Share Row Exclusive Locks | Number of Share Row Exclusive Locks | cnt |
| Share Update Exclusive Locks | Number of Share Update Exclusive Locks | cnt |
| Slowqueries | Number of Long-Running SQL Queries (over 5 minutes) | cnt |
| Tablespace Used | Table Space Size | bytes |
| Tablespace Used [Total] | Table Space Size | bytes |
| Tablespace Used Bytes [MB] | File System Directory Usage (MB) | MB |
| Tablespaces [Total] | File System Directory Usage (MB) | MB |
| Transaction Time Max [Long] | Longest Running Transaction Time (minutes) | min |
| Transaction Time Max Total [Long] | Longest Running Transaction Time (minutes) | min |
| Wait Locks | Number of Sessions Waiting for Locks (per DB) | cnt |
| Wait Locks [Long Total] | Number of Sessions Waiting for Locks for a Long Time (over 300 seconds) | cnt |
| Wait Locks [Long] | Number of Sessions Waiting for Locks | cnt |
| Wait Locks [Total] | Total Number of Sessions Waiting for Locks | cnt |
| Waiting Sessions | Number of Waiting Sessions | cnt |
| Waiting Sessions [Total] | Total Number of Waiting Sessions | cnt |
2 - How-to guides
Users can create PostgreSQL(DBaaS) service by entering required information and selecting detailed options through Samsung Cloud Platform Console.
Creating PostgreSQL(DBaaS)
You can create and use PostgreSQL(DBaaS) service through Samsung Cloud Platform Console.
- Please configure VPC’s Subnet type as General before creating service.
- If Subnet type is Local, creating this Database service is not possible.
- If storing large data of 2 TB or more, backup may take long time or DB performance itself may degrade. To prevent this, operational considerations are needed such as cleaning unnecessary data or moving old data to statistics collection environment
To create PostgreSQL(DBaaS), follow these steps:
Click All Services > Database > PostgreSQL(DBaaS) menu. You will be directed to the Service Home page for PostgreSQL(DBaaS).
On the Service Home page, click the Create PostgreSQL(DBaaS) button. You will be directed to the Create PostgreSQL(DBaaS) page.
On the Create PostgreSQL(DBaaS) page, enter information required for service creation and select detailed options.
- Select required information in Image and Version Selection section.
Category RequiredDetailed Description Image Version Required Provides PostgreSQL(DBaaS) version list Table. PostgreSQL(DBaaS) Image and Version Selection Items - Enter or select required information in Service Information Entry section.
Category RequiredDetailed Description Server Name Prefix Required Server name where DB will be installed - Enter 3~13 characters starting with lowercase English letters, using lowercase letters, numbers, and special characters (
-)
- Actual server name is created with Postfix like 001, 002 based on server name
Cluster Name Required Cluster name where DB servers are configured - Enter 3~20 characters using English letters
- Cluster is a unit that groups multiple servers
Service Type > Server Type Required Server type where DB will be installed - Standard: Standard specifications generally used
- High Capacity: Large capacity servers with 24vCore or more
- For details on server types provided by PostgreSQL(DBaaS), see PostgreSQL(DBaaS) Server Type
Service Type > Planned Compute Optional Status of resources with Planned Compute set - In Use: Number of resources in use among resources with Planned Compute set
- Set: Number of resources with Planned Compute set
- Coverage Preview: Amount applied by Planned Compute for each resource
- Create Planned Compute Service: Move to Planned Compute service application page
- For details, see Applying for Planned Compute
Service Type > Block Storage Required Block Storage settings used by DB according to purpose - Basic OS: Area where DB engine is installed
- DATA: Storage area for table data and archive files
- Select storage type then enter capacity (For details on Block Storage types, see Creating Block Storage)
- SSD: High performance general volume
- HDD: General volume
- SSD_KMS, HDD_KMS: Additional encryption volume using Samsung Cloud Platform KMS (Key Management System) encryption key
- Set Storage type is applied identically to additional storage
- Enter capacity in multiples of 8 in range of 16~5,120
- Must allocate separate TEMP storage for use as large Sort due to SQL execution or monthly batch may cause service interruption
- Additional: DATA, Archive, TEMP, Backup data storage area
- Select Use then enter storage purpose and capacity
- Storage type is applied identically with type set in DATA, capacity can be entered in multiples of 8 in range of 16~5,120
- Click + button to add storage, x button to delete. Up to 9 can be added
- Temporarily saves backup data in BACKUP storage before transmitting backup data
- If backup data exceeds 100 GB and data changes are frequent, recommend adding separate BACKUP storage for stable backup, recommend setting backup capacity to about 60% of DATA capacity
- If BACKUP storage is not added,
/tmparea is used, and backup fails if capacity is insufficient
- Only one Block Storage is allocated per service for Archive, TEMP, BACKUP storage
- Select storage type then enter capacity (For details on Block Storage types, see Creating Block Storage)
Redundancy Configuration Optional Redundancy configuration - If redundancy configuration is used, DB instance is configured divided into Active DB and Standby DB
Network > Common Settings Required Network settings where servers created in service are installed - Select if applying same settings to all installed servers
- Select pre-created VPC and Subnet, IP, Public NAT
- IP can only be auto-created
- Public NAT function can be used only if VPC is connected to Internet Gateway, if Use is checked can select from IPs reserved in VPC product’s Public IP. For details, see Creating Public IP
Network > Per-Server Settings Required Network settings where servers created in service are installed - Select if applying different settings per installed server
- Select pre-created VPC and Subnet, IP, Public NAT
- Enter IP for each server
- Public NAT function can be used only if VPC is connected to Internet Gateway. If Use is checked can select from IPs reserved in VPC product’s Public IP. For details, see Creating Public IP
IP Access Control Optional Service access policy settings - Sets access policy for IPs entered on page, so separate Security Group policy settings are not required
- Enter in IP format (e.g.,
192.168.10.1) or CIDR format (e.g.,192.168.10.0/24,192.168.10.1/32) and click Add button
- To delete entered IP, click x button next to entered IP
Maintenance Window Optional DB maintenance window - If Use is selected, set day of week, start time, duration
- Recommend setting maintenance window for stable DB management. Patch operations proceed at set time and service interruption occurs
- If set to Not Use, Samsung SDS is not responsible for problems caused by not applying patches
Table. PostgreSQL(DBaaS) Service Information Entry Items - Enter 3~13 characters starting with lowercase English letters, using lowercase letters, numbers, and special characters (
- Enter or select required information in Database Configuration Required Information Entry section.
Category RequiredDetailed Description Database Name Required Server name applied when installing DB - Enter 3~20 characters starting with English letters, using English letters and numbers
Database Username Required DB user name - Account is created with this name in OS as well
- Enter 2~20 characters using lowercase English letters
- Database usernames with restricted use can be checked in Console
Database Password Required Password to use when accessing DB - Enter 8~30 characters including English letters, numbers, and special characters (excluding
"’)
Database Password Confirm Required Re-enter password to use when accessing DB identically Database Port Number Required Port number required for DB connection - Enter DB port in range of 1200~65535
Backup > Use Optional Whether to use backup - Select Use to set backup file retention period, backup start time, Archive backup cycle
Backup > Retention Period Optional Backup retention period - Select backup retention period, file retention period can be set 7~35 days
- Additional charges are applied to backup files depending on capacity
Backup > Backup Start Period Optional Backup start time - Select backup start time
- Minutes when backup is performed are set randomly, backup end time cannot be set
Backup > Archive Backup Cycle Optional Archive backup cycle - Select Archive backup cycle
- Archive backup cycle of 1 hour is recommended. When selecting 5 minutes, 10 minutes, 30 minutes, may affect DB performance.
Audit Log Settings Optional Whether to save Audit Log - Select Use to set Audit Log function
- DDL, DML, user connection information records are saved
- User can specify SQL statement types to Audit through
log_statementparameter, can modify through Parameter screen
- For details on this parameter, refer to PostgreSQL documentation
- User can specify SQL statement types to Audit through
- DB performance may degrade when Audit is set
- DDL, DML, user connection information records are saved
Parameter Required Parameters to use in DB - Can check detailed information of parameters by clicking View button
- Parameters can be modified after DB creation is complete, must restart DB after modification
Database Encoding Required Character encoding method to use in DB - Character set used when storing text data
- DB is created with default setting to selected Encoding
DB Locale Required Locale to use in DB - Settings related to string processing, number/currency/date/time display format
- DB is created with default setting to selected Locale
Timezone Required Standard time zone where Database will be used Table. PostgreSQL(DBaaS) Database Configuration Items - Enter or select required information in Additional Information Entry section.
Category RequiredDetailed Description Tags Optional Add tags - Can add up to 50 per resource
- Click Add Tag button then enter or select Key, Value values
Table. PostgreSQL(DBaaS) Additional Information Entry Items
- Select required information in Image and Version Selection section.
On Summary panel, check created detailed information and estimated billing amount, then click Create button.
- When creation is complete, check created resource on Resource List page.
Checking PostgreSQL(DBaaS) Detailed Information
PostgreSQL(DBaaS) service can check and modify overall resource list and detailed information. PostgreSQL(DBaaS) Detail page is composed of Detailed Information, Tags, Operation History tabs, and for DB with Replica configured, Replica Information tab is additionally configured.
To check detailed information of PostgreSQL(DBaaS) service, follow these steps.
- Click All Services > Database > PostgreSQL(DBaaS) menu. You will be directed to the Service Home page for PostgreSQL(DBaaS).
- On the Service Home page, click the PostgreSQL(DBaaS) menu. You will be directed to the PostgreSQL(DBaaS) List page.
- On the PostgreSQL(DBaaS) List page, click the resource for which you want to check detailed information. You will be directed to the PostgreSQL(DBaaS) Detail page.
- At the top of PostgreSQL(DBaaS) Detail page, status information and additional feature information are displayed.
Category Detailed Description Cluster Status Status of cluster where DB is installed - Creating: Cluster creation in progress
- Editing: Cluster changing to state performing Operation
- Error: Cluster state where error occurred during task execution
- If occurring continuously, contact administrator
- Failed: Cluster failed during creation process
- Restarting: Restarting cluster
- Running: Cluster operating normally
- Starting: Starting cluster
- Stopped: Cluster stopped
- Stopping: Stopping cluster
- Synchronizing: Synchronizing cluster
- Terminating: Deleting cluster
- Unknown: Cluster status unknown
- If occurring continuously, contact administrator
- Upgrading: Cluster changing to state performing upgrade
Cluster Control Buttons that can change cluster status - Start: Start stopped cluster
- Stop: Stop running cluster
- Restart: Restart running cluster
- Switch-Over: Switch Standby cluster to Active
Additional Features More Cluster-related management buttons - Service Status Sync: Check real-time DB service status
- Backup History: If backup is set, check backup normal execution and history
- Database Recovery: Recover DB based on specific point in time
- Parameter Management: Can check and modify DB configuration parameters
- Replica Configuration: Configure Replica which is read-only cluster
- Replica Configuration (Other Region): Configure disaster recovery Replica in other region, button disabled if no region configured in that Account
- DB User Management: Check and manage DB account (user) information registered in DB
- DB Access Control Management: Can register and cancel access-allowed IPs based on DB accounts registered in DB
- Archive Settings Management: Can set Archive file retention period and Archive mode
- DB Log Export: Can export logs saved through Audit settings to user’s Object Storage
- Migration Configuration: Provides Migration function of replication method
- OS(Kernel) Upgrade: Upgrade OS Kernel version
Service Termination Button to terminate service Table. PostgreSQL(DBaaS) Status Information and Additional Features
- At the top of PostgreSQL(DBaaS) Detail page, status information and additional feature information are displayed.
Detailed Information
On PostgreSQL(DBaaS) List page, check detailed information of selected resource, and modify information if necessary.
| Category | Detailed Description |
|---|---|
| Server Information | Server information configured in that cluster
|
| Service | Service name |
| Resource Type | Resource type |
| SRN | Unique resource ID in Samsung Cloud Platform
|
| Resource Name | Resource name
|
| Resource ID | Unique resource ID in service |
| Creator | User who created service |
| Creation Date/Time | Date/Time when service was created |
| Modifier | User who modified service information |
| Modification Date/Time | Date/Time when service information was modified |
| Image Version | Installed DB image and version information
|
| Cluster Type | Cluster type (Master Cluster, Replica Cluster, Migration Cluster) |
| Cluster Name | Cluster name where DB servers are configured |
| Master Cluster Name | Master cluster name of Replica
|
| Database Name | Server name applied when DB was installed |
| Database Username | DB user name |
| Planned Compute | Status of resources with Planned Compute set
|
| Maintenance Window | DB patch operation period setting status
|
| Backup | Backup setting status
|
| Audit Log Settings | Audit Log setting status
|
| Timezone | Standard time zone where Database will be used |
| DB Locale | Locale to use in DB |
| Database Encoding | Character encoding method to use in DB |
| VIP | Virtual IP information
|
| Network | Network information where DB is installed (VPC, Subnet, VIP, NAT IP (VIP)) |
| IP Access Control | Service access policy settings
|
| Active & Standby | Active/Standby server type, Basic OS, additional Disk information
|
Replica Information
Replica Information tab is activated only when Replica is configured in cluster. Through Replica Information tab, can check Master cluster name, replica count, Replica’s replication status.
| Category | Detailed Description |
|---|---|
| Master Information | Name of Master cluster |
| Replica Count | Number of Replicas created in Master cluster |
| Replica Status | Replica server status created in Master cluster
|
Tags
On PostgreSQL(DBaaS) List page, check tag information of selected resource, and add, change, or delete.
| Category | Detailed Description |
|---|---|
| Tag List | Tag list
|
Operation History
On PostgreSQL(DBaaS) List page, can check operation history of selected resource.
| Category | Detailed Description |
|---|---|
| Operation History List | Resource change history
|
Managing PostgreSQL(DBaaS) Resources
If existing configuration options of created PostgreSQL(DBaaS) resource need to be changed, or recovery, Replica configuration is needed, can perform tasks on PostgreSQL(DBaaS) Detail page.
Controlling Operation
If changes occur to running PostgreSQL(DBaaS) resource, can start, stop, restart. Also, if HA is configured, can switch Active-Standby servers through Switch-over.
To control PostgreSQL(DBaaS) operation, follow these steps:
- Click All Services > Database > PostgreSQL(DBaaS) menu. You will be directed to the Service Home page for PostgreSQL(DBaaS).
- On the Service Home page, click the PostgreSQL(DBaaS) menu. You will be directed to the PostgreSQL(DBaaS) List page.
- On the PostgreSQL(DBaaS) List page, click the resource to control operation. You will be directed to the PostgreSQL(DBaaS) Detail page.
- Check PostgreSQL(DBaaS) status and complete change through control buttons below.
- Start: DB service installed server and DB service run (Running).
- Stop: DB service installed server and DB service stop (Stopped).
- Restart: Only DB service restarts.
- Switch Over: Can change Active server and Standby server of DB.
Synchronizing Service Status
Can synchronize real-time service status of PostgreSQL(DBaaS).
To check PostgreSQL(DBaaS) service status, follow these steps:
- Click All Services > Database > PostgreSQL(DBaaS) menu. You will be directed to the Service Home page for PostgreSQL(DBaaS).
- On the Service Home page, click the PostgreSQL(DBaaS) menu. You will be directed to the PostgreSQL(DBaaS) List page.
- On the PostgreSQL(DBaaS) List page, click the resource to check service status. You will be directed to the PostgreSQL(DBaaS) Detail page.
- Click Service Status Sync button. Cluster changes to Synchronizing status while checking.
- When check is complete, status is updated in server information item, and cluster changes to Running status.
Changing Server Type
Can change configured server type.
To change server type, follow these steps:
- Click All Services > Database > PostgreSQL(DBaaS) menu. You will be directed to the Service Home page for PostgreSQL(DBaaS).
- On the Service Home page, click the PostgreSQL(DBaaS) menu. You will be directed to the PostgreSQL(DBaaS) List page.
- On the PostgreSQL(DBaaS) List page, click the resource to change server type. You will be directed to the PostgreSQL(DBaaS) Detail page.
- Click Modify icon of server type to change at bottom of detailed information. Server Type Modify popup opens.
- Select server type in Server Type Modify popup, then click Confirm button.
Adding Storage
If data storage space of 5 TB or more is needed, can add storage. For DB configured in redundancy, added simultaneously to both redundancy servers.
- Applied identically with Storage type selected when creating service.
- For DB configured in redundancy, when adding storage, applied simultaneously to storage of Active DB and Standby DB.
- If Replica exists, Master cluster storage cannot be smaller than Replica storage. Expand Replica storage first then expand Master cluster storage.
- When adding Archive/Temp storage, DB restarts and temporarily unavailable.
To add storage, follow these steps:
- Click All Services > Database > PostgreSQL(DBaaS) menu. You will be directed to the Service Home page for PostgreSQL(DBaaS).
- On the Service Home page, click the PostgreSQL(DBaaS) menu. You will be directed to the PostgreSQL(DBaaS) List page.
- On the PostgreSQL(DBaaS) List page, click the resource to add storage. You will be directed to the PostgreSQL(DBaaS) Detail page.
- Click Add Disk button at bottom of detailed information. Additional Storage Request popup opens.
- In Additional Storage Request popup, enter purpose and capacity, then click Confirm button.
Expanding Storage
Can expand storage added as data area up to maximum 5 TB based on initially allocated capacity. For DB configured in redundancy, expanded simultaneously to both redundancy servers.
To expand storage capacity, follow these steps:
- Click All Services > Database > PostgreSQL(DBaaS) menu. You will be directed to the Service Home page for PostgreSQL(DBaaS).
- On the Service Home page, click the PostgreSQL(DBaaS) menu. You will be directed to the PostgreSQL(DBaaS) List page.
- On the PostgreSQL(DBaaS) List page, click the resource to change server type. You will be directed to the PostgreSQL(DBaaS) Detail page.
- Click Modify icon of additional Disk to expand at bottom of detailed information. Additional Storage Modify popup opens.
- In Additional Storage Modify popup, enter expansion capacity, then click Confirm button.
Terminating PostgreSQL(DBaaS)
Can reduce operating costs by terminating unused PostgreSQL(DBaaS). However, since terminating service may immediately stop running service, proceed with termination task after fully considering impact of service interruption.
- For DB with Replica configured, even if Master DB is terminated, Replica is not deleted together. If Replica also needs to be deleted, terminate separately from resource list.
- When terminating DB, stored data and if backup is set, all backup data are deleted.
To terminate PostgreSQL(DBaaS), follow these steps:
- Click All Services > Database > PostgreSQL(DBaaS) menu. You will be directed to the Service Home page for PostgreSQL(DBaaS).
- On the Service Home page, click the PostgreSQL(DBaaS) menu. You will be directed to the PostgreSQL(DBaaS) List page.
- On the PostgreSQL(DBaaS) List page, select resource to terminate and click Service Termination button.
- When termination is complete, check if resource is terminated on PostgreSQL(DBaaS) list page.
2.1 - Managing DB Service
Users can manage PostgreSQL(DBaaS) through the Samsung Cloud Platform Console.
Managing Parameters
Provides functionality to easily view and modify database configuration parameters.
Viewing Parameters
Follow these steps to view configuration parameters.
- Click the All Services > Database > PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS)’s Service Home page.
- On the Service Home page, click the PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS) List page.
- On the PostgreSQL(DBaaS) List page, click the resource for which you want to view and modify parameters. You will move to the PostgreSQL(DBaaS) Detail page.
- Click the More button and click the Parameter Management button. The Parameter Management popup window will open.
- In the Parameter Management popup window, click the View button. The View Notification popup window will open.
- When the View Notification popup window opens, click the Confirm button. Viewing may take some time.
Modifying Parameters
Follow these steps to modify configuration parameters.
- Click the All Services > Database > PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS)’s Service Home page.
- On the Service Home page, click the PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS) List page.
- On the PostgreSQL(DBaaS) List page, click the resource for which you want to view and modify parameters. You will move to the PostgreSQL(DBaaS) Detail page.
- Click the More button and click the Parameter Management button. The Parameter Management popup window will open.
- In the Parameter Management popup window, click the View button. The View Notification popup window will open.
- When the View Notification popup window opens, click the Confirm button. Viewing may take some time.
- If modification is needed, click the Modify button and enter the modification in the custom value area of the Parameter to be modified.
- When input is complete, click the Complete button.
Managing DB Users
Provides management functionality to view DB user information and change status information.
Viewing DB Users
Follow these steps to view DB users.
- Click the All Services > Database > PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS)’s Service Home page.
- On the Service Home page, click the PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS) List page.
- On the PostgreSQL(DBaaS) List page, click the resource for which you want to view DB users. You will move to the PostgreSQL(DBaaS) Detail page.
- Click the More button and click the DB User Management button. You will move to the DB User Management page.
- On the DB User Management page, click the View button. Viewing may take some time.
Changing DB User Status
Follow these steps to change the status of viewed DB users.
- Click the All Services > Database > PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS)’s Service Home page.
- On the Service Home page, click the PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS) List page.
- On the PostgreSQL(DBaaS) List page, click the resource for which you want to modify DB users. You will move to the PostgreSQL(DBaaS) Detail page.
- Click the More button and click the DB User Management button. You will move to the DB User Management page.
- On the DB User Management page, click the View button. Viewing may take some time.
- If modification is needed, click the Modify button and change the status area value or enter remarks.
- When input is complete, click the Complete button.
Managing DB Access Control
Provides IP-based DB user access control management functionality. Users can directly specify IPs that can access the database, allowing access only from permitted IPs.
Viewing DB Access Control
Follow these steps to view DB users with IP access control set.
- Click the All Services > Database > PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS)’s Service Home page.
- On the Service Home page, click the PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS) List page.
- On the PostgreSQL(DBaaS) List page, click the resource for which you want to manage access control. You will move to the PostgreSQL(DBaaS) Detail page.
- Click the More button and click the DB Access Control Management button. You will move to the DB Access Control Management page.
- On the DB Access Control Management page, click the View button. Viewing may take some time.
Adding DB Access Control
Follow these steps to add IP access control.
- Click the All Services > Database > PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS)’s Service Home page.
- On the Service Home page, click the PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS) List page.
- On the PostgreSQL(DBaaS) List page, click the resource for which you want to add IP access control. You will move to the PostgreSQL(DBaaS) Detail page.
- Click the More button and click the DB Access Control Management button. You will move to the DB Access Control Management page.
- On the DB Access Control Management page, click the View button. Viewing may take some time.
- When viewing is complete, click the Add button. The Add DB Access Control popup window will open.
- In the Add DB Access Control popup window, select the DB user name and enter the IP Address.
- When input is complete, click the Complete button.
Deleting DB Access Control
Follow these steps to delete IP access control.
- Click the All Services > Database > PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS)’s Service Home page.
- On the Service Home page, click the PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS) List page.
- On the PostgreSQL(DBaaS) List page, click the resource for which you want to delete IP access control. You will move to the PostgreSQL(DBaaS) Detail page.
- Click the More button and click the DB Access Control Management button. You will move to the DB Access Control Management page.
- On the DB Access Control Management page, click the View button. Viewing may take some time.
- When viewing is complete, click the Delete button. The Delete popup window will open.
- In the Delete popup window, click the Confirm button.
Managing Archive
Provides functionality to set Archive mode and Archive Log retention period, allowing users to flexibly configure Archive log management policies according to their operating environment. Additionally, provides functionality to manually delete Archive logs, enabling users to organize unnecessary log data and effectively manage system resources.
Setting Archive Mode
Follow these steps to set Archive mode.
- Click the All Services > Database > PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS)’s Service Home page.
- On the Service Home page, click the PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS) List page.
- On the PostgreSQL(DBaaS) List page, click the resource for which you want to set Archive mode. You will move to the PostgreSQL(DBaaS) Detail page.
- Click the More button and click the Archive Settings Management button. You will move to the Archive Settings Management page.
- On the Archive Settings Management page, click the View button. Viewing may take some time.
- Click the Modify button and select usage and retention period.
- When modification is complete, click the Complete button.
Deleting Archive Files
Follow these steps to delete Archive files.
- Click the All Services > Database > PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS)’s Service Home page.
- On the Service Home page, click the PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS) List page.
- On the PostgreSQL(DBaaS) List page, click the resource for which you want to set Archive mode. You will move to the PostgreSQL(DBaaS) Detail page.
- Click the More button and click the Archive Settings Management button. You will move to the Archive Settings Management page.
- On the Archive Settings Management page, click Delete All Archive if you want to delete all Archive files, or click Delete Backed Up Archive if you want to delete only backed up Archive files.
Modifying Audit Settings
You can change the Audit log storage settings for PostgreSQL(DBaaS).
Follow these steps to change the Audit log storage settings for PostgreSQL(DBaaS).
- Click the All Services > Database > PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS)’s Service Home page.
- On the Service Home page, click the PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS) List page.
- On the PostgreSQL(DBaaS) List page, click the resource for which you want to view the service status. You will move to the PostgreSQL(DBaaS) Detail page.
- Click the Modify icon in Audit Settings at the bottom of the detailed information. The Modify Audit Settings popup window will open.
- In the Modify Audit Settings popup window, modify the usage and then click the Confirm button.
- Selecting Use sets the Audit log function. Setting Audit logs may degrade DB performance.
- Disabling Use deletes the Audit log storage file. Please back up the Audit log file separately before disabling use.
Exporting DB Log
Supports exporting audit(Audit) log data that requires long-term retention to Object Storage. Users can directly set the log type to be saved, the destination Bucket to export to, and the cycle for exporting logs. Logs are copied and stored to the specified Object Storage according to the set criteria. Additionally, to efficiently manage disk space, provides an option to automatically delete original log files while exporting logs to Object Storage. Using this option allows you to effectively secure storage capacity while safely storing necessary log data for long-term retention.
- To use the DB Log Export function, Object Storage creation is required. For Object Storage creation, please refer to the Object Storage User Guide.
- Please check the expiration date of the authentication key. If the authentication key expires, logs will not be saved to the Bucket.
- Please be careful not to expose authentication key information externally.
Setting DB Log Export Mode
Follow these steps to set DB Log export mode.
- Click the All Services > Database > PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS)’s Service Home page.
- On the Service Home page, click the PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS) List page.
- On the PostgreSQL(DBaaS) List page, click the resource for which you want to export DB Log. You will move to the PostgreSQL(DBaaS) Detail page.
- Click the More button and click the DB Log Export button. You will move to the DB Log Export page.
- On the DB Log Export page, click the Register button. You will move to the Register DB Log Export page.
- On the Register DB Log Export page, enter the corresponding information and then click the Complete button.
Category Required Detailed DescriptionLog Type Required Log type to save Storage Bucket Name Required Object Storage Bucket name to save Authentication Key > Access key Required Access key to access the Object Storage to save Authentication Key > Secret key Required Secret key to access the Object Storage to save File Creation Cycle Required Cycle for creating files in Object Storage Delete Original Log Optional Whether to delete original logs while exporting to Object Storage Table. PostgreSQL(DBaaS) DB Log Export Configuration Items
Managing DB Log Export
Follow these steps to modify, cancel, or immediately export DB Log export settings.
- Click the All Services > Database > PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS)’s Service Home page.
- On the Service Home page, click the PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS) List page.
- On the PostgreSQL(DBaaS) List page, click the resource for which you want to manage DB Log export. You will move to the PostgreSQL(DBaaS) Detail page.
- Click the More button and click the DB Log Export button. You will move to the DB Log Export page.
- On the DB Log Export page, click the More button according to the log type you want to manage and click the Immediate Export, Modify, or Cancel button.
- Immediate Export: The selected log is exported to the Bucket of the previously set Object Storage.
- Modify: Modifies the DB Log export mode settings.
- Cancel: Cancels the DB Log export mode settings.
Upgrading Minor Version
Provides version upgrade functionality for some feature improvements and security patches. Only Minor version upgrades within the same Major version are supported.
- Please check the service status first through service status synchronization before performing version upgrade.
- Please proceed with version upgrade after setting up backup. If backup is not set, some data may not be recoverable when problems occur during update.
- In DBs with Replica configured, the Master DB version cannot be higher than the Replica version. Please check the Replica version first and perform version upgrade if necessary.
- Backed up data is automatically deleted after version upgrade is complete.
Follow these steps to upgrade Minor Version.
- Click the All Services > Database > PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS)’s Service Home page.
- On the Service Home page, click the PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS) List page.
- On the PostgreSQL(DBaaS) List page, click the resource to upgrade the version. You will move to the PostgreSQL(DBaaS) Detail page.
- Click the Modify button in the Image version item. The Version Upgrade popup window will open.
- In the Version Upgrade popup window, select the modified version and backup setting, then click the Confirm button.
- In the Version Upgrade Notification popup window, click the Confirm button.
Configuring Migration
Provides Migration functionality that replicates in real-time while synchronizing with the operating database, without service interruption, using Replication method.
Follow these steps to configure Migration.
- Click the All Services > Database > PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS)’s Service Home page.
- On the Service Home page, click the PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS) List page.
- On the PostgreSQL(DBaaS) List page, click the resource to migrate. You will move to the PostgreSQL(DBaaS) Detail page.
- Click the More button and click the Migration Configuration button. The Migration Configuration popup window will open.
- In the Migration Configuration popup window, check the instructions and click the Confirm button. You will move to the Migration Configuration page.
- On the Migration Configuration page, enter the corresponding information and then click the Connection Check button.
- When connection is complete, click the Complete button.
Category Required Detailed DescriptionSource DB Database Name Required Database name of the Source DB to be migrated Source DB IP Required IP of the Source DB to be migrated Source DB Port Required Port of the Source DB to be migrated Source DB Username Required Username of the Source DB to be migrated Source DB Password Required Password of the Source DB to be migrated Table. PostgreSQL(DBaaS) Migration Configuration Items
Promoting Migration Cluster to Master Cluster
You can promote a configured Migration Cluster to Master Cluster.
Follow these steps to promote Migration Cluster to Master.
- Click the All Services > Database > PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS)’s Service Home page.
- On the Service Home page, click the PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS) List page.
- On the PostgreSQL(DBaaS) List page, click the resource to promote to Master. You will move to the PostgreSQL(DBaaS) Detail page.
- Click the More button and click the Master Promotion button. The Master Promotion Notification popup window will open.
- In the Master Promotion Notification popup window, click the Confirm button.
Upgrading OS Kernel
You can upgrade the OS Kernel to improve operating database functionality and apply security patches.
- Service is interrupted during OS upgrade.
- Upgrade time may vary depending on the version, and if upgrade fails, it will revert to the previous configuration.
- Cannot recover to the previous OS after upgrade is complete.
Follow these steps to upgrade OS Kernel.
- Click the All Services > Database > PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS)’s Service Home page.
- On the Service Home page, click the PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS) List page.
- On the PostgreSQL(DBaaS) List page, click the resource to upgrade OS Kernel. You will move to the PostgreSQL(DBaaS) Detail page.
- Click the More button and click the OS(Kernel) Upgrade button. The OS(Kernel) Upgrade Notification popup window will open.
- In the OS(Kernel) Upgrade Notification popup window, check the instructions and click the Confirm button.
2.2 - DB Backup and Restore
Users can set up PostgreSQL(DBaaS) backup through the Samsung Cloud Platform Console and restore using backed up files.
Backing Up PostgreSQL(DBaaS)
PostgreSQL(DBaaS) provides data backup functionality based on its own backup commands. Additionally, through backup history viewing and backup file deletion functionality, it provides a backup environment optimized for data protection and management.
Setting Up Backup
For PostgreSQL(DBaaS) backup setup method, please refer to Creating PostgreSQL(DBaaS).
Follow these steps to modify backup settings for created resources.
- For stable backup, it is recommended to add a separate BACKUP storage or sufficiently increase storage capacity. Especially when backup target data exceeds 100 GB and there are many data changes, please secure additional storage corresponding to approximately 60% of data capacity. For adding and increasing storage, please refer to Adding PostgreSQL(DBaaS) Storage, Expanding PostgreSQL(DBaaS) Storage guides.
- When backup is set, backup is performed at the specified time after the set time, and additional charges occur depending on backup capacity.
- When backup setting is changed to Not Set, backup execution stops immediately, and stored backup data is deleted and can no longer be used.
Follow these steps to set up backup.
- Click the All Services > Database > PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS)’s Service Home page.
- On the Service Home page, click the PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS) List page.
- On the PostgreSQL(DBaaS) List page, click the resource to set backup. You will move to the PostgreSQL(DBaaS) Detail page.
- Click the Modify button in the backup item. The Backup Settings popup window will open.
- To set backup, click Use in the Backup Settings popup window, select retention period, backup start time, and Archive backup cycle, then click the Confirm button.
- To stop backup settings, uncheck Use in the Backup Settings popup window and click the Confirm button.
Viewing Backup History
Follow these steps to view backup history.
- Click the All Services > Database > PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS)’s Service Home page.
- On the Service Home page, click the PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS) List page.
- On the PostgreSQL(DBaaS) List page, click the resource to view backup history. You will move to the PostgreSQL(DBaaS) Detail page.
- Click the Backup History button. The Backup History popup window will open.
- In the Backup History popup window, you can check backup status, version, backup start datetime, backup completion datetime, and capacity.
Deleting Backup Files
Follow these steps to delete backup history.
- Click the All Services > Database > PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS)’s Service Home page.
- On the Service Home page, click the PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS) List page.
- On the PostgreSQL(DBaaS) List page, click the resource to view backup history. You will move to the PostgreSQL(DBaaS) Detail page.
- Click the Backup History button. The Backup History popup window will open.
- In the Backup History popup window, check the file to delete and then click the Delete button.
Restoring PostgreSQL(DBaaS)
In case of failure or data loss requiring restoration from backup files, you can restore based on a specific point in time through the restore function. When PostgreSQL(DBaaS) restore is performed, a new server is created with the OS image at the initial provisioning time, DB is installed with the version of that backup time, and restoration proceeds with DB configuration information and data.
Follow these steps to restore PostgreSQL(DBaaS).
- Click the All Services > Database > PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS)’s Service Home page.
- On the Service Home page, click the PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS) List page.
- On the PostgreSQL(DBaaS) Resource List page, click the resource to restore. You will move to the PostgreSQL(DBaaS) Detail page.
- Click the Database Restore button. You will move to the Database Restore page.
- Enter the corresponding information in the Database Restore Configuration area and then click the Complete button.
Category RequiredDetailed Description Restore Type Required Setting the point in time user wants to restore - Backup Point(Recommended): Restore based on backup file. Select from the list of backup file time points displayed in the list
- User-Specified Point: Restore to a point user wants within the backupable time range. The recoverable period can restore from the initial backup start time to 1 hour/30 minutes/10 minutes/5 minutes before current time according to Archive backup cycle setting value. Select the date and time to backup
Server Name Prefix Required Server name of restore DB - Enter 3~16 characters starting with lowercase English letters, using lowercase letters, numbers, and special characters(
-)
- Actual server name is created with a postfix like 001, 002 attached based on server name
Cluster Name Required Cluster name of restore DB - Enter 3 ~ 20 characters using English letters
- Cluster is a unit that groups multiple servers
Service Type > Server Type Required Server type where restore DB will be installed - Standard: Standard specifications commonly used
- High Capacity: Large-capacity servers with 24vCore or more
Service Type > Planned Compute Optional Status of resources with Planned Compute set - In Use: Number of resources with Planned Compute set that are currently in use
- Set: Number of resources with Planned Compute set
- Coverage Preview: Amount applied by Planned Compute per resource
- Create Planned Compute Service: Moves to Planned Compute service application page
- For details, refer to Applying for Planned Compute
Service Type > Block Storage Required Block Storage settings used by restore DB - Basic OS: Area where DB engine is installed
- DATA: Storage area for table data and archive files, etc.
- Applied identically with Storage type set in original cluster
- Enter capacity as a multiple of 8 in the range of 16 ~ 5,120
- Additional: Storage area for DATA, Archive, TEMP, Backup data
- Applied identically with Storage type set in original cluster
- Only DATA, TEMP, Archive purposes can be added in restore DB.
- Select Use and then enter storage purpose and capacity
- To add storage, click the + button, to delete, click the x button
- Capacity can be entered as a multiple of 8 in the range of 16 ~ 5,120, and can create up to 9
Database Username Required Database username set in original DB Database Port Number Required Database Port number set in original DB IP Access Control Optional IP address to access restore DB - Enter in IP format (example:
192.168.10.1) or CIDR format (example:192.168.10.1/32,192.168.10.1/32) and click the Add button
- To delete entered IP, click the x button next to the entered IP
Maintenance Period Optional DB maintenance period - When Use is selected, set day of week, start time, and duration
- It is recommended to set a maintenance period for stable DB management. Patching is performed at the set time and service interruption occurs
- If set to Not Used, Samsung SDS is not responsible for problems caused by unapplied patches.
Tags Optional Add tags - Click the Add Tag button and then enter or select Key, Value values
Table. PostgreSQL(DBaaS) Restore Configuration Items
2.3 - Configuring Read Replica
Users can enter required information for Read Replica through the Samsung Cloud Platform Console and create the service through detailed options.
Configuring Replica
Through Replica configuration, you can create replica servers for read-only or disaster recovery purposes. You can create up to 5 Replicas per Database.
Follow these steps to configure Replica.
- Click the All Services > Database > PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS)’s Service Home page.
- On the Service Home page, click the PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS) List page.
- On the PostgreSQL(DBaaS) List page, click the resource to configure Replica. You will move to the PostgreSQL(DBaaS) Detail page.
- Click the Configure Replica button. You will move to the Configure Replica page.
- Enter information in the Configure Replica area and then click the Complete button.
Category RequiredDetailed Description Region Required Region to configure Replica - Only exposed when Replica Configuration(Other Region) is selected
Replica Count Required Number of Replicas to configure - Can configure up to 5 per cluster
- When selecting a value of 2 or more, additional input is required for Replica name and service type information
Replica Name Required Replica server name - Enter 3 ~ 19 characters starting with lowercase English letters, using lowercase letters, numbers, and special characters(
-)
- The entered Replica name is displayed as cluster name in the list
Service Type > Server Type Required Replica server type - Standard: Standard specifications commonly used
- High Capacity: Large-capacity servers with 24vCore or more
Service Type > Planned Compute Optional Status of resources with Planned Compute set - In Use: Number of resources with Planned Compute set that are currently in use
- Set: Number of resources with Planned Compute set
- Coverage Preview: Amount applied by Planned Compute per resource
- Create Planned Compute Service: Moves to Planned Compute service application page
- For details, refer to Applying for Planned Compute
Service Type > Block Storage Required Block Storage settings for Replica DB - Basic OS: Area used on the server where DB is installed
- Applied identically according to the Storage type set in the original DB
- Capacity setting is not possible
- DATA: Storage area for table data and archive files, etc.
- Applied identically according to the Storage type set in the original DB
- Capacity setting is not possible
- Additional: Storage area for DATA, Archive, TEMP, Backup data
- Applied identically according to the Storage type set in the original DB
- Only DATA, TEMP purposes can be added in Replica
- Select Use and then enter the storage purpose and capacity. Enter capacity in the range of 16 ~ 5,120 as a multiple of 8
- To add storage, click the + button, to delete, click the x button. Can add up to 9.
IP Access Control Optional Service access policy setting - Sets access policy for IPs entered on the page, so no separate Security Group policy setting is required
- Enter in IP format (example:
192.168.10.1) or CIDR format (example:192.168.10.0/24,192.168.10.1/32) and click the Add button
- To delete entered IP, click the x button next to the entered IP
Maintenance Period Optional DB maintenance period - When Use is selected, set day of week, start time, and duration
- It is recommended to set a maintenance period for stable DB management. Patching is performed at the set time and service interruption occurs
- If set to Not Used, Samsung SDS is not responsible for problems caused by unapplied patches.
Tags Optional Add tags - Click the Add Tag button and then enter or select Key, Value values
Table. PostgreSQL(DBaaS) Replica Configuration Items
Reconfiguring Replica
In case of network failure or Replication delay with Master Cluster, you can replicate Master Cluster data again through the Replica reconfiguration function.
Follow these steps to reconfigure Replica.
- Click the All Services > Database > PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS)’s Service Home page.
- On the Service Home page, click the PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS) List page.
- On the PostgreSQL(DBaaS) List page, click the resource to reconfigure Replica. You will move to the PostgreSQL(DBaaS) Detail page.
- Click the Reconfigure Replica button. The Reconfigure Replica Notification popup window will open.
- In the Reconfigure Replica Notification popup window, click the Confirm button.
Promoting Replica Cluster to Master Cluster
You can promote a configured Replica Cluster to Master Cluster.
Follow these steps to promote Replica Cluster to Master.
- Click the All Services > Database > PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS)’s Service Home page.
- On the Service Home page, click the PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS) List page.
- On the PostgreSQL(DBaaS) List page, click the resource to promote to Master. You will move to the PostgreSQL(DBaaS) Detail page.
- Click the More button and click the Master Promotion button. The Master Promotion Notification popup window will open.
- In the Master Promotion Notification popup window, click the Confirm button.
2.4 - Connecting to DB Server
Scenario Overview
The PostgreSQL(DBaaS) Server Connection scenario involves creating a Bastion host(Virtual Server) and Database service, and accessing the DB service through the Bastion host. To stably access PostgreSQL(DBaaS) in the Samsung Cloud Platform environment, you need to create a Bastion host and configure network connections using it. To maintain stable and high security levels, it is recommended to configure the Database service in a Private Subnet environment and the Bastion host in a restricted Public Subnet environment.
This scenario explains the process of creating a Bastion host and Database service, configuring the network environment for Bastion host and Database access, and connecting through a DB connection client.
Scenario Components
You can configure this scenario using the following services.
| Service Group | Service | Detailed Description | |
|---|---|---|---|
| Networking | VPC | Service that provides independent virtual networks in cloud environments | |
| Networking | VPC > Subnet | Service that subdivides networks according to user needs/scale within VPC | |
| Networking | VPC > Public IP | Service that reserves public IPs and assigns/releases them to Compute resources | |
| Networking | VPC > Internet Gateway | Service that connects VPC resources to the internet | |
| Networking | Security Group | Virtual firewall that controls server traffic | |
| Database | PostgreSQL(DBaaS) | Service that easily creates and manages EPAS in a web environment | |
| Compute | Virtual Server | Virtual server optimized for cloud computing | |
| Compute | Virtual Server > Keypair | Encrypted file used to connect to Virtual Server |
- The default policy of Security Group is Deny All, so you must register only allowed IPs.
- The All Open(Any IP, Any Port) policy for In/Outbound can expose cloud resources directly to external threats.
- Setting policies with specific IPs and Ports can enhance security.
Scenario Configuration Method
Create the necessary services to configure the scenario through the following procedure.
1. Configuring Network
This explains the process of configuring the network environment for accessing Bastion Host and Database service.
1-1. Creating VPC
- Click the All Services > Networking > VPC menu. You will move to the VPC’s Service Home page.
- On the Service Home page, click the Create VPC button. You will move to the Create VPC page.
- On the Create VPC page, enter the necessary information for service creation.
- Enter the IP range as
192.168.x.0/16.
- Enter the IP range as
- On the Summary panel, check the detailed creation information and estimated billing amount, then click the Complete button.
- When creation is complete, check the created resource on the VPC List page.
1-2. Creating Subnet
- Click the All Services > Networking > VPC menu. You will move to the VPC’s Service Home page.
- On the Service Home page, click the Subnet menu. You will move to the Subnet List page.
- Click the Create Subnet button. You will move to the Create Subnet page.
- On the Create Subnet page, enter the necessary information for service creation.
- Select General as the Subnet type.
- Select the previously created VPC.
- Enter the IP range as
192.168.x.0/24.
- On the Summary panel, check the detailed creation information and estimated billing amount, then click the Complete button.
- When creation is complete, check the created resource on the Subnet List page.
1-3. Creating Internet Gateway
- Click the All Services > Networking > VPC menu. You will move to the VPC’s Service Home page.
- On the Service Home page, click the Internet Gateway menu. You will move to the Internet Gateway List page.
- Click the Create Internet Gateway button. You will move to the Create Internet Gateway page.
- On the Create Internet Gateway page, enter the required information for service creation.
- Select the previously created VPC.
- Select Use for the Firewall usage item.
- On the Summary panel, check the detailed creation information and estimated billing amount, then click the Complete button.
- When creation is complete, check the created resource on the Internet Gateway List page.
1-4. Creating Public IP
- Click the All Services > Networking > VPC menu. You will move to the VPC’s Service Home page.
- On the Service Home page, click the Public IP menu. You will move to the Public IP List page.
- Click the Reserve Public IP button. You will move to the Reserve Public IP page.
- On the Reserve Public IP page, enter the required information for service reservation.
- On the Summary panel, check the detailed creation information and estimated billing amount, then click the Complete button.
- When creation is complete, check the created resource on the Public IP List page.
1-5. Creating Security Group
- Click the All Services > Networking > Security Group menu. You will move to the Security Group’s Service Home page.
- On the Service Home page, click the Create Security Group button. You will move to the Create Security Group page.
- On the Create Security Group page, enter the required information for service creation.
- Check the entered information and click the Complete button.
- When creation is complete, check the created resource on the Security Group List page.
2. Creating Bastion Host
This explains the process of configuring the Bastion Host where the DB connection client should be installed.
2-1. Creating Server Keypair
- Click the All Services > Compute > Virtual Server menu. You will move to the Virtual Server’s Service Home page.
- On the Service Home page, click the Keypair menu. You will move to the Keypair List page.
- Click the Create Keypair button. You will move to the Create Keypair page.
- On the Create Keypair page, enter the required information for service creation.
- Check the creation information and click the Complete button.
- Key download is only possible on the first attempt, and re-issuance is not provided.
- Please store the downloaded key in a safe place.
2-2. Creating Bastion Host
- Click the All Services > Compute > Virtual Server menu. You will move to the Virtual Server’s Service Home page.
- On the Service Home page, click the Create Virtual Server button. You will move to the Create Virtual Server page.
- On the Create Virtual Server page, enter the required information for service creation.
- Select Windows for the image.
- Select the previously created VPC and Subnet.
- Click Use NAT and select the Public IP reserved in 1-4. Creating Public IP.
- Connect the Keypair created in 2-1. Creating Server Keypair.
- On the Summary panel, check the detailed creation information and estimated billing amount, then click the Complete button.
- When creation is complete, check the created resource on the Virtual Server List page.
2-3. Checking Bastion Host Connection ID and Password
- Click the All Services > Compute > Virtual Server menu. You will move to the Virtual Server’s Service Home page.
- On the Service Home page, click the Virtual Server menu. You will move to the Virtual Server List page.
- On the Virtual Server List page, click the resource created in 2-2. Creating Bastion Host. You will move to the detailed information page of that resource.
- On the detailed information page, click the RDP password lookup button in the Keypair name item. The RDP password lookup popup window will open.
- In the RDP password lookup popup window, attach the keypair file downloaded in 2-1. Creating Server Keypair.
- After attaching, click the Password check button. The ID and Password for accessing that resource will be displayed.
- The ID and Password will be used as information for accessing the Bastion host later in 5-1. Connecting to Bastion Host.
3. Creating Database
This explains the process of creating the Database service.
3-1. Creating PostgreSQL(DBaaS) Service
- Click the All Services > Database > PostgreSQL(DBaaS) menu. You will move to the PostgreSQL(DBaaS)’s Service Home page.
- On the Service Home page, click the Create PostgreSQL(DBaaS) button. You will move to the Create PostgreSQL(DBaaS) page.
- On the Create PostgreSQL(DBaaS) page, enter the required information for service creation.
- Select and connect the previously created VPC and Subnet.
- Enter Database-related creation information in the required information input screen.
- Add the Bastion host IP in the IP access control item.
- The Database Port defaults to 2866, but users can specify it.
- On the Summary panel, check the detailed creation information and estimated billing amount, then click the Complete button.
- When creation is complete, check the created resource on the PostgreSQL(DBaaS) List page.
4. Setting Rules
This explains the process of setting rules for users to access the Bastion host and for the Bastion host to access the Database.
4-1. Adding Security Group Security Rules
- Click the All Services > Networking > Security Group menu. You will move to the Security Group’s Service Home page.
- On the Service Home page, click the Security Group menu. You will move to the Security Group List page.
- Select the Security Group resource created in [1-5. Creating Security Group]. You will move to the detailed information page of that resource.
- On the detailed information page, click the Rules tab. You will move to the Rules tab.
- On the Rules tab, click the Add Rule button. You will move to the Add Rule popup window.
- In the Add Rule popup window, enter the following rules and click the Confirm button.
Direction Remote Destination Address Protocol Port Description Inbound CIDR User PC IP TCP 3389 (RDP) Bastion connection PC → Bastion host Outbound CIDR DB IP TCP Database Port (Direct Input) Bastion host → Database Table. Security Group Security Rules to be Added
4-2. Adding IGW Firewall Rules
- Click the All Services > Networking > Firewall menu. You will move to the Firewall’s Service Home page.
- On the Service Home page, click the Firewall menu. You will move to the Firewall List page.
- On the Firewall List page, select the Internet Gateway resource name created in 1-3. Creating Internet Gateway. You will move to the detailed information page of that resource.
- On the detailed information page, click the Rules tab. You will move to the Rules tab.
- On the Rules tab, click the Add Rule button. You will move to the Add Rule popup window.
- In the Add Rule popup window, enter the following rules and click the Confirm button.
Source Address Destination Address Protocol Port Action Direction Description Bastion connection PC IP Bastion host IP TCP 3389(RDP) Allow Inbound User PC → Bastion host Table. Internet Gateway Firewall Rules to be Added
5. Connecting to Database
This explains the process of connecting to the Database through a DB connection client program.
This guide explains how to connect using pgAdmin. There are various Database client programs and CLI utilities, so users can install and use the appropriate tool.
5-1. Connecting to Bastion Host
- Run Remote Desktop Connection in the Windows environment of the PC that wants to connect to the Bastion host, enter the NAT IP of the Bastion Host, and click the Connect button.
- When Remote Desktop Connection succeeds, the User credential input window will open. Enter the ID and Password confirmed in 2-3. Checking Bastion Host Connection ID and Password and click the Confirm button.
5-2. Installing DB Connection Client Program (pgAdmin) on Bastion Host
- Go to the pgAdmin official page and download the pgAdmin program.
- pgAdmin program download path: https://www.pgadmin.org/download/
- Connect the user PC’s hard drive to upload the file to the Bastion host.
- On the Local Resources tab of Remote Desktop Connection, click the More button in the local devices and resources item.
- Select the local disk of the location where the file was downloaded and click the Confirm button.
- Copy the downloaded file to upload it to the Bastion Host, then click the pgAdmin installation file to install it.
5-3. Connecting to Database Using DB Connection Client Program (pgAdmin)
- Run pgAdmin and click the Add New Server button.
- In the Register - Server popup window, enter the Database server information created in 3-1. Creating PostgreSQL(DBaaS) Service in the General tab and Connection tab, then click the Save button.
Screen(Tab) Required Input Item Input Value General Name User-defined (ex. service name) Connection Host name/address Database server IP Connection Port Database Port Connection Maintenance database Database name Connection Password Database password Table. DB Connection Client Program Input Items - Click the database name created in pgAdmin to perform the connection.
- After connection, you can perform simple queries, etc.
2.5 - Using Extensions
PostgreSQL(DBaaS) Extension usage
The list of extensions that can be installed in the current database can be checked with the following SQL statement.
SQL> select * from pg_available_extensions;
PostgreSQL(DBaaS) has the following additional installation items outside of the default extension by version:
| Extension name | description |
|---|---|
| pgaudit | provides detailed audit logging functionality at the session and object level |
| pg_cron | a scheduler that allows job scheduling with cron syntax within the database |
| pg_hint_plan | Provides a feature to apply hint clauses to SQL execution plans |
| pgvector | Vector data type and similarity search, etc. AI vector operation function provided |
| postgis | GIS (Geographic Information System) provides spatial object storage and spatial query functionality |
In addition to the above items, if additional Extension installation is required, please refer to Support Center > Inquiry and inquire.
- Once the inquiry is received, we will proceed with the installation after review. Please note that some Extensions may not work normally during Replica configuration and recovery.
3 - API Reference
4 - CLI Reference
5 - Release Note
PostgreSQL(DBaaS)
- Enhances latest security patches and stability through OS(Kernel) upgrade function.
- Can configure disaster recovery replicas through Replica configuration (Other Region) function.
- PostgreSQL(DBaaS) feature additions
- 2nd Generation Server Type added
- Added 2nd generation (db2) server type based on Intel 4th generation (Sapphire Rapids) Processor. For details, see PostgreSQL(DBaaS) Server Type
- DB User and Access Control Management and Archive Setting Function added
- For details, see DB User Management, DB Access Control Management, Archive Management
- DB Audit Log Export function added
- For details, see DB Log Export
- Backup Notification Function provided
- Provides notification function for backup success and failure. For details, see Creating Notification Policy
- Migration Function added
- Provides replication-based zero-downtime data migration function. For details, see Configuring Migration
- HDD, HDD_KMS types added to Block Storage type
- 2nd Generation Server Type added
- PostgreSQL(DBaaS) feature changes
- PostgreSQL new versions added: 13.16, 14.13, 15.8
- 2nd generation server type added
- Added 2nd generation (dbh2) server type based on Intel 4th generation (Sapphire Rapids) Processor. For details, see PostgreSQL(DBaaS) Server Type
- Block Storage capacity expansion is possible after service creation.
- Per-server network IP setting function added allowing common settings or per-server settings depending on usage purpose.
- Samsung Cloud Platform common feature changes
- Reflected common CX changes such as Account, IAM and Service Home, tags.
- Volume encrypted storage selection option added to Block Storage type.
- Role Switch (Active ↔ Standby) function added for Active DB and Standby DB configured in redundancy.
- DB instance performance and log monitoring possible through integration with cloud monitoring service.
- Planned Compute policy setting possible according to server type selected by customer.
- PostgreSQL(DBaaS) service that allows easy creation and management of PostgreSQL in web environment has been released.

