Scale for a Redis cluster

You can scale Redis DB instances in two ways, vertical scaling and horizontal scaling.

Vertical scaling

You can vertically scale a cluster by changing resource requirements and limits (CPU and storage). For example, you can change the resource class from 1C2G to 2C4G by performing vertical scaling.

Before you start

Run the command below to check whether the cluster STATUS is Running. Otherwise, the following operations may fail.

kubectl -n demo get cluster mycluster
>
NAME           CLUSTER-DEFINITION   VERSION        TERMINATION-POLICY   STATUS     AGE
mycluster      redis                               Delete               Running    19m

kbcli cluster list mycluster -n demo
>
NAME        NAMESPACE   CLUSTER-DEFINITION   VERSION   TERMINATION-POLICY   STATUS    CREATED-TIME
mycluster   demo        redis                          Delete               Running   Sep 29,2024 09:46 UTC+0800

Steps

Apply an OpsRequest to the specified cluster. Configure the parameters according to your needs.

kubectl apply -f - <<EOF
apiVersion: apps.kubeblocks.io/v1alpha1
kind: OpsRequest
metadata:
  name: ops-vertical-scaling
  namespace: demo
spec:
  clusterName: mycluster
  type: VerticalScaling
  verticalScaling:
  - componentName: redis
    requests:
      memory: "2Gi"
      cpu: "1"
    limits:
      memory: "4Gi"
      cpu: "2"
EOF

Check the operation status to validate the vertical scaling.
```
kubectl get ops -n demo
>
NAMESPACE   NAME                   TYPE              CLUSTER     STATUS    PROGRESS   AGE
demo        ops-vertical-scaling   VerticalScaling   mycluster   Succeed   3/3        6m
```
If an error occurs to the vertical scaling operation, you can troubleshoot with kubectl describe ops -n demo command to view the events of this operation.
Check whether the corresponding resources change.
```
kubectl describe cluster mycluster -n demo
```

Change the configuration of spec.componentSpecs.resources in the YAML file.

spec.componentSpecs.resources controls the requests and limits of resources and changing them triggers a vertical scaling.

kubectl edit cluster mycluster -n demo

Edit the values of spec.componentSpecs.resources.

...
spec:
  clusterDefinitionRef: redis
  componentSpecs:
  - name: redis
    componentDef: redis
    replicas: 1
    resources: # Change values of resources
      requests:
        memory: "2Gi"
        cpu: "1"
      limits:
        memory: "4Gi"
        cpu: "2"
...

Check whether the corresponding resources change.
```
kubectl describe cluster mycluster -n demo
```

Configure the parameters --components, --memory, and --cpu and run the command.
```
kbcli cluster vscale mycluster --components="redis" --memory="4Gi" --cpu="2"
```
- --components describes the component name ready for vertical scaling.
- --memory describes the requested and limited size of the component memory.
- --cpu describes the requested and limited size of the component CPU.
Validate the vertical scaling operation.
- View the OpsRequest progress.
  
  KubeBlocks outputs a command automatically for you to view the OpsRequest progress. The output includes the status of this OpsRequest and Pods. When the status is Succeed, this OpsRequest is completed.
```
kbcli cluster describe-ops mycluster-verticalscaling-enbr9 -n demo
```
- Check the cluster status.
```
kbcli cluster list mycluster
>
NAME        NAMESPACE   CLUSTER-DEFINITION   VERSION   TERMINATION-POLICY   STATUS    CREATED-TIME
mycluster   demo        redis                          Delete               Running   Sep 29,2024 09:46 UTC+0800
```
  - STATUS=Updating: it means the vertical scaling is in progress.
  - STATUS=Running: it means the vertical scaling operation has been applied.
  - STATUS=Abnormal: it means the vertical scaling is abnormal. The reason may be the normal instances number is less than the total instance number or the leader instance is running properly while others are abnormal.
    
    To solve the problem, you can check manually to see whether resources are sufficient. If AutoScaling is supported, the system recovers when there are enough resources, otherwise, you can create enough resources and check the result with kubectl describe command.
NOTE
Vertical scaling does not synchronize parameters related to CPU and memory and it is required to manually call the opsRequest of configuration to change parameters accordingly. Refer to Configuration for instructions.
Check whether the corresponding resources change.
```
kbcli cluster describe mycluster -n demo
```

Horizontal scaling

Horizontal scaling changes the amount of pods. For example, you can scale out replicas from three to five.

From v0.9.0, besides replicas, KubeBlocks also supports scaling in and out instances, refer to the Horizontal Scale tutorial](./../user_docs/maintenance/scale//horizontal-scale) for more details and examples.

Before you start

Check whether the cluster status is Running. Otherwise, the following operations may fail.

kubectl -n demo get cluster mycluster
>
NAME           CLUSTER-DEFINITION   VERSION        TERMINATION-POLICY   STATUS     AGE
mycluster      redis                               Delete               Running    19m

kbcli cluster list mycluster -n demo
>
NAME        NAMESPACE   CLUSTER-DEFINITION   VERSION   TERMINATION-POLICY   STATUS    CREATED-TIME
mycluster   demo        redis                          Delete               Running   Sep 29,2024 09:46 UTC+0800

Steps

Apply an OpsRequest to the specified cluster. Configure the parameters according to your needs.

The example below means adding two replicas.

kubectl apply -f - <<EOF
apiVersion: apps.kubeblocks.io/v1alpha1
kind: OpsRequest
metadata:
  name: ops-horizontal-scaling
  namespace: demo
spec:
  clusterName: mycluster
  type: HorizontalScaling
  horizontalScaling:
  - componentName: redis
    scaleOut:
      replicaChanges: 2
EOF

If you want to scale in replicas, replace scaleOut with scaleIn.

The example below means deleting two replicas.

kubectl apply -f - <<EOF
apiVersion: apps.kubeblocks.io/v1alpha1
kind: OpsRequest
metadata:
  name: ops-horizontal-scaling
  namespace: demo
spec:
  clusterName: mycluster
  type: HorizontalScaling
  horizontalScaling:
  - componentName: redis
    scaleIn:
      replicaChanges: 2
EOF

Check the operation status to validate the horizontal scaling.

kubectl get ops -n demo
>
NAMESPACE   NAME                     TYPE                CLUSTER     STATUS    PROGRESS   AGE
demo        ops-horizontal-scaling   HorizontalScaling   mycluster   Succeed   3/3        6m

If an error occurs, you can troubleshoot with kubectl describe ops -n demo command to view the events of this operation.

Check whether the corresponding resources change.
```
kubectl describe cluster mycluster -n demo
```

Change the value of spec.componentSpecs.replicas in the YAML file. spec.componentSpecs.replicas stands for the pod amount and changing this value triggers a horizontal scaling of a cluster.
```
kubectl edit cluster mycluster -n demo
```
Edit the value of spec.componentSpecs.replicas.
```
...
spec:
  clusterDefinitionRef: redis
  componentSpecs:
  - name: redis
    componentDef: redis
    replicas: 2 # Change this value
...
```
Check whether the corresponding resources change.
```
kubectl describe cluster mycluster -n demo
```

Configure the parameters --components and --replicas, and run the command.
```
kbcli cluster hscale mycluster --components="redis" --replicas=2
```
- --components describes the component name ready for horizontal scaling.
- --replicas describes the replica amount of the specified components. Edit the amount based on your demands to scale in or out replicas.
Validate the horizontal scaling operation.
- View the OpsRequest progress.
  
  KubeBlocks outputs a command automatically for you to view the OpsRequest progress. The output includes the status of this OpsRequest and Pods. When the status is Succeed, this OpsRequest is completed.
```
kbcli cluster describe-ops mycluster-horizontalscaling-we2r3 -n demo
```
- View the cluster status.
```
kbcli cluster list mycluster -n demo
>
NAME        NAMESPACE   CLUSTER-DEFINITION   VERSION   TERMINATION-POLICY   STATUS    CREATED-TIME
mycluster   demo        redis                          Delete               Running   Sep 29,2024 09:46 UTC+0800
```
  - STATUS=Updating: it means horizontal scaling is in progress.
  - STATUS=Running: it means horizontal scaling has been applied.
Check whether the corresponding resources change.
```
kbcli cluster describe mycluster -n demo
```

Handle the snapshot exception

If STATUS=ConditionsError occurs during the horizontal scaling process, you can find the cause from cluster.status.condition.message for troubleshooting.

In the example below, a snapshot exception occurs.

Status:
  conditions:
  - lastTransitionTime: "2023-04-10T18:20:26Z"
    message: VolumeSnapshot/mycluster-redis-scaling-dbqgp: Failed to set default snapshot
      class with error cannot find default snapshot class
    reason: ApplyResourcesFailed
    status: "False"
    type: ApplyResources

Reason

This exception occurs because the VolumeSnapshotClass is not configured. This exception can be fixed after configuring VolumeSnapshotClass, but the horizontal scaling cannot continue to run. It is because the wrong backup (volumesnapshot is generated by backup) and volumesnapshot generated before still exist. Delete these two wrong resources and then KubeBlocks re-generates new resources.

Steps:

Configure the VolumeSnapshotClass by running the command below.

kubectl create -f - <<EOF
apiVersion: snapshot.storage.k8s.io/v1
kind: VolumeSnapshotClass
metadata:
  name: csi-aws-vsc
  annotations:
    snapshot.storage.kubernetes.io/is-default-class: "true"
driver: ebs.csi.aws.com
deletionPolicy: Delete
EOF

Delete the wrong backup (volumesnapshot is generated by backup) and volumesnapshot resources.

kubectl delete backup -l app.kubernetes.io/instance=mycluster -n demo

kubectl delete volumesnapshot -l app.kubernetes.io/instance=mycluster -n demo

Result

The horizontal scaling continues after the backup and volumesnapshot are deleted and the cluster restores to running status.

Scale for a Redis cluster

You can scale Redis DB instances in two ways, vertical scaling and horizontal scaling.

Vertical scaling

You can vertically scale a cluster by changing resource requirements and limits (CPU and storage). For example, you can change the resource class from 1C2G to 2C4G by performing vertical scaling.

Before you start

Run the command below to check whether the cluster STATUS is Running. Otherwise, the following operations may fail.

kubectl -n demo get cluster mycluster
>
NAME           CLUSTER-DEFINITION   VERSION        TERMINATION-POLICY   STATUS     AGE
mycluster      redis                               Delete               Running    19m

kbcli cluster list mycluster -n demo
>
NAME        NAMESPACE   CLUSTER-DEFINITION   VERSION   TERMINATION-POLICY   STATUS    CREATED-TIME
mycluster   demo        redis                          Delete               Running   Sep 29,2024 09:46 UTC+0800

Steps

Apply an OpsRequest to the specified cluster. Configure the parameters according to your needs.

kubectl apply -f - <<EOF
apiVersion: apps.kubeblocks.io/v1alpha1
kind: OpsRequest
metadata:
  name: ops-vertical-scaling
  namespace: demo
spec:
  clusterName: mycluster
  type: VerticalScaling
  verticalScaling:
  - componentName: redis
    requests:
      memory: "2Gi"
      cpu: "1"
    limits:
      memory: "4Gi"
      cpu: "2"
EOF

Check the operation status to validate the vertical scaling.
```
kubectl get ops -n demo
>
NAMESPACE   NAME                   TYPE              CLUSTER     STATUS    PROGRESS   AGE
demo        ops-vertical-scaling   VerticalScaling   mycluster   Succeed   3/3        6m
```
If an error occurs to the vertical scaling operation, you can troubleshoot with kubectl describe ops -n demo command to view the events of this operation.
Check whether the corresponding resources change.
```
kubectl describe cluster mycluster -n demo
```

Change the configuration of spec.componentSpecs.resources in the YAML file.

spec.componentSpecs.resources controls the requests and limits of resources and changing them triggers a vertical scaling.

kubectl edit cluster mycluster -n demo

Edit the values of spec.componentSpecs.resources.

...
spec:
  clusterDefinitionRef: redis
  componentSpecs:
  - name: redis
    componentDef: redis
    replicas: 1
    resources: # Change values of resources
      requests:
        memory: "2Gi"
        cpu: "1"
      limits:
        memory: "4Gi"
        cpu: "2"
...

Check whether the corresponding resources change.
```
kubectl describe cluster mycluster -n demo
```

Configure the parameters --components, --memory, and --cpu and run the command.
```
kbcli cluster vscale mycluster --components="redis" --memory="4Gi" --cpu="2"
```
- --components describes the component name ready for vertical scaling.
- --memory describes the requested and limited size of the component memory.
- --cpu describes the requested and limited size of the component CPU.
Validate the vertical scaling operation.
- View the OpsRequest progress.
  
  KubeBlocks outputs a command automatically for you to view the OpsRequest progress. The output includes the status of this OpsRequest and Pods. When the status is Succeed, this OpsRequest is completed.
```
kbcli cluster describe-ops mycluster-verticalscaling-enbr9 -n demo
```
- Check the cluster status.
```
kbcli cluster list mycluster
>
NAME        NAMESPACE   CLUSTER-DEFINITION   VERSION   TERMINATION-POLICY   STATUS    CREATED-TIME
mycluster   demo        redis                          Delete               Running   Sep 29,2024 09:46 UTC+0800
```
  - STATUS=Updating: it means the vertical scaling is in progress.
  - STATUS=Running: it means the vertical scaling operation has been applied.
  - STATUS=Abnormal: it means the vertical scaling is abnormal. The reason may be the normal instances number is less than the total instance number or the leader instance is running properly while others are abnormal.
    
    To solve the problem, you can check manually to see whether resources are sufficient. If AutoScaling is supported, the system recovers when there are enough resources, otherwise, you can create enough resources and check the result with kubectl describe command.
NOTE
Vertical scaling does not synchronize parameters related to CPU and memory and it is required to manually call the opsRequest of configuration to change parameters accordingly. Refer to Configuration for instructions.
Check whether the corresponding resources change.
```
kbcli cluster describe mycluster -n demo
```

Horizontal scaling

Horizontal scaling changes the amount of pods. For example, you can scale out replicas from three to five.

Before you start

Check whether the cluster status is Running. Otherwise, the following operations may fail.

kubectl -n demo get cluster mycluster
>
NAME           CLUSTER-DEFINITION   VERSION        TERMINATION-POLICY   STATUS     AGE
mycluster      redis                               Delete               Running    19m

kbcli cluster list mycluster -n demo
>
NAME        NAMESPACE   CLUSTER-DEFINITION   VERSION   TERMINATION-POLICY   STATUS    CREATED-TIME
mycluster   demo        redis                          Delete               Running   Sep 29,2024 09:46 UTC+0800

Steps

Apply an OpsRequest to the specified cluster. Configure the parameters according to your needs.

The example below means adding two replicas.

kubectl apply -f - <<EOF
apiVersion: apps.kubeblocks.io/v1alpha1
kind: OpsRequest
metadata:
  name: ops-horizontal-scaling
  namespace: demo
spec:
  clusterName: mycluster
  type: HorizontalScaling
  horizontalScaling:
  - componentName: redis
    scaleOut:
      replicaChanges: 2
EOF

If you want to scale in replicas, replace scaleOut with scaleIn.

The example below means deleting two replicas.

kubectl apply -f - <<EOF
apiVersion: apps.kubeblocks.io/v1alpha1
kind: OpsRequest
metadata:
  name: ops-horizontal-scaling
  namespace: demo
spec:
  clusterName: mycluster
  type: HorizontalScaling
  horizontalScaling:
  - componentName: redis
    scaleIn:
      replicaChanges: 2
EOF

Check the operation status to validate the horizontal scaling.

kubectl get ops -n demo
>
NAMESPACE   NAME                     TYPE                CLUSTER     STATUS    PROGRESS   AGE
demo        ops-horizontal-scaling   HorizontalScaling   mycluster   Succeed   3/3        6m

If an error occurs, you can troubleshoot with kubectl describe ops -n demo command to view the events of this operation.

Check whether the corresponding resources change.
```
kubectl describe cluster mycluster -n demo
```

Change the value of spec.componentSpecs.replicas in the YAML file. spec.componentSpecs.replicas stands for the pod amount and changing this value triggers a horizontal scaling of a cluster.
```
kubectl edit cluster mycluster -n demo
```
Edit the value of spec.componentSpecs.replicas.
```
...
spec:
  clusterDefinitionRef: redis
  componentSpecs:
  - name: redis
    componentDef: redis
    replicas: 2 # Change this value
...
```
Check whether the corresponding resources change.
```
kubectl describe cluster mycluster -n demo
```

Configure the parameters --components and --replicas, and run the command.
```
kbcli cluster hscale mycluster --components="redis" --replicas=2
```
- --components describes the component name ready for horizontal scaling.
- --replicas describes the replica amount of the specified components. Edit the amount based on your demands to scale in or out replicas.
Validate the horizontal scaling operation.
- View the OpsRequest progress.
  
  KubeBlocks outputs a command automatically for you to view the OpsRequest progress. The output includes the status of this OpsRequest and Pods. When the status is Succeed, this OpsRequest is completed.
```
kbcli cluster describe-ops mycluster-horizontalscaling-we2r3 -n demo
```
- View the cluster status.
```
kbcli cluster list mycluster -n demo
>
NAME        NAMESPACE   CLUSTER-DEFINITION   VERSION   TERMINATION-POLICY   STATUS    CREATED-TIME
mycluster   demo        redis                          Delete               Running   Sep 29,2024 09:46 UTC+0800
```
  - STATUS=Updating: it means horizontal scaling is in progress.
  - STATUS=Running: it means horizontal scaling has been applied.
Check whether the corresponding resources change.
```
kbcli cluster describe mycluster -n demo
```

Handle the snapshot exception

If STATUS=ConditionsError occurs during the horizontal scaling process, you can find the cause from cluster.status.condition.message for troubleshooting.

In the example below, a snapshot exception occurs.

Status:
  conditions:
  - lastTransitionTime: "2023-04-10T18:20:26Z"
    message: VolumeSnapshot/mycluster-redis-scaling-dbqgp: Failed to set default snapshot
      class with error cannot find default snapshot class
    reason: ApplyResourcesFailed
    status: "False"
    type: ApplyResources

Reason

Steps:

Configure the VolumeSnapshotClass by running the command below.

kubectl create -f - <<EOF
apiVersion: snapshot.storage.k8s.io/v1
kind: VolumeSnapshotClass
metadata:
  name: csi-aws-vsc
  annotations:
    snapshot.storage.kubernetes.io/is-default-class: "true"
driver: ebs.csi.aws.com
deletionPolicy: Delete
EOF

Delete the wrong backup (volumesnapshot is generated by backup) and volumesnapshot resources.

kubectl delete backup -l app.kubernetes.io/instance=mycluster -n demo

kubectl delete volumesnapshot -l app.kubernetes.io/instance=mycluster -n demo

Result

The horizontal scaling continues after the backup and volumesnapshot are deleted and the cluster restores to running status.