2. Pair Clusters

Pairing clusters

In order to failover an application running on one Kubernetes cluster to another Kubernetes cluster, we need to migrate the resources between them. On Kubernetes you will define a trust object required to communicate with the other Kubernetes cluster called a ClusterPair. This creates a pairing between the scheduler (Kubernetes) so that all the Kubernetes resources can be migrated between them. Throughout this section, the notion of source and destination clusters apply only at the Kubernetes level and does not apply to Storage, as you have a single Portworx storage fabric running on both the clusters. As Portworx is stretched across them, the volumes do not need to be migrated.

For reference,

  • Source Cluster is the Kubernetes cluster where your applications are running
  • Destination Cluster is the Kubernetes cluster where the applications will be failed over, in case of a disaster in the source cluster.

Generate and Apply ClusterPair Spec

In Kubernetes you will define a trust object called ClusterPair. This object is required to communicate with the destination cluster. In a nutshell, it creates a pairing with the storage driver (Portworx) as well as the scheduler (Kubernetes) so that the volumes and resources can be migrated between clusters. It is generated and used in the following way:

  • The ClusterPair spec is generated on the destination cluster.
  • The generated spec is then applied on the source cluster

Generate ClusterPair on the destination cluster

To generate the ClusterPair spec, run the following command on the destination cluster:

storkctl generate clusterpair -n migrationnamespace remotecluster

Here, the name (remotecluster) is the Kubernetes object that will be created on the source cluster representing the pair relationship.

During the actual migration, you will reference this name to identify the destination of your migration.

apiVersion: stork.libopenstorage.org/v1alpha1
kind: ClusterPair
    creationTimestamp: null
    name: remotecluster
    namespace: migrationnamespace
            LocationOfOrigin: /etc/kubernetes/admin.conf
            certificate-authority-data: <CA_DATA>
            LocationOfOrigin: /etc/kubernetes/admin.conf
            cluster: kubernetes
            user: kubernetes-admin
      current-context: kubernetes-admin@kubernetes
      preferences: {}
            LocationOfOrigin: /etc/kubernetes/admin.conf
            client-certificate-data: <CLIENT_CERT_DATA>
            client-key-data: <CLIENT_KEY_DATA>
       <insert_storage_options_here>: ""
       mode: DisasterRecovery
  remoteStorageId: ""
  schedulerStatus: ""
  storageStatus: ""

In the generated ClusterPair spec, you will need to do the following modifications:

  • You will see an unpopulated options section. It expects options that are required to pair Storage. However, as we have a single storage fabric, this section is not needed. You should delete the line <insert_storage_options_here>.
  • Under the options section, the mode is set to DisasterRecovery, this is required for scheduling periodic migrations. More information about it in the next step.

Once the modifications are done, save it into a file clusterpair.yaml

Apply the generated ClusterPair on the source cluster

On the source cluster create the clusterpair by applying the generated spec.

kubectl create -f clusterpair.yaml

Verify the Pair status

Once you apply the above spec on the source cluster you should be able to check the status of the pairing using storkctl on the source cluster.

storkctl get clusterpair
remotecluster      NotProvided      Ready              09 Apr 19 18:16 PDT

So, on a successful pairing you should see the “Scheduler Status” as “Ready” and the “Storage Status” as “Not Provided”

Once the pairing is configured, applications can now failover from one cluster to another. In order to achieve that, we need to migrate the Kubernetes resources to the destination cluster. The next step will help your synchronize the Kubernetes resources between your clusters.

Last edited: Wednesday, Jul 10, 2019