MySQL(DBaaS)

• 1: Overview
• 1.1: Server Type
• 1.2: Monitoring Metrics
• 1.3: ServiceWatch Metrics
• 2: How-to guides
• 2.1: MySQL(DBaaS) server connection
• 2.2: Manage DB Service
• 2.3: DB Backup and Recovery
• 2.4: Configure Read Replica
• 3: API Reference
• 4: CLI Reference
• 5: Release Note

1 - Overview

Service Overview

MySQL(DBaaS) is an open source relational database management system (RDBMS). Samsung Cloud Platform provides an environment where MySQL installation is automated through a web-based Console and management functions for operation can be performed.

MySQL(DBaaS) is designed with a high availability architecture that considers storage-based data replication and minimization of failover time. To prevent data loss, when content in the Active server is changed, it is synchronously replicated to the Standby server, and up to 5 read-only servers called Replicas are provided for read load distribution and disaster recovery (DR). Additionally, to prepare for problems with the DB server or data, it provides automatic backup at a user-specified time, enabling data recovery at a desired point in time.

Provided Features

MySQL(DBaaS) provides the following features.

• Auto Provisioning: Database (DB) installation and configuration is possible through UI, and Active-standby redundancy configuration based on storage replication is provided. When the Active server fails, it automatically fails over to Standby.
• Operation Control Management: Provides functionality to control the status of running servers. In addition to start and stop, restart is possible when there is an issue with the DB or to reflect configuration values. When configured with high availability (HA), users can directly switch between Active-Standby nodes through Switch-over.
• Backup and Recovery: Provides data backup functionality based on its own backup commands. Backup time and retention period can be set by the user, and additional charges occur according to backup capacity. Additionally, it provides recovery functionality for backed-up data, and when the user performs recovery, a separate DB is created and recovery proceeds to the point in time selected by the user (backup storage point, user-specified point). When recovering to a user-specified point, the recovery point can be set up to 5 minutes/10 minutes/30 minutes/1 hour ago based on stored backup files and archive files.
• Version Management: Provides version upgrade (Minor) functionality for some feature improvements and security patches. Users can select whether to perform backup according to version upgrade, and if backup is performed, the data is backed up before patching and then the DB engine is updated.
• Replica Configuration: Up to 5 Read Replicas can be configured in the same/different region for read load distribution and disaster recovery (DR).
• Parameter Management: DB configuration parameters for performance improvement and security can be modified.
• Service Status Check: Checks the final status of the current DB service.
• Monitoring: CPU, memory, and performance monitoring information can be checked through Cloud Monitoring and Servicewatch.
• DB User Management: Manages by checking DB account (user) information registered in the DB.
• DB Access Control Management: Access allowed IP registration and cancellation based on DB accounts registered in the DB is possible.
• Archive Management: Archive file retention period (1 day ~ 35 days) in the DB server and Archive mode (On/Off) can be set.
• DB Log Export: Logs stored through Audit settings can be exported to the user’s Object Storage.
• Migration: Supports migration using Replication method by synchronizing data in real-time with the operating database without service interruption.
• OS Kernel Upgrade: OS Kernel can be upgraded for some feature improvements and security patch application.

Components

MySQL(DBaaS) provides pre-verified engine versions and various server types according to the open source support policy. Users can select and use them according to the scale of the service they want to configure.

Engine Version

The engine versions supported by MySQL(DBaaS) are as follows.

Technical support can be used until the supplier’s EoTS (End of Technical Service) date, and the EOS date when new creation stops is set to 6 months before the EoTS date.

According to the supplier’s policy, EOS and EoTS dates may change, so please refer to the supplier’s license management policy page for details.

• MySQL (Community): https://www.mysql.com/support/eol-notice.html

Server Type

The server type supported by MySQL(DBaaS) is in the following format.

For details on the server types provided by MySQL(DBaaS), refer to MySQL(DBaaS) Server Types.

Standard db1v2m4

Prerequisite Services

This is a list of services that must be configured in advance before creating this service. Please prepare in advance by referring to the guide provided for each service.

1.1 - Server Type

MySQL(DBaaS) Server Type

MySQL(DBaaS) provides server types with various combinations of CPU, Memory, and Network Bandwidth. When creating a MySQL(DBaaS), the database engine is installed according to the selected server type, which is chosen based on the intended use.

The server types supported by MySQL(DBaaS) are as follows:

Standard db1v2m4

db1 Server Type

The db1 server type of MySQL(DBaaS) is provided with standard specifications (vCPU, Memory) and is suitable for various database workloads.

• Up to 3.3Ghz Intel 3rd generation (Ice Lake) Xeon Gold 6342 Processor
• Supports up to 16 vCPUs and 256 GB of memory
• Up to 12.5 Gbps networking speed

dbh2 Server Type

The dbh2 server type of MySQL(DBaaS) is provided with high-capacity server specifications and is suitable for large-scale data processing database workloads.

• Up to 3.2GHz Intel 4th generation (Sapphire Rapids) Xeon Gold 6448H Processor
• Supports up to 128 vCPUs and 1,536 GB of memory
• Up to 25Gbps networking speed

1.2 - Monitoring Metrics

MySQL(DBaaS) Monitoring Metrics

The table below shows the performance monitoring metrics of MySQL (DBaaS) that can be viewed through Cloud Monitoring. For detailed usage of Cloud Monitoring, refer to the Cloud Monitoring guide.

MySQL(DBaaS)’s server monitoring metrics, please refer to the Virtual Server Monitoring Metrics guide.

1.3 - ServiceWatch Metrics

MySQL sends metrics to ServiceWatch. The metrics provided by basic monitoring are data collected at a 1-minute interval.

Basic Indicators

The following are the basic metrics for the MySQL namespace.

OS Basic Metrics

MySQL Basic Metrics

2 - How-to guides

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

Create MySQL(DBaaS)

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

Follow these steps to create MySQL(DBaaS).

1. Click All Services > Database > MySQL(DBaaS) menu. You will move to the Service Home page of MySQL(DBaaS).
2. On the Service Home page, click the Create MySQL(DBaaS) button. You will move to the Create MySQL(DBaaS) page.
3. On the Create MySQL(DBaaS) page, enter the information required for service creation and select detailed options.
   • Select the required information in the Image and Version Selection area.

     Classification	Required	Detailed Description
     Image Version	Required	MySQL(DBaaS) version list provided

     Table. MySQL(DBaaS) Image and Version Selection Items
   • Enter or select the required information in the Service Information Entry area.

     Classification	Required	Detailed Description
     Server Name Prefix	Required	Server name where DB will be installed Starts with lowercase English letters, enter 3 to 13 characters using lowercase letters, numbers, and special characters (-) Actual server name is created with a postfix like 001, 002 based on the server name
     Cluster Name	Required	Cluster name where DB servers are configured Enter 3 to 20 characters using English letters Cluster is a unit that bundles multiple servers
     Service Type > Server Type	Required	Server type where DB will be installed Standard: Standard specifications generally used High Capacity: Large capacity server with 24vCore or more For details on server types provided by MySQL(DBaaS), refer to MySQL(DBaaS) Server Types
     Service Type > Planned Compute	Optional	Resource status where Planned Compute is set In Use: Number of resources in use among resources where Planned Compute is set Set: Number of resources where Planned Compute is set Coverage Preview: Amount applied as Planned Compute per resource Create Planned Compute Service: Move to Planned Compute service application page For details, refer to Apply for Planned Compute
     Service Type > Block Storage	Required	Block Storage configuration used by DB according to purpose Basic OS: Area where DB engine is installed DATA: Storage area for table data and archive files, etc. Select storage type and enter capacity (For details on Block Storage types, refer to Create Block Storage) SSD: High performance general volume HDD: General volume SSD_KMS, HDD_KMS: Additional encrypted volume using Samsung Cloud Platform KMS (Key Management System) encryption key Configured Storage type is applied identically to additional storage as well Enter capacity as a multiple of 8 in the range of 16 ~ 5,120 Since SQL execution or large Sort due to monthly batch, etc. may cause service interruption, separate TEMP storage must be allocated and used Add: DATA, Archive, TEMP, Backup data storage area Select Use and enter the purpose and capacity of the storage Storage type is applied identically as the type set in DATA, and capacity can be entered as a multiple of 8 in the range of 16 ~ 5,120 To add storage, click the + button, and to delete, click the x button. Maximum 9 can be added Before transferring backup data, temporarily store backup data in BACKUP storage If backup data exceeds 100 GB and there are many data changes, it is recommended to add separate BACKUP storage for stable backup. It is recommended to set backup capacity to about 60% of DATA capacity If BACKUP storage is not added, the /tmp area is used, and backup fails if capacity is insufficient Per service, only 1 Block Storage is allocated for Archive, TEMP, BACKUP storage
     Redundancy Configuration	Optional	Whether to configure redundancy If redundancy configuration is used, DB instance is configured as Active DB and Standby DB
     Network > Common Settings	Required	Network settings where servers created in the service are installed Select if you want to apply the same settings to all servers being installed Select pre-created VPC and Subnet, IP, Public NAT Only automatic creation is possible for IP Public NAT function can be used only if VPC is connected to Internet Gateway. If you check Use, you can select from IPs reserved in Public IP of VPC product. For details, refer to Create Public IP
     Network > Per Server Settings	Required	Network settings where servers created in the service are installed Select if you want to apply different settings to each server being installed 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 you check Use, you can select from IPs reserved in Public IP of VPC product. For details, refer to Create Public IP
     IP Access Control	Optional	Service access policy setting Since access policy is set for IPs entered on the page, 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 entered IP, click the x button next to the entered IP
     Maintenance Window	Optional	DB maintenance window If you select Use, set day of week, start time, and duration It is recommended to set a maintenance window for stable DB management. Patch work is performed at the set time and service interruption occurs If set to Not Used, Samsung SDS is not responsible for problems caused by not applying patches.

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

     Classification	Required	Detailed Description
     Database Name	Required	Server name applied when installing DB Start with English letters, enter 3 to 20 characters using English letters and numbers
     Database Username	Required	DB user name Account with that name is also created in OS Enter 2 to 20 characters using lowercase English letters Restricted Database usernames can be checked in Console
     Database Password	Required	Password to use when accessing DB Enter 8 to 30 characters including English letters, numbers, and special characters (excluding " ’)
     Database Password Confirm	Required	Re-enter the password to use when accessing DB identically
     Database Port Number	Required	Port number required for DB connection Enter DB port in the range of 1200 ~ 65535
     Backup > Use	Optional	Whether to use backup Select Use to set backup file retention period, backup start time, and Archive backup cycle
     Backup > Retention Period	Optional	Backup retention period Select backup retention period. File retention period can be set from 7 days to 35 days Separate charges occur for backup files according to capacity
     Backup > Backup Start Period	Optional	Backup start time Select backup start time Minutes when backup is performed are set randomly, and 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. If you select 5 minutes, 10 minutes, 30 minutes, it may affect DB performance
     Parameter	Required	Parameters to use in DB Click the View button to check detailed information of parameters Parameters can be modified after DB creation is completed, and after modification, DB must be restarted
     DB Character Set	Required	Character encoding method to use in DB
     Table Case Sensitivity	Optional	Whether DB Table is case-sensitive
     Time Zone	Required	Standard time zone where Database will be used
     ServiceWatch Log Collection	Optional	Whether to collect ServiceWatch logs Select Use to set ServiceWatch log collection function For details on collected logs, refer to ServiceWatch Metrics Provided free up to 5 GB for all services in Account, and if exceeding 5 GB, charges are incurred according to storage capacity When collecting, log group and log stream are automatically created and cannot be deleted until resource is deleted To prevent exceeding 5 GB, direct deletion of log data or shortening of retention period is recommended

     Table. MySQL(DBaaS) Database Configuration Items
   • Enter or select the required information in the Additional Information Entry area.

     Classification	Required	Detailed Description
     Tags	Optional	Add tags Can add up to 50 per resource Click the Add Tag button and then enter or select Key, Value values

     Table. MySQL(DBaaS) Additional Information Entry Items
4. On the Summary panel, check the created detailed information and estimated billing amount, then click the Create button.
   • When creation is completed, check the created resource on the Resource List page.

Check MySQL(DBaaS) Detailed Information

MySQL(DBaaS) service allows you to check and modify the entire resource list and detailed information. The MySQL(DBaaS) Details page is composed of Detailed Information, Tags, Operation History tabs, and for DBs where Replica is configured, the Replica Information tab is additionally configured.

Follow these steps to check the detailed information of MySQL(DBaaS) service.

1. Click All Services > Database > MySQL(DBaaS) menu. You will move to the Service Home page of MySQL(DBaaS).
2. On the Service Home page, click the MySQL(DBaaS) menu. You will move to the MySQL(DBaaS) List page.
3. On the MySQL(DBaaS) List page, click the resource whose detailed information you want to check. You will move to the MySQL(DBaaS) Details page.
   • At the top of the MySQL(DBaaS) Details page, status information and additional feature information are displayed.

     Classification	Detailed Description
     Cluster Status	Status of cluster where DB is installed Creating: Creating cluster Editing: Changing cluster to Operation execution status Error: Status where failure occurred while cluster was performing task If it occurs continuously, contact administrator Failed: Status where cluster failed during creation process Restarting: Restarting cluster Running: Status where cluster is operating normally Starting: Starting cluster Stopped: Status where cluster is stopped Stopping: Stopping cluster Synchronizing: Synchronizing cluster Terminating: Deleting cluster Unknown: Status where cluster status cannot be known If it occurs continuously, contact administrator Upgrading: Changing cluster to upgrade execution status
     Cluster Control	Buttons to change cluster status Start: Start stopped cluster Stop: Stop running cluster Restart: Restart running cluster Switch-Over: Switch Standby cluster to Active
     More Features	Cluster-related management buttons Sync Service Status: Check real-time DB service status Backup History: If backup is set, check whether backup was executed normally and history Database Recovery: Recover DB based on specific point in time Parameter Management: View and modify DB configuration parameters Replica Configuration: Configure Replica which is read-only cluster Replica Configuration (Other-Region): Configure Replica for disaster recovery in another region, button is deactivated if there is no region configured in that Account DB User Management: View and manage DB account (user) information registered in DB DB Access Control Management: Register and cancel access allowed IP based on DB accounts registered in DB Archive Management: Set Archive file retention period and Archive mode can be set DB Log Export: Logs stored through Audit settings can be exported to user’s Object Storage Migration Configuration: Provide Migration function using Replication method OS (Kernel) Upgrade: Upgrade OS Kernel version
     Service Termination	Button to terminate service

     Table. MySQL(DBaaS) Status Information and Additional Features

Detailed Information

On the MySQL(DBaaS) List page, you can check the detailed information of the selected resource and modify information if necessary.

Replica Information

The Replica Information tab is activated only if Replica is configured in the cluster. Through the Replica Information tab, you can check the Master cluster name, number of replicas, and Replica status.

Tags

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

Operation History

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

Manage MySQL(DBaaS) Resources

If you need to change existing configuration options of created MySQL(DBaaS) resources, or need recovery or Replica configuration, you can perform tasks on the MySQL(DBaaS) Details page.

Control Operation

If changes occur to running MySQL(DBaaS) resources, you can start, stop, or restart. Additionally, if HA is configured, you can switch Active-Standby servers through Switch-over.

Follow these steps to control operation of MySQL(DBaaS).

1. Click All Services > Database > MySQL(DBaaS) menu. You will move to the Service Home page of MySQL(DBaaS).
2. On the Service Home page, click the MySQL(DBaaS) menu. You will move to the MySQL(DBaaS) List page.
3. On the MySQL(DBaaS) List page, click the resource to control operation. You will move to the MySQL(DBaaS) Details page.
4. Check MySQL(DBaaS) status and complete the change through the control buttons below.
   • Start: Server and DB service where DB is installed run (Running).
   • Stop: Server and DB service where DB is installed stop (Stopped).
   • Restart: Only DB service is restarted.
   • Switch Over: Can swap Active server and Standby server of DB.

Sync Service Status

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

Follow these steps to check the service status of MySQL(DBaaS).

1. Click All Services > Database > MySQL(DBaaS) menu. You will move to the Service Home page of MySQL(DBaaS).
2. On the Service Home page, click the MySQL(DBaaS) menu. You will move to the MySQL(DBaaS) List page.
3. On the MySQL(DBaaS) List page, click the resource to check service status. You will move to the MySQL(DBaaS) Details page.
4. Click the Sync Service Status button. While checking, cluster changes to Synchronizing status.
5. When check is completed, status is updated in the server information item, and cluster changes to Running status

Change Server Type

You can change the configured server type.

Follow these steps to change server type.

1. Click All Services > Database > MySQL(DBaaS) menu. You will move to the Service Home page of MySQL(DBaaS).
2. On the Service Home page, click the MySQL(DBaaS) menu. You will move to the MySQL(DBaaS) List page.
3. On the MySQL(DBaaS) List page, click the resource to change server type. You will move to the MySQL(DBaaS) Details page.
4. Click the Edit icon of the server type you want to change at the bottom of detailed information. The Edit Server Type popup window opens.
5. On the Edit Server Type popup window, select server type and click the Confirm button.

Add Storage

If you need more than 5 TB of data storage space, you can add storage. For DB configured with redundancy, it is added to both redundancy servers simultaneously.

Follow these steps to add storage.

1. Click All Services > Database > MySQL(DBaaS) menu. You will move to the Service Home page of MySQL(DBaaS).
2. On the Service Home page, click the MySQL(DBaaS) menu. You will move to the MySQL(DBaaS) List page.
3. On the MySQL(DBaaS) List page, click the resource to add storage. You will move to the MySQL(DBaaS) Details page.
4. Click the Add Disk button at the bottom of detailed information. The Additional Storage Request popup window opens.
5. On the Additional Storage Request popup window, enter purpose and capacity, then click the Confirm button.

Expand Storage

Storage added as data area can be expanded up to 5 TB based on initially allocated capacity. For DB configured with redundancy, it is expanded to both redundancy servers simultaneously.

Follow these steps to expand storage capacity.

1. Click All Services > Database > MySQL(DBaaS) menu. You will move to the Service Home page of MySQL(DBaaS).
2. On the Service Home page, click the MySQL(DBaaS) menu. You will move to the MySQL(DBaaS) List page.
3. On the MySQL(DBaaS) List page, click the resource to change server type. You will move to the MySQL(DBaaS) Details page.
4. Click the Edit icon of the additional Disk you want to expand at the bottom of detailed information. The Edit Additional Storage popup window opens.
5. On the Edit Additional Storage popup window, enter expansion capacity and click the Confirm button.

Terminate MySQL(DBaaS)

You can reduce operating costs by terminating unused MySQL(DBaaS). However, when terminating the service, the running service may be immediately interrupted, so you should fully consider the impact of service interruption before proceeding with termination.

Follow these steps to terminate MySQL(DBaaS).

1. Click All Services > Database > MySQL(DBaaS) menu. You will move to the Service Home page of MySQL(DBaaS).
2. On the Service Home page, click the MySQL(DBaaS) menu. You will move to the MySQL(DBaaS) List page.
3. On the MySQL(DBaaS) List page, select the resource to terminate and click the Terminate Service button.
4. When termination is completed, check whether the resource is terminated on the MySQL(DBaaS) list page.

2.1 - MySQL(DBaaS) server connection

Scenario Overview

The MySQL(DBaaS) server connection scenario is a scenario where a Bastion host (Virtual Server) and Database service are created, and the DB service is accessed through the Bastion host. To connect to MySQL(DBaaS) stably in the Samsung Cloud Platform environment, it is necessary to create a Bastion host and use it for network connection. To maintain a stable and high level of security, it is recommended to configure the Database service in a Private Subnet environment and configure the Bastion host in a limited Public Subnet environment.

This scenario largely describes the process of creating a Bastion host and Database service, and configuring the network environment for Bastion host and Database connection, so that it can be accessed through a DB connection client.

Scenario Components

You can configure the scenario using the following services.

Scenario composition method

To configure the scenario, create the necessary services through the following procedure.

1. Configuring the Network

This explains the process of configuring the network environment for Bastion Host and Database service connection.

1-1. Creating a VPC

1. Click All services > Networking > VPC menu. It moves to the Service Home page of VPC.
2. On the Service Home page, click the Create VPC button. It moves to the Create VPC page.
3. VPC Creation page, please enter the information needed to create the service.
   • IP range should be entered as 192.168.x.0/16.
4. In the Summary panel, review the detailed information and estimated charge, then click the Complete button.
   • Once the creation is complete, check the created resource on the VPC list page.

1-2. Creating a Subnet

1. Click All services > Networking > VPC menu. It moves to the Service Home page of VPC.
2. Service Home page, click the Subnet menu. It moves to the Subnet list page.
3. Click the Subnet Creation button. It moves to the Subnet Creation page.
4. Subnet creation page where you enter the information needed to create a service.
   • Subnet type should be selected as General.
   • Please select a pre-created VPC.
   • IP range should be entered as 192.168.x.0/24.
5. In the Summary panel, review the detailed information and estimated charges, then click the Complete button.
   • After creation is complete, check the created resource on the Subnet list page.

1-3. Creating an Internet Gateway

1. Click All services > Networking > VPC menu. It moves to the Service Home page of VPC.
2. Service Home page, click the Internet Gateway menu. It moves to the Internet Gateway list page.
3. Click the Create Internet Gateway button. It moves to the Create Internet Gateway page.
4. Internet Gateway creation page, please enter the required information necessary for service creation.
   • Please select a pre-created VPC.
   • Select use in the Firewall usage item.
5. In the Summary panel, review the detailed information and estimated charges, then click the Complete button.
   • Once the creation is complete, check the created resource on the Internet Gateway list page.

1-4. Creating a Public IP

1. Click All services > Networking > VPC menu. It moves to the Service Home page of VPC.
2. Click the Public IP menu on the Service Home page. It moves to the Public IP list page.
3. Public IP Reservation button, click. Move to the Public IP Reservation page.
4. Public IP Reservation page where you enter the required information necessary for service reservation.
5. Check the detailed information generated in the Summary panel and the expected bill amount, and click the Complete button.
   • After creation is complete, check the created resource on the Public IP List page.

1-5. Creating a Security Group

1. Click the menu for all services > Networking > Security Group. It moves to the Service Home page of Security Group.
2. Click the Security Group Creation button on the Service Home page. It moves to the Security Group Creation page.
3. Security Group creation page where you enter the required information necessary for service creation.
4. Check the input information and click the Complete button.
   • Once creation is complete, check the created resource on the Security Group list page

2. Creating a Bastion Host

This describes the process of configuring the Bastion Host where the database connection client should be installed.

2-1. Creating a Server Keypair

1. Click All Services > Compute > Virtual Server menu. It moves to the Service Home page of Virtual Server.
2. Click the Keypair menu on the Service Home page. It moves to the Keypair list page.
3. Keypair creation button should be clicked. It moves to the Keypair creation page.
4. Keypair creation page, please enter the required information necessary for service creation.
5. Check the creation information and click the Complete button.
   • The key can only be downloaded for the first time, and re-issuance is not provided.
   • Please keep the downloaded key in a safe place.

2-2. Creating a Bastion Host

1. Click All Services > Compute > Virtual Server menu. It moves to the Service Home page of Virtual Server.
2. Click the Virtual Server Creation button on the Service Home page. It moves to the Virtual Server Creation page.
3. Virtual Server Creation page, please enter the required information necessary for service creation.
   • The image is Windows, please select.
   • Please select the pre-created VPC and Subnet.
   • Click NAT Use and select the Public IP reserved in 1-4. Creating Public IP.
   • 2-1. Creating a server Keypair Connect the Keypair created from
4. Summary panel, check the detailed information generated and the expected billing amount, and click the Complete button.
   • Once creation is complete, check the created resource on the Virtual Server list page.

2-3. Check Bastion host connection ID and PW

1. Click All Services > Compute > Virtual Server menu. It moves to the Service Home page of Virtual Server.
2. Service Home page, click the Virtual Server menu. Move to the Virtual Server list page.
3. Virtual Serve list page, click on the resource created in 2-2. Creating a Bastion host. It moves to the detailed information page of the corresponding resource.
4. Click the RDP password inquiry button in the Keypair item on the detailed information page. The RDP password inquiry popup window opens.
5. RDP password inquiry popup window, attach the keypair file downloaded from 2-1. Creating a server keypair.
6. After attaching, click the Password Check button. The ID and password required to access the resource will be displayed.
   • The ID and Password will be used as information to access the Bastion host later in 5-1. Connect to Bastion host.

3. Creating a Database

It describes the process of creating a database service.

3-1. Creating a MySQL (DBaaS) Service

1. Click on the menu for all services > Database > MySQL(DBaaS). It moves to the Service Home page of MySQL(DBaaS).
2. On the Service Home page, click the Create MySQL(DBaaS) button. It moves to the Create MySQL(DBaaS) page.
3. MySQL(DBaaS) creation page, please enter the required information needed for service creation.
   • Select and connect the pre-created VPC and Subnet.
   • Enter database-related creation information on the required information input screen.
   • Add the Bastion host IP to the IP access control item.
   • Database Port is 2866 by default, but you can specify it as you want.
4. In the Summary panel, review the detailed information and estimated charges, then click the Complete button.
   • Once the creation is complete, check the created resource on the MySQL(DBaaS) list page.

4. Setting Rules

This explains the process of setting rules for users to access the Bastion host and rules for the Bastion host to access the Database.

4-1. Adding Security Group Security Rules

1. Click the menu for all services > Networking > Security Group. It moves to the Service Home page of Security Group.
2. Service Home page, click the Security Group menu. Move to the Security Group list page.
3. 1-5. Creating a Security Group Select the Security Group resource created from. It will move to the detailed information page of the corresponding resource.
4. Click the Rules tab on the detailed information page. It moves to the Rules tab.
5. Click the Rule tab and click the Add Rule button. It moves to the Add Rule popup window.
6. Add Rule popup window, enter the rules below, and click the OK button

4-2. Adding IGW Firewall Rules

1. Click All services > Networking > Firewall menu. It moves to the Service Home page of Firewall.
2. Service Home page, click the Firewall menu. It moves to the Firewall list page.
3. Firewall list page, select the Internet Gateway resource name created in 1-3. Creating Internet Gateway, and move to the detailed information page of the corresponding resource.
4. Click the Rules tab on the detailed information page. It moves to the Rules tab.
5. Click the Rule tab and click the Add Rule button. It moves to the Add Rule popup window.
6. Add Rule In the popup window, enter the rules below and click the OK button.

5. Connect to Database

This describes the process of a user accessing the Database through a DB connection client program.

This guide provides instructions on how to connect using MySQL Workbench. There are various database client programs and CLI utilities, so you can install and use the tools that suit you.

5-1. Connecting to the Bastion host

1. Run Remote Desktop Connection in the Windows environment of the PC you want to access the Bastion host, enter the NAT IP of the Bastion Host, and click the Connect button.
2. After a successful remote desktop connection, the User Credential Input Window opens. Enter the ID and Password confirmed in 2-3. Checking Bastion Host Access ID and PW and click the Confirm button.

5-2. Install DB connection client program (MySQL Workbench) on the Bastion host

1. Go to the official MySQL page and download the MySQL Workbench program.
   • MySQL Workbench program download path: https://dev.mysql.com/downloads/workbench
2. Connect the hard drive of the user’s PC to upload the file to the Bastion host.
3. Click the Details button for local devices and resources entries in the Local Resources tab of Remote Desktop Connection.
4. Select the local disk where the file was downloaded to the drive and click the Confirm button.
5. Copy the downloaded file and upload it to the Bastion Host, then click the MySQL Workbench installation file to install it.

5-3. Using DB connection client program (MySQL Workbench) to connect to the Database

1. Run MySQL Workbench and click Database > Manage connections. The Manage Server Connection popup window will appear.
2. Manage Server Connection popup window, click the New button at the bottom left and enter the database server information created in 3-1. MySQL(DBaaS) service creation, then click the Test Connection button. A Password popup window will appear.

   Required Input Element Items	Input Value
   Connection Name	Custom (ex. Service Name)
   Host name	Database server IP
   Port	Database Port
   Username	Database username

   DB connection client program input items
3. In the Password popup window, enter the password set in 3-1. MySQL(DBaaS) service creation and click the OK button. When the connection is successful, click the OK button in the Manage Server Connection popup window.
4. Database > Connect to Database should be clicked. The Connect to Database popup window will appear.
5. Select the Connection Name registered in Stored Connection to perform database connection. After connection, you can try simple queries, etc.

2.2 - Manage DB Service

Users can manage MySQL(DBaaS) through Samsung Cloud Platform Console.

Manage Parameters

Provides functionality to easily view and modify database configuration parameters.

View Parameters

Follow these steps to view configuration parameters.

1. Click All Services > Database > MySQL(DBaaS) menu. You will move to the Service Home page of MySQL(DBaaS).
2. On the Service Home page, click the MySQL(DBaaS) menu. You will move to the MySQL(DBaaS) List page.
3. On the MySQL(DBaaS) List page, click the resource whose parameters you want to view and modify. You will move to the MySQL(DBaaS) Details page.
4. Click the More button and click the Parameter Management button. The Parameter Management popup window opens.
5. On the Parameter Management popup window, click the View button. The View Notification popup window opens.
6. When the View Notification popup window opens, click the Confirm button. It takes some time to view.

Modify Parameters

Follow these steps to modify configuration parameters.

1. Click All Services > Database > MySQL(DBaaS) menu. You will move to the Service Home page of MySQL(DBaaS).
2. On the Service Home page, click the MySQL(DBaaS) menu. You will move to the MySQL(DBaaS) List page.
3. On the MySQL(DBaaS) List page, click the resource whose parameters you want to view and modify. You will move to the MySQL(DBaaS) Details page.
4. Click the More button and click the Parameter Management button. The Parameter Management popup window opens.
5. On the Parameter Management popup window, click the View button. The View Notification popup window opens.
6. When the View Notification popup window opens, click the Confirm button. It takes some time to view.
7. If modification is needed, click the Edit button and enter modification content in the user-defined value area of the Parameter to modify.
8. When input is completed, click the Complete button.

SQL> SHOW COLLATION WHERE Charset = 'character set name';

Manage DB Users

Provides management functionality to view DB user information and change status information.

View DB Users

Follow these steps to view DB users.

1. Click All Services > Database > MySQL(DBaaS) menu. You will move to the Service Home page of MySQL(DBaaS).
2. On the Service Home page, click the MySQL(DBaaS) menu. You will move to the MySQL(DBaaS) List page.
3. On the MySQL(DBaaS) List page, click the resource whose DB users you want to view. You will move to the MySQL(DBaaS) Details page.
4. Click the More button and click the DB User Management button. You will move to the DB User Management page.
5. On the DB User Management page, click the View button. It takes some time to view.

Change DB User Status

Follow these steps to change the status of viewed DB users.

1. Click All Services > Database > MySQL(DBaaS) menu. You will move to the Service Home page of MySQL(DBaaS).
2. On the Service Home page, click the MySQL(DBaaS) menu. You will move to the MySQL(DBaaS) List page.
3. On the MySQL(DBaaS) List page, click the resource whose DB users you want to modify. You will move to the MySQL(DBaaS) Details page.
4. Click the More button and click the DB User Management button. You will move to the DB User Management page.
5. On the DB User Management page, click the View button. It takes some time to view.
6. If modification is needed, click the Edit button and change the status area value or enter remarks content.
7. When input is completed, click the Complete button.

Manage DB Access Control

Provides IP-based DB user access control management functionality. Users can directly specify IPs that can access the database and set it so that only allowed IPs can access.

View DB Access Control

Follow these steps to view DB users where IP access control is set.

1. Click All Services > Database > MySQL(DBaaS) menu. You will move to the Service Home page of MySQL(DBaaS).
2. On the Service Home page, click the MySQL(DBaaS) menu. You will move to the MySQL(DBaaS) List page.
3. On the MySQL(DBaaS) List page, click the resource whose access control you want to manage. You will move to the MySQL(DBaaS) Details page.
4. Click the More button and click the DB Access Control Management button. You will move to the DB Access Control Management page.
5. On the DB Access Control Management page, click the View button. It takes some time to view.

Add DB Access Control

Follow these steps to add IP access control.

1. Click All Services > Database > MySQL(DBaaS) menu. You will move to the Service Home page of MySQL(DBaaS).
2. On the Service Home page, click the MySQL(DBaaS) menu. You will move to the MySQL(DBaaS) List page.
3. On the MySQL(DBaaS) List page, click the resource whose IP access control you want to add. You will move to the MySQL(DBaaS) Details page.
4. Click the More button and click the DB Access Control Management button. You will move to the DB Access Control Management page.
5. On the DB Access Control Management page, click the View button. It takes some time to view.
6. When viewing is completed, click the Add button. The Add DB Access Control popup window opens.
7. On the Add DB Access Control popup window, select DB username and enter IP Address.
8. When input is completed, click the Complete button.

Delete DB Access Control

Follow these steps to delete IP access control.

1. Click All Services > Database > MySQL(DBaaS) menu. You will move to the Service Home page of MySQL(DBaaS).
2. On the Service Home page, click the MySQL(DBaaS) menu. You will move to the MySQL(DBaaS) List page.
3. On the MySQL(DBaaS) List page, click the resource whose IP access control you want to delete. You will move to the MySQL(DBaaS) Details page.
4. Click the More button and click the DB Access Control Management button. You will move to the DB Access Control Management page.
5. On the DB Access Control Management page, click the View button. It takes some time to view.
6. When viewing is completed, click the Delete button. The Delete popup window opens.
7. On the Delete popup window, click the Confirm button.

Manage Archive

Provides Archive mode setting and Archive Log retention period setting functionality so users can flexibly set Archive log management policies according to their operating environment. Additionally, it provides functionality to manually delete Archive logs together, enabling efficient management of system resources by cleaning unnecessary log data.

Set Archive Mode

Follow these steps to set Archive mode.

1. Click All Services > Database > MySQL(DBaaS) menu. You will move to the Service Home page of MySQL(DBaaS).
2. On the Service Home page, click the MySQL(DBaaS) menu. You will move to the MySQL(DBaaS) List page.
3. On the MySQL(DBaaS) List page, click the resource whose Archive mode you want to set. You will move to the MySQL(DBaaS) Details page.
4. Click the More button and click the Archive Settings Management button. You will move to the Archive Settings Management page.
5. On the Archive Settings Management page, click the View button. It takes some time to view.
6. Click the Edit button and select whether to use and retention period.
7. When modification is completed, click the Complete button.

Delete Archive Files

Follow these steps to delete Archive files.

1. Click All Services > Database > MySQL(DBaaS) menu. You will move to the Service Home page of MySQL(DBaaS).
2. On the Service Home page, click the MySQL(DBaaS) menu. You will move to the MySQL(DBaaS) List page.
3. On the MySQL(DBaaS) List page, click the resource whose Archive mode you want to set. You will move to the MySQL(DBaaS) Details page.
4. Click the More button and click the Archive Settings Management button. You will move to the Archive Settings Management page.
5. On the Archive Settings Management page, if you want to delete all Archive files, click the Delete All Archives button, and if you want to delete only backed-up Archive files, click the Delete Backed-up Archives button.

Export DB Log

Supports exporting log data requiring long-term retention among audit (Audit) logs to Object Storage. Users can directly set the log type requiring storage, target Bucket to export, and cycle to export logs. According to the set criteria, logs are copied and stored to the specified Object Storage. Additionally, for efficient management of disk space, it also provides an option to automatically delete original log files while exporting logs to Object Storage. By using that option, you can effectively secure storage capacity while safely storing necessary log data for long-term retention

Set DB Log Export Mode

Follow these steps to set DB Log export mode.

1. Click All Services > Database > MySQL(DBaaS) menu. You will move to the Service Home page of MySQL(DBaaS).
2. On the Service Home page, click the MySQL(DBaaS) menu. You will move to the MySQL(DBaaS) List page.
3. On the MySQL(DBaaS) List page, click the resource whose DB logs you want to export. You will move to the MySQL(DBaaS) Details page.
4. Click the More button and click the DB Log Export button. You will move to the DB Log Export page.
5. On the DB Log Export page, click the Register button. You will move to the DB Log Export Register page.
6. On the DB Log Export Register page, enter the information and click the Complete button.

   Classification	Required	Detailed Description
   Log Type	Required	Log type to store
   Storage Bucket Name	Required	Object Storage Bucket name to store
   Authentication Key > Access key	Required	Access key to access Object Storage to store
   Authentication Key > Secret key	Required	Secret key to access Object Storage to store
   File Creation Cycle	Required	Cycle to create files in Object Storage
   Original Log Deletion	Optional	Whether to delete original log while exporting to Object Storage

   Table. MySQL(DBaaS) DB Log Export Configuration Items

Manage DB Log Export

Follow these steps to modify, terminate, or immediately export DB Log export settings.

1. Click All Services > Database > MySQL(DBaaS) menu. You will move to the Service Home page of MySQL(DBaaS).
2. On the Service Home page, click the MySQL(DBaaS) menu. You will move to the MySQL(DBaaS) List page.
3. On the MySQL(DBaaS) List page, click the resource whose DB Log export you want to manage. You will move to the MySQL(DBaaS) Details page.
4. Click the More button and click the DB Log Export button. You will move to the DB Log Export page.
5. On the DB Log Export page, click the More button according to the log type you want to manage and click the Immediate Export, Edit, Terminate buttons.
   • Immediate Export: Selected logs are exported to the Bucket of Object Storage previously set.
   • Edit: Modifies DB Log export mode settings.
   • Terminate: Terminates DB Log export mode settings.

Minor Version Upgrade

Provides version upgrade functionality for some feature improvements and security patches. Only Minor version upgrade functionality within the same Major version is supported.

Follow these steps to upgrade version.

1. Click All Services > Database > MySQL(DBaaS) menu. You will move to the Service Home page of MySQL(DBaaS).
2. On the Service Home page, click the MySQL(DBaaS) menu. You will move to the MySQL(DBaaS) List page.
3. On the MySQL(DBaaS) List page, click the resource whose version you want to upgrade. You will move to the MySQL(DBaaS) Details page.
4. Click the Edit button in the Image Version item. The Version Upgrade popup window opens.
5. On the Version Upgrade popup window, select modified version and whether to set backup, then click the Confirm button.
6. On the Version Upgrade Notification popup window, click the Confirm button.

Configure Migration

Provides Migration functionality that replicates in real-time while synchronizing with the operating database using Replication method without service interruption.

Follow these steps to configure Migration.

1. Click All Services > Database > MySQL(DBaaS) menu. You will move to the Service Home page of MySQL(DBaaS).
2. On the Service Home page, click the MySQL(DBaaS) menu. You will move to the MySQL(DBaaS) List page.
3. On the MySQL(DBaaS) List page, click the resource to migrate. You will move to the MySQL(DBaaS) Details page.
4. Click the More button and click the Migration Configuration button. The Migration Configuration popup window opens.
5. On the Migration Configuration popup window, check the notice and click the Confirm button. You will move to the Migration Configuration page.
6. On the Migration Configuration page, enter the information and click the Connection Check button.
7. When connection is completed, click the Complete button.

   Classification	Required	Detailed Description
   Source DB Database Name	Required	Database name of Source DB to be Migration target
   Source DB IP	Required	IP of Source DB to be Migration target
   Source DB Port	Required	Port of Source DB to be Migration target
   Source DB Username	Required	Username of Source DB to be Migration target
   Source DB Password	Required	Password of Source DB to be Migration target

   Table. MySQL(DBaaS) Migration Configuration Items

Promote Migration Cluster to Master Cluster

You can promote the configured Migration Cluster to Master Cluster.

Follow these steps to promote Migration Cluster to Master.

1. Click All Services > Database > MySQL(DBaaS) menu. You will move to the Service Home page of MySQL(DBaaS).
2. On the Service Home page, click the MySQL(DBaaS) menu. You will move to the MySQL(DBaaS) List page.
3. On the MySQL(DBaaS) List page, click the resource to promote to Master. You will move to the MySQL(DBaaS) Details page.
4. Click the More button and click the Master Promotion button. The Master Promotion Notification popup window opens.
5. On the Master Promotion Notification popup window, click the Confirm button.

Upgrade OS Kernel

You can upgrade OS Kernel for operating database feature improvements and security patch application.

Follow these steps to upgrade OS Kernel.

1. Click All Services > Database > MySQL(DBaaS) menu. You will move to the Service Home page of MySQL(DBaaS).
2. On the Service Home page, click the MySQL(DBaaS) menu. You will move to the MySQL(DBaaS) List page.
3. On the MySQL(DBaaS) List page, click the resource whose OS Kernel you want to upgrade. You will move to the MySQL(DBaaS) Details page.
4. Click the More button and click the OS (Kernel) Upgrade button. The OS (Kernel) Upgrade Notification popup window opens.
5. On the OS (Kernel) Upgrade Notification popup window, check the notice and click the Confirm button.

2.3 - DB Backup and Recovery

The user can set up a backup of MySQL(DBaaS) through the Samsung Cloud Platform Console and restore it with the backed-up file.

MySQL(DBaaS) Backup

PostgreSQL(DBaaS) provides a data backup feature based on its own backup command. It also provides an optimized backup environment for data protection and management through backup history checking and backup file deletion functions.

Setting up backup

The method of setting up a backup for MySQL(DBaaS) is described in MySQL(DBaaS) creation guide.

To modify the backup settings of the generated resource, follow these steps.

To set up backup, follow these steps.

1. All Services > Database > MySQL(DBaaS) menu is clicked. It moves to the Service Home page of MySQL(DBaaS).
2. Service Home page, click the MySQL(DBaaS) menu. Move to the MySQL(DBaaS) list page.
3. MySQL(DBaaS) list page, click the resource to set the backup. It moves to the MySQL(DBaaS) details page.
4. Click the Edit button of the backup item. The Backup Settings popup window opens.
5. If you set up a backup, click Use in the Backup Settings popup window, select the retention period, backup start time, and Archive backup cycle, and then click the Confirm button.
   • If you want to stop the backup settings, uncheck Use in the Backup Settings popup window and click the OK button.

Check Backup History

To view the backup history, follow these steps.

1. All Services > Database > MySQL(DBaaS) menu is clicked. It moves to the Service Home page of MySQL(DBaaS).
2. On the Service Home page, click the MySQL(DBaaS) menu. It moves to the MySQL(DBaaS) list page.
3. MySQL(DBaaS) list page, click the resource to check the backup history. Move to the MySQL(DBaaS) details page.
4. Click the Backup History button. The Backup History popup window opens.
5. Backup History popup window where you can check the backup status, version, backup start time, backup completion time, and capacity.

Delete backup files

To delete the backup history, follow these steps.

1. Click All Services > Database > MySQL(DBaaS) menu. It moves to the Service Home page of MySQL(DBaaS).
2. On the Service Home page, click the MySQL(DBaaS) menu. It moves to the MySQL(DBaaS) list page.
3. MySQL(DBaaS) list page, click the resource to check the backup history. Move to the MySQL(DBaaS) detail page.
4. Click the Backup History button. The Backup History popup window opens.
5. Backup History popup window, check the file you want to delete, and then click the Delete button.

Recovering MySQL(DBaaS)

In the event of a failure or data loss that requires restoration from a backup file, recovery is possible based on a specific point in time through the recovery function. When performing MySQL (DBaaS) recovery, a new server is created with the OS image at the initial provisioning time, the DB is installed with the version at the backup point in time, and the recovery proceeds with the DB configuration information and data.

To restore MySQL(DBaaS), follow these steps.

1. All Services > Database > MySQL(DBaaS) menu is clicked. It moves to the Service Home page of MySQL(DBaaS).
2. On the Service Home page, click the MySQL(DBaaS) menu. It moves to the MySQL(DBaaS) list page.
3. MySQL(DBaaS) resource list page, click the resource you want to restore. It moves to the MySQL(DBaaS) details page.
4. Database Recovery Click the button. Database Recovery Navigate to the page.
5. Enter the corresponding information in the Database Recovery Configuration area, and then click the Complete button.

2.4 - Configure Read Replica

Users can create the service by entering required information for Read Replica through Samsung Cloud Platform Console and selecting detailed options.

Configure Replica

Through Replica configuration, you can create replica servers for read-only or disaster recovery purposes. You can create up to 5 Replicas per Database.

Follow these steps to configure Replica.

1. Click All Services > Database > MySQL(DBaaS) menu. You will move to the Service Home page of MySQL(DBaaS).
2. On the Service Home page, click the MySQL(DBaaS) menu. You will move to the MySQL(DBaaS) List page.
3. On the MySQL(DBaaS) List page, click the resource to configure Replica. You will move to the MySQL(DBaaS) Details page.
4. Click the Replica Configuration button. You will move to the Replica Configuration page.
5. After entering information in the Replica Configuration area, click the Complete button.

   Classification	Required	Detailed Description
   Region	Required	Region to configure Replica Displayed only when Replica Configuration (Other Region) is selected
   Replica Count	Required	Number of Replicas to configure Can configure up to 5 per cluster If you select a value of 2 or more, you need to additionally enter Replica name and service type information
   Replica Name	Required	Replica server name Start with lowercase English letters and enter 3 to 19 characters using lowercase letters, numbers, and special characters (-) Entered Replica name is displayed as cluster name in the list
   Service Type > Server Type	Required	Replica server type Standard: Standard specifications generally used High Capacity: Large capacity server with 24vCore or more
   Service Type > Planned Compute	Optional	Resource status where Planned Compute is set In Use: Number of resources in use among resources where Planned Compute is set Set: Number of resources where Planned Compute is set Coverage Preview: Amount applied as Planned Compute per resource Create Planned Compute Service: Move to Planned Compute service application page For details, refer to Apply for Planned Compute
   IP Access Control	Optional	Service access policy setting Since access policy is set for IPs entered on the page, 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 entered IP, click the x button next to the entered IP
   Maintenance Window	Optional	DB maintenance window If you select Use, set day of week, start time, and duration It is recommended to set a maintenance window for stable DB management. Patch work is performed at the set time and service interruption occurs If set to Not Used, Samsung SDS is not responsible for problems caused by not applying patches.
   Tags	Optional	Add tags Click the Add Tag button and then enter or select Key, Value values

   Table. MySQL(DBaaS) Replica Configuration Items

Reconfigure Replica

In case of network failure or Replication delay with Master Cluster occurs, you can replicate Master Cluster’s data again through Replica reconfiguration functionality.

Follow these steps to reconfigure Replica.

1. Click All Services > Database > MySQL(DBaaS) menu. You will move to the Service Home page of MySQL(DBaaS).
2. On the Service Home page, click the MySQL(DBaaS) menu. You will move to the MySQL(DBaaS) List page.
3. On the MySQL(DBaaS) List page, click the resource to reconfigure Replica. You will move to the MySQL(DBaaS) Details page.
4. Click the Replica Reconfiguration button. The Replica Reconfiguration Notification popup window opens.
5. On the Replica Reconfiguration Notification popup window, click the Confirm button.

Promote Replica Cluster to Master Cluster

You can promote the configured Replica Cluster to Master Cluster.

Follow these steps to promote Replica Cluster to Master.

1. Click All Services > Database > MySQL(DBaaS) menu. You will move to the Service Home page of MySQL(DBaaS).
2. On the Service Home page, click the MySQL(DBaaS) menu. You will move to the MySQL(DBaaS) List page.
3. On the MySQL(DBaaS) List page, click the resource to promote to Master. You will move to the MySQL(DBaaS) Details page.
4. Click the More button and click the Master Promotion button. The Master Promotion Notification popup window opens.
5. On the Master Promotion Notification popup window, click the Confirm button.

3 - API Reference

4 - CLI Reference

5 - Release Note

MySQL(DBaaS)