Cluster Replication Wizard

The Cluster Replication Wizard allows you to create and edit Kubernetes replication jobs. Replication jobs allow you to replicate an entire cluster or part of a cluster on a continuing periodic basis. Typically, they might be used for maintaining a DR or hot standby cluster, or for periodically creating a dev/test replica of a production cluster.

The wizard consists of several steps, not all of which will appear in all cases. You can jump back and forth between steps by clicking on the step names on the left-hand side of the wizard.

Defining a Kubernetes replication job

  1. In the Cluster step of the wizard you must select the replication source from the list of active clusters. Note that depending on how you reached the wizard, the source cluster may already be selected for you. In that case, the wizard will open on the next step. After choosing a cluster, click Next.

  2. In the Selections step, you choose exactly what will be copied to the destination cluster using the following options:


    Select either Full Cluster or Select Namespaces. Choosing Select Namespaces will prompt you to select the specific namespaces to include in the copy operation. Choosing Full Cluster (the default) will include all namespaces. Choosing Full Cluster and then Exclude namespaces will allow you to exclude specific namespaces.

    Advanced Options

    Opening the Advanced options section will allow you to set the following options:

    Select resource types (optional)

    Allows you to copy only specific Kubernetes resources types.

    Select labels (optional)

    Enter key-value pairs to specify the labels for the objects that you wish to copy in the cluster.


    If you enter multiple label selectors separated by spaces in the Select Labels field, the relationship between them is assumed to be logical AND. So if you enter a:b c:d, it means that a must equal b AND c must equal d in order for the selector to match.

    CloudCasa will also allow you to enter a single key with multiple comma-separated values, and the relationship between these is assumed to be logical OR. So entering a:b,c means that a must equal b OR c. These can be combined, so entering a:b,c x:y means that a must equal b OR c AND x must equal y. That’s equivalent to (a == b || a == c) && x == y for you C lovers out there. Note that OR is not currently possible between different keys.

    Destination storage for copy

    This allows you to select the temporary object storage used during replication. Choose one of the following options:

    • Inherit from cluster preferences - Use the default storage destination for the cluster.

    • CloudCasa Storage - Use CloudCasa Storage. Select the cloud provider and region.

    • User-provided Storage - Select one of the user-defined object storage endpoints that you registered in the Storage page.

    Concurrent streams

    Select the number of data transfer streams to use between your cluster and the destination storage during the replication job. The allowed range is between 1 and 16 streams. The default is 2 streams.

    Max speed per stream

    Specify the maximum bandwidth for the data transfer between your cluster and the destination storage during the replication job in MB per second. Leave this field blank so as not to limit the bandwidth. The default value is blank for “Unlimited”.

    Data mover pod timeout

    Time that the agent waits for the data mover pod to start once snapshot PVCs are bound. This should only need to be changed in special cases.

    Copy from live Longhorn PVs

    By default CloudCasa replication jobs read from snapshots, but mounting a Longhorn snapshot can take a long time due to Longhorn’s copy activity. If you enable this option, CloudCasa will read directly from the live Longhorn PVs instead, making the job run faster and use less resources at the expense of crash consistency. When enabling this option, you should consider using app hooks in order to obtain an application consistent copy.

    Exclude unattached PVCs

    By default, CloudCasa will include unattached PVCs in the copy operation. Enabling this options will cause unattached PVCs to be excluded from the copy. Be aware that there is currently no option to restore unattached PVCs to the replication target.

    Enable storage class mapping for PV snapshots mounted during backup

    This option allows you to use different storage classes when PV snapshots are mounted for copying the data off during replication operations. This may be useful, for example, to indicate to your storage system that less replicas or different parameters should be used for these transient volumes than for normal production volumes. By default, the storage class of the original source volume will be used.

    Note: You must specify a storage class that uses the same CSI driver as that used by the original storage class in order for mounting of snapshots to succeed. The new storage class should only differ in parameters such as number of replicas.

    CSI snapshot timeout

    The amount of time the agent will wait for a PV snapshot to become ready when mounting. The default is 10 minutes, which should be adequate for most applications. PVs using certain storage systems such as Longhorn may require this to be increased.

  3. In the Destination step, select the destination cluster for the replication job. You can choose a pre-existing cluster, or you can choose to create a new EKS, AKS, or GKE cluster in a registered cloud account. If you choose an existing clusters, you must select specific namespaces for replication. These namespaces will be deleted and re-created on the destination cluster with each run on the replication job. If you choose to create a new cluster, the entire new cluster will be deleted and re-created with each run of the replication job.

    See also

    For more information about cluster creation, see Creating Clusters With CloudCasa.

  4. In the Restore Transforms step, you can choose transformations that will be applied on the destination cluster. These include:

    Rename Namespaces

    Enabling this option will allow you to rename replicated namespaces by either adding a prefix and/or suffix, or applying a mapping.

    Add prefix/postfix

    Add a prefix or postfix to the replicated namespace(s). For example, if there were namespaces “sales” and “services” in the source cluster and you add a suffix, “-dev”, to the namespaces, the replication job will create the namespaces “sales-dev” and “services-dev” in the destination cluster.

    Set new names

    This allows you to create a set of mappings from old namespace names to new namespace names. Names left unmapped will be replicated unchanged.

    Change Storage Classes

    Gives you the option to remap storage classes on the destination cluster. When selected, the UI will display the storage classes used by PVs/PVCs on the source cluster, and allow you to enter new storage classes to substitute for each on the destination cluster. By default, the same storage classes will be used.

    Make sure that a destination storage class is compatible with the source storage class with regards to properties such as supported access modes.

    Preserve node ports

    If selected, automatically assigned node ports for services in the source cluster will be preserved in the destination cluster. Make sure that these ports are available in the destination cluster.

    Note that manually assigned node ports are not affected by this option and are always preserved.

  5. In the Policy step, you can choose a policy for the replication job. Policies define the schedules under which jobs will run. You can see your policies under Configuration/Policies. If you need to define a new policy, you can click Add policy + at the top right. If you don’t select a policy, your replication job won’t be scheduled automatically, but can be run manually on an ad-hoc basis. Note that the retention and SafeLock fields in a policy definition will be ignored for replication jobs.

    Click Next to proceed.

    See also

    For more information about policies, see Policies.

  6. In the App Hooks step you can choose to add source cluster pre and post-replication application hooks, and destination cluster post-replication application hooks.

    See also

    For more information about App Hooks, see App Hooks.

  7. Review the Summary of the replication job settings to verify that they are correct. In this step you must also enter the following:

    Replication name

    You must assign a name for the replication job.

    By default, new replication jobs will be run immediately. You can toggle off the Run now option if you would rather simply save the job and run it later.

    When you’re done, click Save or Save & Run.

Your new replication job is defined! If you selected the “Run now” option, it will start to execute immediately. If not, you can run it manually later from the Cluster/Replication page or the cluster dashboard.