How-to guides

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

Creating MariaDB(DBaaS)

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

To create MariaDB(DBaaS), follow these steps:

1. Click the All Services > Database > MariaDB(DBaaS) menu. 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. On the Create MariaDB(DBaaS) page, enter the information required for service creation and select detailed options.
   • Select the required information in the Image and Version Selection area.

     Classification	Required	Detailed Description
     Image Version	Required	Provides version list of MariaDB(DBaaS)

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

     Classification	Required	Detailed Description
     Server Name Prefix	Required	Server name where DB will be installed Start with lowercase English letters, enter 3 to 13 characters using lowercase letters, numbers, and special characters (-) Actual server name is created with a postfix like 001, 002 based on the server name
     Cluster Name	Required	Cluster name where DB servers are configured Enter 3 to 20 characters using English Cluster is a unit that bundles multiple servers
     Service Type > Server Type	Required	Server type where DB will be installed Standard: Standard specification commonly used High Capacity: Large capacity server with 24 vCore or more For more information on server types provided by MariaDB(DBaaS), see MariaDB(DBaaS) Server Type
     Service Type > Planned Compute	Optional	Resource status 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 resource-based Planned Compute Create Planned Compute Service: Move to Planned Compute service application page For more information, see Apply for Planned Compute
     Service Type > Block Storage	Required	Block Storage setting used by DB according to purpose Basic OS: Area where DB engine is installed DATA: Storage area for table data and archive files, etc. Select storage type then enter capacity. (For more information by Block Storage type, see Creating Block Storage) SSD: High-performance general volume HDD: General volume SSD_KMS, HDD_KMS: Additional encrypted volume using Samsung Cloud Platform KMS (Key Management System) encryption key Set Storage type is applied equally to additional storage Enter capacity in multiples of 8 within the range of 16 to 5,120 Since service interruption may occur due to large Sort such as SQL execution or monthly batch, separate TEMP storage must be allocated and used Additional: DATA, Archive, TEMP, Backup data storage area Select Use then enter Purpose and Capacity of storage Storage type is applied equally to the type set in DATA, and capacity can be entered in multiples of 8 within the range of 16 to 5,120 To add storage, click the + button, and to delete, click the x button. Can add up to 9 Before transferring backup data, temporarily store backup data in BACKUP storage If backup data exceeds 100 GB and data changes are frequent, it is recommended to add separate BACKUP storage for stable backup. It is recommended to set backup capacity to about 60% of DATA capacity If BACKUP storage is not added, /tmp area is used, and backup fails if capacity is insufficient Only one Block Storage is allocated per service for Archive, TEMP, BACKUP storage
     Redundancy Configuration	Optional	Redundancy configuration If using redundancy configuration, DB instances are configured as Active DB and Standby DB
     Network > Common Settings	Required	Network settings where servers created in the service are installed Select if you want to apply the same settings to all installed servers Select pre-created VPC and Subnet, IP, Public NAT Only automatic IP generation is possible Public NAT function is only available when VPC is connected to Internet Gateway. If you check Use, you can select from IPs reserved in Public IP of VPC product. For more information, see Creating Public IP
     Network > Per Server Settings	Required	Network settings where servers created in the service are installed Select if you want to apply different settings for each installed server Select pre-created VPC and Subnet, IP, Public NAT Enter IP for each server Public NAT function is only available when VPC is connected to Internet Gateway. If you check Use, you can select from IPs reserved in Public IP of VPC product. For more information, see Creating Public IP
     IP Access Control	Optional	Service access policy setting Since access policy is set for the IP entered on the page, you don’t need to set Security Group policy separately Enter in IP format (example: 192.168.10.1) or CIDR format (example: 192.168.10.0/24, 192.168.10.1/32) and click the Add button To delete the entered IP, click the x button next to the entered IP
     Maintenance Period	Optional	DB maintenance period If selecting Use, set day of week, start time, and duration It is recommended to set the maintenance period for stable DB management. Patch work is performed at the set time and service interruption occurs If set to not used, Samsung SDS is not responsible for problems caused by not applying patches.

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

     Classification	Required	Detailed Description
     Database Name	Required	Server name applied when DB is installed Start with English, enter 3 to 20 characters using English and numbers
     Database Username	Required	DB user name Account with that name is also created in OS Enter 2 to 20 characters using lowercase English letters Limited Database usernames can be checked in Console
     Database Password	Required	Password to use when accessing DB Enter 8 to 30 characters including English letters, numbers, and special characters (excluding " ’)
     Database Password Confirmation	Required	Re-enter password to use when accessing DB identically
     Database Port Number	Required	Port number required for DB connection Enter DB port within the range of 1200 to 65535
     Backup > Use	Optional	Backup usage Select Use to set backup file retention period, backup start time, and Archive backup cycle
     Backup > Retention Period	Optional	Backup retention period Select backup retention period. File retention period can be set from 7 days to 35 days Separate fees are charged for backup files depending on capacity
     Backup > Backup Start Period	Optional	Backup start time Select backup start time The minutes when backup is performed are set randomly, and backup end time cannot be set
     Backup > Archive Backup Cycle	Optional	Archive backup cycle Select Archive backup cycle 1 hour is recommended for Archive backup cycle. When selecting 5 minutes, 10 minutes, 30 minutes, it may affect DB performance
     Audit Log Setting	Optional	Audit Log storage Select Use to set Audit Log function User access information recording is stored Users can specify event types to Audit through server_audit_events parameter, and can modify through Parameter screen For details on that parameter, see MariaDB documentation DB performance may deteriorate when Audit is set
     ServiceWatch Log Collection	Optional	ServiceWatch log collection Select Use to set ServiceWatch log collection function For details on collected logs, see ServiceWatch Metrics Provided free up to 5 GB for all services in Account, and fees are charged depending on storage capacity when exceeding 5 GB When collecting, log group and log stream are automatically created, and cannot be deleted until resource is deleted To prevent exceeding 5 GB, directly deleting log data or shortening retention period is recommended
     Parameter	Required	Parameters to use for DB Click the View button to check detailed information of parameters After DB creation is complete, parameter modification is possible, and DB must be restarted after modification
     DB Character Set	Required	Character encoding method to use for DB As a character set used when storing text data, DB is created with default setting to selected Encoding
     Time Zone	Required	Standard time zone where Database will be used

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

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

     Table. MariaDB(DBaaS) Additional Information Entry Items
4. In the Summary panel, review the detailed information and estimated charges, and click the Create button.
   • Once creation is complete, check the created resource on the Resource List page.

Checking MariaDB(DBaaS) Detailed Information

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

To check the detailed information of MariaDB(DBaaS) service, follow these steps:

1. Click the 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. On the MariaDB(DBaaS) List page, click the resource to check detailed information. It moves to the MariaDB(DBaaS) Details page.
   • At the top of the MariaDB(DBaaS) Details page, status information and additional function information are displayed.

     Classification	Detailed Description
     Cluster Status	Cluster status where DB is installed Creating: Cluster is being created Editing: Cluster is changing to Operation execution state Error: State where error occurred while cluster is performing operation If it occurs continuously, contact administrator Failed: State where cluster failed during creation process Restarting: State where cluster is being restarted Running: State where cluster is operating normally Starting: State where cluster is starting Stopped: State where cluster is stopped Stopping: State where cluster is in stop state Synchronizing: State where cluster is synchronizing Terminating: State where cluster is being deleted Unknown: State where cluster status is unknown If it occurs continuously, contact administrator Upgrading: State where cluster is changing to upgrade execution state
     Cluster Control	Buttons to change cluster status Start: Start stopped cluster Stop: Stop running cluster Restart: Restart running cluster Switch-Over: Switch Standby cluster to Active
     More Additional Functions	Cluster-related management buttons Sync Service Status: Check real-time DB service status Backup History: If backup is set, check backup normal execution status and history Database Recovery: Recover DB based on specific point in time Parameter Management: Check and modify DB configuration parameters Replica Configuration: Configure Replica which is read-only cluster Replica Configuration (Other-Region): Configure disaster recovery replica in different region, button is disabled if no region configured in that Account DB User Management: Check and manage DB account (user) information registered in DB DB Access Control Management: Allows registration and termination of access allowed IP based on DB accounts registered in DB Archive Setting Management: Archive file retention period setting and Archive mode setting are possible DB Log Export: Logs stored through Audit settings can be exported to user’s Object Storage Migration Configuration: Provides Migration function of Replication method OS(Kernel) Upgrade: OS Kernel version upgrade
     Service Termination	Button to terminate service

     Table. MariaDB(DBaaS) Status Information and Additional Functions

Detailed Information

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

Replica Information

The Replica Information tab is activated only when Replica is configured in the cluster. Through the Replica Information tab, you can check Master cluster name, replica count, and Replica status.

Tags

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

Operation History

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

Managing MariaDB(DBaaS) Resources

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

Controlling Operation

If changes occur in running MariaDB(DBaaS) resources, you can start, stop, or restart. Also, if configured with HA, you can switch Active-Standby servers through Switch-over.

To control MariaDB(DBaaS) operation, follow these steps:

1. Click the 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. On the MariaDB(DBaaS) List page, click the resource to control operation. It moves to the MariaDB(DBaaS) Details page.
4. Check MariaDB(DBaaS) status and complete changes through the control buttons below.
   • Start: DB service installed server and DB service will run (Running).
   • Stop: DB service installed server and DB service will stop (Stopped).
   • Restart: Only DB service will restart.
   • Switch Over: Can switch Active server and Standby server of DB.

Syncing Service Status

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

To check MariaDB(DBaaS) service status, follow these steps:

1. Click the 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. On the MariaDB(DBaaS) List page, click the resource to check service status. It moves to the MariaDB(DBaaS) Details page.
4. Click the Sync Service Status button. While retrieving, the cluster changes to Synchronizing status.
5. When retrieval is complete, the status is updated in the server information item, and the cluster changes to Running status.

Changing Server Type

You can change the configured server type.

To change the server type, follow these steps:

1. Click the 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. On the MariaDB(DBaaS) List page, click the resource to change server type. It moves to the MariaDB(DBaaS) Details page.
4. Click the Edit icon of the server type you want to change at the bottom of detailed information. The Edit Server Type popup window opens.
5. In the Edit Server Type popup window, select the server type and click the OK button.

Adding Storage

If data storage space of 5TB or more is needed, you can add storage. For DB configured with redundancy, both redundancy servers are added simultaneously.

To add storage, follow these steps:

1. Click the 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. On the MariaDB(DBaaS) List page, click the resource to add storage. It moves to the MariaDB(DBaaS) Details page.
4. Click the Disk Add button at the bottom of detailed information. The Additional Storage Request popup window opens.
5. In the Additional Storage Request popup window, after entering purpose and capacity, click the OK button.

Expanding Storage

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

To expand storage capacity, follow these steps:

1. Click the 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. On the MariaDB(DBaaS) List page, click the resource to change server type. It moves to the MariaDB(DBaaS) Details page.
4. Click the Edit icon of the additional Disk you want to expand at the bottom of detailed information. The Edit Additional Storage popup window opens.
5. In the Edit Additional Storage popup window, after entering expansion capacity, click the OK button.

Terminating MariaDB(DBaaS)

You can reduce operating costs by terminating unused MariaDB(DBaaS). However, if you terminate the service, the running service may stop immediately, so you should proceed with termination after fully considering the impact caused by service interruption.

To terminate MariaDB(DBaaS), follow these steps:

1. Click the 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. On the MariaDB(DBaaS) List page, select the resource to terminate and click the Terminate Service button.
4. When termination is complete, check if the resource is terminated on the MariaDB(DBaaS) List page.