CacheStore(DBaaS)

• 1: Overview
• 1.1: Server Types
• 1.2: Monitoring metrics
• 2: How-to guides
• 2.1: CacheStore Service Manage
• 2.2: CacheStore Backup and Restore
• 2.3: CacheStore(DBaaS) Server Connection
• 3: API Reference
• 4: CLI Reference
• 5: Release Note

1 - Overview

Service Overview

CacheStore(DBaaS) is a service that provides the in-memory data stores Redis OSS and Valkey. Samsung Cloud Platform provides an environment that automates the installation of Redis OSS and valkey through a web-based console and performs management functions for operation.

CacheStore (DBaaS) provides a Sentinel architecture consisting of a Master server that performs read/write operations and read‑only Replica servers that replicate the Master data. Sentinel checks the status of DB servers with the engine installed, and when a failure occurs on the Master server, it automatically fails over the Replica servers to the Master server. Additionally, to prepare for potential issues with the DB server or data, we provide a feature that automatically backs up at a user-specified time, enabling data recovery based on the backup point.

Provided Features

CacheStore(DBaaS) provides the following features.

• Auto Provisioning(Auto Provisioning): It is possible to install and configure the Database (DB) via the UI, and a redundant configuration can be set up with a Sentinel-based Single Master server and Replica servers (1 or 2).
• Operation Control Feature: Provides a function to control the status of running servers. * In addition to start and stop, you can restart if there is a DB issue or to apply configuration changes. * When configured for high availability (HA), you can switch the Active-Standby servers via a switch-over.
• Backup and Recovery: Provides data backup functionality based on its own backup commands. * Backup time windows and storage locations can be set by the user, and additional fees apply based on backup size. * It also provides a recovery function for backed‑up data, so when the user performs a recovery, a separate database is created and the recovery proceeds to the point in time selected by the user.
• Parameter Management: Performance improvement and security-related DB configuration parameters can be modified.
• Service Status Query: Retrieves the final status of the current DB service.
• Monitoring: CPU, memory, and DB performance monitoring information can be viewed through the Cloud Monitoring service.
• Minor version upgrade: To apply some feature improvements and security patches, you can perform a Minor version upgrade within the same Major version.

Component

CacheStore (DBaaS) provides pre‑validated engine versions and various server types in accordance with its open‑source support policy. Users can select and use it according to the scale of the service they wish to configure.

Engine version

The engine versions supported by CacheStore (DBaaS) are as follows.

Technical support can be used until the supplier’s EoTS (End of Technical Service) date, and the EOS date when new creation is stopped is set to six months before the EoTS date.

Since the EOS and EoTS dates may change according to the supplier’s policy, please refer to the supplier’s license management policy page for details.

• Redis: https://redis.io/docs/latest/operate/oss_and_stack/install/version-mgmt/
• Valkey: https://valkey.io/topics/releases/

Server type

The server types supported by CacheStore (DBaaS) are as follows.

For detailed information about the server types provided by CacheStore(DBaaS), see CacheStore(DBaaS) Server Types.

Standard redis1v2m4

Preceding Service

This is a list of services that must be pre-configured before creating the service. Please refer to the guide provided for each service and prepare in advance.

1.1 - Server Types

CacheStore(DBaaS) server type

CacheStore(DBaaS) offers server types composed of various combinations such as CPU, Memory, and Network Bandwidth. When creating a CacheStore (DBaaS), Redis is installed according to the server type selected for the intended use.

The server types supported by CacheStore(DBaaS) are as follows.

Standard redis1v2m4

redis1 server type

The redis1 server type of CacheStore (DBaaS) is offered with standard specifications (vCPU, Memory) and is suitable for various database workloads.

• Intel 3rd‑generation (Ice Lake) Xeon Gold 6342 Processor up to 3.3 GHz
• Supports up to 16 vCPUs and 256 GB of memory
• Maximum networking speed of 12.5 Gbps

css1 server type

The css1 server type of CacheStore (DBaaS) is provided with standard specifications (vCPU, Memory) and is suitable for various database workloads.

• Intel 3rd‑generation (Ice Lake) Xeon Gold 6342 Processor up to 3.3 GHz
• Supports up to 16 vCPUs and 256 GB of memory
• Maximum networking speed of 12.5 Gbps

1.2 - Monitoring metrics

CacheStore(DBaaS) Monitoring Metrics

The table below shows the performance monitoring metrics for CacheStore (DBaaS) that can be viewed through Cloud Monitoring. For detailed usage of Cloud Monitoring, refer to the Cloud Monitoring guide.

For CacheStore (DBaaS) server monitoring metrics, refer to the Virtual Server Monitoring Metrics guide.

2 - How-to guides

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

Create CacheStore (DBaaS)

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

To create a CacheStore (DBaaS), follow the steps below.

1. All Services > Database > CacheStore(DBaaS) Click the menu. 1. Go to the Service Home page of CacheStore (DBaaS).
2. On the Service Home page, click the Create CacheStore (DBaaS) button. 2. Create CacheStore (DBaaS) Go to the page.
3. On the Create CacheStore (DBaaS) 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 status	Detailed description
     Image version	Essential	Provide version list for CacheStore (DBaaS)

     Table. CacheStore (DBaaS) Image and version selection items
   • Enter or select the required information in the Service Information Input area.

     Category	required status	Detailed description
     Server name Prefix	Required	Server name where Redis/Valkey will be installed must start with a lowercase English letter, and using lowercase letters, numbers, and the special character (-) input 3 to 13 characters Based on the server name, a postfix such as 001, 002 is appended to create the actual server name
     Cluster name	Required	Cluster name where Redis/Valkey is installed Enter using English letters, 3 to 20 characters A cluster is a unit that groups multiple servers
     Service Type > Server Type	Required	Server type for installing Redis/Valkey Standard: Standard specification commonly used For detailed information about the server types provided by CacheStore (DBaaS), refer to CacheStore(DBaaS) 서버 타입.
     Service Type > Planned Compute	Required	Status of resources with Planned Compute configured In Use: Number of resources with Planned Compute that are currently in use Configured: Number of resources with Planned Compute configured Coverage preview: Amount applied per resource by Planned Compute Create Planned Compute service: Navigate to the Planned Compute service request page For more details, see Apply for Planned Compute
     Service Type > Block Storage	Required	Block Storage settings used by the DB according to purpose Basic OS: Area where the DB engine is installed DATA: Storage area for table data, archive files, etc. Select the storage type and then enter the capacity (refer to Block Storage 생성하기 for details on each Block Storage type) SSD: High‑performance general volume HDD: General volume SSD_KMS, HDD_KMS: Additional encrypted volumes that use Samsung Cloud Platform KMS (Key Management System) encryption keys The configured storage type is also applied to additional storage Enter the capacity as a multiple of 8 within the range 16 to 5,120
     high availability	Select	High Availability (HA) configuration option When High Availability (HA) is enabled, it is provided as a Master-Replica setup, and the Replica can be configured with 1 or 2 instances Sentinel Port number: The port used for connecting to Sentinel Enter a port for Master-Replica communication within the range 1200 to 65535 Replica count: Number of Replicas to configure 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 Set the server type for Sentinel to the minimum specification
     Network	Required	The network where CacheStore (DBaaS) is installed Select a pre‑created VPC and Subnet to connect IP can only be auto‑generated
     Network > Common Settings	Required	Network settings for servers created by the service Select when you want to apply the same settings to all installed servers Select a pre‑created VPC and Subnet IP can only be auto‑generated
     Network > Server-specific Settings	Required	Network settings where servers generated by the service are installed Select when you want to apply different settings per installed server Select a pre‑created VPC, Subnet, IP, and Public NAT Enter the IP for each server The Public NAT feature is available only when the VPC is connected to an Internet Gateway. Use when checked, you can select from reserved IPs in the VPC product’s Public IP. For more details, see Public IP 생성하기
     IP access control	Select	Service Access Policy Configuration Since the access policy is set for the IP entered on the page, you do not need to configure a separate Security Group policy. 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 period	Select	CacheStore(DBaaS) maintenance period If you select Use, set the day, start time, and duration It is recommended to set a maintenance period for stable DB management. Patch operations will be performed at the scheduled time, causing service interruption If set to unused, Samsung SDS is not responsible for issues arising from unapplied patches.

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

     Category	required status	Detailed description
     Backup	Select	Backup usage If you select Use, you can set the backup file retention period and backup start time Backup files incur additional charges based on their size The file retention period can be set from 7 to 35 days The minute at which the backup runs (minutes) is set randomly, and the backup end time cannot be configured
     Redis/Valkey Port number	Required	Port number required for Redis/Valkey connection Enter a port within the range 1200 ~ 65535
     Redis/Valkey password	Essential	Password required when connecting to Redis/Valkey include letters, numbers, and special characters (excluding $ “ ‘) and enter 8 to 30 characters
     Check Redis/Valkey password	Required	Re-enter the same password
     Parameter	Required	Parameters to use with Redis/Valkey View button can be clicked to view detailed parameter information Parameters can be modified after creation is complete, and a DB restart is required after modification
     time zone	Required	The time zone where the database will be used

     Table. CacheStore (DBaaS) Database configuration items
   • Additional Information Input area, enter or select the required information.

     Category	required status	Detailed description
     Tag	Select	Add Tag Up to 50 per resource can be added After clicking the Add Tag button, enter or select Key, Value values

     Table. CacheStore (DBaaS) additional information input fields
4. Summary Check the detailed information and estimated billing amount generated in the panel, and click the Create button.
   • Once creation is complete, check the created resource on the Resource List page.

View CacheStore (DBaaS) detailed information

The CacheStore (DBaaS) service allows you to view and edit the full list of resources and detailed information. CacheStore(DBaaS) Details page consists of Details, Tags, Activity History tabs.

To view detailed information about the CacheStore (DBaaS) service, follow these steps.

1. All Services > Database > CacheStore(DBaaS) Click the menu. 1. Navigate to the Service Home page of CacheStore (DBaaS).
2. On the Service Home page, click the CacheStore(DBaaS) menu. 2. Go to the CacheStore(DBaaS) List page.
3. CacheStore(DBaaS) List page, click the resource to view its detailed information. 3. CacheStore(DBaaS) Details Go to the page.
   • CacheStore(DBaaS) Details At the top of the page, status information and additional feature information are displayed.

     Category	Detailed description
     Cluster status	Cluster status with Redis installed Creating: Cluster is being created Editing: Cluster is changing to an operational state Error: Cluster encountered an error while performing tasks If this persists, contact the administrator Failed: Cluster failed during creation Restarting: Cluster is being restarted Running: Cluster is operating normally Starting: Cluster is starting Stopped: Cluster is stopped Stopping: Cluster is being stopped Synchronizing: Cluster is synchronizing Terminating: Cluster is being terminated Unknown: Cluster status is unknown If this persists, contact the administrator
     Cluster control	Buttons to change the cluster state Start: Start a stopped cluster Stop: Stop a running cluster Restart: Restart a running cluster Switch-Over: Promote a replica cluster to Master
     View more add-ons	Cluster-related management buttons Service status synchronization: Real-time Redis/Valkey service status lookup Backup history: When backup is configured, verify successful execution and view history Database recovery: Recover the DB based on a specific point in time Parameter management: View and modify Redis/Valkey configuration parameters Rename-Command: Change the name of a Redis/Valkey command
     Service termination	Button to cancel the service

     Table. CacheStore(DBaaS) status information and additional features

Detailed Information

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

Tag

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

Work History

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

Managing CacheStore (DBaaS) Resources

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

Control operation

If changes occur to a running CacheStore (DBaaS) resource, you can start, stop, or restart it. Also, when HA is configured, you can switch the Master-Replica servers via a switch‑over.

To control the operation of CacheStore (DBaaS), follow these steps.

1. Click the All Services > Database > CacheStore(DBaaS) menu. 1. Navigate to the Service Home page of CacheStore (DBaaS).
2. On the Service Home page, click the CacheStore(DBaaS) menu. 2. CacheStore(DBaaS) List Navigate to the page.
3. CacheStore(DBaaS) List page, click the resource you want to control. 3. CacheStore(DBaaS) Details Go to the page.
4. Check the CacheStore status and complete the change using the control button below.
   • Start: the server where the CacheStore service is installed and the CacheStore service is running (Running).
   • Stop: The server where the CacheStore service is installed and the CacheStore service can be stopped (Stopped).
   • Restart: Only the CacheStore service can be restarted.
   • Switch Over: You can switch the Master server and the Replica server.

Synchronize service status

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

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

1. Click the All Services > Database > CacheStore(DBaaS) menu. 1. Go to the Service Home page of CacheStore (DBaaS).
2. On the Service Home page, click the CacheStore(DBaaS) menu. 2. Navigate to the CacheStore(DBaaS) List page.
3. CacheStore(DBaaS) List page, click the resource to view the service status. 3. CacheStore(DBaaS) Details Go to the page.
4. Click the Service Status Sync button. 4. While it is being queried, the cluster changes to Synchronizing state.
5. When the query completes, the status in the server information field is updated, and the cluster changes to the Running state.

Change server type

You can change the configured server type.

To change the server type, follow these steps.

1. All Services > Database > CacheStore(DBaaS) Click the menu. 1. Go to the Service Home page of CacheStore (DBaaS).
2. On the Service Home page, click the CacheStore(DBaaS) menu. 2. Go to the CacheStore(DBaaS) List page.
3. On the CacheStore(DBaaS) List page, click the resource to change the server type. 3. Go 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. 4. Edit Server Type The popup window opens.
5. Edit Server Type After selecting the server type in the popup window, click the Confirm button.

Cancel CacheStore (DBaaS)

You can reduce operating costs by terminating unused CacheStore (DBaaS). However, if you terminate the service, the running service may be stopped immediately, so you should proceed with the termination only after fully considering the impact that may occur when the service is discontinued.

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

1. All Services > Database > CacheStore(DBaaS) Click the menu. 1. Navigate to the Service Home page of CacheStore (DBaaS).
2. On the Service Home page, click the CacheStore(DBaaS) menu. 2. CacheStore(DBaaS) List Go to the page.
3. On the CacheStore(DBaaS) List page, select the resource to cancel, and click the Cancel Service button.
4. After termination is complete, check whether the resource has been terminated on the CacheStore(DBaaS) list page.

2.1 - CacheStore Service Manage

Users can manage CacheStore (DBaaS) through the Samsung Cloud Platform Console.

Parameter Management

Provides a feature that allows you to easily view and edit database configuration parameters.

View Parameters

To view configuration parameters, follow these steps.

1. Click the All Services > Database > CacheStore(DBaaS) menu. Navigate to the Service Home page of CacheStore(DBaaS).
2. On the Service Home page, click the CacheStore(DBaaS) menu. You will be taken to the CacheStore(DBaaS) List page.
3. On the CacheStore(DBaaS) List page, click the resource whose parameters you want to view or edit. You will be taken to the CacheStore(DBaaS) Details page.
4. Click the More button, then click the Parameter Management button. The Parameter Management popup opens.
5. Parameter Management in the popup window, click the Search button. The Search Notification popup window opens.
6. View Notification when the popup window opens, click the Confirm button. Retrieving may take a short amount of time.

Modify Parameter

To modify the configuration parameters, follow the steps below.

1. Click the All Services > Database > CacheStore(DBaaS) menu. Navigate to the Service Home page of CacheStore(DBaaS).
2. On the Service Home page, click the CacheStore(DBaaS) menu. You will be taken to the CacheStore(DBaaS) List page.
3. On the CacheStore(DBaaS) List page, click the resource whose parameters you want to view or edit. You will be taken to the CacheStore(DBaaS) Details page.
4. Click the More button, then click the Parameter Management button. The Parameter Management popup opens.
5. In the Parameter Management popup, click the Query button. The Query Notification popup opens.
6. Lookup Notification When the popup window opens, click the Confirm button. The lookup may take a short amount of time.
7. If a modification is needed, click the Edit button and enter the changes in the custom value field of the Parameter to be edited.
8. When the input is complete, click the Complete button.

Rename Command

Provides Redis OSS/Valkey command lookup and command name editing functionality. To look up commands and edit command names, follow these steps.

1. Click the All Services > Database > CacheStore(DBaaS) menu. Navigate to the Service Home page of CacheStore(DBaaS).
2. On the Service Home page, click the CacheStore(DBaaS) menu. You will be taken to the CacheStore(DBaaS) List page.
3. On the CacheStore(DBaaS) List page, click the resource whose Command name you want to edit. You will be taken to the CacheStore(DBaaS) Detail page.
4. Click the More button, then click the Rename-Command button. You will be taken to the Rename-Command page.
5. On the Rename-Command page, click the Lookup button. The Lookup notification popup opens.
6. View Notification when the popup window opens, click the Confirm button. Retrieving may take a short amount of time.
7. If a modification is needed, click the Edit button and enter the changes in the custom value field of the Command you want to modify.
8. When the input is complete, click the Complete button.

Minor Version Upgrade

We provide version upgrade functionality for some feature improvements and security patches. Only Minor version upgrades are supported within the same Major version.

To upgrade the Minor Version, follow the steps below.

1. Click the All Services > Database > CacheStore(DBaaS) menu. Navigate to the Service Home page of CacheStore(DBaaS).
2. On the Service Home page, click the CacheStore(DBaaS) menu. You will be taken to the CacheStore(DBaaS) List page.
3. CacheStore(DBaaS) List page, click the resource to upgrade the version. You will be taken to the CacheStore(DBaaS) Details page.
4. Click the Edit icon of the Image version item. The Version Upgrade popup window opens.
5. Version Upgrade In the popup window, select the revised version, then click the Confirm button.
6. Version Upgrade Notification Click the Confirm button in the popup window.

2.2 - CacheStore Backup and Restore

Users can configure backups of CacheStore (DBaaS) through the Samsung Cloud Platform Console and restore from the backed-up files.

CacheStore(DBaaS) Backup

CacheStore (DBaaS) provides data backup functionality based on its own backup commands. Additionally, it offers a backup environment optimized for data protection and management through backup history verification and backup file deletion features.

Configure backup

For instructions on configuring backups for CacheStore(DBaaS), see CacheStore(DBaaS) Create.

To modify the backup settings of the created resource, follow the steps below.

1. Click the All Services > Database > CacheStore(DBaaS) menu. Navigate to the Service Home page of CacheStore(DBaaS).
2. Click the CacheStore(DBaaS) menu on the Service Home page. You will be taken to the CacheStore(DBaaS) List page.
3. On the CacheStore(DBaaS) List page, click the resource for which you want to set up a backup. You will be taken to the CacheStore(DBaaS) Details page.
4. Click the Edit icon of the backup item. The Backup Settings popup window opens.
5. When configuring a backup, click Use in the Backup Settings popup, select the retention period, backup start time, and Archive backup interval, then click the Confirm button.
   • If you stop the backup configuration, deselect Use in the Backup Settings popup window and click the Confirm button.

Check backup history

To check the backup history, follow these steps.

1. Click the All Services > Database > CacheStore(DBaaS) menu. Navigate to the Service Home page of CacheStore(DBaaS).
2. Click the CacheStore(DBaaS) menu on the Service Home page. You will be taken to the CacheStore(DBaaS) List page.
3. CacheStore(DBaaS) List page, click the resource for which you want to view the backup history. You will be taken to the CacheStore(DBaaS) Details page.
4. Click the Backup History button. The Backup History popup window opens.
5. Backup History In the popup window, you can view the backup status, version, backup start time, backup completion time, and size.

Delete backup file

To delete the backup history, follow these steps.

1. Click the All Services > Database > CacheStore(DBaaS) menu. Navigate to the Service Home page of CacheStore(DBaaS).
2. Click the CacheStore(DBaaS) menu on the Service Home page. You will be taken to the CacheStore(DBaaS) List page.
3. CacheStore(DBaaS) List Click the resource whose backup history you want to view. You will be taken to the CacheStore(DBaaS) Details page.
4. Click the Backup History button. The Backup History popup window opens.
5. Backup History popup window, check the files you want to delete, then click the Delete button.

CachStore(DBaaS) Recover

If a failure or data loss requires restoration from a backup file, recovery can be performed based on a specific point in time using the recovery feature.

To restore CacheStore(DBaaS), follow the steps below.

1. Click the All Services > Database > CacheStore(DBaaS) menu. Navigate to the Service Home page of CacheStore(DBaaS).
2. On the Service Home page, click the CacheStore(DBaaS) menu. You will be taken to the CacheStore(DBaaS) List page.
3. On the CacheStore(DBaaS) List page, click the resource you want to recover. You will be taken to the CacheStore(DBaaS) Details page.
4. Click the Database Recovery button. You will be taken to the Database Recovery page.
5. After entering information in the Database recovery configuration area, click the Complete button.

   Category	Required	Detailed description
   Recovery type	Required	User sets the desired recovery point Recover based on the backup file, selecting a point in time from the list displayed for backup files
   Server name prefix	Required	Server name of the recovery DB Start with a lowercase English letter and use lowercase letters, numbers, and special characters (-) to enter 3 to 16 characters A postfix such as 001, 002 is appended to the base server name to create the actual server name
   Cluster name	Required	Cluster name of the recovery DB Enter using English letters, 3 to 20 characters A cluster is a unit that groups multiple servers
   Service Type > Server Type	Required	Server type for the recovery DB Standard: Standard specifications commonly used High Capacity: Large-capacity server with 24 vCores or more (to be provided later)
   Service Type > Planned Compute	Selection	Status of resources with Planned Compute configured In Use: Number of resources with Planned Compute that are currently in use Configured: Number of resources with Planned Compute configured Coverage Preview: Amount applied by Planned Compute per resource Create Planned Compute Service: Go to the Planned Compute service request page Apply for Planned Compute
   Service Type > Block Storage	Required	Block Storage settings used by the recovery DB Base OS: Area where the DB engine is installed DATA: Area where AOF (Append Only File) and RDB (Redis Database) files, etc., are stored Apply the same Storage type as configured in the original cluster Capacity can be entered as a multiple of 8 within the range 56 to 5,120
   Redis/Valkey Port number	Required	Redis/Valkey port number configured in the source DB
   IP access control	Selection	Service Access Policy Settings Since the access policy is set for the IP entered on the page, you do not need to configure a separate Security Group policy. Enter the IP in jIP 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 IP
   maintenance period	Selection	CacheStore(DBaaS) DB maintenance window If you select Use, set the day of week, start time, and duration It is recommended to set a maintenance window for stable DB management. Patch operations will be performed at the scheduled time, causing service interruption If set to not use, Samsung SDS is not responsible for any issues arising from unapplied patches.
   tag	Selection	Add Tag Add Tag After clicking the Add Tag button, enter or select Key, Value values

   Table. CacheStore (DBaaS) recovery configuration items

2.3 - CacheStore(DBaaS) Server Connection

Scenario Overview

Connecting to CacheStore (DBaaS) The scenario involves creating a Bastion host (Virtual Server) and a Database service, and accessing the DB service through the Bastion host. To reliably connect to CacheStore (DBaaS) in the Samsung Cloud Platform environment, you need to create a Bastion host and establish a network connection using it. To maintain stability and a high level of security, it is recommended to configure the Database service in a Private Subnet environment and set up the Bastion host in a restricted Public Subnet environment.

This scenario primarily describes creating a Bastion host and a Database service, configuring the network environment for Bastion host and Database access, and connecting through a DB client.

Scenario components

You can build the scenario using the following services.

Scenario setup method

Create the services needed to construct the scenario by following the steps below.

Set up the network

Describes the process of configuring the network environment for accessing the Bastion Host and Database services.

1-1. Create VPC

1. Click the All Services > Networking > VPC menu. Navigate to the VPC’s Service Home page.
2. Click the Create VPC button on the Service Home page. Navigate to the Create VPC page.
3. On the VPC Creation page, enter the information required to create the service.
   • Enter the IP range as 192.168.x.0/16
4. Summary panel, verify the detailed information and estimated billing amount generated, and click the Complete button.
   • After creation is complete, check the created resources on the VPC List page.

1-2. Create Subnet

1. Click the All Services > Networking > VPC menu. You will be taken to the VPC Service Home page.
2. On the Service Home page, click the Subnet menu. You will be taken to the Subnet List page.
3. Click the Subnet Create button. You will be taken to the Subnet Create page.
4. On the Subnet Creation page, enter the information required to create the service.
   • Select the Subnet type as General.
   • Select a pre‑created VPC.
   • Enter the IP range as 192.168.x.0/24.
5. Summary Check the detailed information and estimated billing amount generated in the panel, and click the Complete button.
   • After creation is complete, check the created resources on the Subnet List page.

1-3. Create Internet Gateway

1. Click the All Services > Networking > VPC menu. You will be taken to the VPC’s Service Home page.
2. On the Service Home page, click the Internet Gateway menu. You will be taken to the Internet Gateway List page.
3. Click the Create Internet Gateway button. Navigate to the Create Internet Gateway page.
4. Internet Gateway Creation page, enter the required information needed to create the service.
   • Select a pre‑created VPC.
   • In the Firewall usage item, select Use.
5. Summary Check the detailed information and estimated billing amount generated in the panel, and click the Complete button.
   • When creation is complete, verify the created resource on the Internet Gateway list page.

1-4. Create Public IP

1. Click the All Services > Networking > VPC menu. Navigate to the VPC’s Service Home page.
2. Click the Public IP menu on the Service Home page. You will be taken to the Public IP List page.
3. Click the Public IP reservation button. You will be taken to the Public IP reservation page.
4. On the Public IP reservation page, enter the required information needed to reserve the service.
5. Summary Check the detailed information and estimated billing amount generated in the panel, and click the Complete button.
   • After creation is complete, check the created resources on the Public IP List page.

1-5. Create Security Group

1. Click the All Services > Networking > Security Group menu. Go to the Service Home page of Security Group.
2. Click the Create Security Group button on the Service Home page. You will be taken to the Create Security Group page.
3. On the Security Group creation page, enter the required information needed to create the service.
4. Check the input information and click the Complete button.
   • Once creation is complete, check the created resources on the Security Group List page.

Create bastion host

Describes the process of configuring a Bastion Host that requires the database client to be installed.

2-1. Create Server Keypair

1. Click the All Services > Compute > Virtual Server menu. Navigate to the Service Home page of Virtual Server.
2. On the Service Home page, click the Keypair menu. You will be taken to the Keypair List page.
3. Click the Create Keypair button. You will be taken to the Create Keypair page.
4. On the Keypair creation page, enter the required information for creating the service.
5. Check the creation information and click the Complete button.
   • The key can be downloaded only once, and reissuance is not available.
   • Please store the downloaded key in a secure location.

2-2. Create Bastion host

1. Click the All Services > Compute > Virtual Server menu. Navigate to the Service Home page of Virtual Server.
2. On the Service Home page, click the Create Virtual Server button. It navigates to the Create Virtual Server page.
3. On the Virtual Server Creation page, enter the required information needed to create the service.
   • Select Windows for the image.
   • Select the pre‑created VPC and Subnet.
   • Click Use NAT, and select the reserved Public IP from 1-4. Create Public IP.
   • Connect the Keypair created in 2-1. 서버 Keypair 생성하기.
4. Summary Check the detailed information and estimated billing amount generated in the panel, and click the Complete button.
   • When creation is complete, check the created resources on the Virtual Server List page.

2-3. Check Bastion host login ID and PW

1. Click the All Services > Compute > Virtual Server menu. Navigate to the Service Home page of Virtual Server.
2. On the Service Home page, click the Virtual Server menu. You will be taken to the Virtual Server List page.
3. On the Virtual Serve List page, click the resource you created in 2-2. Bastion host Create. You will be taken to the detailed information page for that resource.
4. On the detail page, click the RDP password view button in the Keypair name field. The RDP password view popup window will open.
5. In the RDP password lookup popup window, attach the keypair file downloaded from 2-1. 서버 Keypair 생성하기.
6. After attaching, click the Password verification button. The ID and Password for accessing the resource are displayed.
   • This ID and password will be used later as credentials to access the Bastion host in 5-1. Bastion host Connecting.

Create Database

Describes the process of creating a Database service.

3-1. Create CacheStore(DBaaS) Service

1. Click the All Services > Database > CacheStore(DBaaS) menu. Go to the Service Home page of CacheStore(DBaaS).
2. On the Service Home page, click the CacheStore(DBaaS) Create button. You will be taken to the CacheStore(DBaaS) Create page.
3. Enter the required information for creating the service on the CacheStore(DBaaS) Creation page.
   • Select the pre‑created VPC and Subnet and connect them.
   • Enter the database-related creation details on the required information input screen.
   • Add the Bastion host IP in the IP access control section.
   • The Database Port defaults to 2866, but the user can also specify it.
4. Summary Check the detailed information and estimated billing amount generated in the panel, and click the Complete button.
   • When creation is complete, verify the created resource on the CacheStore(DBaaS) list page.

Configuring Rules

It explains the process of configuring rules for a user to connect to the Bastion host and rules for connecting to the Database from the Bastion host.

4-1. Security Group Add Security Rules

1. Click the All Services > Networking > Security Group menu. Go to the Service Home page of Security Group.
2. On the Service Home page, click the Security Group menu. You will be taken to the Security Group List page.
3. Select the Security Group resource created in 1-5. Create Security Group. Go to the detailed information page of that resource.
4. Click the Rules tab on the detail information page. You will be taken to the Rules tab.
5. Click the Add Rule button in the Rules tab. It navigates to the Add Rule popup.
6. Add Rule In the popup window, enter the rule below, and click the Confirm button.

   direction	Remote	Target address	Protocol	Port	Explanation
   Inbound	CIDR	User PC IP	TCP	3389 (RDP)	Bastion client PC → Bastion host
   Outbound	CIDR	DB IP	TCP	Database Port (manual entry)	Bastion host → Database

   Table. Security Group rules that need to be added

4-2. Add IGW Firewall rule

1. All Services > Networking > Firewall Click the menu. Go to the Service Home page of Firewall.
2. From the Service Home page, click the Firewall menu. You will be taken to the Firewall List page.
3. On the Firewall List page, select the Internet Gateway resource name created in 1-3. Internet Gateway 생성하기. You will be taken to the detailed information page for that resource.
4. Click the Rules tab on the detail page. You will be taken to the Rules tab.
5. Click the Add Rule button on the Rules tab. You will be taken to the Add Rule popup.
6. Add Rule In the popup window, enter the rule below and click the Confirm button.

   origin address	Destination address	Protocol	Port	Operation	direction	Explanation
   Bastion connection PC IP	Bastion host IP	TCP	3389(RDP)	Allow	Inbound	User PC → Bastion host

   Table. Internet Gateway Firewall rules that need to be added

Connect to Database

Describes the process of a user connecting to a database via a DB client program.

This guide explains how to connect using Another Redis Desktop Manager. Since there are various database client programs and CLI utilities, you may install and use the tool that best fits your needs.

5-1. Connecting to Bastion host

1. In the Windows environment of the PC that will connect to the Bastion host, run Remote Desktop Connection, then enter the NAT IP of the Bastion Host and click the Connect button.
2. When the remote desktop connection succeeds, the user credential input window opens. Enter the ID and Password you verified in 2-3. Bastion host 접속 ID 및 PW 확인하기 and click the Confirm button.

5-2. Install DB connection client program(Another Redis Desktop Manager) on the Bastion host

1. Please download the Another Redis Desktop Manager program.
   • Another Redis Desktop Manager program download URL: https://github.com/qishibo/AnotherRedisDesktopManager/releases
2. Connect the user’s PC hard drive to upload the file to the Bastion host.
3. In the Local Resources tab of the Remote Desktop Connection, click the Details button for the Local Devices and Resources item.
4. Select the local disk where the file was downloaded on the drive, and click the OK button.
5. Copy the downloaded file, upload it to the Bastion Host, and click the pgAdmin installer to install.

5-3. Connect to the database using the DB client program (Another Redis Desktop Manager)

1. Run Another Redis Desktop Manager and click New Connection. The New Connection popup will appear.
2. New Connection in the popup window, enter the Database server information created from 3-1. CacheStore(DBaaS) 서비스 생성하기 and click the OK button.

   Required input field	input value
   Host	Database server IP
   Port	Database Port
   Password	Database password
   Connection Name	Custom (ex. service name)

   Table.DB connection client program input fields
3. After connecting, you can check basic Redis information, manage data, and perform CRUD operations on keys.

3 - API Reference

4 - CLI Reference

5 - Release Note

CacheStore(DBaaS)