How-to guides

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

Create PostgreSQL (DBaaS)

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

To create 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. Navigate to the Create PostgreSQL (DBaaS) page.

3. Create PostgreSQL (DBaaS) page, enter the information required to create the service and select advanced 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 options
   • In the Service Information Input area, enter or select the required information.

     Category	required status	Detailed description
     Server name Prefix	Required	Server name where the DB will be installed must start with a lowercase English letter and be entered using lowercase letters, numbers, and the special character (-) with a length of 3 to 13 characters A postfix such as 001, 002 is appended to the base server name to generate the actual server name
     Cluster name	Required	Cluster name of 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 specifications 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	Status of resources 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 application page For more details, see Planned Compute Apply
     Service Type > Block Storage	Required	Block Storage configuration used by the DB according to its 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 (refer to 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 Enter capacity 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 must 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 changes frequently, it is recommended to add a separate BACKUP storage for reliable backup; set the backup capacity to about 60 % of the DATA capacity If a BACKUP storage is not added, the /tmp area is used, and backup will fail 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 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 IP can only be generated automatically The Public NAT feature is available only when the VPC is connected to an Internet Gateway; when Use is checked, you can select a reserved IP from the VPC product’s Public IP pool. For more information, see Public IP 생성하기
     Network > Server-specific Settings	Required	Network settings where servers generated by the service are installed Select when you want to apply different settings for each 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. If you check Use, you can select a reserved IP from the VPC product’s Public IP. For more details, refer to Public IP 생성하기
     IP access control	Select	Service Access Policy Configuration Since the access policy is set for the IP entered on the page, a separate Security Group policy configuration is not 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 an entered IP, click the x button next to the entered IP
     maintenance period	Select	Database maintenance window If you select Use, set the day, start time, and duration It is recommended to set a maintenance window for stable management of the database. Patch operations will be performed at the scheduled time, causing service interruption If set to not use, Samsung SDS is not responsible for issues arising from unapplied patches.

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

     Category	required status	Detailed description
     Database name	Required	Server name applied during DB installation must start with an English letter and 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 viewed 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 “ ‘)
     Database password verification	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 ~ 65535
     Backup > Use	Select	Backup usage Select Use to set the backup file retention period, backup start time, and Archive backup interval
     Backup > Retention period	Select	Backup retention period Select the backup retention period, set the file retention period from 7 days to 35 days Backup files incur additional charges based on 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 set
     Backup > Archive backup cycle	Select	Archive backup frequency Select the archive backup frequency The archive backup frequency is recommended to be 1 hour. Selecting 5 minutes, 10 minutes, or 30 minutes may affect DB performance.
     Audit Log Settings	Select	Whether to store Audit Log Select Enable 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
     Parameter	Required	Parameters to be used in the DB Lookup button can be clicked to view detailed information of the parameter Parameters can be modified after the DB creation is complete, and the DB must be restarted after any modifications
     Database Encoding	Essential	Character encoding method to be used for the DB Character set used when storing text data The DB is created with the selected encoding as the default setting
     DB Locale	Required	Locale to be used for the DB settings related to string handling, number/currency/date/time formatting, etc. The DB is created with default settings using the selected Locale
     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 Review the detailed information and estimated charges generated in the panel, then click the Create button.

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

View PostgreSQL (DBaaS) details

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

To view detailed information about the PostgreSQL (DBaaS) service, 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 Navigate to the page.
3. PostgreSQL(DBaaS) List Click the resource on the page to view detailed information. 3. PostgreSQL(DBaaS) Details Go to the page.
   • PostgreSQL(DBaaS) Details The top of the page displays status information and additional feature details.

     Category	Detailed description
     Cluster status	Cluster status with DB installed Creating: Creating cluster Editing: Cluster is transitioning to an operational state Error: Cluster encountered an error during operation If it occurs continuously, contact the administrator Failed: Cluster failed during creation Restarting: Restarting cluster Running: Cluster is running normally Starting: Starting cluster Stopped: Cluster is stopped Stopping: Cluster is stopping Synchronizing: Synchronizing cluster Terminating: Terminating cluster Unknown: Unknown cluster status If it occurs continuously, contact the administrator Upgrading: Cluster is transitioning to an upgrading state
     Cluster control	Button to change the cluster state Start: Start a stopped cluster Stop: Stop a running cluster Restart: Restart a running cluster Switch-Over: Switch a standby cluster to active
     View more features	Cluster-related management buttons Service status synchronization: Retrieve real-time DB service status Backup history: When 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: Set up a read‑only Replica cluster Replica configuration (Other Region): Set up 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 allowed IPs based on DB accounts registered in the DB Archive settings management: Set archive file retention period and enable archive mode Export DB logs: Export logs stored via audit settings to the user’s Object Storage Migration configuration: Provide migration functionality using replication method OS (Kernel) upgrade: Upgrade the OS kernel version
     Service termination	Button to cancel the service

     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, edit the information.

Replica information

Replica information tab is enabled only when a Replica is configured in the cluster. Through the Replica information tab, you can view the Master cluster name, the number of replicas, and the replication status of the Replica.

tag

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

Work History

On the PostgreSQL (DBaaS) List page, you can view the operation history of the selected resource.

Managing PostgreSQL (DBaaS) 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 operation 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 Navigate to the page.
3. PostgreSQL (DBaaS) List On the page, click the resource you want 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: DB service is installed on the server and the DB service is running (Running).
   • Stop: The server hosting the DB service and the DB service itself are 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).

To check the service status of PostgreSQL (DBaaS), follow the steps below.

1. Click the All Services > Database > PostgreSQL(DBaaS) 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 Navigate to the page.
3. PostgreSQL(DBaaS) List Click the resource on the page to view the service status. 3. PostgreSQL(DBaaS) Details Navigate to the page.
4. Click the Service Status Synchronization button. 4. While it is being queried, the cluster changes to Synchronizing state.
5. When the query completes, the status in the server information field is updated, and the cluster changes to the Running state.

Change server type

You can change the configured server type.

To change the server type, follow these steps.

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 Navigate to the page.
3. On the PostgreSQL (DBaaS) List page, click the resource whose server type you want to change. 3. PostgreSQL(DBaaS) Details Go 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 After selecting the server type in the popup window, click the Confirm button.

Add storage

If you need more than 5 TB of data storage, you can add additional storage. For a DB configured with redundancy, all redundant servers are added simultaneously.

To add storage, follow these steps.

1. Click the All Services > Database > PostgreSQL(DBaaS) 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. On the PostgreSQL (DBaaS) List page, click the resource to add storage. 3. PostgreSQL(DBaaS) Details Go to the page.
4. Click the Add Disk button at the bottom of the details. 4. Additional Storage Request The popup window opens.
5. Additional Storage Request In the popup window, after entering the purpose and size, click the Confirm button.

Expand storage

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

To increase storage capacity, follow the steps below.

1. Click the All Services > Database > PostgreSQL(DBaaS) 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 Navigate to the page.
3. On the PostgreSQL(DBaaS) List page, click the resource you want to change the server type for. 3. PostgreSQL(DBaaS) Details Go to the 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 In the popup window, after entering the expansion capacity, click the Confirm button.

Cancel PostgreSQL (DBaaS)

You can cancel unused PostgreSQL (DBaaS) to reduce operating costs. However, if you terminate the service, the running service may be stopped immediately, so you should proceed with the termination only after fully considering the impact that may occur when the service is discontinued.

To cancel PostgreSQL (DBaaS), follow these steps.

1. Click the All Services > Database > PostgreSQL(DBaaS) 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 Navigate to the page.
3. On the PostgreSQL (DBaaS) List page, select the resource to cancel and click the Cancel Service button.
4. After termination is complete, check on the PostgreSQL(DBaaS) list page whether the resource has been terminated.