Skip to main content

Create cluster

Create cluster

A cluster is an object composed of multiple nodes that is automatically managed by the MemStore service. When creating or deleting a cluster, the service automatically changes the cluster status while performing the operation. A cluster consists of multiple nodes, and each node functions as either a Primary or a Replica.
There are the following methods to create a new cluster in the MemStore service.

info
  • The Security Group applied to the cluster must allow port 6379 for cluster access.
  • t1i instance types may take a few minutes to tens of minutes to transition to Running status after initial creation.
    Additionally, if the CPU credit is insufficient, tasks that put a load on the CPU may not operate properly, so caution is needed.
caution

User authentication is not supported for Redis OSS engine versions 5 or lower.

  1. Go to Data Store > MemStore on the KakaoCloud Console.

  2. Click the Create cluster button in the Cluster menu.

Create new cluster

Use cluster mode

  1. In the configuration options, select Create a new cluster and click the Enable button for Cluster Mode Setting.

  2. Enter the necessary information to create the cluster.

    CategoryItemDescription
    Cluster Mode SettingSelect whether to enable or disable the cluster mode
    Basic settingsCluster NameName of the cluster
    Description (optional)Enter a description for the cluster (up to 100 characters)
    Redis Compatibility SettingsEngine VersionSet the version of the Redis OSS engine to run on the node
    - Currently, only version 6.2.5 is supported. More engine versions will be supported in the future.
    PortSet the port to be used for Redis access
    - Currently, only the default port 6379 is supported. It will be improved to allow users to set custom ports.
    User AuthenticationSelect whether to use user authentication for MemStore resource access
    If not used, access is possible with the default account. If used, access is possible with the entered ID and password.
    User account settingsIDEnter when using user authentication
    - Format: 1 to 32 characters, lowercase letters, and _ only
    * Reserved account names cannot be used.
    Password- Format: 8 to 16 characters
    - Cannot use Korean, spaces, or special characters /, ', ", @
    Parameter GroupSelect the parameter group that matches the selected engine version and cluster mode
    Shard settingsNumber of ShardsNumber of shards to be created
    - Minimum 1 ~ Maximum 12, entered as an integer
    Number of Nodes per ShardNumber of nodes per shard to be created
    - Minimum 2 ~ Maximum 5, entered as an integer
    Node typeSelect a node type that provides sufficient memory for optimal service performance
    - For more details, refer to Node type
    Network settingsVPCSelect one of the pre-created user VPCs
    SubnetSelect a pre-created user Subnet
    - Multiple selections possible
    Security GroupCreate a new Security Group or select an existing Security Group to apply to the cluster
    - Multiple selections possible
    Shard placementSelect the Subnet where each node in the shard will be created

Disable cluster mode

  1. In the configuration options, select Create a new cluster and click the Disable button in the Cluster Mode Settings on the Create cluster screen.

  2. Enter the necessary information to create the cluster.

    CategoryItemDescription
    Cluster mode settingSelect whether to enable or disable cluster mode
    Basic settingsCluster NameName of the cluster
    - The same cluster name cannot be created within the same project
    Description (optional)Enter a description for the cluster (up to 100 characters)
    Redis compatibility settingsEngine VersionSet the version of the Redis OSS engine to run on the node
    - Currently, 6.2.5, 5.0.6 versions are supported. More versions will be supported in the future.
    PortSet the port to be used for Redis access
    - Currently, only the default port 6379 is supported. It will be improved to allow users to set custom ports.
    User authenticationSelect whether to use user authentication for MemStore resource access
    If not used, access is possible with the default account. If used, access is possible with the entered ID and password.
    User account settingsIDEnter when using user authentication
    - Format: 1 to 32 characters, lowercase letters, and _ only
    * Reserved account names cannot be used.
    Password- Format: 8 to 16 characters
    - Cannot use Korean, spaces, or special characters /, ', ", @
    Parameter groupSelect the parameter group that matches the selected engine version and cluster mode
    Number of nodesNumber of NodesNumber of nodes to be created
    - When using high availability: Minimum 2 ~ Maximum 6, entered as an integer
    _ Creates 1 Primary node and 1 to 5 Replica nodes
    - When not using high availability: 1 ~ 6, entered as an integer
    _ Creates 1 Primary node and 0 to 5 Replica nodes
    Example: To create 1 Primary node and 2 Replica nodes, enter 3 in the number of nodes.
    High AvailabilitySelect whether to use high availability in the event of a node failure
    - If high availability is enabled, a new node is created and the node count is maintained when a node fails.
    Node typeSelect a node type that provides sufficient memory for optimal service performance
    - For more details, refer to Node type
    Network settingsVPCSelect one of the pre-created user VPCs
    SubnetSelect a pre-created user Subnet
    Security GroupCreate a new Security Group or select an existing Security Group to apply to the cluster
    - Multiple selections possible
    Node placementSelect the Subnet where each node will be created based on the selected network settings
    Automatic backupAutomatic backup OptionSelect whether to enable automatic backup option. When enabled, a backup is automatically performed once per day
    - Available only when there are 2 or more nodes
    Backup Retention PeriodSelect backup retention period, from a minimum of 1 day to a maximum of 35 days
    Automatic backup Start TimeSelect the start time for automatic backup. The backup will begin within 15 minutes of the selected time.

Restore cluster

info
  • Restoration is available only when cluster mode is disabled.
caution
  • Restoration is not available for Redis OSS engine versions 7 or higher when restoring from a user file.
  • When restoring from an existing MemStore backup, restoration may fail if the cache size of the source backup is greater than 60% of the memory of the target cluster flavor.

Disable cluster mode

  1. In the configuration options, select Restore cluster.

  2. To restore from an existing backup, select Backup Type > MemStore Backup. To restore from a file stored in Object Storage, select Backup Type > User Backup File and enter the Object Storage path of the backup file.

  3. Enter the necessary information to create the cluster.

    CategoryItemDescription
    Cluster mode settingSelect whether to enable or disable cluster mode. Currently, restoration is supported only in Disable mode.
    Basic settingsCluster NameName of the cluster
    - The same cluster name cannot be created within the same project
    Description (optional)Enter a description for the cluster (up to 100 characters)
    Redis compatibility settingsEngine VersionSet the version of the Redis OSS engine to run on the node
    - Currently, 6.2.5, 5.0.6 versions are supported. More versions will be supported in the future.
    PortSet the port to be used for Redis access
    - Currently, only the default port 6379 is supported. It will be improved to allow users to set custom ports.
    User authenticationSelect whether to use user authentication for MemStore resource access
    If not used, access is possible with the default account. If used, access is possible with the entered ID and password.
    User account settingsIDEnter when using user authentication
    - Format: 1 to 32 characters, lowercase letters, and _ only
    * Reserved account names cannot be used.
    Password- Format: 8 to 16 characters
    - Cannot use Korean, spaces, or special characters /, ', ", @
    Parameter groupSelect the parameter group that matches the selected engine version and cluster mode
    Number of nodesNumber of NodesNumber of nodes to be created
    - When using high availability: Minimum 2 ~ Maximum 6, entered as an integer
    _ Creates 1 Primary node and 1 to 5 Replica nodes
    - When not using high availability: 1 ~ 6, entered as an integer
    _ Creates 1 Primary node and 0 to 5 Replica nodes
    Example: To create 1 Primary node and 2 Replica nodes, enter 3 in the number of nodes.
    High AvailabilitySelect whether to use high availability in the event of a node failure
    - If high availability is enabled, a new node is created and the node count is maintained when a node fails.
    Node typeSelect a node type that provides sufficient memory for optimal service performance
    - For more details, refer to Node type
    Network settingsVPCSelect one of the pre-created user VPCs
    SubnetSelect a pre-created user Subnet
    Security GroupCreate a new Security Group or select an existing Security Group to apply to the cluster
    - Multiple selections possible
    Node placementSelect the Subnet where each node will be created based on the selected network settings
    Automatic backupAutomatic backup OptionSelect whether to enable automatic backup option. When enabled, a backup is automatically performed once per day
    - Available only when there are 2 or more nodes
    Backup Retention PeriodSelect backup retention period, from a minimum of 1 day to a maximum of 35 days
    Automatic backup Start TimeSelect the start time for automatic backup. The backup will begin within 15 minutes of the selected time.