How-to guides
Users can create the MySQL(DBaaS) service by entering required information through Samsung Cloud Platform Console and selecting detailed options.
Create MySQL(DBaaS)
You can create and use the MySQL(DBaaS) service in Samsung Cloud Platform Console.
- Before creating the service, please configure the VPC’s Subnet type as General.
- If the Subnet type is Local, the corresponding Database service cannot be created.
- If loading large amounts of data of 2 TB or more, backup may take a long time or DB performance may deteriorate. To prevent this, consideration is needed from an operational perspective, such as cleaning unnecessary data or moving old data to a statistical collection environment
Follow these steps to create MySQL(DBaaS).
- Click All Services > Database > MySQL(DBaaS) menu. You will move to the Service Home page of MySQL(DBaaS).
- On the Service Home page, click the Create MySQL(DBaaS) button. You will move to the Create MySQL(DBaaS) page.
- On the Create MySQL(DBaaS) page, enter the information required for service creation and select detailed options.
- Select the required information in the Image and Version Selection area.
Classification RequiredDetailed Description Image Version Required MySQL(DBaaS) version list provided Table. MySQL(DBaaS) Image and Version Selection Items - Enter or select the required information in the Service Information Entry area.
Classification RequiredDetailed Description Server Name Prefix Required Server name where DB will be installed - Starts with lowercase English letters, enter 3 to 13 characters using lowercase letters, numbers, and special characters (
-)
- Actual server name is created with a postfix like 001, 002 based on the server name
Cluster Name Required Cluster name where DB servers are configured - Enter 3 to 20 characters using English letters
- Cluster is a unit that bundles multiple servers
Service Type > Server Type Required Server type where DB will be installed - Standard: Standard specifications generally used
- High Capacity: Large capacity server with 24vCore or more
- For details on server types provided by MySQL(DBaaS), refer to MySQL(DBaaS) Server Types
Service Type > Planned Compute Optional Resource status where Planned Compute is set - In Use: Number of resources in use among resources where Planned Compute is set
- Set: Number of resources where Planned Compute is set
- Coverage Preview: Amount applied as Planned Compute per resource
- Create Planned Compute Service: Move to Planned Compute service application page
- For details, refer to Apply for Planned Compute
Service Type > Block Storage Required Block Storage configuration used by DB according to purpose - Basic OS: Area where DB engine is installed
- DATA: Storage area for table data and archive files, etc.
- Select storage type and enter capacity (For details on Block Storage types, refer to Create Block Storage)
- SSD: High performance general volume
- HDD: General volume
- SSD_KMS, HDD_KMS: Additional encrypted volume using Samsung Cloud Platform KMS (Key Management System) encryption key
- Configured Storage type is applied identically to additional storage as well
- Enter capacity as a multiple of 8 in the range of 16 ~ 5,120
- Since SQL execution or large Sort due to monthly batch, etc. may cause service interruption, separate TEMP storage must be allocated and used
- Select storage type and enter capacity (For details on Block Storage types, refer to Create Block Storage)
- Add: DATA, Archive, TEMP, Backup data storage area
- Select Use and enter the purpose and capacity of the storage
- Storage type is applied identically as the type set in DATA, and capacity can be entered as a multiple of 8 in the range of 16 ~ 5,120
- To add storage, click the + button, and to delete, click the x button. Maximum 9 can be added
- Before transferring backup data, temporarily store backup data in BACKUP storage
- If backup data exceeds 100 GB and there are many data changes, it is recommended to add separate BACKUP storage for stable backup. It is recommended to set backup capacity to about 60% of DATA capacity
- If BACKUP storage is not added, the
/tmparea is used, and backup fails if capacity is insufficient
- Per service, only 1 Block Storage is allocated for Archive, TEMP, BACKUP storage
Redundancy Configuration Optional Whether to configure redundancy - If redundancy configuration is used, DB instance is configured as Active DB and Standby DB
Network > Common Settings Required Network settings where servers created in the service are installed - Select if you want to apply the same settings to all servers being installed
- Select pre-created VPC and Subnet, IP, Public NAT
- Only automatic creation is possible for IP
- Public NAT function can be used only if VPC is connected to Internet Gateway. If you check Use, you can select from IPs reserved in Public IP of VPC product. For details, refer to Create Public IP
Network > Per Server Settings Required Network settings where servers created in the service are installed - Select if you want to apply different settings to each server being installed
- Select pre-created VPC and Subnet, IP, Public NAT
- Enter IP for each server
- Public NAT function can be used only if VPC is connected to Internet Gateway. If you check Use, you can select from IPs reserved in Public IP of VPC product. For details, refer to Create Public IP
IP Access Control Optional Service access policy setting - Since access policy is set for IPs entered on the page, separate Security Group policy setting is not required
- Enter in IP format (e.g.,
192.168.10.1) or CIDR format (e.g.,192.168.10.0/24,192.168.10.1/32), and click the Add button
- To delete entered IP, click the x button next to the entered IP
Maintenance Window Optional DB maintenance window - If you select Use, set day of week, start time, and duration
- It is recommended to set a maintenance window for stable DB management. Patch work is performed at the set time and service interruption occurs
- If set to Not Used, Samsung SDS is not responsible for problems caused by not applying patches.
Table. MySQL(DBaaS) Service Configuration Items - Starts with lowercase English letters, enter 3 to 13 characters using lowercase letters, numbers, and special characters (
- Enter or select the required information in the Database Configuration Required Information Entry area.
Classification RequiredDetailed Description Database Name Required Server name applied when installing DB - Start with English letters, enter 3 to 20 characters using English letters and numbers
Database Username Required DB user name - Account with that name is also created in OS
- Enter 2 to 20 characters using lowercase English letters
- Restricted Database usernames can be checked in Console
Database Password Required Password to use when accessing DB - Enter 8 to 30 characters including English letters, numbers, and special characters (excluding
"’)
Database Password Confirm Required Re-enter the password to use when accessing DB identically Database Port Number Required Port number required for DB connection - Enter DB port in the range of 1200 ~ 65535
Backup > Use Optional Whether to use backup - Select Use to set backup file retention period, backup start time, and Archive backup cycle
Backup > Retention Period Optional Backup retention period - Select backup retention period. File retention period can be set from 7 days to 35 days
- Separate charges occur for backup files according to capacity
Backup > Backup Start Period Optional Backup start time - Select backup start time
- Minutes when backup is performed are set randomly, and backup end time cannot be set
Backup > Archive Backup Cycle Optional Archive backup cycle - Select Archive backup cycle
- Archive backup cycle of 1 hour is recommended. If you select 5 minutes, 10 minutes, 30 minutes, it may affect DB performance
Parameter Required Parameters to use in DB - Click the View button to check detailed information of parameters
- Parameters can be modified after DB creation is completed, and after modification, DB must be restarted
DB Character Set Required Character encoding method to use in DB Table Case Sensitivity Optional Whether DB Table is case-sensitive Time Zone Required Standard time zone where Database will be used ServiceWatch Log Collection Optional Whether to collect ServiceWatch logs - Select Use to set ServiceWatch log collection function
- For details on collected logs, refer to ServiceWatch Metrics
- Provided free up to 5 GB for all services in Account, and if exceeding 5 GB, charges are incurred according to storage capacity
- When collecting, log group and log stream are automatically created and cannot be deleted until resource is deleted
- To prevent exceeding 5 GB, direct deletion of log data or shortening of retention period is recommended
Table. MySQL(DBaaS) Database Configuration Items - Enter or select the required information in the Additional Information Entry area.
Classification RequiredDetailed Description Tags Optional Add tags - Can add up to 50 per resource
- Click the Add Tag button and then enter or select Key, Value values
Table. MySQL(DBaaS) Additional Information Entry Items
- Select the required information in the Image and Version Selection area.
- On the Summary panel, check the created detailed information and estimated billing amount, then click the Create button.
- When creation is completed, check the created resource on the Resource List page.
Check MySQL(DBaaS) Detailed Information
MySQL(DBaaS) service allows you to check and modify the entire resource list and detailed information. The MySQL(DBaaS) Details page is composed of Detailed Information, Tags, Operation History tabs, and for DBs where Replica is configured, the Replica Information tab is additionally configured.
Follow these steps to check the detailed information of MySQL(DBaaS) service.
- Click All Services > Database > MySQL(DBaaS) menu. You will move to the Service Home page of MySQL(DBaaS).
- On the Service Home page, click the MySQL(DBaaS) menu. You will move to the MySQL(DBaaS) List page.
- On the MySQL(DBaaS) List page, click the resource whose detailed information you want to check. You will move to the MySQL(DBaaS) Details page.
- At the top of the MySQL(DBaaS) Details page, status information and additional feature information are displayed.
Classification Detailed Description Cluster Status Status of cluster where DB is installed - Creating: Creating cluster
- Editing: Changing cluster to Operation execution status
- Error: Status where failure occurred while cluster was performing task
- If it occurs continuously, contact administrator
- Failed: Status where cluster failed during creation process
- Restarting: Restarting cluster
- Running: Status where cluster is operating normally
- Starting: Starting cluster
- Stopped: Status where cluster is stopped
- Stopping: Stopping cluster
- Synchronizing: Synchronizing cluster
- Terminating: Deleting cluster
- Unknown: Status where cluster status cannot be known
- If it occurs continuously, contact administrator
- Upgrading: Changing cluster to upgrade execution status
Cluster Control Buttons to change cluster status - Start: Start stopped cluster
- Stop: Stop running cluster
- Restart: Restart running cluster
- Switch-Over: Switch Standby cluster to Active
More Features Cluster-related management buttons - Sync Service Status: Check real-time DB service status
- Backup History: If backup is set, check whether backup was executed normally and history
- Database Recovery: Recover DB based on specific point in time
- Parameter Management: View and modify DB configuration parameters
- Replica Configuration: Configure Replica which is read-only cluster
- Replica Configuration (Other-Region): Configure Replica for disaster recovery in another region, button is deactivated if there is no region configured in that Account
- DB User Management: View and manage DB account (user) information registered in DB
- DB Access Control Management: Register and cancel access allowed IP based on DB accounts registered in DB
- Archive Management: Set Archive file retention period and Archive mode can be set
- DB Log Export: Logs stored through Audit settings can be exported to user’s Object Storage
- Migration Configuration: Provide Migration function using Replication method
- OS (Kernel) Upgrade: Upgrade OS Kernel version
Service Termination Button to terminate service Table. MySQL(DBaaS) Status Information and Additional Features
- At the top of the MySQL(DBaaS) Details page, status information and additional feature information are displayed.
Detailed Information
On the MySQL(DBaaS) List page, you can check the detailed information of the selected resource and modify information if necessary.
| Classification | Detailed Description |
|---|---|
| Server Information | Server information configured in that cluster
|
| Service | Service Name |
| Resource Type | Resource Type |
| SRN | Unique resource ID in Samsung Cloud Platform
|
| Resource Name | Resource name
|
| Resource ID | Unique resource ID in service |
| Creator | User who created the service |
| Creation Date | Date when service was created |
| Modifier | User who modified service information |
| Modification Date | Date when service information was modified |
| Image Version | Installed DB image and version information
|
| Cluster Type | Cluster type (Master Cluster, Replica Cluster, Migration Cluster) |
| Cluster Name | Cluster name where DB servers are configured |
| Master Cluster Name | Master cluster name of Replica
|
| Database Name | Server name applied when installing DB |
| Database Username | DB user name |
| Planned Compute | Resource status where Planned Compute is set
|
| Maintenance Window | DB maintenance window status
|
| Backup | Backup setting status
|
| ServiceWatch Log Collection | ServiceWatch log collection setting status
|
| DB Character Set | Encoding method to use in DB |
| Table Case Sensitivity | Whether DB Table is case-sensitive |
| Time Zone | Standard time zone where Database will be used |
| VIP | Virtual IP information
|
| Network | Network information where DB is installed (VPC, Subnet, VIP, NAT IP (VIP)) |
| IP Access Control | Service access policy setting
|
| Active & Standby | Active/Standby server type, basic OS, additional Disk information
|
Replica Information
The Replica Information tab is activated only if Replica is configured in the cluster. Through the Replica Information tab, you can check the Master cluster name, number of replicas, and Replica status.
| Classification | Detailed Description |
|---|---|
| Master Information | Name of Master cluster |
| Replica Count | Number of Replicas created in Master cluster |
| Replica Status | Replica server status created in Master cluster
|
Tags
On the MySQL(DBaaS) List page, you can check the tag information of the selected resource and add, modify, or delete it.
| Classification | Detailed Description |
|---|---|
| Tag List | Tag list
|
Operation History
On the MySQL(DBaaS) List page, you can check the operation history of the selected resource.
| Classification | Detailed Description |
|---|---|
| Operation History List | Resource change history
|
Manage MySQL(DBaaS) Resources
If you need to change existing configuration options of created MySQL(DBaaS) resources, or need recovery or Replica configuration, you can perform tasks on the MySQL(DBaaS) Details page.
Control Operation
If changes occur to running MySQL(DBaaS) resources, you can start, stop, or restart. Additionally, if HA is configured, you can switch Active-Standby servers through Switch-over.
Follow these steps to control operation of MySQL(DBaaS).
- Click All Services > Database > MySQL(DBaaS) menu. You will move to the Service Home page of MySQL(DBaaS).
- On the Service Home page, click the MySQL(DBaaS) menu. You will move to the MySQL(DBaaS) List page.
- On the MySQL(DBaaS) List page, click the resource to control operation. You will move to the MySQL(DBaaS) Details page.
- Check MySQL(DBaaS) status and complete the change through the control buttons below.
- Start: Server and DB service where DB is installed run (Running).
- Stop: Server and DB service where DB is installed stop (Stopped).
- Restart: Only DB service is restarted.
- Switch Over: Can swap Active server and Standby server of DB.
Sync Service Status
You can synchronize the real-time service status of MySQL(DBaaS).
Follow these steps to check the service status of MySQL(DBaaS).
- Click All Services > Database > MySQL(DBaaS) menu. You will move to the Service Home page of MySQL(DBaaS).
- On the Service Home page, click the MySQL(DBaaS) menu. You will move to the MySQL(DBaaS) List page.
- On the MySQL(DBaaS) List page, click the resource to check service status. You will move to the MySQL(DBaaS) Details page.
- Click the Sync Service Status button. While checking, cluster changes to Synchronizing status.
- When check is completed, status is updated in the server information item, and cluster changes to Running status
Change Server Type
You can change the configured server type.
Follow these steps to change server type.
- Server restart is required when modifying server type. Please check SW license modification matters or SW settings and reflection according to spec change separately.
- Click All Services > Database > MySQL(DBaaS) menu. You will move to the Service Home page of MySQL(DBaaS).
- On the Service Home page, click the MySQL(DBaaS) menu. You will move to the MySQL(DBaaS) List page.
- On the MySQL(DBaaS) List page, click the resource to change server type. You will move to the MySQL(DBaaS) Details page.
- 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.
- On the Edit Server Type popup window, select server type and click the Confirm button.
Add Storage
If you need more than 5 TB of data storage space, you can add storage. For DB configured with redundancy, it is added to both redundancy servers simultaneously.
- It is applied identically as the Storage type selected when creating the service.
- For DB with high availability setting, when adding storage, it is applied to both Active DB and Standby DB storage simultaneously.
- If Replica exists, Master cluster storage cannot be smaller than Replica storage. Please expand Replica storage first and then expand Master cluster storage
- When adding Archive/Temp storage, DB restarts and cannot be used temporarily
Follow these steps to add storage.
- Click All Services > Database > MySQL(DBaaS) menu. You will move to the Service Home page of MySQL(DBaaS).
- On the Service Home page, click the MySQL(DBaaS) menu. You will move to the MySQL(DBaaS) List page.
- On the MySQL(DBaaS) List page, click the resource to add storage. You will move to the MySQL(DBaaS) Details page.
- Click the Add Disk button at the bottom of detailed information. The Additional Storage Request popup window opens.
- On the Additional Storage Request popup window, enter purpose and capacity, then click the Confirm button.
Expand Storage
Storage added as data area can be expanded up to 5 TB based on initially allocated capacity. For DB configured with redundancy, it is expanded to both redundancy servers simultaneously.
Follow these steps to expand storage capacity.
- Click All Services > Database > MySQL(DBaaS) menu. You will move to the Service Home page of MySQL(DBaaS).
- On the Service Home page, click the MySQL(DBaaS) menu. You will move to the MySQL(DBaaS) List page.
- On the MySQL(DBaaS) List page, click the resource to change server type. You will move to the MySQL(DBaaS) Details page.
- 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.
- On the Edit Additional Storage popup window, enter expansion capacity and click the Confirm button.
Terminate MySQL(DBaaS)
You can reduce operating costs by terminating unused MySQL(DBaaS). However, when terminating the service, the running service may be immediately interrupted, so you should fully consider the impact of service interruption before proceeding with termination.
- For DB where Replica is configured, even if Master DB is terminated, Replica is not deleted together. If you want to delete Replica as well, please terminate separately from the resource list.
- When terminating DB, stored data and if backup is set, all backup data including backup data are deleted.
Follow these steps to terminate MySQL(DBaaS).
- Click All Services > Database > MySQL(DBaaS) menu. You will move to the Service Home page of MySQL(DBaaS).
- On the Service Home page, click the MySQL(DBaaS) menu. You will move to the MySQL(DBaaS) List page.
- On the MySQL(DBaaS) List page, select the resource to terminate and click the Terminate Service button.
- When termination is completed, check whether the resource is terminated on the MySQL(DBaaS) list page.