Skip to main content

Manage cluster

A cluster is an object composed of multiple nodes that users can manage through tasks such as viewing, monitoring, and deleting.
You can manage clusters in the following ways:

caution

We recommend regular monitoring and management to ensure system available memory usage does not exceed 50%.
In KakaoCloud MemStore, the maxmemory setting is configured to about 65% of the system available memory.
When the max memory is reached, the allkeys-lru policy deletes the least recently used keys.

View cluster list

You can view a list of clusters created within your project.

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

  2. In the Cluster tab, check the list of currently created clusters.

    ItemDescription
    NameThe name assigned to the cluster at creation
    - Click the name to view detailed cluster information
    StatusThe current status of the cluster
    - For detailed status values, see Cluster lifecycle and status
    Engine versionThe Redis OSS engine version running on the nodes
    Node typeThe node type selected during cluster creation
    - Hover over the node type to see vCPU and memory details
    - For types, refer to Node types
    Cluster modeWhether cluster mode is enabled
    High availabilityWhether automatic failover is enabled for node failures
    Auto backup retentionRetention period of automatic backups for the cluster
    - New backups follow updated retention settings
    - Hover to see backup start time
    Shard countNumber of shards in the cluster
    - If cluster mode is disabled, this shows as a hyphen (-)
    Node countNumber of nodes in the cluster
    UptimeTime since the cluster was created
    - Hover to view the cluster creation date

View cluster information

You can check information about clusters created within your project.

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

  2. In the Cluster tab, select a cluster to view its details.

  3. Use the available tabs to view information:

    Details tab

    SectionFieldDescription
    Top infoOperation statusCurrent operational status of the cluster
    Cluster modeWhether cluster mode is enabled
    High availabilityWhether automatic failover is enabled for node failures
    Endpoint - PrimaryRead/write-enabled endpoint
    Endpoint - ReadRead-only endpoint
    - Not provided in cluster mode
    Details - ClusterCluster nameName assigned at creation
    Created byUser who initially requested cluster creation
    Cluster modeWhether cluster mode is enabled
    High availabilityWhether automatic failover is enabled
    Node typeNode type selected during creation. See Node types
    vCPU per nodeNumber of vCPUs allocated per node
    Memory per nodeMemory allocated per node
    Shard countNumber of shards in the cluster
    Node countNumber of nodes
    - See the Shard/Node list tab for shard and node status
    Created atTime of cluster creation
    Cluster IDObject ID of the cluster
    NetworkVPCVPC selected during cluster creation
    Availability zoneAZ deployment
    - Multi: distributed across multiple AZs
    - Single: deployed in a single AZ
    Primary endpointRead/write-enabled endpoint
    Read endpointRead-only endpoint
    - Not provided in cluster mode
    PortPort running on the node (default: 6379)
    BackupBackup countTotal number of backups created
    Auto backup retentionAuto backup retention period
    - New backups follow updated settings
    - Hover to see backup start time
    Auto backup start timeTime when the daily auto backup begins (within 15 minutes of selected time)
    Redis compatibilityEngine versionRedis engine version used
    LicenseRedis OSS license information
    User authenticationWhether user authentication was enabled
    IDAdmin ID entered when authentication is enabled
    - Not displayed if disabled
    Parameter groupParameter group applied and its application status
    - See Parameter application status
    TLS encryptionWhether TLS encryption is enabled
    - CA file can be downloaded after creation

    Shard/Node list tab

    See How-to guides > Manage shards and nodes

    Backup tab

    You can create and manage backups from the cluster.
    Backups created from this tab are manual backups.
    See Backup management > Create manual backup for details.

    ItemDescription
    NameName of the backup
    StatusCurrent status of the backup
    - See Backup status values
    TypeBackup type (manual or automatic)
    Backup file sizeSize of the backup file
    Cache sizeCache size of the backup
    Auto backup retentionRetention period for automatic backups
    - New backups follow updated retention settings
    - Hover to see backup start time
    Retention expirationApplies to auto backups only; shows when the backup will expire and be deleted
    Backup start timeTime the backup started
    [⋮] menuOptions: Restore, Copy, Export, Delete
    - See Backup management for details

    Security tab

    See How-to guides > Manage cluster > View security group

    Monitoring tab

    See How-to guides > Manage cluster > Monitor cluster

Monitor cluster

In the Monitoring tab, you can check the detailed status of nodes within the cluster to manage them flexibly and efficiently while minimizing required resources.

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

  2. Select the cluster you want to monitor from the Cluster tab.

  3. Click the Monitoring tab to view information.

    ItemDescription
    ① Monitoring nodeSelect a node to monitor
    ② Data periodPeriod of data displayed in the monitoring graph
    - 1 hour (default) / 3 hours / 12 hours / 1 day / 7 days
    ③ MetricsSelect metrics to monitor
    - MemStore / CPU / Memory / Network
    - All selected by default
    - Multiple selections allowed
    ④ View modeGraph view mode
    - 1-column, 2-column, 3-column options
    ⑤ Auto refresh intervalSet auto-refresh interval
    - No refresh (default) / 10s / 30s / 1min / 5min
    ⑥ Manual refreshClick to manually refresh monitoring results

    Monitoring data provided

    CategoryMetricDescription
    MemStoreCalls by command (calls/sec)Calls per second by Redis command over time
    MemStoreConnections (count)Number of connections over time
    - Max Connections: Max number of clients
    - Active Connections: Current number of clients
    MemStoreCache hit ratio (%)Redis cache hit ratio over time
    MemStoreExpired/evicted keys (count)Number of expired/evicted keys over time
    CPUTotal usage (%)Total CPU usage over time
    MemoryTotal usage (%)Total memory usage over time
    MemoryUsage by type (Bytes)Memory usage by type over time
    NetworkRX per interface (Bytes/sec)Received bytes per second over time
    NetworkTX per interface (Bytes/sec)Transmitted bytes per second over time
    NetworkRX per interface (PPS)Packets received per second over time
    NetworkTX per interface (PPS)Packets sent per second over time

Configure high availability

MemStore offers a high availability (HA) feature to ensure service continuity and stable operations.
If HA is enabled, the system takes automated actions in case of node failure. HA settings can be changed without downtime, but the cluster must be in Running status and have at least one replica node.

  1. Go to the KakaoCloud Console > Data Store > MemStore.
  2. From the Cluster tab, click the [⋮] menu of your cluster and select Configure high availability.
  3. In the popup window, choose to enable or disable HA and click Save.
  4. Check the detailed cluster page to confirm the change.

Delete cluster

You can delete clusters that are no longer in use.

  1. Go to the KakaoCloud Console > Data Store > MemStore.
  2. In the Cluster tab, click the [⋮] menu for the cluster and select Delete cluster.
  3. In the popup, enter the cluster name.
  4. To preserve automatic backups, check Preserve automatic backups.
  5. Click Delete.

MemStore user account

MemStore provides an optional user authentication feature. If enabled, users must authenticate using the set ID and password. If not enabled, access is granted using a password-less default account.

Command restrictions

To ensure stable operation and management, the following Redis commands are restricted. Attempting to use them returns a NOPERM error.

CommandDescription
ACLACL-related commands
BGREWRITEAOFAOF rewrite
BGSAVEBackground save
CLIENT PAUSEPause clients
CLUSTER ADDSLOTSAdd slots
CLUSTER BUMPEPOCHBump epoch
CLUSTER DELSLOTSRemove slots
CLUSTER FAILOVERFailover command
CLUSTER FLUSHSLOTSFlush slots
CLUSTER FORGETRemove node link
CLUSTER MEETConnect cluster nodes
CLUSTER REPLICATEReplicate node
CLUSTER RESETReset cluster
CLUSTER SAVECONFIGSave config
CLUSTER SET-CONFIG-EPOCHSet config epoch
CLUSTER SETSLOTSet slot options
CONFIGConfiguration commands
DEBUGDebugging commands
FAILOVERFailover command
MIGRATEData migration
MODULEModule-related commands
PSYNCReplication status check
REPLCONFReplication config
REPLICAOFSet replica
RESTORE-ASKINGRestore data
SAVESave data
SHUTDOWNShutdown Redis
SLAVEOFSet master
SORTSort command
SYNCSync command

View security group

In the Security tab of the cluster details, you can view applied security groups and policies.
To access a cluster, port 6379 (or the port you specified) must be allowed in the security group.
Click a group name to manage it in VPC > Security Groups.

Modify security group

You can update the security groups attached to a cluster. At least one group must be attached.

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

  2. From the Cluster tab, click the [⋮] menu for the cluster and select Modify security group.

  3. In the popup, select the groups to attach.

    ItemDescription
    Selected cluster nameName of the cluster being modified
    Select security groupsChoose groups to apply. Selected groups appear as chips below
    Applied rulesView inbound/outbound rules for each group
  4. Click Apply.

Access MemStore cluster

To access the cluster from an instance in MemStore, use a Redis Client after completing cluster setup.

Prerequisites

To connect, prepare an environment where the instance and cluster share the same network (VPC) and ensure TCP port 6379 (default) is allowed in the instance's outbound rules.

Connect to cluster

  1. Refer to Virtual Machine > Create and connect to instance to access your VM. Install Redis Client if it's not already available.

  2. Go to the KakaoCloud Console > MemStore.

  3. Select the cluster.

  4. In the Details tab, find the Endpoint. Copy it for use in the next step.

  5. Connect to the cluster using the Redis Client with the following command:

    Connect to Redis instance
    redis-cli -h {ENDPOINT} -p {PORT}
    ParameterDescription
    {ENDPOINT}The endpoint from the Details tab
    {PORT}Port for Redis connection, default is 6379 or your custom port

Change parameter group

You can change the parameter group attached to a cluster.
Select a group that matches the engine version and cluster mode of the cluster. Be aware that changes in parameter values may impact service operations. If a parameter group change is already in progress, a new request may fail.
See Manage parameter groups for guidance.

  1. Go to the KakaoCloud Console > Data Store > MemStore.
  2. From the Cluster tab, click the [⋮] menu for the cluster and select Change parameter group.
  3. In the popup, choose the new parameter group and click Confirm.