Installation Using the OpenShift Operator

A Red Hat certified OpenShift operator is available for installing and updating the CloudCasa agent. This operator works for both the SaaS and self-hosted versions of CloudCasa.

Installing the CloudCasa OpenShift operator

  1. Configure your cluster in CloudCasa, if it hasn’t been configured there already. Obtain the CloudCasa cluster ID.

    See also

    Adding a Cluster

  2. Go to OperatorHub and search for CloudCasa. Select the entry for “CloudCasa Operator”.

  3. On the CloudCasa Operator page, click install. If you want to choose a specific operator version, you can select it in the version drop-down. The latest version is the default choice.

  4. In the following screen, you can alter the namespace where the operator will be installed. Note that this is different from the namespace where the CloudCasa agent will be installed. You will also have to manually approve the install plan.

  5. After waiting a few minutes, the CloudCasa Operator should be listed as ready in the Installed Operators tab.

Installing the CloudCasa agent using the OpenShift operator

  1. Go to Installed Operators -> CloudCasa Operator.

  2. Click on the CloudCasa tab, then click Create CloudCasa.

  3. You must enter a Name (e.g. “cloudcasa”) and the CloudCasa Cluster ID obtained in the first step above.

  4. After a few minutes, the CloudCasa Agent will be installed and will register itself with the CloudCasa service. In the CloudCasa UI, the status of the cluster should change to “Active”.

Note: By default the Openshift operator will install the CloudCasa agent containers from Red Hat’s container repository at registry.connect.redhat.com. Red Hat now requires authentication to access this repository, so your OpenShift cluster should be configured to access it. This can be done by adding credentials for registry.connect.redhat.com to the cluster’s global pull secret using the command oc set data secret/pull-secret.

See also

For more information see Red Hat’s documentation Updating the global cluster pull secret.

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.

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. 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 the 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.

Configuring the agent for use with self-hosted CloudCasa

When installing the agent for use with self-hosted CloudCasa, you must configure the correct image repository and tag for the self-hosted agent containers as described above. You must also set the server.address option to point to your CloudCasa server. See the CloudCasa Self-hosted Administrator’s Guide or contact your administrator for more information.

Updating the CloudCasa agent using the operator

The operator will automatically update when an update is available on the server:

SaaS: when a new version is released. Self-hosted: when the server administrator updates the images.openshift tags to point to the new image versions.

Uninstalling the CloudCasa agent and operator

To uninstall the CloudCasa agent, go to the Installed Operators -> Operator Details page for the CloudCasa Operator. Click on the side (3-dots) menu next to the name you chose (e.g. cloudcasa) for the agent, and select Delete CloudCasa.

To uninstall the CloudCasa operator, go to the Installed Operators tab. Click on the side (3-dots) menu next to the CloudCasa Operator entry and select Uninstall Operator.

If you have questions about installing or using the CloudCasa OpenShift operator, contact CloudCasa support.