MySQL(DBaaS)

• 1: Overview
• 1.1: Server Type
• 1.2: Monitoring Metrics
• 2: How-to guides
• 2.1: MySQL(DBaaS) server connection
• 2.2: Managing DB Services
• 2.3: DB Backup and Recovery
• 2.4: Setting up 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 that can automate MySQL installation and perform management functions for operation through a web-based console.

MySQL(DBaaS) is designed as a high-availability architecture that performs storage-based data replication and minimizes failover time. To prevent data loss, when the content of the Active server changes, it is synchronously replicated to the Standby server, and up to five read-only servers called Replicas for read load balancing and disaster recovery (DR) are provided. Additionally, to prepare for issues with the DB server or data, it offers an automatic backup function at user-specified times, supporting data recovery at the desired point in time.

Provided Features

MySQL(DBaaS) provides the following features.

• Auto Provisioning (Auto Provisioning): Installation and configuration of Database (DB) is possible via UI, and it provides an Active-standby redundancy configuration based on storage replication. In case of an Active server failure, automatic failover to Standby occurs.
• Operation Control Management: Provides functionality to control the status of running servers. In addition to start and stop, restart is possible if there is a DB issue or to apply configuration values. When configured for high availability (HA), users can directly perform node switching between Active-Standby via Switch-over.
• Backup and Recovery: Provides a data backup function based on its own backup commands. The backup time window and storage agency can be set by the user, and additional fees are incurred based on backup size. It also provides a recovery function for backed-up data, creating a separate DB when the user performs a recovery, and the recovery proceeds to the point in time selected by the user (backup save 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 before the stored backup file and archive file.
• Version Management: Provides version upgrade (Minor) functionality for some feature improvements and security patches. Whether to perform a backup for the version upgrade can be selected by the user, and if a backup is performed, the data is backed up before applying the patch, then the DB engine is updated.
• Replica configuration: You can add up to 5 read-only Read Replicas, enabling read performance scaling and load balancing.
• Parameter Management: Performance improvement and security-related DB configuration parameter modifications are possible.
• Service Status Query: Retrieves the final status of the current DB service.
• Monitoring: CPU, memory, DB performance monitoring information can be checked via the Cloud Monitoring service.
• DB User Management: View and manage DB account (user) information registered in the DB.
• DB Access Control Management: Based on DB accounts registered in the DB, you can register and revoke allowed IPs.
• Archive Management: You can set the Archive file retention period (1 day~35 days) within the DB server and configure the Archive mode (On/Off).
• DB Log Export: You can export stored logs to the user’s Object Storage through Audit settings.
• Migration: Synchronize data in real time with the operating database, and support migration using the Replication method without service interruption.

Components

MySQL (DBaaS) provides pre-validated 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 is stopped is set to six months before the EoTS date.

Since the EOS and EoTS dates may change according to the supplier’s policy, 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 types supported by MySQL (DBaaS) are as follows.

For detailed information about the server types provided by MySQL(DBaaS), please refer to MySQL(DBaaS) Server Types.

Standard db1v2m4

  



Category
Example
Detailed Description




Server Type
Standard
Provided Server Types
Standard: Standard specifications (vCPU, Memory) configuration commonly used
High Capacity: Large server specifications of 24 vCores or more


Server Specifications
db1
Provided Server Specifications
db1: Standard specifications (vCPU, Memory) configuration commonly used
dbH2: Large-scale server specifications
Provides servers with 24 vCores or more


Server specifications
v2
Number of vCores
v2: 2 virtual cores


Server specifications
m4
Memory capacity
m4: 4GB Memory




  Table. MySQL(DBaaS) server type components





# Pre-service

This is a list of services that must be pre-configured before creating the service. Please refer to the guide provided for each service for details and prepare in advance.<br>







  



Service Category
Service
Detailed Description




Networking
VPC
A service that provides an independent virtual network in a cloud environment




  Table. MySQL (DBaaS) Pre-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.

2 - How-to guides

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

Creating MySQL(DBaaS)

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

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

1. Click the All Services > Database > MySQL(DBaaS) menu. Go to the Service Home page of MySQL(DBaaS).
2. Click the MySQL(DBaaS) 생성 button on the Service Home page. You will be taken to the MySQL(DBaaS) 생성 page.
3. MySQL(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	Detailed description
     Image version	Required	Provide version list of MySQL (DBaaS)

     Table. MySQL(DBaaS) image and version selection items
   • Service Information Input area, please enter or select the required information.

     Category	Required	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 composed of DB servers Enter using English letters, 3 to 20 characters A cluster is a unit that groups multiple servers
     Service Type > Server Type	Required	Server type where DB will be installed Standard: Standard specifications commonly used High Capacity: Large-capacity server of 24 vCore or more For detailed information about the server types provided by MySQL (DBaaS), refer to MySQL (DBaaS) Server Types
     Service Type > Planned Compute	Optional	Status of resources with Planned Compute set In Use: Number of resources with Planned Compute that are in use Configured: Number of resources with Planned Compute set Coverage preview: Amount applied per resource by Planned Compute Create Planned Compute Service: Go to Planned Compute service application page See Apply for Planned Compute for details
     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 created by the service are deployed Select if you want to apply the same settings to all servers being installed Select a pre‑created VPC, Subnet, IP, and 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 per installed server Select a pre‑created VPC, Subnet, IP, and Public NAT Enter each server’s IP The Public NAT feature is available only when the VPC is connected to an Internet Gateway. If you check Use, you can select a reserved IP from the VPC product’s Public IP. For more details, 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 Use: set day of 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 unapplied patches.

     Table. MySQL(DBaaS) Service Configuration Items
   • Database configuration required information input Enter or select the required information in the area.

     Category	Required	Detailed description
     Database name	Required	Server name applied when installing DB Start with an English letter, use English letters and numbers, and enter 3 to 20 characters
     Database username	Required	DB user name An account with the same name is also created on the OS Enter using lowercase English letters, 2 to 20 characters Restricted Database 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 (“ ‘ excluded)
     Database Password Confirmation	Required	Re-enter the same password to be used when accessing the DB
     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 Select 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. File retention period can be set from 7 days to 35 days Backup files incur additional charges depending on size
     Backup > Backup Start Period	Select	Backup Start Time Select backup start time The minutes (minutes) at which the backup is performed 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
     Parameter	Required	Parameters to use in the DB View button to click to view detailed information of the parameter Parameters can be modified after DB creation is completed, and after modification the DB must be restarted
     DB character set	Required	Character encoding method to be used in the DB
     Table case sensitivity	select	DB Table case sensitivity status
     Time zone	Required	Standard time zone to be used by the Database

     Table. MySQL(DBaaS) Database configuration items
   • Enter additional information in the area, please enter or select the required information.

     Category	Required	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. MySQL(DBaaS) Additional Information Input Items
4. Summary Check the detailed information and estimated billing amount generated in the panel, and click the Complete button.
   • Once creation is complete, check the created resource on the Resource List page.

MySQL(DBaaS) Check detailed information

The MySQL (DBaaS) service allows you to view and edit the full resource list and detailed information. The MySQL (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 MySQL (DBaaS) service, follow the steps below.

1. Click the All Services > Database > MySQL(DBaaS) menu. Go to the Service Home page of MySQL(DBaaS).
2. Click the MySQL(DBaaS) menu on the Service Home page. You will be taken to the MySQL(DBaaS) List page.
3. Click the resource to view detailed information on the MySQL(DBaaS) List page. It moves to the MySQL(DBaaS) Details page.

• MySQL(DBaaS) Details At the top of the page, status information and information about additional features 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 a failure while performing a task 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	Button 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 additional features	Cluster related management buttons Service status synchronization: Real-time DB service status lookup 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: DB configuration parameters can be queried and modified Replica configuration: Set up a read-only cluster called Replica DB user management: View and manage DB account (user) information registered in the DB DB access control management: Based on DB accounts registered in the DB, you can register and revoke allowed IPs Archive management: Can set archive file retention period and archive mode DB Log export: Through audit settings, stored logs can be exported to the user’s Object Storage Migration configuration: Provides migration functionality using replication method
  Service cancellation	Button to cancel the service

  Table. MySQL(DBaaS) status information and additional features

Detailed Information

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

Replica Information

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

Tag

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

Work History

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

MySQL(DBaaS) Resource Management

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

Operating Control

If changes occur to the running MySQL (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 MySQL (DBaaS), follow the steps below.

1. Click the All Services > Database > MySQL(DBaaS) menu. Go to the Service Home page of MySQL(DBaaS).
2. Click the MySQL(DBaaS) menu on the Service Home page. Go to the MySQL(DBaaS) List page.
3. Click the resource to control operation on the MySQL(DBaaS) List page. It moves to the MySQL(DBaaS) Details page.
4. Check the status of MySQL (DBaaS) and complete the change using the control button below.
   • Start: The server where the DB service is installed and the DB service are running (Running).
   • Stop: The server where the DB service is installed and the DB service are stopped.
   • Restart: Only the DB service will be restarted.
   • Switch Over: You can switch the DB’s Active server and Standby server.

Synchronize Service Status

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

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

1. All Services > Database > MySQL(DBaaS) Click the menu. Navigate to the Service Home page of MySQL(DBaaS).
2. Click the MySQL(DBaaS) menu on the Service Home page. Go to the MySQL(DBaaS) List page. 3. MySQL(DBaaS) List Click the resource to view the service status. MySQL(DBaaS) Detail Navigate to the page.
3. Service status synchronization button. Click the button. While fetching, the cluster changes to Synchronizing state.
4. When the query is completed, the status in the server information item is updated, 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 > MySQL(DBaaS) Click the menu. Go to the Service Home page of MySQL(DBaaS).
2. Click the MySQL(DBaaS) menu on the Service Home page. Go to the MySQL(DBaaS) List page.
3. Click the resource to change the server type on the MySQL(DBaaS) 목록 page. It will move to the MySQL(DBaaS) 상세 page.
4. Click the Edit icon of the server type you want to change at the bottom of the detailed information. The Server Type Edit popup window will open.
5. Server Type Edit In the popup window, after selecting the server type, 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 > MySQL(DBaaS) Click the menu. Go to the Service Home page of MySQL(DBaaS).
2. Click the MySQL(DBaaS) menu on the Service Home page. Navigate to the MySQL(DBaaS) List page.
3. On the MySQL(DBaaS) List page, click the resource to add storage. It navigates to the MySQL(DBaaS) Details page.
4. Click the Add Disk button at the bottom of the detailed information. 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

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

To increase storage capacity, follow the steps below.

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

MySQL(DBaaS) Cancel

You can cancel unused MySQL (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 MySQL (DBaaS), follow the steps below.

1. All Services > Database > MySQL(DBaaS) Click the menu. Go to the Service Home page of MySQL(DBaaS).
2. Click the MySQL(DBaaS) menu on the Service Home page. You will be taken to the MySQL(DBaaS) List page.
3. MySQL(DBaaS) List On the 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 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. 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. Password popup window, enter the password set in 3-1. MySQL(DBaaS) service creation and click the OK button. When the success is complete, 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 - Managing DB Services

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

Managing Parameters

It provides a feature to easily view and modify database configuration parameters.

Viewing Parameters

To view configuration parameters, follow these steps:

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

Modifying Parameters

To modify configuration parameters, follow these steps:

1. Click the All Services > Database > MySQL(DBaaS) menu. It moves to the Service Home page of MySQL(DBaaS).
2. Click the MySQL(DBaaS) menu on the Service Home page. It moves to the MySQL(DBaaS) List page.
3. Click the resource you want to view and modify parameters on the MySQL(DBaaS) List page. It moves to the MySQL(DBaaS) Details page.
4. Click the More button and then click the Parameter Management button. The Parameter Management popup window opens.
5. Click the View button in the Parameter Management popup window. The View Notification popup window opens.
6. When the View Notification popup window opens, click the OK button. It takes some time to view.
7. If modification is necessary, click the Modify button and enter the modification contents in the user-defined value area of the parameter to be modified.
8. When the input is complete, click the Save button.

Managing DB Users

It provides a management feature that allows you to view DB user information and change status information.

Viewing DB Users

To view DB users, follow these steps:

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

Changing DB User Status

To change the status of the viewed DB user, follow these steps:

1. Click the All Services > Database > MySQL(DBaaS) menu. It moves to the Service Home page of MySQL(DBaaS).
2. Click the MySQL(DBaaS) menu on the Service Home page. It moves to the MySQL(DBaaS) List page.
3. Click the resource you want to modify DB users on the MySQL(DBaaS) List page. It moves to the MySQL(DBaaS) Details page.
4. Click the More button and then click the DB User Management button. It moves to the DB User Management page.
5. Click the View button on the DB User Management page. It takes some time to view.
6. If modification is necessary, click the Modify button and change the status area value or enter remarks.
7. When the input is complete, click the Save button.

Managing DB Access Control

It provides an IP-based DB user access control management feature. Users can directly specify the IP that can access the database, allowing only allowed IPs to access.

Viewing DB Access Control

To view DB users with IP access control set, follow these steps:

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

Adding DB Access Control

To add IP access control, follow these steps:

1. Click the All Services > Database > MySQL(DBaaS) menu. It moves to the Service Home page of MySQL(DBaaS).
2. Click the MySQL(DBaaS) menu on the Service Home page. It moves to the MySQL(DBaaS) List page.
3. Click the resource you want to add IP access control on the MySQL(DBaaS) List page. It moves to the MySQL(DBaaS) Details page.
4. Click the More button and then click the DB Access Control Management button. It moves to the DB Access Control Management page.
5. Click the View button on the DB Access Control Management page. It takes some time to view.
6. When the view is complete, click the Add button. The DB Access Control Add popup window opens.
7. In the DB Access Control Add popup window, select the DB user name and enter the IP address.
8. When the input is complete, click the Save button.

Deleting DB Access Control

To delete IP access control, follow these steps:

1. Click All Services > Database > MySQL(DBaaS) menu. The MySQL(DBaaS) Service Home page will be displayed.
2. Click the MySQL(DBaaS) menu on the Service Home page. The MySQL(DBaaS) list page will be displayed.
3. Click the resource for which you want to delete IP access control on the MySQL(DBaaS) list page. The MySQL(DBaaS) details page will be displayed.
4. Click the More button and then click the DB Access Control Management button. The DB Access Control Management page will be displayed.
5. Click the Inquiry button on the DB Access Control Management page. It may take some time to retrieve the data.
6. Once the inquiry is complete, click the Delete button. A Delete pop-up window will appear.
7. Click the Confirm button in the Delete pop-up window.

Managing Archive

The Archive mode setting and Archive Log retention period setting functions are provided, allowing users to flexibly set the Archive log management policy according to their operating environment. Additionally, the function to manually delete Archive logs is provided together, allowing users to clean up unnecessary log data and effectively manage system resources.

Setting Archive Mode

To set the Archive mode, follow these steps:

1. Click All Services > Database > MySQL(DBaaS) menu. The MySQL(DBaaS) Service Home page will be displayed.
2. Click the MySQL(DBaaS) menu on the Service Home page. The MySQL(DBaaS) list page will be displayed.
3. Click the resource for which you want to set the Archive mode on the MySQL(DBaaS) list page. The MySQL(DBaaS) details page will be displayed.
4. Click the More button and then click the Archive Settings Management button. The Archive Settings Management page will be displayed.
5. Click the Inquiry button on the Archive Settings Management page. It may take some time to retrieve the data.
6. Click the Modify button and select the usage and retention period.
7. Once the modification is complete, click the Save button.

Deleting Archive Files

To delete Archive files, follow these steps:

1. Click All Services > Database > MySQL(DBaaS) menu. The MySQL(DBaaS) Service Home page will be displayed.
2. Click the MySQL(DBaaS) menu on the Service Home page. The MySQL(DBaaS) list page will be displayed.
3. Click the resource for which you want to set the Archive mode on the MySQL(DBaaS) list page. The MySQL(DBaaS) details page will be displayed.
4. Click the More button and then click the Archive Settings Management button. The Archive Settings Management page will be displayed.
5. Click the Archive All Delete button to delete all Archive files, or click the Backup Archive Delete button to delete only the backed-up Archive files.

Exporting DB Logs

The function to export audit logs to Object Storage is supported, allowing users to set the log type, target bucket, and export cycle. According to the set criteria, the logs are copied to the specified Object Storage for storage. Additionally, an option to automatically delete the original log files when exporting logs to Object Storage is provided, allowing users to effectively secure storage capacity while safely storing necessary log data.

Setting DB Log Export Mode

To set the DB Log export mode, follow these steps:

1. Click All Services > Database > MySQL(DBaaS) menu. The MySQL(DBaaS) Service Home page will be displayed.
2. Click the MySQL(DBaaS) menu on the Service Home page. The MySQL(DBaaS) list page will be displayed.
3. Click the resource for which you want to export DB logs on the MySQL(DBaaS) list page. The MySQL(DBaaS) details page will be displayed.
4. Click the More button and then click the DB Log Export button. The DB Log Export page will be displayed.
5. Click the Register button on the DB Log Export page. The DB Log Export Registration page will be displayed.
6. Enter the required information on the DB Log Export Registration page and click the Save button.

Managing DB Log Export

To modify, cancel, or immediately export DB log settings, follow these steps:

1. Click All Services > Database > MySQL(DBaaS) menu. The MySQL(DBaaS) Service Home page will be displayed.
2. Click the MySQL(DBaaS) menu on the Service Home page. The MySQL(DBaaS) list page will be displayed.
3. Click the resource for which you want to manage DB log export on the MySQL(DBaaS) list page. The MySQL(DBaaS) details page will be displayed.
4. Click the More button and then click the DB Log Export button. The DB Log Export page will be displayed.
5. Click the More button for the log type you want to manage on the DB Log Export page, and then click the Immediate Export, Modify, or Cancel button.
   • Immediate Export: Exports the selected log to the Object Storage bucket.
   • Modify: Modifies the DB log export mode setting.
   • Cancel: Cancels the DB log export mode setting.

Upgrading DB Version

The function to upgrade the version for some feature improvements and security patches is provided. Only minor version upgrades are supported within the same major version.

To upgrade the version, follow these steps:

1. Click the All Services > Database > MySQL(DBaaS) menu. It moves to the Service Home page of MySQL(DBaaS).
2. Click the MySQL(DBaaS) menu on the Service Home page. It moves to the MySQL(DBaaS) List page.
3. Click the resource to be upgraded on the MySQL(DBaaS) List page. It moves to the MySQL(DBaaS) Details page.
4. Click the Modify button in the image/version item. The Version Upgrade popup window opens.
5. In the Version Upgrade popup window, select the version to be modified and the backup setting, and then click the OK button.
6. Click the OK button in the Version Upgrade Notification popup window.

Configuring Migration

It provides a migration function that synchronizes with the operating database in real-time and replicates in a replication manner without interrupting the service.

To configure the migration, follow these steps:

1. Click the All Services > Database > MySQL(DBaaS) menu. It moves to the Service Home page of MySQL(DBaaS).
2. Click the MySQL(DBaaS) menu on the Service Home page. It moves to the MySQL(DBaaS) List page.
3. Click the resource to be migrated on the MySQL(DBaaS) List page. It moves to the MySQL(DBaaS) Details page.
4. Click the More button and then click the Configure Migration button. The Configure Migration popup window opens.
5. In the Configure Migration popup window, check the instructions and click the OK button. It moves to the Configure Migration page.
6. On the Configure Migration page, enter the corresponding information and click the Connect Check button.
7. When the connection is complete, click the Complete button.

The configured migration cluster can be promoted to a master cluster.

To promote the migration cluster to a master, follow these steps:

1. Click the All Services > Database > MySQL(DBaaS) menu. It moves to the Service Home page of MySQL(DBaaS).
2. Click the MySQL(DBaaS) menu on the Service Home page. It moves to the MySQL(DBaaS) List page.
3. Click the resource to be promoted to a master on the MySQL(DBaaS) List page. It moves to the MySQL(DBaaS) Details page.
4. Click the More button and then click the Promote to Master button. The Master Promotion Notification popup window opens.
5. Click the OK button in the Master Promotion Notification popup window.

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 버튼을 클릭하세요. Database Recovery 페이지로 이동합니다.
5. Enter the corresponding information in the Database Recovery Configuration area, and then click the Complete button.

2.4 - Setting up Read Replica

The user can enter the necessary information for the Read Replica through the Samsung Cloud Platform Console and create the service through detailed options.

Configuring Replica

You can create a read-only replica server through Replica configuration. Up to 5 Replicas can be created per Database.

To configure a replica, follow these procedures.

1. All services > Database > MySQL(DBaaS) menu, click. 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 on the resource to configure the Replica. Move to the MySQL(DBaaS) details page.
4. Click the Replica Configuration button. It moves to the Replica Configuration page.
5. Enter information in the Replica Configuration area, then click the Complete button.

   Classification	Necessity	Detailed Description
   Number of Replicas	Required	Number of Replicas to configure Up to 5 can be configured per cluster If selecting 2 or more values, additional input of Replica name and service type information is required
   Replica name	required	Replica server name Starts with lowercase English letters, using lowercase letters, numbers, and special characters (-) to input 3 ~ 19 characters The entered Replica name is exposed as the cluster name in the list
   Service Type > Server Type	Required	Replica Server Type Standard: Standard specification commonly used High Capacity: High-capacity server with 24vCore or more
   Service Type > Planned Compute	Select	Current status of resources with Planned Compute set In Use: Number of resources with Planned Compute set that are in use Settings: Number of resources with Planned Compute set Coverage Preview: Amount applied by Planned Compute for each resource Create Planned Compute Service: Move to the Planned Compute service application page For more information, refer to Apply for Planned Compute
   IP Access Control	Select	Set service access policy Set access policy for IP entered on the page, so 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 the entered IP, click the x button next to the entered IP
   Maintenance period	Select	DB maintenance period Use is selected, set the day of the week, start time, and duration It is recommended to set the maintenance period for stable management of the DB. Patch work is performed at the set time and service interruption occurs If set to not used, the company is not responsible for the problems that occur due to non-application of patches.
   tag	selection	add tag add tag button click after Key, Value value input or selection

   Table. MySQL(DBaaS) Replica Configuration Items

Replica reconstruction

In the event of a network failure or replication delay with the Master Cluster, the Replica reconstruction function can be used to re-replicate the Master Cluster’s data.

To reassemble the replica, follow the procedure below.

1. Click All Services > Database > MySQL(DBaaS) menu. 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. Click on the resource to be reconstructed as a replica on the MySQL(DBaaS) list page. It moves to the MySQL(DBaaS) details page.
4. Replica Reconstruction 버튼을 클릭하세요. Replica Reconstruction Notification 팝업창이 열립니다.
5. Replica Reconstruction Alert popup window, click the Confirm button.

Promote Replica Cluster to Master Cluster

You can promote a fully configured Replica Cluster to a Master Cluster.

To promote the Replica Cluster to Master, 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. Click the resource to be promoted to Master on the MySQL(DBaaS) list page. It moves 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. In the Master Promotion Alert popup window, click the OK button.

3 - API Reference

4 - CLI Reference

5 - Release Note

MySQL(DBaaS)