Restore a MongoDB Cluster from Backup

This guide demonstrates two methods to restore a MongoDB cluster from backup in KubeBlocks:

1. Cluster Annotation Method - Simple declarative approach using YAML annotations
2. OpsRequest API Method - Enhanced operational control with progress monitoring

Prerequisites

Before proceeding, ensure the following:

• Environment Setup:
  • A Kubernetes cluster is up and running.
  • The kubectl CLI tool is configured to communicate with your cluster.
  • KubeBlocks CLI and KubeBlocks Operator are installed. Follow the installation instructions here.
• Namespace Preparation: To keep resources isolated, create a dedicated namespace for this tutorial:

kubectl create ns demo
namespace/demo created

Preparing for Restoration: Locate one Full Backup

Before restoring, ensure that there is a full backup available. The restoration process will use this backup to create a new MongoDB cluster.

• Backup repository accessible from new cluster
• Valid full backup in Completed state
• Adequate CPU/memory resources
• Sufficient storage capacity

Find available full backups:

kubectl get backup -n demo -l dataprotection.kubeblocks.io/backup-type=Full,app.kubernetes.io/instance=mongo-cluster # get the list of full backups

Pick ONE of the Backups whose status is Completed.

Option 1: Cluster Annotation Restoration

Step 1: Create Restored Cluster

Create a new cluster with restore configuration:

Key parameters:

• kubeblocks.io/restore-from-backup annotation
• Backup name and namespace located from the previous steps

apiVersion: apps.kubeblocks.io/v1
kind: Cluster
metadata:
  name: mongo-cluster-restored
  namespace: demo
  annotations:
    # NOTE: replace <FULL_BACKUP_NAME> with your backup
    kubeblocks.io/restore-from-backup: '{"mongodb":{"name":"<FULL_BACKUP_NAME>","namespace":"demo","volumeRestorePolicy":"Parallel"}}'
spec:
  terminationPolicy: Delete
  clusterDef: mongodb
  topology: replicaset
  componentSpecs:
    - name: mongodb
      serviceVersion: "6.0.16"
      replicas: 3
      resources:
        limits:
          cpu: '0.5'
          memory: 0.5Gi
        requests:
          cpu: '0.5'
          memory: 0.5Gi
      volumeClaimTemplates:
        - name: data
          spec:
            storageClassName: ""
            accessModes:
              - ReadWriteOnce
            resources:
              requests:
                storage: 20Gi

Step 2: Monitor Restoration

Track restore progress with:

# Watch restore status
kubectl get restore -n demo -w

# Watch cluster status
kubectl get cluster -n demo -w

Option 2: OpsRequest API Restoration

Step 1: Initiate Restore Operation

Create restore request via OpsRequest API:

apiVersion: operations.kubeblocks.io/v1alpha1
kind: OpsRequest
metadata:
  name: mongo-cluster-restore
  namespace: demo
spec:
  clusterName: mongo-cluster-restored
  force: false
  restore:
    backupName: <FULL_BACKUP_NAME>
    backupNamespace: demo
  type: Restore

Step 2: Track Operation Progress

Monitor restore status:

# Watch restore status
kubectl get restore -n demo -w

# Watch cluster status
kubectl get cluster -n demo -w

Step 3: Validate Restored Cluster

Confirm successful restoration:

kubectl get cluster mongo-cluster-restored -n demo

Example Output:

NAME                    CLUSTER-DEFINITION   TERMINATION-POLICY   STATUS    AGE
mongo-cluster-restored  mongodb              Delete               Running   3m3s

Cleanup

To remove all created resources, delete the MongoDB cluster along with its namespace:

kubectl delete cluster mongo-cluster -n demo
kubectl delete cluster mongo-cluster-restored -n demo
kubectl delete ns demo

Summary

This guide covered two restoration methods:

1. Cluster Annotation - Simple YAML-based approach

   • Retrieve system credentials
   • Create cluster with restore annotation
   • Monitor progress

2. OpsRequest API - Enhanced operational control

   • Create restore request
   • Track operation status
   • Verify completion