Create cluster
Cluster is a management unit composed of one or more nodes. Each node has a Primary or Replica role, and shard and node configuration differ depending on whether cluster mode is enabled.
Creation and usage notes
- The security group applied to the cluster must allow access on the connection port specified when creating the cluster.
t1inode types may take several minutes to tens of minutes to transition to theRunningstate after initial creation.- For
t1inode types, workloads with CPU load may not operate normally if the CPU credit balance is low.
User authentication supported versions
User authentication is not supported for Redis OSS engine version 5 or lower.
Create new cluster
The following describes how to create a new cluster in the MemStore service.
- Go to the KakaoCloud Console > Data Store > MemStore.
- In the Cluster menu, click the [Create cluster] button.
Use cluster mode
- In the configuration options, select Create new cluster and choose Enable for Cluster mode setting.
- Enter the required information to create a cluster.
| Category | Item | Description |
|---|---|---|
| Cluster mode setting | Select whether to enable cluster mode | |
| Basic settings | Cluster name | Name of the cluster - Duplicate names are not allowed within the same project |
| Description (optional) | Optional description of the cluster (up to 100 characters) | |
| Engine | Engine version | Select the database engine and version to run on the nodes |
| Port | Database connection port - Can specify a port between 2000 and 50000 | |
| User authentication | Enable or disable user authentication for MemStore resource access If disabled, default account is used. If enabled, access is via specified ID and password | |
| User account settings | ID | Required when user authentication is enabled * Reserved usernames cannot be used |
| Password | - Format: 8-16 characters | |
| Transport encryption (TLS) | Whether to use encrypted connections If disabled, a plain connection is used. If enabled, TLS 1.2 is supported. The required ca.crt file can be downloaded from the cluster detail page after creation | |
| Parameter group | Select a parameter group that matches the chosen engine version and cluster mode | |
| Shard configuration | Number of shards | Number of shards to create - Valkey: 3 to 12 - Redis OSS: 1 to 12 |
| Nodes per shard | Enter the number of nodes per shard - Must be an integer between 2 and 5 | |
| Node type | Choose a node type that offers sufficient memory for your service environment and performance needs - See Node types for details | |
| Network settings | VPC | Select one of the pre-created user VPCs |
| Subnet | Select from pre-created user subnets - Multiple selections allowed | |
| Security group | Create a new security group or select an existing one to apply to the cluster - Multiple selections allowed | |
| Shard placement | Select the subnets where each node in a shard will be created | |
| Automatic backup | Auto backup option | Whether to enable automatic daily backup - Available only when there are two or more nodes |
| Backup retention period | Backup retention period, selectable from 1 to 35 days | |
| Auto backup start time | Time when automatic backup starts; backup begins within 15 minutes of the selected time |
Create cluster without enabling cluster mode
-
In the configuration options, select Create new cluster and choose Disable for Cluster mode setting.
-
Enter the required information to create a cluster.
Category Item Description Cluster mode setting Select whether to enable cluster mode Basic settings Cluster name Name of the cluster
- Duplicate names are not allowed within the same projectDescription (optional) Optional description of the cluster (up to 100 characters) Engine Engine version Select the database engine and version to run on the nodes Port Database connection port
- Can specify a port between2000and50000User authentication Enable or disable user authentication for MemStore resource access
If disabled, access is via default account. If enabled, use the specified ID and password
* Not supported for Redis OSS engine version 5 or lowerUser account settings ID Required when user authentication is enabled
- Reserved usernames cannot be usedPassword - Format: 8-16 characters
- Korean characters, spaces, and special characters/,',",@are not allowedTransport encryption (TLS) Whether to use encrypted connections
If disabled, a plain connection is used.
If enabled, TLS 1.2 is supported. The required ca.crt file can be downloaded from the cluster detail page after creation
* Not supported for Redis OSS engine version 5 or lowerParameter group Select a parameter group that matches the chosen engine version and cluster mode Scale Number of nodes Number of nodes to create, up to 6
- Valkey: Automatic failover is enabled automatically with two or more nodes
- Redis OSS: Automatic failover can be enabled with two or more nodesNode type Choose a node type that offers sufficient memory for your service environment and performance needs
- See Node types for detailsNetwork settings VPC Select one of the pre-created user VPCs Subnet Select from pre-created user subnets Security group Create a new security group or select an existing one to apply to the cluster
- Multiple selections allowedNode placement Based on the selected network configuration, choose subnets for each role-based node Automatic backup Auto backup option Whether to enable automatic daily backup
- Available only when there are two or more nodesBackup retention period Backup retention period, selectable from 1 to 35 days
Restore cluster
You can restore a MemStore cluster from an existing backup or a backup file stored in Object Storage.
When restoring a backup that uses cluster mode, the cluster is created based on the cluster mode and shard configuration of the selected backup.
When restoring a backup that does not use cluster mode, the cluster is created with a single-shard structure and you can adjust the number of nodes. Automatic failover is enabled automatically for Valkey when there are at least two nodes. For Redis OSS, you can choose whether to enable it when there are at least two nodes, and you can change the setting after cluster creation. For details, see Automatic failover.
Before restoring
- For MemStore service stability, you can restore only to the same or a later engine version than the source backup.
- Restoration is only possible using the same cluster mode as the selected backup.
- If restoring from an existing MemStore backup, and the source backup cache size exceeds 60% of the memory of the target cluster flavor, restoration may fail.
- In the configuration options, select Restore cluster.
- To restore from an existing backup, choose Backup type > MemStore backup in the restore settings.
- To restore from a file stored in Object Storage, choose Backup type > User backup file and enter the Object Storage path containing the backup file. Valkey user backup files support both cluster mode settings. Redis OSS user backup files can be restored only with cluster mode disabled.
- Enter the required information, and then click [Restore].
MemStore backup
- Step 1: Basic information
| Category | Item | Description |
|---|---|---|
| Creation method | Select Restore from backup | |
| Restore settings | Backup type | Select MemStore backup |
| Backup file | Select the backup source file to restore | |
| Cluster mode setting | Whether cluster mode is enabled. The available mode is determined by the selected file | |
| Basic cluster information | Name | Cluster name - Duplicate cluster names cannot be used in the same project |
| Description (optional) | Additional cluster description of up to 100 characters |
- Steps 2 and 3: Cluster configuration and advanced settings
The basic process is the same as creating a cluster. For service stability, you can restore only to the same or a later engine version than the backup. Restoration may fail if the source backup cache size is 60% or more of the memory of the target cluster node type.
User backup file
- Step 1: Basic information
| Category | Item | Description |
|---|---|---|
| Creation method | Select Restore from backup | |
| Restore settings | Backup type | Select User backup file |
| Backup file path | Verify that you have permission to use the bucket and file, and then enter the Object Storage path containing the backup file - Valkey and Redis OSS: When cluster mode is disabled, you can enter only one file path - Valkey: When cluster mode is enabled, you can enter backup file paths separated by commas, up to the maximum number of shards. The number of paths must be less than or equal to the number of shards | |
| Cluster mode setting | Whether cluster mode is enabled - Valkey: Supports enabled and disabled cluster mode - Redis OSS: Supports only disabled cluster mode | |
| Basic cluster information | Name | Cluster name - Duplicate cluster names cannot be used in the same project |
| Description (optional) | Additional cluster description of up to 100 characters |
- Steps 2 and 3: Cluster configuration and advanced settings
The basic process is the same as creating a cluster. For service stability, you can restore only to the same or a later engine version than the backup. Restoration may fail if the source backup cache size is 60% or more of the memory of the target cluster node type.