The page has been translated by Gen AI.

How-to guides

The user can enter the necessary information of CacheStore(DBaaS) through the Samsung Cloud Platform Console and create the service by selecting detailed options.

Creating CacheStore(DBaaS)

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

Notice

Please configure the Subnet type of VPC to General before creating the service.

  • If the Subnet type is Local, the creation of the corresponding Database service is not allowed.

To create a CacheStore(DBaaS), follow these steps.

  1. Click 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) creation button. It moves to the CacheStore(DBaaS) creation page.

  3. CacheStore(DBaaS) creation page, enter the information required for service creation and select detailed options.

    • Image and Version Selection area, please select the necessary information.

      Classification
      Necessity
      Detailed Description
      Image VersionRequiredProvides a list of CacheStore (DBaaS) versions
      Fig. CacheStore(DBaaS) image and version selection items

    • Enter Service Information Enter or select the required information in the area.

      Classification
      Necessity
      Detailed Description
      Server Name PrefixRequiredServer name where Redis/Valkey will be installed
      • Starts with lowercase English letters, and consists of 3 to 13 characters using lowercase letters, numbers, and special characters (-)
      • A postfix such as 001, 002 is attached based on the server name to create the actual server name
      Cluster NameRequiredName of the cluster where Redis/Valkey is installed
      • Enter in English, 3-20 characters
      • 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 ComputeRequiredCurrent status of resources with Planned Compute set
      • In Use: Number of resources with Planned Compute set that are currently in use
      • Settings: Number of resources with Planned Compute set
      • Coverage Preview: Amount applied by Planned Compute for each resource
      • Create Planned Compute Service: Move to the Planned Compute service application page
      Service Type > Block StorageRequiredBlock Storage settings used by DB according to purpose
      • Basic OS: Area where DB engine is installed
      • DATA: Storage area for table data, archive files, etc.
        • Please select the storage type and enter the capacity. (For more information on each Block Storage type, see Creating 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 key
        • The set Storage type will be applied equally to additional storage
        • Capacity should be entered in multiples of 8 within the range of 16 to 5,120
      High AvailabilityOptionalWhether to configure High Availability (HA)
      • Using High Availability (HA) configuration provides Master-Replica configuration, and Replica can be configured with 1 or 2
      • Sentinel Port Number: Port number used when connecting to Sentinel
        • Port for Master-Replica communication, enter within the range of 1,024 to 65,535
      • Number of Replicas: Number of Replicas to be configured
        • If 1 is selected, it is configured as Master-Replica-Sentinel
        • If 2 is selected, it is configured as Master-Replica-Replica, and Sentinel is automatically installed on the server where Redis is installed
        • The server type of Sentinel is set to the minimum specification
      NetworkRequiredThe network where CacheStore(DBaaS) is installed
      • Select and connect the pre-created VPC and Subnet
      • IP can only be generated automatically
      Network > Common SettingsRequiredNetwork settings for servers created by the service
      • Select if you want to apply the same settings to all servers being installed
      • Select pre-created VPC and Subnet
        • IP can only be generated automatically
      Network > Server-specific settingsRequiredNetwork settings for servers created by the service
      • Select to apply different settings for each server being installed
      • Select pre-created VPC and Subnet, IP, Public NAT
        • Enter the IP for each server
        • The Public NAT function is only available if the VPC is connected to the Internet Gateway. If Use is checked, you can select from the reserved IP in the VPC product’s Public IP. For more information, see Creating Public IP
      IP Access ControlSelectSet service access policy
      • Set access policy for the IP entered on the page, so you don’t need to set Security Group policy separately
      • 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 the entered IP, click the x button next to the entered IP
      Maintenance periodSelectionCacheStore(DBaaS) maintenance period
      • Use is selected to set the day of the week, start time, and duration
      • It is recommended to set the maintenance period for stable DB management, and patch work is performed at the set time, resulting in service interruption
      • If not used, Samsung SDS is not responsible for any problems that occur due to non-application of patches
      Fig. CacheStore(DBaaS) Service Configuration Items

    • Database Configuration Required Information Input area, please enter or select the required information.

      Classification
      Necessity
      Detailed Description
      BackupSelectionWhether to use backup
      • Use is selected to set the backup file storage period and backup start time
      • Backup files are charged separately according to capacity
        • The file storage period can be set from 7 to 35 days
      • The minute (minutes) when the backup is performed is set randomly, and the backup end time cannot be set
      Redis/Valkey Port numbermandatoryPort number required for Redis/Valkey connection
      • Port must be entered within the range of 1,024 ~ 65,535
      Redis/Valkey passwordmandatoryPassword required when connecting to Redis/Valkey
      • Enter 8-30 characters, including English, numbers, and special characters (excluding $ " )
      Redis/Valkey password confirmationrequiredRe-enter the password identically
      ParameterRequiredRedis/Valkey parameters to use
      • Query button can be clicked to check detailed information of parameters
      • Parameters can be modified after creation is completed, and DB restart is required after modification
      Time ZoneRequiredTime zone where the Database will be used
      Fig. CacheStore(DBaaS) Database Configuration Items

    • Enter Additional Information Enter or select the required information in the area.

      Classification
      Mandatory
      Detailed Description
      TagSelectionAdd Tag
      • Up to 50 can be added per resource
      • Click the Add Tag button and enter or select Key, Value
      Table. Additional information input items for CacheStore(DBaaS)

  4. In the Summary panel, review the detailed information and estimated charges, and click the Complete button.

    • Once creation is complete, check the created resource on the Resource List page.

Check CacheStore(DBaaS) detailed information

The CacheStore(DBaaS) service allows you to view and modify the entire resource list and detailed information. The CacheStore(DBaaS) details page consists of detailed information, tags, and operation history tabs.

To check the detailed information of the CacheStore(DBaaS) service, follow the next procedure.

  1. Click All Services > Database > CacheStore(DBaaS) menu. It moves to the Service Home page of CacheStore(DBaaS).
  2. Service Home page, click the CacheStore(DBaaS) menu. Move to the CacheStore(DBaaS) list page.
  3. CacheStore(DBaaS) list page, click the resource to check the detailed information. Move to the CacheStore(DBaaS) details page.
    • CacheStore(DBaaS) details page top shows status information and additional features.
DivisionDetailed Description
Cluster StatusRedis cluster status installed
  • Creating: The cluster is being created
  • Editing: The cluster is changing to the operation performance state
  • Error: The cluster has an error occurred during operation
    • If it occurs continuously, contact the administrator
  • Failed: The cluster failed during the creation process
  • Restarting: The cluster is being restarted
  • Running: The cluster is operating normally
  • Starting: The cluster is being started
  • Stopped: The cluster is stopped
  • Stopping: The cluster is being stopped
  • Synchronizing: The cluster is being synchronized
  • Terminating: The cluster is being deleted
  • Unknown: The cluster status is unknown
    • If it occurs continuously, contact the administrator
Cluster ControlButtons that can change the cluster status
  • Start: Start a stopped cluster
  • Stop: Stop a running cluster
  • Restart: Restart a running cluster
  • Switch-Over: Switch a Replica cluster to Master
Additional features moreCluster-related management buttons
  • Service status synchronization: Real-time Redis/Valkey service status inquiry
  • Backup history: If backup is set, check the normal execution of backup and history
  • Database recovery: Recover DB based on a specific point in time
  • Parameter management: Possible to inquire and modify Redis/Valkey configuration parameters
  • Rename-Command: Change the name of Redis/Valkey Command
Service CancellationA button to cancel the service
Fig. CacheStore(DBaaS) Status Information and Additional Features

Detailed Information

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

ClassificationDetailed Description
Server InformationServer information configured in the corresponding 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
  • In DB service, it means cluster SRN
Resource NameResource Name
  • In DB service, it means cluster name
Resource IDUnique resource ID in the service
CreatorThe user who created the service
Creation TimeTime when the service was created
ModifierService information modified user
Modified TimeTime when service information was modified
Image/VersionInstalled Redis/Valkey Image and Version Information
Cluster NameRedis/Valkey server cluster name
Planned ComputePlanned Compute settings for current resources
Maintenance periodDB patch work period setting status
  • If maintenance period setting is required, click the Edit icon to set
BackupBackup setting status
  • If backup setting is required, 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 to communicate
VIPVirtual IP information
  • Only available when high availability is set
NetworkNetwork information (VPC, Subnet) where CacheStore (DBaaS) is installed
IP Access ControlService Access Policy Setting
  • If IP addition or deletion is required, click the Modify icon to set
Master & ReplicaMaster, Replica server type, default OS, additional Disk information
  • In case of server type modification, click the Modify icon next to the server type to set
  • Modifying the server type requires a server restart. Please check separately for SW license modifications and SW settings due to specification changes.
SentinelSentinel server type, basic OS information
  • When configuring HA, it is possible to check when 1 replica is selected
Table. CacheStore(DBaaS) Database detailed information items

Tag

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
  • Check Key, Value information of tag
  • Up to 50 tags can be added per resource
  • Search and select existing Key and Value lists when entering tags
Fig. CacheStore(DBaaS) Tags Tab Items

Work History

CacheStore(DBaaS) list page where you can check the operation history of the selected resource.

DivisionDetailed Description
Work History ListResource Change History
  • Work time, resource ID, resource name, work details, event topic, work result, and worker information can be checked
  • To perform a detailed search, click the Detailed Search button
Fig. CacheStore(DBaaS) Work History Tab Detailed Information Items

CacheStore(DBaaS) resource management

If you need to change or restore the existing setting options of the generated CacheStore(DBaaS) resource, or change the command, you can perform the task from the CacheStore(DBaaS) details page.

Operating Control

If changes occur in the running CacheStore (DBaaS) resource, you can start, stop, and restart it. Also, if HA is configured, you can switch the Master-Replica server through Switch-over.

To control the operation of CacheStore(DBaaS), follow the next procedure.

  1. Click 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. CacheStore(DBaaS) list page, click the resource to control the operation. Move to the CacheStore(DBaaS) details page.
  4. Check the CacheStore status and complete the change through the control button below.
    • Start: The CacheStore service is installed on the server and the CacheStore service is running.
    • Stop: CacheStore service can stop the server where CacheStore service is installed.
    • Restart: Only the CacheStore service can be restarted.
    • Switch Over: You can switch between the Master server and the Replica server.

Synchronizing Service Status

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

To check the service status of CacheStore(DBaaS), follow the next procedure.

  1. Click All Services > Database > CacheStore(DBaaS) menu. It moves to the Service Home page of CacheStore(DBaaS).
  2. Service Home page, click the CacheStore(DBaaS) menu. It moves to the CacheStore(DBaaS) list page.
  3. CacheStore(DBaaS) list page, click the resource to query the service status. Move to the CacheStore(DBaaS) details page.
  4. Click the 서비스 상태 동기화 button. During the query, the cluster changes to Synchronizing status.
  5. When the query 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
Modifying the server type requires a server restart. Please check separately for SW license modifications and SW settings due to server specification changes.

To change the server type, follow these steps.

  1. Click 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 you want to change the server type for. 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 the detailed information. The Server Type Edit popup window opens.
  5. In the Server Type Modification popup window, select the server type and click the OK button.

Cancel CacheStore(DBaaS)

You can cancel unused CacheStore (DBaaS) to reduce operating costs. However, when canceling the service, the operating service may be stopped immediately, so you should consider the impact of stopping the service sufficiently before proceeding with the cancellation work.

To cancel CacheStore(DBaaS), follow the procedure below.

  1. All Services > Database > CacheStore(DBaaS) menu is clicked. It moves to the Service Home page of CacheStore(DBaaS).
  2. Service Home page, click the CacheStore(DBaaS) menu. Move to the CacheStore(DBaaS) list page.
  3. On the CacheStore(DBaaS) list page, select the resource to be canceled and click the Service Cancellation button.
  4. Once the cancellation is complete, please check if the resource has been cancelled on the CacheStore(DBaaS) list page.
Monitoring Metrics
Managing CacheStore Service