How-to guides

Users can create the service by entering the required information for PostgreSQL (DBaaS) through the Samsung Cloud Platform Console and selecting detailed options.

PostgreSQL(DBaaS) Create

You can create and use a PostgreSQL (DBaaS) service from the Samsung Cloud Platform Console.

To create a PostgreSQL (DBaaS), follow the steps below.

1. Click the All Services > Database > PostgreSQL(DBaaS) menu. 1. Navigate to the Service Home page of PostgreSQL (DBaaS).

2. On the Service Home page, click the PostgreSQL(DBaaS) Create button. 2. PostgreSQL(DBaaS) Creation Navigate to the page.

3. On the PostgreSQL(DBaaS) Creation page, enter the information required to create the service and select detailed options.

   • Select the required information in the Image and version selection area.

     Category	Required status	Detailed description
     Image version	required	Provide a list of PostgreSQL (DBaaS) versions

     Table. PostgreSQL (DBaaS) Image and version selection items
   • In the Service Information Input area, enter or select the required information.

     Category	Required	Detailed description
     Server name Prefix	required	The server name where the DB will be installed must start with a lowercase English letter, and using lowercase letters, numbers, and special characters (-) be entered with 3 to 13 characters Based on the server name, a postfix such as 001, 002 is appended to generate the actual server name
     Cluster name	required	Cluster name of the DB servers Enter using English letters, 3 to 20 characters A cluster is a unit that groups multiple servers
     Service Type > Server Type	required	Server type for DB installation Standard: Standard specification commonly used High Capacity: Large-capacity server with 24 vCores or more For detailed information about the server types provided by PostgreSQL(DBaaS), refer to PostgreSQL(DBaaS) Server Type
     Service Type > Planned Compute	Selection	Resource status with Planned Compute configured In Use: Number of resources with Planned Compute configured that are currently in use Configured: Number of resources with Planned Compute configured Coverage Preview: Amount applied per resource by Planned Compute Create Planned Compute Service: Navigate to the Planned Compute service request page For more details, refer to Planned Compute Request
     Service Type > Block Storage	required	Block Storage settings used by the DB according to purpose Basic OS: Area where the DB engine is installed DATA: Storage area for table data, archive files, etc. Select a storage type and then enter the capacity (see Create Block Storage for details on each Block Storage type) SSD: High‑performance general volume HDD: General volume SSD_KMS, HDD_KMS: Additional encrypted volumes that use Samsung Cloud Platform KMS (Key Management System) encryption keys The configured storage type is applied identically to additional storage Capacity must be entered as a multiple of 8 within the range 16–5,120 Because executing SQL or monthly batch jobs can cause large sorts that may interrupt service, a separate TEMP storage should be allocated and used Add: DATA, Archive, TEMP, Backup data storage areas After selecting Use, enter the storage’s purpose and capacity The storage type is applied the same as the type set for DATA, and capacity can be entered as a multiple of 8 within the range 16–5,120 To add storage, click the Add button; to delete, click the x button. Up to 9 can be added. Backup data is temporarily stored in the BACKUP storage before transmission If the data to be backed up exceeds 100 GB and undergoes frequent changes, it is recommended to add a separate BACKUP storage for reliable backup; the backup capacity is advised to be set at about 60 % of the DATA capacity. If a BACKUP storage is not added, the /tmp area is used, and backup fails if capacity is insufficient For each service, Archive, TEMP, and BACKUP storages are allocated only one Block Storage each
     Redundant configuration	Select	Redundancy configuration status When redundancy configuration is used, the DB instance is set up as an Active DB and a Standby DB
     Network > Common Settings	required	Network settings for the servers created by the service
     Select when you want to apply the same settings to all installed servers
     Select a pre‑created VPC, Subnet, IP, and Public NAT
     Each server’s IP is generated automatically
     The Public NAT feature is available only when the VPC is connected to an Internet Gateway. Selecting Use allows you to choose from the reserved IPs in the VPC product’s Public IP. For more details, refer to Public IP 생성하기
     Network > Server Settings	required	Network settings where servers generated by the service are installed Select when you want to apply different settings per installed server Select a pre‑created VPC, Subnet, IP, and Public NAT Enter the IP for each server The Public NAT feature is available only when the VPC is connected to an Internet Gateway. Use when checked, you can select from reserved IPs in the VPC product’s Public IP. For more details, see Creating Public IP
     IP access control	Selection	Service access policy configuration Since the access policy is set for the IP entered on the page, you do not need to configure a separate Security Group policy Enter the IP 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 the Add button To delete an entered IP, click the x button next to the IP
     Maintenance period	Selection	DB maintenance window If you select Use, set the day of week, start time, and duration The maintenance window is a feature that allows the user to set the time slot for performing patch operations, and any patch work within that period must be performed directly by the user. We ask you to set a maintenance window for the stable operation of the system, and we are not responsible for any issues arising from not setting it or from failure to perform tasks within the window.

     Table. PostgreSQL (DBaaS) Service Information Input Items
   • Database Configuration Required Information Input Enter or select the required information in the area.

     Category	Required status	Detailed description
     Database name	Required	Server name applied when installing DB starts with an English letter and must be entered using English letters and numbers, 3 to 20 characters
     Database username	Required	DB user name An account with the same name is also created on the OS Enter using lowercase English letters, 2 to 20 characters Restricted database user names can be checked in the Console
     Database password	Required	Password to use when accessing the DB Enter 8 to 30 characters, including letters, numbers, and special characters (excluding “ ‘)
     Verify Database Password	required	Re-enter the same password to be used for DB access.
     Database Port number	Required	Port number required for DB connection Enter the DB port within the range 1200 to 65535
     Backup > Use	Selection	Backup usage Select Use to set the backup file retention period, backup start time, and Archive backup interval
     Backup > Retention Period	Selection	Backup retention period Select the backup retention period, and set the file retention period from 7 days to 35 days Backup files incur additional charges based on their size
     Backup > Backup Start Period	Selection	Backup start time Select backup start time The minutes (minutes) during which the backup runs are set randomly, and the backup end time cannot be configured
     Backup > Archive backup cycle	Select	Archive backup interval Select the archive backup interval The archive backup interval is recommended at 1 hour. Selecting 5 minutes, 10 minutes, or 30 minutes may affect DB performance.
     Audit Log Settings	Select	Whether to store Audit Log Select Use to configure the Audit Log feature DDL, DML, and user connection information records are stored Users can specify the type of SQL statements to audit via the log_statement parameter, and can modify it through the Parameter screen For detailed information about this parameter, refer to the PostgreSQL documentation Enabling Audit may degrade database performance
     ServiceWatch log collection	Select	ServiceWatch log collection status Select Use to configure the ServiceWatch log collection feature It is provided free of charge up to 5 GB for all services within the Account, and charges apply based on storage size if it exceeds 5 GB. When collected, log groups and log streams are created automatically, and they cannot be deleted until the resource is removed. To prevent exceeding 5 GB, it is recommended to delete log data directly or shorten the retention period.
     Parameter	required	Parameters to be used in the DB Query button can be clicked to view detailed information of the parameter Parameters can be modified after the DB creation is complete, and after modification the DB must be restarted
     Database Encoding	Required	Character encoding method to use for the DB Character set used when storing text data The DB is created with the selected encoding set as default
     DB Locale	required	Locale to be used in the DB settings related to string handling, number/currency/date/time formatting, etc. The DB is created with the selected Locale as the default setting
     time zone	required	Standard time zone for the database

     Table. PostgreSQL(DBaaS) Database configuration items
   • In the Additional Information Input area, enter or select the required information.

     Category	Required status	Detailed description
     tag	Select	Add Tag Up to 50 per resource can be added After clicking the Add Tag button, enter or select Key, Value values

     Table. PostgreSQL(DBaaS) additional information input fields

4. Summary Check the detailed information and estimated billing amount generated in the panel, and click the Create button.

   • When creation is complete, check the created resource on the Resource List page.

PostgreSQL(DBaaS) Check detailed information

The PostgreSQL (DBaaS) service allows you to view and edit the full resource list and detailed information. PostgreSQL(DBaaS) Details page consists of Details, Tags, Activity History tabs, and when the DB has a Replica configured, an additional Replica Information tab is included.

Follow the steps below to view detailed information about the PostgreSQL (DBaaS) service.

1. All Services > Database > PostgreSQL(DBaaS) Click the menu. 1. Navigate to the Service Home page of PostgreSQL (DBaaS).
2. On the Service Home page, click the PostgreSQL(DBaaS) menu. 2. PostgreSQL(DBaaS) List Navigate to the page.
3. PostgreSQL(DBaaS) List Click the resource to view detailed information on the page. 3. PostgreSQL(DBaaS) Details Go to the page.
   • PostgreSQL(DBaaS) Details The top of the page displays status information and details about additional features.

     Category	Detailed description
     Cluster status	Cluster status with DB installed Creating: Cluster is being created Editing: Cluster is being changed to an operational state Error: Cluster encountered an error while performing tasks If it occurs continuously, contact the administrator Failed: Cluster failed during creation Restarting: Cluster is being restarted Running: Cluster is operating normally Starting: Cluster is starting Stopped: Cluster is stopped Stopping: Cluster is being stopped Synchronizing: Cluster is synchronizing Terminating: Cluster is being terminated Unknown: Cluster status is unknown If it occurs continuously, contact the administrator Upgrading: Cluster is being upgraded
     Cluster control	Buttons that can change the cluster state Start: Start a stopped cluster Stop: Stop a running cluster Restart: Restart a running cluster Switch-Over: Convert a standby cluster to active
     More features	Cluster management buttons Service status synchronization: View real-time DB service status Backup history: If backup is configured, verify successful execution and view the history Database recovery: Recover the DB based on a specific point in time Parameter management: View and modify DB configuration parameters Replica configuration: Configure a read-only cluster as a Replica Replica configuration (Other Region): Configure a disaster-recovery Replica in another region; if the account has no region to configure, the button is disabled DB user management: View and manage DB account (user) information registered in the DB DB access control management: Register and revoke IPs allowed to access based on DB accounts registered in the DB Archive settings management: Set archive file retention period and configure archive mode DB Log export: Export stored logs to the user’s Object Storage via audit settings Migration configuration: Provides migration functionality using replication method Block Storage usage management: Provides usage query functionality per Block Storage type OS (Kernel) upgrade: Upgrade OS Kernel version
     Service cancellation	Cancel service button

     Table. PostgreSQL (DBaaS) status information and additional features

Detailed Information

PostgreSQL (DBaaS) List page allows you to view detailed information of the selected resource and, if needed, modify the information.

Replica information

Replica information tab is enabled only when a Replica is configured in the cluster. Replica information tab allows you to view the Master cluster name, replica count, and the replication status of the Replica.

Tag

PostgreSQL (DBaaS) List page allows you to view the tag information of the selected resource, and you can add, modify, or delete it.

Job History

PostgreSQL(DBaaS) List page allows you to view the operation history of the selected resource.

PostgreSQL(DBaaS) Managing Resources

If you need to change or restore the existing configuration options of a created PostgreSQL (DBaaS) resource, or require a replica configuration, you can perform the task on the PostgreSQL(DBaaS) Details page.

Control Operation

If changes occur to a running PostgreSQL (DBaaS) resource, you can start, stop, or restart it. Also, when HA is configured, you can switch the Active-Standby servers via a switch‑over.

To control the operation of PostgreSQL (DBaaS), follow the steps below.

1. All Services > Database > PostgreSQL(DBaaS) Click the menu. 1. Navigate to the Service Home page of PostgreSQL (DBaaS).
2. On the Service Home page, click the PostgreSQL(DBaaS) menu. 2. PostgreSQL(DBaaS) List Go to the page.
3. On the PostgreSQL(DBaaS) List page, click the resource you wish to control. 3. PostgreSQL(DBaaS) Details Navigate to the page.
4. Check the PostgreSQL (DBaaS) status and complete the change using the control button below.
   • Start: The server where the DB service is installed and the DB service are running(Running).
   • Stop: The server where the DB service is installed and the DB service will be stopped (Stopped).
   • Restart: Only the DB service will be restarted.
   • Switch Over: You can switch the DB’s active server and standby server.

Synchronize service status

You can synchronize the real-time service status of PostgreSQL (DBaaS).

Follow the steps below to check the service status of PostgreSQL (DBaaS).

1. All Services > Database > PostgreSQL(DBaaS) Click the menu. 1. Go to the Service Home page of PostgreSQL (DBaaS).
2. On the Service Home page, click the PostgreSQL(DBaaS) menu. 2. PostgreSQL(DBaaS) List Go to the page.
3. PostgreSQL (DBaaS) List page, click the resource to view the service status. 3. PostgreSQL(DBaaS) Details Navigate to the page.
4. Click the Service Status Synchronization button. 4. During the query, the cluster changes to Synchronizing state.
5. Once the query completes, the status in the server information field is updated, and the cluster changes to Running status.

Change Server Type

You can change the configured server type.

Follow these steps to change the server type.

1. Click the All Services > Database > PostgreSQL(DBaaS) menu. 1. Go to the Service Home page of PostgreSQL (DBaaS).
2. Click the PostgreSQL(DBaaS) menu on the Service Home page. 2. PostgreSQL(DBaaS) List Go to the page.
3. On the PostgreSQL(DBaaS) list page, click the resource to change the server type. 3. PostgreSQL(DBaaS) Details Navigate to the page.
4. Click the Edit icon of the server type you want to change at the bottom of the detailed information. 4. Edit Server Type The popup window opens.
5. Edit Server Type In the popup, after selecting the server type, click the Confirm button.

Add storage

If you need more than 5 TB of data storage, you can add additional storage. In the case of a redundant DB configuration, all redundant servers are added simultaneously.

To add storage, follow the steps below.

1. All Services > Database > PostgreSQL(DBaaS) Click the menu. 1. Go to the Service Home page of PostgreSQL (DBaaS).
2. On the Service Home page, click the PostgreSQL(DBaaS) menu. 2. PostgreSQL(DBaaS) List Go to the page.
3. Click the resource to add storage on the PostgreSQL(DBaaS) List page. 3. PostgreSQL(DBaaS) Details Navigate to the page.
4. Click the Add Disk button at the bottom of the detailed information. 4. Additional Storage Request The popup window opens.
5. Additional Storage Request In the popup window, after entering purpose and capacity, click the Confirm button.

Expanding Storage

Storage added to the data area can be expanded up to a maximum of 5 TB based on the initially allocated capacity. In the case of a redundant DB configuration, all redundant servers are expanded simultaneously.

To increase storage capacity, follow these steps.

1. Click the All Services > Database > PostgreSQL(DBaaS) menu. 1. Navigate to the Service Home page of PostgreSQL (DBaaS).
2. On the Service Home page, click the PostgreSQL(DBaaS) menu. 2. PostgreSQL(DBaaS) List Go to the page.
3. On the PostgreSQL(DBaaS) List page, click the resource whose server type you want to change. 3. Go to the PostgreSQL(DBaaS) Details page.
4. Click the Edit icon of the additional Disk you want to add at the bottom of the detailed information. 4. Edit Additional Storage The popup window opens.
5. Edit Additional Storage After entering the expansion capacity in the popup window, click the Confirm button.

PostgreSQL(DBaaS) Terminate

You can cancel unused PostgreSQL (DBaaS) to reduce operating costs. However, if you terminate the service, the currently operating service may be discontinued immediately, so you should proceed with the termination only after fully considering the impact of the service interruption.

If you want to cancel PostgreSQL (DBaaS), follow the steps below.

1. Click the All Services > Database > PostgreSQL(DBaaS) menu. 1. Navigate to the Service Home page of PostgreSQL (DBaaS).
2. On the Service Home page, click the PostgreSQL(DBaaS) menu. 2. PostgreSQL(DBaaS) List Navigate to the page.
3. PostgreSQL(DBaaS) List On the page, select the resource to cancel and click the Cancel Service button.
4. Once termination is complete, verify on the PostgreSQL(DBaaS) list page that the resource has been terminated.