The page has been translated by Gen AI.

How-to guides

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

Creating MySQL(DBaaS)

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

Notice
  • Please configure the VPC’s Subnet type as General before creating the service.
    • If the Subnet type is Local, the creation of the corresponding Database service is not possible.
  • If you load more than 2 TB of large-scale data, backups may take a long time or the DB’s performance may degrade. To prevent this, you need to consider operational aspects such as cleaning up unnecessary data or moving old data to a statistical collection environment.

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

  1. Click the All Services > Database > MySQL(DBaaS) menu. Go to the Service Home page of MySQL(DBaaS).
  2. Click the MySQL(DBaaS) 생성 button on the Service Home page. You will be taken to the MySQL(DBaaS) 생성 page.
  3. MySQL(DBaaS) Creation page, enter the information required to create the service and select detailed options.
    • Select the required information in the Image and Version Selection area.
      Category
      Required
      Detailed description
      Image versionRequiredProvide version list of MySQL (DBaaS)
      Table. MySQL(DBaaS) image and version selection items
    • Service Information Input area, please enter or select the required information.
      Category
      Required
      Detailed description
      Server Name PrefixRequiredServer name where DB will be installed
      • Start with an English lowercase letter, and use lowercase letters, numbers, and the special character (-) to input 3 to 13 characters
      • Based on the server name, a postfix such as 001, 002 is attached to create the actual server name
      Cluster NameRequiredCluster 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 TypeRequiredServer type where DB will be installed
      • Standard: Standard specifications commonly used
      • High Capacity: Large-capacity server of 24 vCore or more
      Service Type > Planned ComputeOptionalStatus of resources with Planned Compute set
      • In Use: Number of resources with Planned Compute that are in use
      • Configured: Number of resources with Planned Compute set
      • Coverage preview: Amount applied per resource by Planned Compute
      Redundancy configurationSelectRedundancy configuration status
      • If redundancy configuration is used, the DB instance is configured as Active DB and Standby DB
      Network > Common SettingsRequiredNetwork settings where servers created by the service are deployed
      • Select if you want to apply the same settings to all servers being installed
      • Select a pre‑created VPC, Subnet, IP, and Public NAT
        • IP can only be auto‑generated
        • The Public NAT feature is available only when the VPC is connected to an Internet Gateway. If you check Use, you can select from reserved IPs in the VPC product’s Public IP. For details, see Create Public IP.
      Network > Server-specific SettingsRequiredNetwork settings where servers generated by the service are installed
      • Select if you want to apply different settings per installed server
      • Select a pre‑created VPC, Subnet, IP, and Public NAT
        • Enter each server’s IP
        • The Public NAT feature is available only when the VPC is connected to an Internet Gateway. If you check Use, you can select a reserved IP from the VPC product’s Public IP. For more details, see Create Public IP.
      IP Access ControlSelectService 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 PeriodSelectDB Maintenance Period
      • Use: set day of week, start time, and duration
      • It is recommended to set a maintenance period for stable DB management. Patch work will be performed at the set time, causing service interruption.
      • If set to not use, Samsung SDS is not responsible for issues arising from unapplied patches.
      Table. MySQL(DBaaS) Service Configuration Items
    • Database configuration required information input Enter or select the required information in the area.
      Category
      Required
      Detailed description
      Database nameRequiredServer name applied when installing DB
      • Start with an English letter, use English letters and numbers, and enter 3 to 20 characters
      Database usernameRequiredDB 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 passwordRequiredPassword to use when accessing the DB
      • Enter 8-30 characters including letters, numbers, and special characters ( excluded)
      Database Password ConfirmationRequiredRe-enter the same password to be used when accessing the DB
      Database Port numberRequiredPort number required for DB connection
      • Enter DB port within the range 1,024 ~ 65,535
      Backup > UseSelectWhether to use backup
      • Select Use to set backup file retention period, backup start time, Archive backup cycle
      Backup > Retention PeriodSelectBackup Retention Period
      • Select the backup retention period. File retention period can be set from 7 days to 35 days
      • Backup files incur additional charges depending on size
      Backup > Backup Start PeriodSelectBackup Start Time
      • Select backup start time
      • The minutes (minutes) at which the backup is performed are set randomly, and the backup end time cannot be set
      Backup > Archive backup frequencySelectArchive 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
      ParameterRequiredParameters to use in the DB
      • View button to click to view detailed information of the parameter
      • Parameters can be modified after DB creation is completed, and after modification the DB must be restarted
      DB character setRequiredCharacter encoding method to be used in the DB
      Table case sensitivityselectDB Table case sensitivity status
      Time zoneRequiredStandard time zone to be used by the Database
      Table. MySQL(DBaaS) Database configuration items
    • Enter additional information in the area, please enter or select the required information.
      Category
      Required
      Detailed description
      TagSelectAdd Tag
      • Up to 50 can be added per resource
      • After clicking the Add Tag button, enter or select Key, Value values
      Table. MySQL(DBaaS) Additional Information Input Items
  4. Summary Check the detailed information and estimated billing amount generated in the panel, and click the Complete button.
    • Once creation is complete, check the created resource on the Resource List page.

MySQL(DBaaS) Check detailed information

The MySQL (DBaaS) service allows you to view and edit the full resource list and detailed information. The MySQL (DBaaS) Details page consists of Details, Tags, Activity History tabs, and for databases with a Replica configured, a Replica Information tab is additionally provided.

To view detailed information of the MySQL (DBaaS) service, follow the steps below.

  1. Click the All Services > Database > MySQL(DBaaS) menu. Go to the Service Home page of MySQL(DBaaS).
  2. Click the MySQL(DBaaS) menu on the Service Home page. You will be taken to the MySQL(DBaaS) List page.
  3. Click the resource to view detailed information on the MySQL(DBaaS) List page. It moves to the MySQL(DBaaS) Details page.
  • MySQL(DBaaS) Details At the top of the page, status information and information about additional features are displayed.
    CategoryDetailed description
    Cluster StatusCluster status with DB installed
    • Creating: Cluster is being created
    • Editing: Cluster is changing to operation execution state
    • Error: Cluster encountered a failure while performing a task
      • If it occurs continuously, contact the administrator
    • Failed: Cluster failed during creation
    • Restarting: Cluster is being restarted
    • Running: Cluster is operating normally
    • Starting: Cluster is being started
    • Stopped: Cluster is stopped
    • Stopping: Cluster is being stopped
    • Synchronizing: Cluster is being synchronized
    • Terminating: Cluster is being deleted
    • Unknown: Cluster status is unknown
      • If it occurs continuously, contact the administrator
    • Upgrading: Cluster is changing to upgrade execution state
    Cluster ControlButton 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 featuresCluster 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 cancellationButton to cancel the service
    Table. MySQL(DBaaS) status information and additional features

Detailed Information

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

CategoryDetailed description
Server InformationServer information configured in the cluster
  • Category: Server type (Active, Standby, Replica)
  • Server Name: Server name
  • IP:Port: Server IP and port
  • Status: Server status
ServiceService Name
Resource TypeResource Type
SRNUnique resource ID in Samsung Cloud Platform
  • In DB service, it means cluster SRN
Resource NameResource Name
  • In DB service, it means the cluster name
Resource IDUnique resource ID in the service
CreatorUser who created the service
Creation timeService creation time
EditorUser who modified the service information
Modification Date/TimeDate and time when service information was modified
Image/VersionInstalled DB image and version information
  • If a version upgrade is needed, click the Edit icon to set
Cluster TypeCluster Type (Master Cluster, Replica Cluster, Migration Cluster)
Cluster NameName of the cluster composed of DB servers
Master cluster nameReplica’s Master cluster name
  • If detailed information of Replica, can be confirmed
Database nameServer name applied when installing DB
Database usernameDB user name
Planned ComputeResource status with Planned Compute set
Maintenance PeriodDB Maintenance Period Status
  • If maintenance period setting is required, click the Edit icon to set
BackupBackup Settings Status
  • If backup settings are needed, click the Edit icon to set
Time zoneStandard time zone used by the Database
DB character setEncoding method to use in DB
Table case sensitivityDB Table case sensitivity status
VIPVirtual IP information
  • Can be checked only when high availability is configured
NetworkNetwork information where DB is installed (VPC, Subnet, VIP, NAT IP(VIP))
IP Access ControlService Access Policy Settings
  • If you need to add or delete an IP, click the Edit icon to set
Active & StandbyActive/Standby server type, default OS, additional Disk information
  • If you need to modify the server type, click the Edit icon next to the server type to set it. Refer to the server type modification procedure Change Server Type
    • Modifying the server type requires a server reboot
  • If you need to expand storage, click the Edit icon next to the storage capacity to expand. Refer to the storage expansion procedure Expand Storage
  • If you need to add storage, click the Add Disk button next to Additional Disk to add. Refer to the storage addition procedure Add Storage
Table. MySQL(DBaaS) Database detailed information items

Replica Information

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

CategoryDetailed description
Master InformationName of Master Cluster
Replica countNumber of Replicas created in the Master cluster
Replica statusReplica server status created in the Master cluster
  • Server name, status query, status details, status check time can be verified
  • To query the Replica status, click the Status Query button
    • While querying, the cluster remains in Synchronizing status, and once the query is complete, the cluster changes to Running status
Table. Replica Information Tab Detailed Information Items

Tag

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

CategoryDetailed description
Tag ListTag List
  • You can view the Key and Value information of tags
  • Up to 50 tags can be added per resource
  • When entering tags, search and select from the previously created Key and Value list
Table. MySQL(DBaaS) Tag Tab Items

Work History

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

CategoryDetailed description
Work History ListResource Change History
  • Work date and time, Resource ID, Resource name, Work details, Event topic, Work result, Check worker information
Table. Work History Tab Detailed Information Items

MySQL(DBaaS) Resource Management

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

Operating Control

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

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

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

Synchronize Service Status

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

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

  1. All Services > Database > MySQL(DBaaS) Click the menu. Navigate to the Service Home page of MySQL(DBaaS).
  2. Click the MySQL(DBaaS) menu on the Service Home page. Go to the MySQL(DBaaS) List page. 3. MySQL(DBaaS) List Click the resource to view the service status. MySQL(DBaaS) Detail Navigate to the page.
  3. Service status synchronization button. Click the button. While fetching, the cluster changes to Synchronizing state.
  4. When the query is completed, the status in the server information item is updated, and the cluster changes to Running state.

Change Server Type

You can change the configured server type.

To change the server type, follow the steps below.

Caution
  • If you modify the server type, a server reboot is required. Please separately verify any SW license changes or SW settings and their application due to spec changes.
  1. All Services > Database > MySQL(DBaaS) Click the menu. Go to the Service Home page of MySQL(DBaaS).
  2. Click the MySQL(DBaaS) menu on the Service Home page. Go to the MySQL(DBaaS) List page.
  3. Click the resource to change the server type on the MySQL(DBaaS) 목록 page. It will move to the MySQL(DBaaS) 상세 page.
  4. Click the Edit icon of the server type you want to change at the bottom of the detailed information. The Server Type Edit popup window will open.
  5. Server Type Edit In the popup window, after selecting the server type, click the Confirm button.

Add Storage

If you need more than 5 TB of data storage space, you can add storage. In the case of a redundant DB configuration, all redundant servers are added simultaneously.

Caution
  • It is applied the same way as the selected Storage type when creating a service.
  • If a DB is configured for high availability, adding storage will be applied simultaneously to the storage of the Active DB and the Standby DB.
  • If a Replica exists, the storage of the Master cluster cannot be larger than the storage of the Replica. Please expand the Replica storage first, then expand the Master cluster storage.
  • When adding Archive/Temp storage, the DB restarts and is temporarily unavailable

To add storage, follow the steps below.

  1. All Services > Database > MySQL(DBaaS) Click the menu. Go to the Service Home page of MySQL(DBaaS).
  2. Click the MySQL(DBaaS) menu on the Service Home page. Navigate to the MySQL(DBaaS) List page.
  3. On the MySQL(DBaaS) List page, click the resource to add storage. It navigates to the MySQL(DBaaS) Details page.
  4. Click the Add Disk button at the bottom of the detailed information. The Add Storage Request popup window opens.
  5. Additional Storage Request After entering purpose and capacity in the popup window, click the Confirm button.

Expanding storage

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

To increase storage capacity, follow the steps below.

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

MySQL(DBaaS) Cancel

You can cancel unused MySQL (DBaaS) to reduce operating costs. However, if you cancel the service, the running service may be stopped immediately, so you should consider the impact of service interruption sufficiently before proceeding with the cancellation.

Caution
  • In the case of a DB with a Replica configured, even if you terminate the Master DB, the Replica is not deleted together. If you also want to delete the Replica, please terminate it separately from the resource list.
  • If you cancel the DB, any stored data and, if backup is set, all backup data will be deleted.

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

  1. All Services > Database > MySQL(DBaaS) Click the menu. Go to the Service Home page of MySQL(DBaaS).
  2. Click the MySQL(DBaaS) menu on the Service Home page. You will be taken to the MySQL(DBaaS) List page.
  3. MySQL(DBaaS) List On the page, select the resource to cancel, and click the Cancel Service button.
  4. When the termination is complete, check whether the resource has been terminated on the MySQL (DBaaS) list page.
Monitoring Metrics
MySQL(DBaaS) server connection