Create and manage parameter groups
Parameter groups allow you to view and manage parameters required for MemStore Redis OSS configuration based on engine version.
You can also manage parameters in bulk for all clusters linked to a specific parameter group.
The parameter list and core concepts in MemStore are compatible with Redis OSS. Since changing parameters may affect your MemStore service, it is highly recommended to review the appropriate values in advance.
Here is how to manage parameter groups in the MemStore service.
- You can receive notifications for parameter group events such as creation or updates through Alert Center > Event Notifications.
- For configurable events, see Cloud Trail > Core Concepts, and for notification setup, refer to Alert Center > Manage Notification Policies.
View parameter group list
You can view both default and custom parameter groups provided by KakaoCloud MemStore.
-
Go to the KakaoCloud Console > Data Store > MemStore menu.
-
Click the Parameter Groups menu, then choose the Custom Group or Default Group tab.
-
Proceed to the matching Parameter Group menu.
Item Description Name Name of the parameter group Cluster mode Whether cluster mode is used Family MemStore engine version compatible with the group Linked clusters Number of clusters linked to this group
- A warning icon appears if any cluster has parameter sync issuesDescription Description of the parameter group More Custom groups only
- Edit: Modify parameters
- Copy: Create a new group with the same parameters
- Reset to default: Revert parameters to default values
- Rollback: Revert to previous parameter values (unavailable if no history or already rolled back)
- Delete: Delete the parameter group
View parameter group details
You can check detailed information of a MemStore parameter group.
-
Go to the KakaoCloud Console > Data Store > MemStore menu.
-
Click the Parameter Groups menu, then choose the Custom Group or Default Group tab.
-
Navigate to the appropriate tab and select the parameter group to view.
- Parameter Tab
- Linked Clusters Tab
- Recent Events Tab
Item Description Name Name of the parameter Value Parameter value Type Parameter type
- SomeDynamic
parameters apply globally and require session refreshData format Format of the parameter value Editable Indicates if the parameter is editable: No
,Yes
, orYes (modified)
Item Description Name Cluster name Status Cluster status Parameter sync status Status of parameter application; see Parameter application status Engine version Redis OSS engine version used by the cluster Node type Instance type used in the cluster configuration Cluster mode Whether cluster mode is enabled ( Enabled
,Disabled
)High availability Whether HA is enabled ( Enabled
,Disabled
)[Button] Retry Retry applying parameters to the cluster when the sync status is Error-Sync
orSuspended
You can check key events related to the parameter group over the past 7 days.
Item Description Time Time of event occurrence Name Event name Details Event details including results and affected cluster - Types of events per parameter group:
Group type Event name Description Common Apply Parameter Group Triggered when apply request is made Apply Parameter Group Failed Triggered when application fails Apply Parameter Group Complete Triggered when application is completed for all clusters Apply Parameter Group To Cluster Triggered when applying to specific cluster begins Apply Parameter Group To Cluster Failed Triggered when cluster application fails Apply Parameter Group To Cluster Complete Triggered when application is completed on a cluster Custom Create Parameter Group When group creation is requested Update Parameter Group When group modification is requested Update Parameters When parameter values are updated Reset Parameters When parameters are reset to default Rollback Parameters When parameters are rolled back to previous values
Create parameter group
-
Go to the KakaoCloud Console > Data Store > MemStore menu.
-
Click the Parameter Groups menu and select the Custom Group tab.
-
In the Custom Group tab, click the icon and select Create Parameter Group.
-
On the Create Parameter Group page, fill in the required details. Parameter values can be edited after creation.
Section Field Description Basic Settings Parameter group name Name of the parameter group
- Must be unique within the same projectDescription (optional) Up to 100 characters Group Settings Family MemStore family engine version Cluster mode Whether cluster mode is enabled Default parameter group Select from predefined groups for the engine version Parameters - Initial values for the parameters in the group
Modify parameter group
For custom parameter groups, you can edit the description and modify parameter values after creation. Only parameters with Editable: Yes
can be modified. Once edited, the status changes to Yes (modified)
.
- Some
Dynamic
parameters apply globally and require a session refresh. - If the sync status of a linked cluster is
Pending
orApplying
, parameters cannot be modified. - Selected checkboxes persist across page navigation when editing.
- Some parameter modifications may affect MemStore service operation. See Parameters to be careful when modifying.
- If issues occur after modification, consider using
Copy
,Retry
,Rollback
, orReset to default
options to manage parameter backups.
-
Go to the KakaoCloud Console > Data Store > MemStore menu.
-
Click the Parameter Groups menu and select the Custom Group tab.
-
After identifying the group to modify, click the [More] icon > Edit.
-
On the Modify Parameter Group page, update the desired fields.
Section Field Description Basic Info Parameter group name Name of the group Description (optional) Up to 100 characters Editable Parameters - List of editable parameters in the group
- Modified parameters are marked asYes (modified)
-
If the parameter group is linked to multiple clusters, you can choose how to apply the changes:
Apply all at once
: Apply the changes to all clusters simultaneously.Apply sequentially
: Apply the changes to each cluster one at a time.
Parameters to be careful when modifying
When modifying parameter values in a custom parameter group, some parameters may impact the operation of the MemStore service. Please refer to the following details.
repl-backlog
- A buffer that temporarily stores data for partial synchronization (psync) when replication between primary and replica nodes is interrupted due to network issues.
- During a network partition, the primary node stores data in the backlog and attempts psync once the replica reconnects.
- The primary node retains backlog data for a certain time (
repl-backlog-ttl
) after the last replica disconnects. After that, the buffer is released. - If the replica reconnects after the buffer is cleared, a full sync is triggered.
- Related parameters:
repl-backlog-size
,repl-backlog-ttl
client-output-buffer-limit-normal-hard-limit
Type | Range | Description |
---|---|---|
integer | 0~ | Maximum client output buffer memory. When set to 0 , there is no limit.Potential issue If memory usage exceeds this limit, the client connection is closed. Setting this value too low may prevent MemStore provisioning. Recommended to use a sufficient value or default (0) based on workload. |
client-output-buffer-limit-normal-soft-limit
Type | Range | Description |
---|---|---|
integer | 0~ | Threshold for client output buffer memory. Applies during a period defined by client-output-buffer-limit-normal-soft-seconds .Potential issue If memory usage exceeds the threshold during the defined time, the client connection is closed. Setting this value too low may prevent MemStore provisioning. Recommended to use a sufficient value or default (0). |
client-output-buffer-limit-normal-soft-seconds
Type | Range | Description |
---|---|---|
integer | 0~2147483647 | Allowed time (in seconds) for exceeding soft limit before disconnect. Potential issue If memory usage exceeds the soft limit for longer than this period, the client connection is terminated. Recommended to use a sufficient value or default (0). |
min-replicas-max-lag
Type | Range | Description |
---|---|---|
integer | 0~2147483647 | Max ping delay allowed from replica to primary node. Potential issue If the primary doesn't receive a ping within this time, the replica is marked as unavailable. Recommended to set an appropriate value based on service reliability needs. |
min-replicas-to-write
Type | Range | Description |
---|---|---|
integer | 0~2147483647 | Minimum number of replicas required for the primary to process write requests. Potential issue If the number of healthy replicas is less than this value, writes will be rejected. Example: min-replicas-to-write: 5 with only two replicas results in:primary.memstore:6379> SET hello memstore(error) NOREPLICAS Not enough good replicas to write. |
repl-backlog-size
Type | Range | Description |
---|---|---|
integer | 16384~ | Size of the backlog buffer for replication between primary and replicas. Potential issue If the replication lag exceeds the backlog size, a full sync will be triggered. Setting this value too low may impact performance or cause temporary service unavailability. Recommended to configure a sufficient value based on workload. |
repl-backlog-ttl
Type | Range | Description |
---|---|---|
integer | 0~2147483647 | Retention period (seconds) for backlog buffer in the primary node.0 means never released.Potential issue After this time, the backlog is cleared and full sync is required. Low values may cause frequent full syncs, affecting performance or availability. Set a sufficient value based on workload. |
maxclients
Type | Range | Description |
---|---|---|
integer | 100~65000 | Maximum number of client connections per node. Potential issue Setting this too low may cause connection failures and trigger failover due to health check failures. Configure a sufficient value based on node type and workload. |
Copy parameter group
You can use the copy function to back up a custom parameter group by creating a new group with the same settings.
- Go to the KakaoCloud Console > Data Store > MemStore menu.
- Click the Parameter Groups menu and select the Custom Group tab.
- Find the group to copy, then click the [More] icon > Copy.
- In the Copy Parameter Group popup, review and confirm the information.
- Confirm that the copied group appears under the Custom Group tab.
Reset parameter group to default
You can reset a custom parameter group back to the default values based on the selected engine version. Resetting applies the default values to all linked clusters.
You cannot reset a group if any linked cluster is in Pending
or Applying
state.
- Go to the KakaoCloud Console > Data Store > MemStore menu.
- Click the Parameter Groups menu and select the Custom Group tab.
- Find the group to reset, then click the [More] icon > Reset to default.
- In the Reset to Default popup, review the notice and click Confirm.
If linked to multiple clusters, choose how to apply:
-Apply all at once
: Applies changes to all clusters simultaneously.
-Apply sequentially
: Applies changes one by one. Clusters waiting are marked asPending
. - Verify that the parameter sync status is updated correctly across all clusters.
Roll back parameter group
You can roll back a custom parameter group to the previous values only if there is a prior modification history.
- Cannot roll back if any linked cluster is in
Pending
orApplying
state. - Once rolled back, further rollback is not possible unless new changes are made.
- Go to the KakaoCloud Console > Data Store > MemStore menu.
- Click the Parameter Groups menu and select the Custom Group tab.
- Find the group to roll back, then click the [More] icon > Rollback.
- In the Rollback Parameter Group popup, review the notice and click Confirm.
- Verify that rollback is reflected correctly across all linked clusters.
Delete parameter group
You can delete a custom parameter group that is no longer in use.
- Default parameter groups cannot be deleted.
- Parameter groups linked to clusters cannot be deleted.
- Go to the KakaoCloud Console > Data Store > MemStore menu.
- Click the Parameter Groups menu and select the Custom Group tab.
- Find the group to delete, then click the [More] icon > Delete.
- In the Delete Parameter Group popup, enter the required information and click Confirm.
- Confirm that the group is deleted from the Custom Group tab.
Retry parameter application
You can retry applying parameters only when the parameter sync status of the linked instance is not In-Sync
, but Error-Sync
or Suspended
.
For more details about parameter sync statuses, refer to Parameter application status.
- Go to the KakaoCloud Console > Data Store > MemStore menu.
- Click the Parameter Groups menu and select the Custom Group tab.
- Navigate to the appropriate Parameter Group menu and select the parameter group to view its details.
- Go to the Linked Clusters tab.
- Click the [Retry] button for the instance where you want to retry the application.