The CloudCasa agent Helm chart

To perform any backup or restore operations on a cluster, you first need to install and register a CloudCasa agent. Several methods are available for doing this. The default method is to use kubectl to apply a custom manifest file generated by CloudCasa, which contains all of the appropriate resources, including a unique ClusterID for each cluster being registered.

For customers who prefer to use Helm for installation, a CloudCasa agent Helm chart is also available. The agent Helm chart is published in our Helm repository, which is available at: https://catalogicsoftware.github.io/cloudcasa-helmchart/

Versions of our Helm chart are also used for agent installation through certain partner applications and marketplaces, including Rancher Apps and Marketplace and the DigitalOcean Marketplace. These partner charts have their own instructions for usage.

Installing the CloudCasa agent using Helm

  1. Log in to https://home.cloudcasa.io and add your Kubernetes cluster under the Protection tab. Note the returned cluster ID.

    See also

    For more information on configuring clusters see Overview of Clusters.

  2. Add the CloudCasa Helm repo to your Helm configuration if it hasn’t been added already.

    helm repo add cloudcasa-repo https://catalogicsoftware.github.io/cloudcasa-helmchart

  3. To install the agent, execute the following helm commands, replacing <Cluster ID> with the Cluster ID obtained above:

    helm repo update
helm install cloudcasa cloudcasa-repo/cloudcasa --set clusterID=<Cluster ID>

    This will install the CloudCasa agent and complete registration of the cluster with the CloudCasa service.

Using an alternate image repository

The agent manager container can be installed from an alternate repository by setting values for image.repository and image.tag. Add the options --set image.repository=<repository> and/or --set image.tag=<tag> to the helm install command.

Note that the alternate repository will also need to be set for the cluster in CloudCasa so that all agent containers will be loaded from it. This can be done using the Private container registry for agent field under Advanced options in the Add cluster dialog. See Adding a Cluster for more information.

If the registry you are using requires authentication, you can define a Kubernetes secret with the authentication information and reference it by setting a value for imagePullSecret. Example: --set imagePullSecret=registrySecret. See the Kubernetes Docs for more information. Note that the secret must be created in the cloudcasa-io namespace, so you may need to create the namespace first. Also note that when uninstalling the agent, you may need to delete the cloudcasa-io namespace manually after running helm uninstall with kubectl delete namespace cloudcasa-io.

Finally, the secret name will also need to be set in CloudCasa for the cluster, so that it will be used for all agent containers. This can be done using the Image pull secret field under Advanced options in the Add cluster dialog. See Adding a Cluster for more information.

Updating the CloudCasa agent using Helm

  1. Log in to https://home.cloudcasa.io and obtain the cluster ID for your cluster by selecting it under the Protection tab. You can also obtain the current setting for it with the command helm get values cloudcasa.

  2. Execute the following commands to update the agent, replacing <Cluster ID> with the Cluster ID obtained above:

    $ helm repo update
$ helm upgrade cloudcasa cloudcasa-repo/cloudcasa --set clusterID=<Cluster ID>

Uninstalling the CloudCasa agent using Helm

  1. Execute the following command to uninstall the agent:

    $ helm uninstall cloudcasa

  2. The agent creates some custom resource definitions on the cluster after installation. If you wish to remove these are well, use the command:

    $ kubectl delete crds -l component=kubeagent-backup-helper

If you have questions about accessing the Helm registry or using the Helm chart, contact CloudCasa support.