Scale instance capacity

This page describes how to scale a Memorystore for Redis Cluster instance. Your instance's capacity is determined by the number of shards in your instance and your instance's node type. To scale your instance, you must change the shard count or node type. For more information about an instance's behavior during scaling, see About scaling instance capacity.

Scale the shard count

You can increase or decrease the number of shards for an instance by using either the Google Cloud console or Google Cloud CLI.

Console

1. In the Google Cloud console, go to the Memorystore for Redis Cluster page.

   Memorystore for Redis Cluster

2. Click your cluster ID.

3. In the Configurations section, click the pencil icon next to Shards.

4. In the Shards field, enter the number of shards to which you want to scale your instance.

5. Click Update cluster.

gcloud

To scale the number of shards for an instance, use the gcloud redis clusters update command:

gcloud redis clusters update INSTANCE_ID \
--region=REGION_ID \
--shard-count=SHARD_COUNT

Replace the following:

• INSTANCE_ID: the ID of your instance.
• REGION_ID: the region where your instance is located.
• SHARD_COUNT: the number of shards in your instance. The shard count determines the total memory capacity for storing instance data. For more information about cluster and node specifications for Memorystore for Redis Cluster instances, see Cluster and node specification.

For example:

gcloud redis clusters update my-instance \
--region=us-central1 \
--shard-count=8

Scale the node type

You can scale the node type for an instance by using the Google Cloud CLI.

gcloud

1. To retrieve information about an instance, use the gcloud redis clusters describe command:

   gcloud redis clusters describe INSTANCE_ID \
   --region=REGION_ID
   

   Replace the following:

   • INSTANCE_ID: the ID of your instance
   • REGION_ID: the region where your instance is located (for example, us-central1)

2. Check the output to see if the following conditions exist:

   1. The output contains a redisConfigs section.

   2. The maxmemory-clients, maxmemory, or maxclients parameters appear in this section.

   If any of these parameters appear, then when you scale the node type for the instance, you must scale the values for the parameters to reflect values that Memorystore for Redis Cluster can accept for the scaled node type. For more information, see Modifiable configuration parameters.

3. To scale the node type, use the gcloud redis clusters update command:

   gcloud redis clusters update INSTANCE_ID \
   --region=REGION_ID \
   --node-type=NODE_TYPE
   

   Replace the following:

   • INSTANCE_ID: the ID of your instance.
   • REGION_ID: the region where your instance is located.

   • NODE_TYPE: the node type to which you want to scale your instance. Acceptable values for this parameter are redis-shared-core-nano, redis-standard-small, redis-highmem-medium, and redis-highmem-xlarge.

     Note: You can't scale your instance down to the redis-shared-core-nano node type.
     Caution: We recommend that you use the redis-shared-core-nano node type for development or testing purposes only. If you run Memorystore for Redis Cluster in a production environment, then we recommend using the redis-standard-small, redis-highmem-medium, or redis-highmem-xlarge node types. For more information about these node types, see Choose a node type.

   For this example, you scale the node type of the my-instance instance to redis-highmem-medium. This instance is located in the us-central1 region.

   gcloud redis clusters update my-instance \
   --region=us-central1 \
   --node-type=redis-highmem-medium
   

   For this example, you change the value of the maxclients parameter to 15,000.

   gcloud redis clusters update my-instance \
   --region=us-central1 \
   --node-type=redis-highmem-medium \
   --update-redis-config=maxclients=15000