Restore a Cluster from Cloud Storage with Hazelcast Platform Operator

Learn how to back up data in Hazelcast maps to cloud storage and restore a cluster from that backup data.

Context

In this tutorial, you’ll do the following:

  • Deploy Hazelcast with persistence enabled.

  • Create a Hazelcast map that has persistence enabled.

  • Back up all map entries to external storage in the cloud.

  • Restart the Hazelcast cluster and restore the backup map entries from the cloud.

Before you Begin

Before starting this tutorial, make sure that you meet the following prerequisites:

Step 1. Start the Hazelcast Cluster

To access all examples, clone the following repository:

git clone https://github.com/hazelcast-guides/hazelcast-platform-operator-external-backup-restore.git
cd hazelcast-platform-operator-external-backup-restore

You can find examples under the clients directory.

  1. Create a license secret

    Create a secret with your Hazelcast Enterprise License.

    kubectl create secret generic hazelcast-license-key --from-literal=license-key=<hz-license-key>
  2. Create the Hazelcast Cluster

    Run the following command to create the Hazelcast cluster with Persistence enabled using External type.

    cat <<EOF | kubectl apply -f -
    apiVersion: hazelcast.com/v1alpha1
    kind: Hazelcast
    metadata:
      name: my-hazelcast
    spec:
      clusterSize: 3
      licenseKeySecret: hazelcast-license-key
      persistence:
        baseDir: "/data/hot-restart/"
        clusterDataRecoveryPolicy: "FullRecoveryOnly"
        pvc:
          accessModes: ["ReadWriteOnce"]
          requestStorage: 8Gi
      agent:
        repository: hazelcast/platform-operator-agent
      exposeExternally:
        type: Smart
        discoveryServiceType: LoadBalancer
        memberAccess: NodePortExternalIP
    EOF
    The agent configuration is optional. If you do not pass the agent configuration, the operator directly use the latest stable version of the agent.
  3. Check the Cluster Status

    Run the following commands to see the cluster status

    $ kubectl get hazelcast my-hazelcast
    NAME           STATUS    MEMBERS
    my-hazelcast   Running   3/3
    $ kubectl get pods -l app.kubernetes.io/instance=my-hazelcast
    
    NAME             READY   STATUS    RESTARTS   AGE
    my-hazelcast-0   2/2     Running   0          3m43s
    my-hazelcast-1   2/2     Running   0          3m16s
    my-hazelcast-2   2/2     Running   0          2m50s

    As you can see from the pod states, when backup is used, the Backup Agent container will be deployed with the Hazelcast container in the same Pod. The agent is responsible for backing data up into the external storage.

  4. Get the Address of the Hazelcast Cluster

    After verifying that the cluster is Running and all the members are ready, run the following command to find the discovery and member addresses.

    $ kubectl get hazelcastendpoint --selector="app.kubernetes.io/instance=my-hazelcast"
    NAME                 TYPE        ADDRESS
    my-hazelcast         Discovery   35.232.180.22:5701
    my-hazelcast-0       Member      34.31.31.174:30393
    my-hazelcast-0-wan   WAN         34.31.31.174:30483
    my-hazelcast-1       Member      34.134.146.100:30894
    my-hazelcast-1-wan   WAN         34.134.146.100:31597
    my-hazelcast-2       Member      34.72.7.175:30606
    my-hazelcast-2-wan   WAN         34.72.7.175:31121
    my-hazelcast-wan     WAN         35.232.180.22:5710

    The ADDRESS column displays the external address of your Hazelcast cluster.

Step 2. Create Persistent Map and Put Data

  1. Create Persistent Map

    Run the following command to create the Map resource with Persistence enabled.

    cat <<EOF | kubectl apply -f -
    apiVersion: hazelcast.com/v1alpha1
    kind: Map
    metadata:
      name: persistent-map
    spec:
      hazelcastResourceName: my-hazelcast
      persistenceEnabled: true
    EOF
  2. Configure the Hazelcast client to connect to the cluster.

    • CLC

    • Java

    • NodeJS

    • Go

    • Python

    • .NET

    Before using CLC, it should be installed in your system. Check the installation instructions for CLC: Installing the Hazelcast CLC.

    Run the following command for adding the cluster config to the CLC.

    clc config add hz cluster.name=dev cluster.address=<EXTERNAL-IP>
    ClientConfig config = new ClientConfig();
    config.getNetworkConfig().addAddress("<EXTERNAL-IP>");
    const { Client } = require('hazelcast-client');
    
    const clientConfig = {
        network: {
            clusterMembers: [
                '<EXTERNAL-IP>'
            ]
        }
    };
    const client = await Client.newHazelcastClient(clientConfig);
    import (
    	"log"
    
    	"github.com/hazelcast/hazelcast-go-client"
    )
    
    func main() {
    	config := hazelcast.Config{}
    	cc := &config.Cluster
    	cc.Network.SetAddresses("<EXTERNAL-IP>")
    	ctx := context.TODO()
    	client, err := hazelcast.StartNewClientWithConfig(ctx, config)
    	if err != nil {
    		panic(err)
    	}
    }
    import logging
    import hazelcast
    
    logging.basicConfig(level=logging.INFO)
    
    client = hazelcast.HazelcastClient(
        cluster_members=["<EXTERNAL-IP>"],
        use_public_ip=True,
    )
    var options = new HazelcastOptionsBuilder()
        .With(args)
        .With((configuration, options) =>
        {
            options.LoggerFactory.Creator = () => LoggerFactory.Create(loggingBuilder =>
                loggingBuilder
                    .AddConfiguration(configuration.GetSection("logging"))
                    .AddConsole());
    
            options.Networking.Addresses.Add("<EXTERNAL-IP>:5701");
            options.Networking.UsePublicAddresses = true;
    
        })
        .Build();
  3. Start the client to fill the map.

    • CLC

    • Java

    • NodeJS

    • Go

    • Python

    • .NET

    Run the following command to fill a map.

    for i in {1..10};
    do
       clc -c hz map set --name persistent-map key-$i value-$i;
    done

    Run the following command to check the map size.

    clc -c hz map size --name persistent-map
    cd clients/java
    mvn package
    java -jar target/*jar-with-dependencies*.jar fill

    You should see the following output.

    Successful connection!
    Starting to fill the map with random entries.
    Current map size: 2
    Current map size: 3
    Current map size: 4
    ....
    ....
    cd clients/nodejs
    npm install
    npm start fill

    You should see the following output.

    Successful connection!
    Starting to fill the map with random entries.
    Current map size: 2
    Current map size: 3
    Current map size: 4
    ....
    ....
    cd clients/go
    go run main.go fill

    You should see the following output.

    Successful connection!
    Starting to fill the map with random entries.
    Current map size: 2
    Current map size: 3
    Current map size: 4
    ....
    ....
    cd clients/python
    pip install -r requirements.txt
    python main.py fill

    You should see the following output.

    Successful connection!
    Starting to fill the map with random entries.
    Current map size: 2
    Current map size: 3
    Current map size: 4
    ....
    ....
    cd clients/dotnet
    dotnet build
    dotnet run fill
    Successful connection!
    Starting to fill the map with random entries.
    Current map size: 2
    Current map size: 3
    Current map size: 4
    ....
    ....

Step 3. Trigger External Backup

For triggering backup, you need bucketURI where backup data will be stored in and secret with credentials for accessing the given Bucket URI.

  1. Create Secret

    Run one of the following command to create the secret according to the cloud provider you want to backup.

    • AWS

    • GCP

    • Azure

    kubectl create secret generic <secret-name> --from-literal=region=<region> \
    	--from-literal=access-key-id=<access-key-id> \
    	--from-literal=secret-access-key=<secret-access-key>
    kubectl create secret generic <secret-name> --from-file=google-credentials-path=<service_account_json_file>
    kubectl create secret generic <secret-name> \
    	--from-literal=storage-account=<storage-account> \
    	--from-literal=storage-key=<storage-key>
  2. Trigger Backup

    Run the following command to trigger backup

    cat <<EOF | kubectl apply -f -
    apiVersion: hazelcast.com/v1alpha1
    kind: HotBackup
    metadata:
      name: hot-backup
    spec:
      hazelcastResourceName: my-hazelcast
      bucketURI: "<bucketURI>"
      secret: <secret-name>
    EOF

    Example URI → "s3://operator-backup?prefix=hazelcast/2022-06-08-17-01-20/"

  3. Check the Status of the Backup

    Run the following command to check the status of the backup

    kubectl get hotbackup hot-backup

    The status of the backup is displayed in the output.

    NAME         STATUS
    hot-backup   Success

Step 4. Restore from External Backup

  1. Delete the Hazelcast Cluster

    Run the following command to delete the Hazelcast cluster

    kubectl delete hazelcast my-hazelcast
  2. Create new Hazelcast Cluster

    For restoring you will use the HotBackup resource you have created.

    Run the following command to create the Hazelcast cluster. Before the Hazelcast cluster is started, the operator starts the Restore Agent(InitContainer) which restores the backup data.

    cat <<EOF | kubectl apply -f -
    apiVersion: hazelcast.com/v1alpha1
    kind: Hazelcast
    metadata:
      name: my-hazelcast
    spec:
      clusterSize: 3
      licenseKeySecret: hazelcast-license-key
      persistence:
        baseDir: "/data/hot-restart/"
        clusterDataRecoveryPolicy: "FullRecoveryOnly"
        pvc:
          accessModes: ["ReadWriteOnce"]
          requestStorage: 8Gi
        restore:
          hotBackupResourceName: hot-backup
      exposeExternally:
        type: Smart
        discoveryServiceType: LoadBalancer
        memberAccess: NodePortExternalIP
    EOF

    As you may see, the agent configuration is not set. Thus, the operator directly use the latest stable version of the agent.

  3. Check the Cluster Status

    Run the following commands to see the cluster status

    $ kubectl get hazelcast my-hazelcast
    NAME           STATUS    MEMBERS
    my-hazelcast   Running   3/3

    After verifying that the cluster is Running and all the members are ready, run the following command to find the discovery and member addresses.

    $ kubectl get hazelcastendpoint --selector="app.kubernetes.io/instance=my-hazelcast"
    NAME                 TYPE        ADDRESS
    my-hazelcast         Discovery   35.232.180.22:5701
    my-hazelcast-0       Member      34.31.31.174:30393
    my-hazelcast-0-wan   WAN         34.31.31.174:30483
    my-hazelcast-1       Member      34.134.146.100:30894
    my-hazelcast-1-wan   WAN         34.134.146.100:31597
    my-hazelcast-2       Member      34.72.7.175:30606
    my-hazelcast-2-wan   WAN         34.72.7.175:31121
    my-hazelcast-wan     WAN         35.232.180.22:5710

    Since we recreate the Hazelcast cluster, services are also recreated. The ADDRESS may change.

  4. Check the Map Size

    Configure the Hazelcast client to connect to the cluster external address as you did in Configure the Hazelcast Client.

    Start the client to check the map size and see if the restore is successful.

    • CLC

    • Java

    • NodeJS

    • Go

    • Python

    • .NET

    clc -c hz map size --name persistent-map
    cd clients/java
    mvn package
    java -jar target/*jar-with-dependencies*.jar size

    You should see the following output.

    Successful connection!
    Current map size: 12
    cd clients/nodejs
    npm install
    npm start size

    You should see the following output.

    Successful connection!
    Current map size: 12
    cd clients/go
    go run main.go size

    You should see the following output.

    Successful connection!
    Current map size: 12
    cd clients/python
    pip install -r requirements.txt
    python main.py size

    You should see the following output.

    Successful connection!
    Current map size: 12
    cd clients/dotnet
    dotnet run size

    You should see the following output.

    Successful connection!
    Current map size: 12

Clean Up

To clean up the created resources remove the all Custom Resources and PVCs.

kubectl delete secret <secret-name>
kubectl delete secret hazelcast-license-key
kubectl delete $(kubectl get hazelcast,hotbackup,map -o name)
kubectl delete pvc -l "app.kubernetes.io/managed-by=hazelcast-platform-operator"