The page has been translated by Gen AI.

How-to guides

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

Creating CacheStore(DBaaS)

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

Notice

Before creating a service, configure the VPC Subnet type as General.

  • If the Subnet type is Local, the Database service cannot be created.

To create CacheStore(DBaaS), follow these steps:

  1. Click the All Services > Database > CacheStore(DBaaS) menu. It moves to the Service Home page of CacheStore(DBaaS).
  2. On the Service Home page, click the Create CacheStore(DBaaS) button. It moves to the Create CacheStore(DBaaS) page.
  3. On the Create CacheStore(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 VersionRequiredProvides version list of CacheStore(DBaaS)
      Table. CacheStore(DBaaS) Image and Version Selection Items
    • Enter or select the required information in the Service Information Entry area.
      Classification
      Required
      Detailed Description
      Server Name PrefixRequiredServer name where Redis/Valkey 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 NameRequiredCluster name where Redis/Valkey is installed
      • Enter 3 to 20 characters using English
      • Cluster is a unit that bundles multiple servers
      Service Type > Server TypeRequiredServer type where Redis/Valkey will be installed
      • Standard: Standard specification commonly used
      Service Type > Planned ComputeRequiredResource 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
      Service Type > Block StorageRequiredBlock 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
      High AvailabilityOptionalHigh Availability (HA) configuration
      • If using HA configuration, provided as Master-Replica configuration with 1 or 2 replicas
      • Sentinel Port Number: Port number used when connecting to Sentinel
        • Port for Master-Replica communication, enter within the range of 1200 to 65535
      • Replica Count: Number of replicas to configure
        • If selecting 1, configured as Master-Replica-Sentinel
        • If selecting 2, configured as Master-Replica-Replica, and Sentinel is automatically installed on the server where Redis is installed
        • Sentinel server type is set to minimum specification
      NetworkRequiredNetwork where CacheStore(DBaaS) is installed
      • Select and connect to pre-created VPC and Subnet
      • Only automatic IP generation is possible
      Network > Common SettingsRequiredNetwork 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
        • Only automatic IP generation is possible
      Network > Per Server SettingsRequiredNetwork 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 ControlOptionalService 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 PeriodOptionalCacheStore(DBaaS) 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. CacheStore(DBaaS) Service Configuration Items
    • Enter or select the required information in the Database Configuration Required Information Entry area.
      Classification
      Required
      Detailed Description
      BackupOptionalBackup usage
      • If selecting Use, set backup file retention period and backup start time
      • Separate fees are charged for backup files depending on capacity
        • File retention period can be set from 7 days to 35 days
      • The minutes when backup is performed are set randomly, and backup end time cannot be set
      Redis/Valkey Port NumberRequiredPort number required for Redis/Valkey connection
      • Enter port within the range of 1200 to 65535
      Redis/Valkey PasswordRequiredPassword required for Redis/Valkey connection
      • Enter 8 to 30 characters including English letters, numbers, and special characters (excluding $ " )
      Redis/Valkey Password ConfirmationRequiredRe-enter password identically
      ParameterRequiredParameters to use for Redis/Valkey
      • Click the View button to check detailed information of parameters
      • After creation is complete, parameter modification is possible, and DB restart is required after modification
      Time ZoneRequiredTime zone where Database will be used
      Table. CacheStore(DBaaS) Database Configuration Items
    • Enter or select the required information in the Additional Information Entry area.
      Classification
      Required
      Detailed Description
      TagsOptionalAdd tags
      • Can add up to 50 per resource
      • Click the Add Tag button then enter or select Key, Value values
      Table. CacheStore(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 CacheStore(DBaaS) Detailed Information

CacheStore(DBaaS) service allows you to check and modify the entire resource list and detailed information. The CacheStore(DBaaS) Details page consists of Detailed Information, Tags, Operation History tabs.

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

  1. Click the All Services > Database > CacheStore(DBaaS) menu. It moves to the Service Home page of CacheStore(DBaaS).
  2. On the Service Home page, click the CacheStore(DBaaS) menu. It moves to the CacheStore(DBaaS) List page.
  3. On the CacheStore(DBaaS) List page, click the resource to check detailed information. It moves to the CacheStore(DBaaS) Details page.
    • At the top of the CacheStore(DBaaS) Details page, status information and additional function information are displayed.
      ClassificationDetailed Description
      Cluster StatusCluster status where Redis 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
      Cluster ControlButtons to change cluster status
      • Start: Start stopped cluster
      • Stop: Stop running cluster
      • Restart: Restart running cluster
      • Switch-Over: Switch Replica cluster to Master
      More Additional FunctionsCluster-related management buttons
      • Sync Service Status: Check real-time Redis/Valkey 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 Redis/Valkey configuration parameters
      • Rename-Command: Change name of Redis/Valkey Command
      Service TerminationButton to terminate service
      Table. CacheStore(DBaaS) Status Information and Additional Functions

Detailed Information

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

ClassificationDetailed Description
Server InformationServer information configured in the cluster
  • Category: Server type (Master, Replica, Sentinel)
  • 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
  • For DB service, means cluster SRN
Resource NameResource name
  • For DB service, means cluster name
Resource IDUnique resource ID in the service
CreatorUser who created the service
Creation DateDate and time when the service was created
ModifierUser who modified the service information
Modification DateDate and time when the service information was modified
Image VersionInstalled Redis/Valkey image and version information
  • If minor version upgrade is needed, click the Edit icon to set
Cluster NameCluster name where Redis/Valkey servers are configured
Planned ComputeResource status with Planned Compute set
Maintenance PeriodDB patch work period setting status
  • If maintenance period setting is needed, click the Edit icon to set
BackupBackup setting status
  • If backup setting is needed, click the Edit icon to set
Redis/Valkey Port NumberPort number required for Redis/Valkey connection
Time ZoneRedis/Valkey time zone
Sentinel Port NumberPort number for Master and Replica communication
VIPVirtual IP information
  • Only available when high availability is set
NetworkNetwork information where CacheStore(DBaaS) is installed (VPC, Subnet)
IP Access ControlService access policy setting
  • If IP addition and deletion are needed, click the Edit icon to set
Master & ReplicaMaster, Replica server type, Basic OS, Additional Disk information
  • If server type modification is needed, click the Edit icon next to server type to set
  • If server type is modified, server restart is required. Please check SW license modification matters or SW settings and application due to specification change separately.
SentinelSentinel server type, Basic OS information
  • Available when selecting 1 replica during HA configuration
Table. CacheStore(DBaaS) Database Detailed Information Items

Tags

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

ClassificationDetailed Description
Tag ListTag list
  • Can check Key, Value information of tags
  • Can add up to 50 tags per resource
  • When entering tags, search and select from existing Key and Value lists
Table. CacheStore(DBaaS) Tag Tab Items

Operation History

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

ClassificationDetailed Description
Operation History ListResource change history
  • Can check operation date, resource ID, resource name, operation details, event topic, operation result, operator information
  • To perform detailed search, click the Detailed Search button
Table. CacheStore(DBaaS) Operation History Tab Detailed Information Items

Managing CacheStore(DBaaS) Resources

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

Controlling Operation

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

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

  1. Click the All Services > Database > CacheStore(DBaaS) menu. It moves to the Service Home page of CacheStore(DBaaS).
  2. On the Service Home page, click the CacheStore(DBaaS) menu. It moves to the CacheStore(DBaaS) List page.
  3. On the CacheStore(DBaaS) List page, click the resource to control operation. It moves to the CacheStore(DBaaS) Details page.
  4. Check CacheStore status and complete changes through the control buttons below.
    • Start: CacheStore service installed server and CacheStore service will run (Running).
    • Stop: CacheStore service installed server and CacheStore service can stop (Stopped).
    • Restart: Can restart only CacheStore service.
    • Switch Over: Can switch Master server and Replica server.

Syncing Service Status

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

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

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

Caution
If you modify the server type, server restart is required. Please check SW license modification matters or SW settings and application due to server specification change separately.

To change the server type, follow these steps:

  1. Click the All Services > Database > CacheStore(DBaaS) menu. It moves to the Service Home page of CacheStore(DBaaS).
  2. On the Service Home page, click the CacheStore(DBaaS) menu. It moves to the CacheStore(DBaaS) List page.
  3. On the CacheStore(DBaaS) List page, click the resource to change server type. It moves to the CacheStore(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.

Terminating CacheStore(DBaaS)

You can reduce operating costs by terminating unused CacheStore(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 CacheStore(DBaaS), follow these steps:

  1. Click the All Services > Database > CacheStore(DBaaS) menu. It moves to the Service Home page of CacheStore(DBaaS).
  2. On the Service Home page, click the CacheStore(DBaaS) menu. It moves to the CacheStore(DBaaS) List page.
  3. On the CacheStore(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 CacheStore(DBaaS) List page.
Monitoring Metrics
Managing CacheStore Service