How-to guides

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

Create Scalable DB(DBaaS)

You can create and use the Scalable DB (DBaaS) service in the Samsung Cloud Platform Console.

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

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

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

3. On the Scalable DB(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 version list of Scalable DB (DBaaS)

     Table. Scalable DB (DBaaS) Image and version selection items
   • Service Information Input (Primary Node) 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 using lowercase letters, numbers, and special characters (-) enter 3 - 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 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 on which the DB will be installed High Capacity: Large-capacity server with 24 vCores or more For detailed information about the server types provided by Scalable DB (DBaaS), refer to Scalable DB(DBaaS) 서버 타입.
     Service Type > Planned Compute	Select	Status of resources with Planned Compute configured In Use: Number of resources with Planned Compute 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 Request
     Service Type > Block Storage	Required	Block Storage settings used by the DB according to purpose Base 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 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 large sorts during SQL execution or monthly batch jobs can cause service interruptions, a separate TEMP storage must be allocated and used Add: Storage areas for DATA, Archive, TEMP, Backup data 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 Before transmitting backup data, temporarily store it in the BACKUP storage 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 BACKUP storage is not added, using the /tmp area is recommended For each service, Archive, TEMP, and BACKUP storages are allocated only one Block Storage each
     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; checking use allows you to select from reserved IPs in the VPC product’s Public IP. For more details, 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 When Use is checked, you can select a reserved IP from the VPC product’s Public IP. For more information, refer to 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 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 DB. 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. Scalable DB(DBaaS) Primary Node Service Information Input Items
   • Service Information Input (Read Node) Enter or select the required information in this area.

     Category	required status	Detailed description
     Read Node count	Required	Select the number of Read Nodes to create within the range 1 - 5 The Host name is automatically assigned as a combination of the server name prefix + r + a three‑digit number (001 - 999) for each Node
     Service Type > Server Type	Required	Server type on which the DB will be installed High Capacity: large-capacity server with 24 vCores or more For detailed information about the server types provided by Scalable DB (DBaaS), refer to Scalable DB(DBaaS) 서버 타입.
     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 신청하기
     Service Type > Block Storage	Required	Block Storage settings used by the DB according to purpose Base 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 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 large sorts during SQL execution or monthly batch jobs can cause service interruptions, a separate TEMP storage must be allocated and used Add: Storage areas for DATA, Archive, TEMP, Backup data After selecting Use, enter the storage’s purpose and capacity The storage type is applied the same as the type set for DATA, and the 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 Before transmitting backup data, temporarily store it in the BACKUP storage 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, using the /tmp area is recommended For each service, Archive, TEMP, and BACKUP storages are allocated only one Block Storage each
     Network > Common Settings	Required	Network settings for servers created by the service Select when you want to apply the same configuration to all installed servers Automatically apply the same as the Primary Node configuration items
     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 Automatically applied same as the Primary Node configuration items, IP information can be entered manually
     Scaling Policy Settings > Node Count	Required	Enter the number of Read Nodes referenced commonly by both Auto Scaling and Manual Scaling Min: Enter the minimum number of nodes to maintain based on the scaling policy, within the range 1 - 5 Max: Enter the maximum number of nodes to maintain based on the scaling policy, within the range 1 - 5
     Scaling policy configuration > Auto Scale-out policy	option	Auto Scale-out policy detailed settings Use after selecting, set the detailed items of the execution condition of the Auto Scale-out policy Enter the wait time for the Cooldown item, after the scaling operation by the policy is completed, before restarting the scaling operation, enter the wait time within the range 60 – 3,600
     Scaling Policy Settings > Auto Scale-in Policy	option	Auto Scale-in policy detailed settings After selecting Use, configure the detailed items of the execution condition of the Auto Scale-out policy Enter the wait time for the Cooldown item; after the scaling operation by the policy is completed, input the wait time within the range of 60 – 3,600 before restarting the scaling operation

     Table. Scalable DB (DBaaS) Read Node Service Information Input Items
   • Enter or select the required information in the Proxy Service Information Input area.

     Category	required status	Detailed description
     Proxy Endpoint Settings > Read Endpoint Port	Required	Set the port to connect to the Read Node that handles read requests The port cannot be the same as the Database Port and must be entered within the range 1200 - 65535
     Proxy Endpoint Settings > Write Endpoint Port	Required	Set the Port to connect to the Primary Node that will handle write requests The port cannot be the same as the Database Port and must be entered within the range 1200 - 65535
     Proxy Endpoint Settings > Connection Idle Time	Required	Enter the idle time in milliseconds (ms) before automatically terminating a client connection with no request Enter a value within the range 0 - 1,728,000,000
     Proxy Endpoint Settings > Read Connection Count	Required	Set the maximum number of connections that a Proxy can create simultaneously with a Read Node Enter within the range 10 - 100,000
     Proxy Endpoint Settings > Write Connection Count	Required	Set the maximum number of connections that a Proxy can create simultaneously with the Primary Node Enter within the range 10 - 100,000
     Proxy Endpoint Settings > Lagging Time	Required	Set the Replication delay time allowed for the Read Node Enter a value in the range 0 - 126,144,000

     Table. Scalable DB (DBaaS) Proxy Service Information Input Items
   • In the Enter required database configuration information area, enter or select the necessary information.

     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 - 20 characters long
     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 - 30 characters including letters, numbers, and special characters (excluding “ ‘)
     Database password verification	Required	Re-enter the same password to use for DB access
     Database Port number	Required	Port number required for DB connection Enter the DB port within the range 1200 ~ 65535
     Backup > Use	Selection	Backup usage Select Use to set backup file retention period, backup start time, and Archive backup interval
     Backup > Retention Period	Selection	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 Time	Selection	Backup start time Select backup start time The minutes during which the backup runs (minutes) are set randomly, and the backup end time cannot be set
     Backup > Archive backup cycle	Selection	Archive backup interval Select the archive backup interval The archive backup interval is recommended to be 1 hour. Selecting 5 minutes, 10 minutes, or 30 minutes may affect DB performance.
     Parameter	Required	Parameters to be used in the DB Query button can be clicked to view detailed information of the parameters
     DB character set	Required	Set the DB character set appropriate for the characters (language) to be used in the DB The DB is created with the selected character set as the default
     time zone	Required	Standard time zone for the database
     ServiceWatch log collection	Selection	ServiceWatch log collection status use to enable the ServiceWatch log collection feature For detailed information about the collected logs, see ServiceWatch 지표 Up to 5 GB is provided free of charge for all services within the account, and charges apply based on storage size for usage exceeding 5 GB When collecting, log groups and log streams are created automatically and cannot be deleted until the resources are removed To prevent exceeding 5 GB, it is recommended to delete log data directly or shorten the retention period

     Table. Essential items for configuring a Scalable DB (DBaaS) database
   • In the Additional Information Input area, enter or select the required information.

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

     Table. Scalable DB (DBaaS) additional information input fields

4. Summary panel, check the detailed information and estimated charges generated, and click the Create button.

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

Scalable DB(DBaaS) View detailed information

The Scalable DB (DBaaS) service allows you to view and edit the full list of resources and detailed information. Scalable DB (DBaaS) Details page consists of Details, Read Node Status View, Auto Scaling Policy, Tags, Operation History tabs.

To view detailed information about the Scalable DB (DBaaS) service, follow these steps.

1. All Services > Database > Scalable DB(DBaaS) Click the menu. 1. Go to the Service Home page of Scalable DB (DBaaS).
2. On the Service Home page, click the Scalable DB(DBaaS) menu. 2. Navigate to the Scalable DB(DBaaS) List page.
3. On the Scalable DB(DBaaS) List page, click the resource to view detailed information. 3. Scalable DB(DBaaS) Details Navigate to the page.
   • Scalable DB(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: 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 upgrading
     Cluster control	Button to change the cluster state Start: Start a stopped cluster Stop: Stop a running cluster
     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 Add node: Add a Read Node to the DB; for detailed instructions on adding nodes, see 노드 추가하기 Delete node: Delete a Read Node from the DB; for detailed instructions on deleting nodes, see 노드 삭제하기 Proxy Endpoint configuration management: View and modify Proxy Endpoint settings; for detailed instructions on node deletion, see Proxy Endpoint 설정 관리하기
     Service termination	Button to cancel the service

     Table. Scalable DB (DBaaS) status information and additional features

Detailed Information

Scalable DB (DBaaS) List page allows you to view detailed information of the selected resource and edit the information if needed.

Read Node status query

Read Node Status View tab allows the user to view the server status and replication status of the configured Read Node. For detailed information, please refer to Read Node Status Query.

Auto Scaling policy

The Auto Scaling policy tab lets you add, modify, and delete Auto Scaling policies to manage the automatic scaling and shrinking of Read Nodes. For more details, please refer to Auto Scaling 정책 설정하기.

Tag

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

Job History

Scalable DB(DBaaS) List page lets you view the operation history of the selected resource.

Managing Scalable DB (DBaaS) Resources

If you need to manage the created Scalable DB (DBaaS) resources, you can perform the tasks on the Scalable DB(DBaaS) Details page.

Control Operation

If a change occurs to a running Scalable DB (DBaaS) resource, you can start or stop it.

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

1. Click the All Services > Database > Scalable DB(DBaaS) menu. 1. Go to the Service Home page of Scalable DB (DBaaS).
2. On the Service Home page, click the Scalable DB(DBaaS) menu. 2. Scalable DB(DBaaS) List Go to the page.
3. Scalable DB(DBaaS) List Click the resource you want to control on the page. 3. Scalable DB(DBaaS) Details Navigate to the page.
4. Check the status of Scalable DB (DBaaS) 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 where the DB service is installed and the DB service are stopped.

Synchronize Service Status

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

To view and synchronize the service status of Scalable DB (DBaaS), follow the steps below.

1. All Services > Database > Scalable DB (DBaaS) Click the menu. 1. Navigate to the Service Home page of Scalable DB (DBaaS).
2. On the Service Home page, click the Scalable DB(DBaaS) menu. 2. Scalable DB(DBaaS) List Navigate to the page.
3. Scalable DB(DBaaS) List Click the resource on the page to view the service status. 3. Scalable DB(DBaaS) Details Navigate to the page.
4. Service Status Sync Click the 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.

Managing Proxy Endpoint Settings

You can modify the Proxy Endpoint settings of Scalable DB (DBaaS).

To modify the Proxy Endpoint settings of Scalable DB (DBaaS), follow the steps below.

1. All Services > Database > Scalable DB(DBaaS) Click the menu. 1. Navigate to the Service Home page of Scalable DB (DBaaS).
2. On the Service Home page, click the Scalable DB(DBaaS) menu. 2. Go to the Scalable DB (DBaaS) List page.
3. Scalable DB(DBaaS) List Click the resource on the page to view the service status. 3. Scalable DB(DBaaS) Details Navigate to the page.
4. In the add-on menu, click the Proxy Endpoint Settings Management button. 4. Proxy Endpoint Settings Management Navigate to the page.
5. On the Proxy Endpoint Settings Management page, click the Search button. 5. Next, when the query alert appears, click the Confirm button.
6. On the Proxy Endpoint Settings Management page, click the Edit button. 6. Go to the Proxy Endpoint Settings Edit page.
7. On the Edit Proxy Endpoint Settings page, after modifying the desired items, click the Done button.

Scalable DB(DBaaS) Terminate

You can reduce operating costs by terminating unused Scalable DB (DBaaS). Note that terminating the service may cause the currently operating service to stop immediately, so you should proceed with the termination only after fully considering the impact of a service interruption.

To cancel Scalable DB(DBaaS), follow the steps below.

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