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.

To create PostgreSQL(DBaaS), follow these steps:

1. Click All Services > Database > PostgreSQL(DBaaS) menu. You will be directed to the Service Home page for PostgreSQL(DBaaS).

2. On the Service Home page, click the Create PostgreSQL(DBaaS) button. You will be directed to the Create PostgreSQL(DBaaS) page.

3. 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	Required	Detailed 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	Required	Detailed 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, /tmp area is used, and backup fails if capacity is insufficient Only one Block Storage is allocated per service for Archive, TEMP, BACKUP 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 or select required information in Database Configuration Required Information Entry section.

     Category	Required	Detailed 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_statement parameter, can modify through Parameter screen For details on this parameter, refer to PostgreSQL documentation DB performance may degrade when Audit is set
     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	Required	Detailed 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

4. 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.

1. Click All Services > Database > PostgreSQL(DBaaS) menu. You will be directed to the Service Home page for PostgreSQL(DBaaS).
2. On the Service Home page, click the PostgreSQL(DBaaS) menu. You will be directed to the PostgreSQL(DBaaS) List page.
3. 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

Detailed Information

On PostgreSQL(DBaaS) List page, check detailed information of selected resource, and modify information if necessary.

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.

Tags

On PostgreSQL(DBaaS) List page, check tag information of selected resource, and add, change, or delete.

Operation History

On PostgreSQL(DBaaS) List page, can check operation history of selected resource.

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:

1. Click All Services > Database > PostgreSQL(DBaaS) menu. You will be directed to the Service Home page for PostgreSQL(DBaaS).
2. On the Service Home page, click the PostgreSQL(DBaaS) menu. You will be directed to the PostgreSQL(DBaaS) List page.
3. On the PostgreSQL(DBaaS) List page, click the resource to control operation. You will be directed to the PostgreSQL(DBaaS) Detail page.
4. 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:

1. Click All Services > Database > PostgreSQL(DBaaS) menu. You will be directed to the Service Home page for PostgreSQL(DBaaS).
2. On the Service Home page, click the PostgreSQL(DBaaS) menu. You will be directed to the PostgreSQL(DBaaS) List page.
3. On the PostgreSQL(DBaaS) List page, click the resource to check service status. You will be directed to the PostgreSQL(DBaaS) Detail page.
4. Click Service Status Sync button. Cluster changes to Synchronizing status while checking.
5. 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:

1. Click All Services > Database > PostgreSQL(DBaaS) menu. You will be directed to the Service Home page for PostgreSQL(DBaaS).
2. On the Service Home page, click the PostgreSQL(DBaaS) menu. You will be directed to the PostgreSQL(DBaaS) List page.
3. On the PostgreSQL(DBaaS) List page, click the resource to change server type. You will be directed to the PostgreSQL(DBaaS) Detail page.
4. Click Modify icon of server type to change at bottom of detailed information. Server Type Modify popup opens.
5. 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.

To add storage, follow these steps:

1. Click All Services > Database > PostgreSQL(DBaaS) menu. You will be directed to the Service Home page for PostgreSQL(DBaaS).
2. On the Service Home page, click the PostgreSQL(DBaaS) menu. You will be directed to the PostgreSQL(DBaaS) List page.
3. On the PostgreSQL(DBaaS) List page, click the resource to add storage. You will be directed to the PostgreSQL(DBaaS) Detail page.
4. Click Add Disk button at bottom of detailed information. Additional Storage Request popup opens.
5. 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:

1. Click All Services > Database > PostgreSQL(DBaaS) menu. You will be directed to the Service Home page for PostgreSQL(DBaaS).
2. On the Service Home page, click the PostgreSQL(DBaaS) menu. You will be directed to the PostgreSQL(DBaaS) List page.
3. On the PostgreSQL(DBaaS) List page, click the resource to change server type. You will be directed to the PostgreSQL(DBaaS) Detail page.
4. Click Modify icon of additional Disk to expand at bottom of detailed information. Additional Storage Modify popup opens.
5. 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.

To terminate PostgreSQL(DBaaS), follow these steps:

1. Click All Services > Database > PostgreSQL(DBaaS) menu. You will be directed to the Service Home page for PostgreSQL(DBaaS).
2. On the Service Home page, click the PostgreSQL(DBaaS) menu. You will be directed to the PostgreSQL(DBaaS) List page.
3. On the PostgreSQL(DBaaS) List page, select resource to terminate and click Service Termination button.
4. When termination is complete, check if resource is terminated on PostgreSQL(DBaaS) list page.