MariaDB(DBaaS)

• 1: Overview
• 1.1: Server Type
• 1.2: Monitoring Metrics
• 2: How-to guides
• 2.1: MariaDB(DBaaS) server connection
• 2.2: Managing DB Services
• 2.3: DB Backup and Recovery
• 2.4: Configuring Read Replica
• 3: API Reference
• 4: CLI Reference
• 5: Release Note

1 - Overview

Service Overview

MariaDB (DBaaS) is an open source relational database (RDBMS) with high compatibility with MySQL. Samsung Cloud Platform provides an environment that can automate MariaDB installation and perform management functions for operation through a web-based console.

MariaDB (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 are provided for read load balancing and disaster recovery (DR). Additionally, to prepare for issues with the DB server or data, it offers a feature that automatically backs up at a user-specified time, supporting data recovery at the desired point in time.

Provided Features

MariaDB (DBaaS) provides the following features.

• Auto Provisioning (Auto Provisioning): Installation and configuration of Database (DB) via UI is possible, and it provides an Active-standby redundancy configuration built on storage replication. In case of an Active server failure, it automatically fails over to Standby.
• Operation Control Management: Provides a function to control the status of running servers. In addition to start and stop, restart is possible if there is an issue with the DB or to apply configuration values. When configured for high availability (HA), the user can directly perform node switching between Active-Standby via Switch-over.
• Backup and Recovery: Provides data backup functionality based on its own backup command. The backup time window and storage organization can be set by the user, and additional fees may be incurred depending on backup volume. It also provides a recovery function for backed-up data, so when the user performs recovery, a separate DB is created and recovery proceeds to the point in time selected by the user (backup save point, user-defined point). When recovering to a user-specified point, the recovery point can be set to 5 minutes/10 minutes/30 minutes/1 hour before the stored backup file and archive file.
• Version Management: Provides version upgrade (Minor) functionality due to 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, 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.
• Audit setting: Provides an Audit setting feature that can monitor the user’s DB access and the results of DDL (Data Definition Language)/DML (Data Manipulation Language) execution.
• 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 through 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 for access.
• 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: Through Audit settings, you can export stored logs to the user’s Object Storage.
• Migration: Synchronize data in real time with the operating database, and support migration using replication method without service interruption.

Components

MariaDB (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 MariaDB (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 6 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.

• MariaDB (Community): https://mariadb.org/about/#maintenance-policy

Server Type

The server types supported by MariaDB (DBaaS) are as follows.

For detailed information about the server types provided by MariaDB(DBaaS), see MariaDB(DBaaS) Server Type.

Standard db1v2m4

Preliminary Service

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

1.1 - Server Type

MariaDB(DBaaS) Server Type

MariaDB(DBaaS) provides server types with various combinations of CPU, Memory, and Network Bandwidth. When creating a MariaDB(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 MariaDB(DBaaS) are as follows:

Standard db1v2m4

db1 Server Type

The db1 server type of MariaDB(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 MariaDB(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

MariaDB(DBaaS) Monitoring Metrics

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

For server monitoring metrics of MariaDB(DBaaS), refer to the Virtual Server monitoring metrics guide.

2 - How-to guides

The user can enter the required information for MariaDB (DBaaS) and select detailed options through the Samsung Cloud Platform Console to create the service.

Creating MariaDB(DBaaS)

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

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

1. Click the All Services > Database > MariaDB(DBaaS) menu. You will be taken to the Service Home page of MariaDB(DBaaS).
2. Service Home on the page click the MariaDB(DBaaS) creation button. Navigate to the MariaDB(DBaaS) creation page.
3. MariaDB(DBaaS) creation on the page, enter the information required to create the service, and select detailed options.
   • Please select the required information in the Image and version selection area.

     Category	Required	Detailed description
     Image version	Required	Provide version list of MariaDB (DBaaS)

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

     Category	Required or not	Detailed description
     Server name Prefix	Required	Name of the server where the DB will be installed Start with a lowercase English 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 server types provided by MariaDB (DBaaS), refer to MariaDB(DBaaS) Server Type
     Service Type > Planned Compute	Select	Status of resources with Planned Compute set In Use: Number of resources with Planned Compute set that are currently in use Configured: Number of resources with Planned Compute set Coverage Preview: Amount applied by Planned Compute per resource Create Planned Compute Service: Go to the Planned Compute service application page For details, refer to Apply for Planned Compute
     Service Type > Block Storage	Required	Block Storage settings used by DB according to purpose Base OS: Area where the DB engine is installed DATA: Storage area for table data, archive files, etc. Select the storage type and then enter the capacity. (For detailed information on each Block Storage type, refer to Create Block Storage) SSD: High-performance general volume HDD: General volume SSD_KMS, HDD_KMS: Additional encrypted volumes using Samsung Cloud Platform KMS (Key Management System) encryption keys The configured storage type is applied identically to additional storage Capacity must be entered as a multiple of 8 within the range 16 ~ 5,120 Since large sorts during SQL execution or monthly batch processes can cause service interruptions, a separate TEMP storage must be allocated and used Additional: Data storage areas for DATA, Archive, TEMP, Backup After selecting Use, enter the storage’s purpose and capacity The storage type is applied the same as set for DATA, and capacity can be entered as a multiple of 8 within the range 16 ~ 5,120 Click the + button to add storage, and the x button to delete. Up to 9 can be added Temporarily store backup data in BACKUP storage before transmitting backup data If the data to be backed up exceeds 100 GB and changes frequently, it is recommended to add a separate BACKUP storage for reliable backup. It is advised to set the backup capacity to about 60% of the DATA capacity If a BACKUP storage is not added, using the /tmp area is recommended For each service, only one Block Storage is allocated for Archive, TEMP, BACKUP
     Redundancy Configuration	Selection	Redundancy Configuration Status If redundancy configuration is used, the DB instance is configured as Active DB and Standby DB
     Network > Common Settings	Required	Network settings where servers generated by the service are installed Select if you want to apply the same settings to all servers being installed Select a pre‑created VPC, Subnet, IP, 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 a reserved IP from the VPC product’s Public IP. See Create Public IP for details.
     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, 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 from reserved IPs in the VPC product’s Public IP. For more details, see Create Public IP.
     IP Access Control	Select	Service Access Policy Settings Since the access policy is set for the IP entered on the page, a separate Security Group policy setting is not required. Enter in IP format (e.g., 192.168.10.1) or CIDR format (e.g., 192.168.10.0/24, 192.168.10.1/32) and click the Add button To delete an entered IP, click the x button next to the entered IP
     Maintenance Period	Select	DB Maintenance Period Use is selected, set day of week, start time, and duration It is recommended to set a maintenance period for stable DB management. Patch work is 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. MariaDB (DBaaS) Service Information Input Items
   • Database configuration required information input area, please enter or select the required information.

     Category	Required or not	Detailed description
     Database name	Required	Server name applied when installing DB Start with English letters, use English letters and numbers, input 3 ~ 20 characters
     Database username	Required	DB user name An account with 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 the backup file retention period, backup start time, and Archive backup cycle
     Backup > Retention Period	Select	Backup retention period Select backup retention period. File retention period can be set from 7 days to 35 days Backup files incur separate charges based on size
     Backup > Backup Start Period	Select	Backup Start Time Select backup start time The minutes (minutes) at which the backup runs are set randomly, and the backup end time cannot be set
     Backup > Archive backup frequency	Select	Archive backup frequency Select the Archive backup frequency Archive backup frequency is recommended at 1 hour. Selecting 5 minutes, 10 minutes, or 30 minutes may affect DB performance
     Audit Log Settings	Select	Whether to store Audit Log Enable를 선택하여 Audit Log 기능을 설정 User connection information records are stored Users can specify the types of events to audit via the server_audit_events parameter, and it can be modified through the Parameter screen Refer to the MariaDB documentation for details on this parameter Enabling Audit may degrade DB performance
     Parameter	Required	Parameters to use in the DB Lookup Click the button to view detailed information of the parameter Parameters can be modified after DB creation is complete, and after modification the DB must be restarted
     DB character set	Required	Character encoding method to use for the DB The character set used when storing text data, and the DB is created with this encoding set as the default.
     Time zone	Required	Standard time zone to be used by the Database

     Table. MariaDB(DBaaS) Database configuration items
   • Additional Information Input area: enter or select the required information.

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

     Table. MariaDB(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.

MariaDB(DBaaS) Check detailed information

MariaDB(DBaaS) service can view and edit the full resource list and detailed information. The MariaDB(DBaaS) Details page consists of Details, Tags, Activity Log tabs, and for DBs with a Replica configured, an additional Replica Information tab is included.

To view detailed information about the MariaDB (DBaaS) service, follow the steps below.

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

• MariaDB(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 being changed to operation execution state Error: Cluster encountered a failure while performing tasks If it occurs continuously, contact the administrator Failed: Cluster failed during creation Restarting: Cluster is being restarted Running: Cluster is operating normally Starting: Cluster is being started Stopped: Cluster is stopped Stopping: Cluster is being stopped Synchronizing: Cluster is being synchronized Terminating: Cluster is being deleted Unknown: Cluster status is unknown If it occurs continuously, contact the administrator Upgrading: Cluster is changing to upgrade execution state
  Cluster Control	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 termination	Button to cancel the service

  Table. MariaDB (DBaaS) status information and additional features

Detailed Information

MariaDB(DBaaS) List page allows you to view detailed information of the selected resource and, if necessary, edit the information.

Replica Information

Replica Information tab is enabled only when a Replica is configured in the cluster. Replica Information tab allows you to check the master cluster name, number of replicas, and replica status.

Tag

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

Work History

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

MariaDB(DBaaS) Manage Resources

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

Control Operation

If changes occur to the running MariaDB (DBaaS) resources, you can start, stop, or restart them. Also, if HA is configured, you can switch the Active-Standby servers via Switch-over.

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

1. All Services > Database > MariaDB(DBaaS) Click the menu. Navigate to the Service Home page of MariaDB(DBaaS).
2. Click the MariaDB(DBaaS) menu on the Service Home page. Go to the MariaDB(DBaaS) list page.
3. MariaDB(DBaaS) 목록 Click the resource to control operation. MariaDB(DBaaS) 상세 Navigate to the page.
4. Check the status of MariaDB (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 will be stopped (Stopped).

• Restart: Only the DB service will be restarted.
  • Switch Over: You can switch the DB’s Active server and Standby server.

Synchronize Service Status

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

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

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

Change Server Type

You can change the configured server type.

To change the server type, follow the steps below.

1. Click the All Services > Database > MariaDB(DBaaS) menu. You will be taken to the Service Home page of MariaDB(DBaaS).
2. Service Home page, click the MariaDB(DBaaS) menu. Navigate to the MariaDB(DBaaS) list page.
3. MariaDB(DBaaS) List page, click the resource to change the server type. Move to the MariaDB(DBaaS) Details page.
4. Click the Edit icon of the server type you want to change at the bottom of the detailed information. The Edit Server Type popup window will open.
5. Edit Server Type After selecting the server type in the popup window, click the Confirm button.

Add Storage

If more than 5TB of data storage space is required, 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. Click the All Services > Database > MariaDB(DBaaS) menu. Navigate to the Service Home page of MariaDB(DBaaS).
2. Service Home page, click the MariaDB(DBaaS) menu. Navigate to the MariaDB(DBaaS) list page.
3. MariaDB(DBaaS) List Click the resource to add storage on the page. MariaDB(DBaaS) Details Navigate to the 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 In the popup window, after entering purpose and capacity, click the Confirm button.

Expanding Storage

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

To increase storage capacity, follow the steps below.

1. All Services > Database > MariaDB(DBaaS) Click the menu. Navigate to the Service Home page of MariaDB(DBaaS).
2. Click the MariaDB(DBaaS) menu on the Service Home page. Navigate to the MariaDB(DBaaS) List page.
3. Click the resource to change the server type on the MariaDB(DBaaS) List page. It moves to the MariaDB(DBaaS) Details page.
4. Click the Edit icon of the additional Disk you want to add 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.

MariaDB(DBaaS) Cancel

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

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

2.1 - MariaDB(DBaaS) server connection

Scenario Overview

The MariaDB(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 access MariaDB (DBaaS) stably in the Samsung Cloud Platform environment, it is necessary to create a Bastion host and network connection using it. 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, to connect through a DB access 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 required for service creation.
   • IP range should be entered as 192.168.x.0/16.
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 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. Service Home page, click the Public IP menu. 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, enter the required information necessary for service reservation.
5. In the Summary panel, review the details generated and the expected charge amount, then click the Complete button.
   • Once creation is complete, check the created resource on the Public IP List page.

1-5. Creating a Security Group

1. Click All services > Networking > Security Group menu. 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, please enter the required information necessary for service creation.
4. Check the input information and click the Complete button.
   • After 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. Service Home page, click the Keypair menu. It moves to the Keypair list page.
3. Create Keypair button should be clicked. It moves to the Create Keypair 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 a 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. In the Summary panel, review the details generated and the expected charge amount, then click the Complete button.
   • After 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. It moves 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, as described in 5-1. Bastion host 접속하기.

3. Creating a Database

It describes the process of creating a database service.

3-1. Creating the MariaDB (DBaaS) Service

1. Click on the menu for all services > Database > MariaDB(DBaaS). It moves to the Service Home page of MariaDB(DBaaS).
2. On the Service Home page, click the Create MariaDB(DBaaS) button. It moves to the Create MariaDB(DBaaS) page.
3. MariaDB(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 MariaDB(DBaaS) list page.

4. Setting Rules

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

4-1. Adding Security Group Security Rules

1. Click on 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 In the 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. Rule tab, 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. Connecting to the 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 also install and use the tools that are suitable for users.

5-1. Connect to Bastion host

1. Run Remote Desktop Connection in the Windows environment of the PC you want to connect to 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. Installing 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. MariaDB(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 user name

   DB connection client program input items
3. Password popup window, enter the password set in 3-1. MariaDB(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를 클릭하세요. 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 MariaDB (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 > MariaDB (DBaaS) menu. You will be taken to the Service Home page of MariaDB (DBaaS).
2. Click the MariaDB (DBaaS) menu on the Service Home page. You will be taken to the MariaDB (DBaaS) List page.
3. Click the resource you want to view and modify parameters on the MariaDB (DBaaS) List page. You will be taken to the MariaDB (DBaaS) Details page.
4. Click the More button and then click the Parameter Management button. The Parameter Management popup window will open.
5. Click the View button in the Parameter Management popup window. The View Notification popup window will open.
6. When the View Notification popup window opens, click the OK button. It may take some time to view.

Modifying Parameters

To modify configuration parameters, follow these steps:

1. Click the All Services > Database > MariaDB (DBaaS) menu. You will be taken to the Service Home page of MariaDB (DBaaS).
2. Click the MariaDB (DBaaS) menu on the Service Home page. You will be taken to the MariaDB (DBaaS) List page.
3. Click the resource you want to view and modify parameters on the MariaDB (DBaaS) List page. You will be taken to the MariaDB (DBaaS) Details page.
4. Click the More button and then click the Parameter Management button. The Parameter Management popup window will open.
5. Click the View button in the Parameter Management popup window. The View Notification popup window will open.
6. When the View Notification popup window opens, click the OK button. It may take some time to view.
7. If modification is necessary, click the Modify button and enter the modification contents in the custom 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 > MariaDB (DBaaS) menu. You will be taken to the Service Home page of MariaDB (DBaaS).
2. Click the MariaDB (DBaaS) menu on the Service Home page. You will be taken to the MariaDB (DBaaS) List page.
3. Click the resource you want to view DB users on the MariaDB (DBaaS) List page. You will be taken to the MariaDB (DBaaS) Details page.
4. Click the More button and then click the DB User Management button. You will be taken to the DB User Management page.
5. Click the View button on the DB User Management page. It may take 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 > MariaDB (DBaaS) menu. You will be taken to the Service Home page of MariaDB (DBaaS).
2. Click the MariaDB (DBaaS) menu on the Service Home page. You will be taken to the MariaDB (DBaaS) List page.
3. Click the resource you want to modify DB users on the MariaDB (DBaaS) List page. You will be taken to the MariaDB (DBaaS) Details page.
4. Click the More button and then click the DB User Management button. You will be taken to the DB User Management page.
5. Click the View button on the DB User Management page. It may take some time to view.
6. If modification is necessary, click the Modify button and change the status value or enter notes.
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 authorized 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 > MariaDB (DBaaS) menu. You will be taken to the Service Home page of MariaDB (DBaaS).
2. Click the MariaDB (DBaaS) menu on the Service Home page. You will be taken to the MariaDB (DBaaS) List page.
3. Click the resource you want to manage access control on the MariaDB (DBaaS) List page. You will be taken to the MariaDB (DBaaS) Details page.
4. Click the More button and then click the DB Access Control Management button. You will be taken to the DB Access Control Management page.
5. Click the View button on the DB Access Control Management page. It may take some time to view.

Adding DB Access Control

To add IP access control, follow these steps:

1. Click the All Services > Database > MariaDB (DBaaS) menu. You will be taken to the Service Home page of MariaDB (DBaaS).
2. Click the MariaDB (DBaaS) menu on the Service Home page. You will be taken to the MariaDB (DBaaS) List page.
3. Click the resource you want to add IP access control on the MariaDB (DBaaS) List page. You will be taken to the MariaDB (DBaaS) Details page.
4. Click the More button and then click the DB Access Control Management button. You will be taken to the DB Access Control Management page.
5. Click the View button on the DB Access Control Management page. It may take some time to view.
6. When the view is complete, click the Add button. The DB Access Control Add popup window will open.
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. All Services > Database > MariaDB(DBaaS) menu, click. Move to the Service Home page of MariaDB(DBaaS).
2. On the Service Home page, click the MariaDB(DBaaS) menu. Move to the MariaDB(DBaaS) list page.
3. On the MariaDB(DBaaS) list page, click the resource for which you want to delete IP access control. Move to the MariaDB(DBaaS) details page.
4. Click the More button and then click the DB Access Control Management button. Move to the DB Access Control Management page.
5. On the DB Access Control Management page, click the Inquire button. It takes some time to inquire.
6. Once the inquiry is complete, click the Delete button. The Delete pop-up window opens.
7. In the Delete pop-up window, click the Confirm button.

Managing Archives

The Archive mode setting and Archive Log storage period setting functions are provided to allow users to flexibly set the Archive log management policy according to their operating environment. In addition, 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. All Services > Database > MariaDB(DBaaS) menu, click. Move to the Service Home page of MariaDB(DBaaS).
2. On the Service Home page, click the MariaDB(DBaaS) menu. Move to the MariaDB(DBaaS) list page.
3. On the MariaDB(DBaaS) list page, click the resource for which you want to set the Archive mode. Move to the MariaDB(DBaaS) details page.
4. Click the More button and then click the Archive Settings Management button. Move to the Archive Settings Management page.
5. On the Archive Settings Management page, click the Inquire button. It takes some time to inquire.
6. Click the Modify button and select the usage and storage period.
7. Once the modification is complete, click the Save button.

Deleting Archive Files

To delete Archive files, follow these steps:

1. All Services > Database > MariaDB(DBaaS) menu, click. Move to the Service Home page of MariaDB(DBaaS).
2. On the Service Home page, click the MariaDB(DBaaS) menu. Move to the MariaDB(DBaaS) list page.
3. On the MariaDB(DBaaS) list page, click the resource for which you want to set the Archive mode. Move to the MariaDB(DBaaS) details page.
4. Click the More button and then click the Archive Settings Management button. Move to the Archive Settings Management page.
5. On the Archive Settings Management page, click the Delete All Archives button to delete all Archive files, or click the Delete Backed-up Archives button to delete only the backed-up Archive files.

Exporting DB Logs

Supports exporting log data that requires long-term storage among audit logs to Object Storage. Users can directly set the type of log to be stored, the target bucket to be exported, and the cycle of exporting logs. According to the set criteria, logs are copied to the specified Object Storage for storage. In addition, an option to automatically delete the original log file while exporting logs to Object Storage is provided to efficiently manage disk space. By utilizing this option, users can safely store necessary log data for a long time while effectively securing storage capacity.

Setting DB Log Export Mode

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

1. All Services > Database > MariaDB(DBaaS) menu, click. Move to the Service Home page of MariaDB(DBaaS).
2. On the Service Home page, click the MariaDB(DBaaS) menu. Move to the MariaDB(DBaaS) list page.
3. On the MariaDB(DBaaS) list page, click the resource for which you want to export DB logs. Move to the MariaDB(DBaaS) details page.
4. Click the More button and then click the DB Log Export button. Move to the DB Log Export page.
5. On the DB Log Export page, click the Registration button. Move to the DB Log Export Registration page.
6. On the DB Log Export Registration page, enter the corresponding information and click the Save button.

Managing DB Log Export

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

1. All Services > Database > MariaDB(DBaaS) menu, click. Move to the Service Home page of MariaDB(DBaaS).
2. On the Service Home page, click the MariaDB(DBaaS) menu. Move to the MariaDB(DBaaS) list page.
3. On the MariaDB(DBaaS) list page, click the resource for which you want to manage DB log export. Move to the MariaDB(DBaaS) details page.
4. Click the More button and then click the DB Log Export button. 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 then click the Immediate Export, Modify, or Cancel button.
   • Immediate Export: Exports the selected log to the Object Storage bucket set earlier.
   • Modify: Modifies the DB log export mode setting.
   • Cancel: Cancels the DB log export mode setting.

Upgrading DB Version

Provides a version upgrade function due to some feature improvements and security patches. Only minor version upgrades are supported within the same major version.

To upgrade the version, follow the procedure below.

1. Click the All Services > Database > MariaDB(DBaaS) menu. It moves to the Service Home page of MariaDB(DBaaS).
2. Click the MariaDB(DBaaS) menu on the Service Home page. It moves to the MariaDB(DBaaS) list page.
3. Click the resource to be upgraded on the MariaDB(DBaaS) list page. It moves to the MariaDB(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 Confirm button.
6. Click the Confirm 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 the procedure below.

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 to click the Configure Migration button. The Configure Migration popup window opens.
5. In the Configure Migration popup window, check the instructions and click the Confirm 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 the procedure below.

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 to click the Promote to Master button. The Master Promotion Notification popup window opens.
5. Click the Confirm button in the Master Promotion Notification popup window.

2.3 - DB Backup and Recovery

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

Backing up MariaDB(DBaaS)

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

Setting up backup

The backup setting method of MariaDB(DBaaS) is referred to MariaDB(DBaaS) creation.

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

1. All Services > Database > MariaDB(DBaaS) menu is clicked. It moves to the Service Home page of MariaDB(DBaaS).
2. Service Home page, click the MariaDB(DBaaS) menu. Move to the MariaDB(DBaaS) list page.
3. MariaDB(DBaaS) list page, click the resource to set the backup. Move to the MariaDB(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 OK button.
   • If you want to stop the backup setting, uncheck Use in the Backup Setting popup window and click the OK button.

Check backup history

To check the backup history, follow these steps.

1. Click All Services > Database > MariaDB(DBaaS) menu. It moves to the Service Home page of MariaDB(DBaaS).
2. On the Service Home page, click the MariaDB(DBaaS) menu. It moves to the MariaDB(DBaaS) list page.
3. MariaDB(DBaaS) list page, click the resource to check the backup history. It moves to the MariaDB(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.

Deleting backup files

To delete a backup file, follow these steps.

1. All Services > Database > MariaDB(DBaaS) menu is clicked. It moves to the Service Home page of MariaDB(DBaaS).
2. On the Service Home page, click the MariaDB(DBaaS) menu. It moves to the MariaDB(DBaaS) list page.
3. MariaDB(DBaaS) list page, click the resource to check the backup history. It moves to the MariaDB(DBaaS) details page.
4. Click the Backup History button. The Backup History popup window opens.
5. In the Backup History popup window, check the files you want to delete and click the Delete button.

Restore MariaDB(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 MariaDB (DBaaS) recovery, a new server is created with the OS image at the initial provisioning time, and 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 MariaDB(DBaaS), follow these procedures.

1. Click All Services > Database > MariaDB(DBaaS) menu. It moves to the Service Home page of MariaDB(DBaaS).
2. Service Home page, click the MariaDB(DBaaS) menu. Move to the MariaDB(DBaaS) list page.
3. MariaDB(DBaaS) list page, click the resource you want to restore. Move to the MariaDB(DBaaS) details page.
4. Database Recovery 버튼을 클릭하세요. Database Recovery 페이지로 이동합니다.
5. After entering information in the database recovery configuration area, click the Complete button.

2.4 - Configuring Read Replica

Users can create a Read Replica by entering the required information through the Samsung Cloud Platform Console and configuring detailed options.

Configuring Replica

Replica configuration allows you to create a read-only replica server. You can create up to 5 replicas per database.

To configure a replica, follow these steps:

1. Click All Services > Database > MariaDB(DBaaS). This will take you to the MariaDB(DBaaS) Service Home page.
2. Click MariaDB(DBaaS) on the Service Home page. This will take you to the MariaDB(DBaaS) list page.
3. Click the resource you want to configure a replica for on the MariaDB(DBaaS) list page. This will take you to the MariaDB(DBaaS) details page.
4. Click the Replica Configuration button. This will take you to the Replica Configuration page.
5. Enter the information in the replica configuration area and click the Complete button.

Reconfiguring Replica

If a network failure or replication delay occurs between the master cluster and the replica, you can reconfigure the replica to re-replicate the master cluster’s data.

To reconfigure a replica, follow these steps:

1. Click All Services > Database > MariaDB(DBaaS). This will take you to the MariaDB(DBaaS) Service Home page.
2. Click MariaDB(DBaaS) on the Service Home page. This will take you to the MariaDB(DBaaS) list page.
3. Click the resource you want to reconfigure a replica for on the MariaDB(DBaaS) list page. This will take you to the MariaDB(DBaaS) details page.
4. Click the Reconfigure Replica button. The Reconfigure Replica notification popup will open.
5. Click the Confirm button in the Reconfigure Replica notification popup.

Promoting Replica Cluster to Master

You can promote a configured replica cluster to a master cluster.

To promote a replica cluster to a master, follow these steps:

1. Click All Services > Database > MariaDB(DBaaS). This will take you to the MariaDB(DBaaS) Service Home page.
2. Click MariaDB(DBaaS) on the Service Home page. This will take you to the MariaDB(DBaaS) list page.
3. Click the resource you want to promote to a master on the MariaDB(DBaaS) list page. This will take you to the MariaDB(DBaaS) details page.
4. Click the More button and then click the Promote to Master button. The Promote to Master notification popup will open.
5. Click the Confirm button in the Promote to Master notification popup.

3 - API Reference

4 - CLI Reference

5 - Release Note

MariaDB(DBaaS)