How-to guides

Users can enter the required information for PostgreSQL (DBaaS) through the Samsung Cloud Platform Console, select detailed options, and create the service.

Creating PostgreSQL(DBaaS)

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

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

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

2. Click the PostgreSQL(DBaaS) Create button on the Service Home page. Navigate to the PostgreSQL(DBaaS) Create page.

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

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

     Category	Required or not	Detailed description
     Image version	Required	Provide version list of PostgreSQL (DBaaS)

     Table. PostgreSQL (DBaaS) image and version selection items
   • Service Information Input Enter or select the required information in the area.

     Category	Required or not	Detailed description
     Server Name Prefix	Required	Server name where DB will be installed Start with an English lowercase letter, and use lowercase letters, numbers, and the special character (-) to input 3 to 13 characters Based on the server name, a postfix such as 001, 002 is attached to create the actual server name
     Cluster Name	Required	Cluster name of DB servers Enter using English letters, 3 ~ 20 characters A cluster is a unit that groups multiple servers
     Service Type > Server Type	Required	Server type where DB will be installed Standard: Standard specifications commonly used High Capacity: Large-capacity server of 24 vCore or more For detailed information about server types provided by PostgreSQL (DBaaS), refer to PostgreSQL(DBaaS) Server Type
     Service Type > Planned Compute	Select	Status of resources with Planned Compute set In Use: Number of resources with Planned Compute set that are currently in use Configured: Number of resources with Planned Compute set Coverage Preview: Amount applied by Planned Compute per resource Create Planned Compute Service: Go to the Planned Compute service application page For more details, refer to Apply for Planned Compute
     Service Type > Block Storage	Required	Set Block Storage used by DB according to purpose Base OS: Area where DB engine is installed DATA: Storage area for table data, archive files, etc. After selecting storage type, enter capacity (refer to Create Block Storage for details of each Block Storage type) SSD: High-performance general volume HDD: General volume SSD_KMS, HDD_KMS: Additional encrypted volumes using 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 large sorts from SQL execution or monthly batch may cause service interruption, 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 the same as set for DATA, and capacity can be entered as a multiple of 8 within 16 ~ 5,120 Click the + button to add storage, x button to delete. Up to 9 can be added Backup data is temporarily stored in BACKUP storage before transmission If backup data exceeds 100 GB and changes frequently, it is recommended to add a separate BACKUP storage for reliable backup; set backup capacity to about 60% of DATA capacity If BACKUP storage is not added, using the /tmp area is recommended For each service, Archive, TEMP, BACKUP storages are allocated only one Block Storage
     Redundancy Configuration	Select	Redundancy Configuration Status If redundancy configuration is used, the DB instance is configured as Active DB and Standby DB
     Network > Common Settings	Required	Network settings where servers generated by the service are installed Select if you want to apply the same settings to all servers being installed Select a pre-created VPC, Subnet, IP, Public NAT IP can only be auto-generated The Public NAT feature is available only when the VPC is connected to an Internet Gateway; if you check Use, you can select from reserved IPs in the VPC product’s Public IP. For details, see Create Public IP
     Network > Server-specific Settings	Required	Network settings where servers generated by the service are installed Select if 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 from reserved IPs in the VPC product’s Public IP. For more details, see Create Public IP.
     IP Access Control	Select	Service Access Policy Settings Since the access policy is set for the IP entered on the page, a separate Security Group policy setting is 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 the Add button To delete an entered IP, click the x button next to the entered IP
     Maintenance Period	Select	DB Maintenance Period If Use is selected, set the day of the week, start time, and duration. It is recommended to set a maintenance period for stable DB management. Patch work will be performed at the set time, causing service interruption. If set to not use, Samsung SDS is not responsible for issues arising from patches not being applied.

     Table. PostgreSQL(DBaaS) Service Information Input Items
   • Database Configuration Required Information Input In the area, please enter or select the required information.

     Category	Required or not	Detailed description
     Database name	Required	Server name applied when installing DB Start with English letters, use English letters and numbers, input 3 ~ 20 characters
     Database username	Required	DB user name An account with that name is also created on the OS Enter using lowercase English letters, 2 to 20 characters Restricted Database usernames can be checked in the Console
     Database Password	Required	Password to use when accessing the DB Enter 8~30 characters including letters, numbers, and special characters (excluding “ and ‘)
     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 DB port within the range 1,024 ~ 65,535
     Backup > Use	Select	Whether to use backup Use to set backup file retention period, backup start time, Archive backup cycle
     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 are charged separately based on size
     Backup > Backup Start Period	Select	Backup Start Time Select backup start time The minutes at which the backup runs are set randomly, and the backup end time cannot be set
     Backup > Archive Backup Frequency	Select	Archive Backup Frequency Select the Archive Backup Frequency Archive Backup Frequency 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 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 Refer to the PostgreSQL documentation for details on this parameter Enabling Audit may degrade DB performance
     Parameter	Required	Parameters to use in the DB Click the Search button to view detailed information of the parameters Parameters can be modified after DB creation is complete, and the DB must be restarted after modification
     Database Encoding	Required	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 use for DB Settings related to string processing, number/currency/date/time display formats, etc. The DB is created with default settings using the selected Locale
     Time zone	Required	Standard time zone to be used by the Database

     Table. PostgreSQL(DBaaS) Database configuration items
   • Additional Information Input Enter or select the required information in the area.

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

     Table. PostgreSQL(DBaaS) Additional Information Input Items

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

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

PostgreSQL(DBaaS) Check detailed information

PostgreSQL(DBaaS) service can view and edit the full resource list and detailed information. PostgreSQL(DBaaS) Details page consists of Details, Tags, Activity History tabs, and for databases with a Replica configured, a Replica Information tab is additionally provided.

To view detailed information of the PostgreSQL (DBaaS) service, follow the steps below.

1. All Services > Database > PostgreSQL(DBaaS) Click the menu. Navigate to the Service Home page of PostgreSQL(DBaaS).
2. Click the PostgreSQL(DBaaS) menu on the Service Home page. Move to the PostgreSQL(DBaaS) List page.
3. Click the resource to view detailed information on the PostgreSQL(DBaaS) List page. It moves to the PostgreSQL(DBaaS) Details page.

• PostgreSQL(DBaaS) Details At the top of the page, status information and additional feature information are displayed.

  Category	Detailed description
  Cluster Status	Cluster status with DB installed Creating: Cluster is being created Editing: Cluster is changing to operation execution 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 being started Stopped: Cluster is stopped Stopping: Cluster is being stopped Synchronizing: Cluster is being synchronized Terminating: Cluster is being deleted Unknown: Cluster status is unknown If it occurs continuously, contact the administrator Upgrading: Cluster is changing to upgrade execution state
  Cluster Control	Buttons to change 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
  More functions	Cluster related management buttons Service status synchronization: View real-time DB service status Backup history: If backup is set, check whether backup runs normally and view history Database recovery: Recover DB based on a specific point in time Parameter management: View and modify DB configuration parameters Replica configuration: Configure a read-only cluster Replica; if there is no region to configure for the account, the button is disabled Replica configuration (Other Region): Configure a disaster recovery Replica in another region 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 management: Set archive file retention period and archive mode Export DB Log: Export logs stored via audit settings to the user’s Object Storage Migration configuration: Provide migration function using replication method
  Service cancellation	Button to cancel the service

  Table. PostgreSQL(DBaaS) status information and additional features

Detailed Information

PostgreSQL(DBaaS) List On the page, you can view detailed information of the selected resource and, if necessary, 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 check the master cluster name, the number of replicas, 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.

Work History

You can view the operation history of the selected resource on the PostgreSQL(DBaaS) List page.

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 work on the PostgreSQL (DBaaS) Details page.

Operating Control

If changes occur to the running PostgreSQL (DBaaS) resources, you can start, stop, or restart them. Also, if 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. Navigate to the Service Home page of PostgreSQL(DBaaS).
2. Click the PostgreSQL(DBaaS) menu on the Service Home page. Navigate to the PostgreSQL(DBaaS) list page.
3. PostgreSQL(DBaaS) List Click the resource to control operation on the page. 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 is 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).

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

1. All Services > Database > PostgreSQL(DBaaS) Click the menu. Go to the Service Home page of PostgreSQL(DBaaS).
2. Service Home page, click the PostgreSQL(DBaaS) menu. Navigate to the PostgreSQL(DBaaS) list page.
3. PostgreSQL(DBaaS) List Click the resource to view the service status on the page. PostgreSQL(DBaaS) Details Navigate to the page.
4. Service status synchronization Click the button. While it is being queried, the cluster changes to Synchronizing state.
5. When the query is completed, the status is updated in the server information item, and the cluster changes to Running state.

Change Server Type

You can change the configured server type.

To change the server type, follow the steps below.

1. All Services > Database > PostgreSQL(DBaaS) Click the menu. Navigate to the Service Home page of PostgreSQL(DBaaS).
2. Click the PostgreSQL(DBaaS) menu on the Service Home page. Navigate to the PostgreSQL(DBaaS) List page.
3. PostgreSQL(DBaaS) 목록 Click the resource to change the server type on the page. PostgreSQL(DBaaS) 상세 Navigate to the page.
4. Click the Edit icon of the server type you want to change at the bottom of the detailed information. The Edit Server Type popup window will open.
5. Server Type Edit 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 space, you can add 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. Navigate to the Service Home page of PostgreSQL(DBaaS).
2. Click the PostgreSQL(DBaaS) menu on the Service Home page. Go to the PostgreSQL(DBaaS) List page.
3. PostgreSQL(DBaaS) List on the page, click the resource to add storage. PostgreSQL(DBaaS) Details navigate to the page.
4. At the bottom of the detailed information, click the Add Disk button. The Add Storage Request popup window opens.
5. Additional Storage Request After entering purpose and capacity in the popup window, click the Confirm button.

Expanding storage

You can expand the storage added to the data area 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 the steps below.

1. All Services > Database > PostgreSQL(DBaaS) Click the menu. Navigate to the Service Home page of PostgreSQL(DBaaS).
2. Click the PostgreSQL(DBaaS) menu on the Service Home page. Go to the PostgreSQL(DBaaS) list page.
3. PostgreSQL(DBaaS) List page, click the resource to change the server type. You will be taken to the PostgreSQL(DBaaS) Details page.
4. Click the Edit icon of the additional Disk you want to expand at the bottom of the detailed information. Edit Additional Storage popup window opens.
5. Add Storage Modification In the popup window, after entering the expansion capacity, click the Confirm button.

PostgreSQL(DBaaS) Cancel

You can cancel unused PostgreSQL (DBaaS) to reduce operating costs. However, if you cancel the service, the running service may be stopped immediately, so you should consider the impact of service interruption sufficiently before proceeding with the cancellation.

To cancel PostgreSQL (DBaaS), follow the steps below.

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