MemoryDB Operations
Available Operations
Add Replica
What is it?
Using this operation a user can scale up replicas of shard(s) in a cluster.
When to use?
This operation can be run only when the cluster is in running
state or when an existing operation is success
. User need to wait if any existing operation is already running on the same cluster and can check its status via odin provided Jenkins.
How to use ?
Insert the replica count to be added for the shard(s) in numOfReplicasPerShard
. E.g: If you have 5 replicas and you want to add 5 more, the value of numOfReplicasPerShard
will be 5. Replica count in all shards will be increased by 5
odin operate component --name [YOUR_COMPONENT_NAME] --service [YOUR_SERVICE_NAME]
--operation add-replica --env [YOUR_ENV_NAME] --options='{}'
numOfReplicasPerShard
number
The number of read replicas to add to the cluster across all shards
Remove Replica
What is it?
Using this operation a user can scale down replicas of shard(s) in a cluster.
When to use?
This operation can be run only when the cluster is in running
state or when an existing operation is success
. User need to wait if any existing operation is already running on the same cluster and can check its status via odin provided Jenkins.
How to use ?
Insert the replica count to be removed for the shard(s) in numOfReplicasPerShard
. E.g: If you have 5 replicas and you want to remove 2 replicas, the value of numOfReplicasPerShard
will be 2. Replica count in all shards will be decreased by 2
odin operate component --name [YOUR_COMPONENT_NAME] --service [YOUR_SERVICE_NAME]
--operation remove-replica --env [YOUR_ENV_NAME] --options='{}'
numOfReplicasPerShard
number
The number of read replicas to be removed from the cluster across all shards
Add Shard
What is it?
Using this operation a user can scale up number of shards in a cluster.
When to use?
This operation can be run only when the cluster is in running
state or when an existing operation is success
. User need to wait if any existing operation is already running on the same cluster and can check its status via odin provided Jenkins.
How to use ?
Insert the shard count to be added for the cluster in numOfShards
. E.g: If you have 2 shards and you want to add 2 more, the value of numOfShards
will be 2. Shard count will be increased by 2
odin operate component --name [YOUR_COMPONENT_NAME] --service [YOUR_SERVICE_NAME]
--operation add-shard --env [YOUR_ENV_NAME] --options='{}'
numOfShards
number
The number of shards to add to the cluster
Remove Shard
What is it?
Using this operation a user can scale down number of shards in a cluster.
When to use?
This operation can be run only when the cluster is in running
state or when an existing operation is success
. User need to wait if any existing operation is already running on the same cluster and can check its status via odin provided Jenkins.
How to use ?
Insert the shard count to be removed from the cluster in numOfShards
. E.g: If you have 5 shards and you want to remove 2, the value of numOfShards
will be 2. Shard count will be decreased by 2
odin operate component --name [YOUR_COMPONENT_NAME] --service [YOUR_SERVICE_NAME]
--operation remove-shard --env [YOUR_ENV_NAME] --options='{}'
numOfShards
number
The number of shards to remove from the cluster
Vertical Scale
What is it?
Using this operation a user can vertically scale up/down the replicas in all shards of a cluster.
When to use?
This operation can be run only when the cluster is in running
state or when an existing operation is success
. User need to wait if any existing operation is already running on the same cluster and can check its status via odin provided Jenkins.
How to use ?
Insert the desired instance type for the cluster in instanceType
. E.g: If you have cache.t4g.medium instance type and you want to have all instances with cache.t4g.large, the value of instanceType will be cache.t4g.large. All the replicas across all the shards will have new instance type
odin operate component --name [YOUR_COMPONENT_NAME] --service [YOUR_SERVICE_NAME]
--operation vertical-scale --env [YOUR_ENV_NAME] --options='{}'
instanceType
String
Desired instance type
Last updated