KubeBlocks
BlogsKubeBlocks Cloud
KubeBlocks for Pulsar

Cluster Management

Create
Scale
Expand volume
Restart
Stop/Start
Delete protection

Configuration

Configure cluster parameters
  1. Before you start
  2. Steps

Expand volume

You can expand the storage volume size of each pod.

Before you start

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

kubectl get cluster mycluster -n demo

kbcli cluster list mycluster -n demo

Steps

  1. Apply an OpsRequest. Change the value of storage according to your need and run the command below to expand the volume of a cluster.

    kubectl apply -f - <<EOF
apiVersion: apps.kubeblocks.io/v1alpha1
kind: OpsRequest
metadata:
  name: ops-volume-expand
  namespace: demo
spec:
  clusterRef: mycluster
  type: VolumeExpansion
  volumeExpansion:
  - componentName: bookies
    volumeClaimTemplates:
    - name: ledgers
      storage: "200Gi"
    - name: journal
      storage: "40Gi"      
EOF

  2. Validate the volume expansion operation.

    kubectl get ops -n demo
>
NAMESPACE   NAME                   TYPE              CLUSTER     STATUS    PROGRESS   AGE
demo        ops-volume-expansion   VolumeExpansion   mycluster   Succeed   3/3        6m

  3. Check whether the corresponding cluster resources change.

    kubectl describe cluster mycluster -n demo

  1. Change the value of spec.components.volumeClaimTemplates.spec.resources in the cluster YAML file.

    spec.components.volumeClaimTemplates.spec.resources is the storage resource information of the pod and changing this value triggers the volume expansion of a cluster.

    apiVersion: apps.kubeblocks.io/v1alpha1
kind: Cluster
metadata:
  name: mycluster
  namespace: demo
spec:
  clusterDefinitionRef: pulsar
  clusterVersionRef: pulsar-3.0.2
  componentSpecs:
  - name: pulsar
    componentDefRef: pulsar
    replicas: 1
    volumeClaimTemplates:
    - name: data
      spec:
        accessModes:
          - ReadWriteOnce
        resources:
          requests:
            storage: 40Gi # Change the volume storage size
  terminationPolicy: Delete

  2. Check whether the corresponding cluster resources change.

    kubectl describe cluster mycluster -n demo

  1. Configure the values of --components, --volume-claim-templates, and --storage, and run the command below to expand the volume.

    NOTE

    Expand volume for journal first. ledger volume expansion must be performed after the journal volume expansion.

    • Expand volume for journal.

      kbcli cluster volume-expand mycluster --storage=40Gi --components=bookies -t journal -n demo
      • --components describes the component name for volume expansion.
      • --volume-claim-templates describes the VolumeClaimTemplate names in components.
      • --storage describes the volume storage size.

    • Expand volume for ledger.

      kbcli cluster volume-expand mycluster --storage=200Gi --components=bookies -t ledgers -n demo

  2. Validate the volume expansion operation.

    • View the OpsRequest progress.

      KubeBlocks outputs a command automatically for you to view the details of the OpsRequest progress. The output includes the status of this OpsRequest and PVC. When the status is Succeed, this OpsRequest is completed.

      kbcli cluster describe-ops mycluster-volumeexpansion-njd9n -n demo

    • View the cluster status.

      kbcli cluster list mycluster -n demo
      • STATUS=Updating: it means the volume expansion is in progress.
      • STATUS=Running: it means the volume expansion operation has been applied.

  3. After the OpsRequest status is Succeed or the cluster status is Running again, check whether the corresponding resources change.

    kbcli cluster describe mycluster -n demo

© 2025 ApeCloud PTE. Ltd.