Deploying Agents Using a Helm Chart

This procedure describes how to deploy Control-M/Agents in a Kubernetes cluster by adding the BMC-provided Helm chart repository for the Control-M/Agent to your Kubernetes environment and then installing the provided Helm chart.

Begin

1. Add a repository named controlm to contain the Helm charts of the Control-M/Agent that is obtained from the Control-M Repository by running the following command:
   helm repo add controlm https://controlm-charts.s3.us-west-2.amazonaws.com/ 

   Note

   If you do not have Internet access from the machine where you plan to run the Helm installation, do the following:

   1. On a machine with Internet access, use the following URL to obtain a compressed TGZ file of the Helm chart:
      https://controlm-charts.s3.us-west-2.amazonaws.com/helix-controlm-agent-9.21.310.tgz
   2. Copy the TGZ file to the machine where you plan to run the Helm installation.
   3. Skip to step 5, and in the Helm command, specify the path to the helix-controlm-agent-9.21.310.tgz file instead of controlm/helix-controlm-agent (the path to the chart in the repository).
2. Ensure that the controlm repository is listed as one of your repositories by running the following command:
   helm repo list
3. List the charts within the new controlm repository by running the following command:
   helm search repo controlm
   The chart for installation of the Helix Control-M/Agent is named helix-controlm-agent.
4. Work with your Control-M Administrator to obtain the name of your Control-M/Server.

5. Run the helm install command with the parameter values that you want to set, as described in Helm-Installation-Parameters

   helm install <releaseName> controlm/helix-controlm-agent --version 9.21.310 \
   --set server.name=IN01 --set api.endpoint=https://controlm-tenant-aapi.us2.controlm.com/automation-api \
   --set api.token=b25QcmVuOjc0Z6E4MGWyLTQ2ZjYtNDFkYS06NWQzLWNiNTQ4ZjIwODMzWg== \
   --set agent.tag=Admin --set pvc.storageClass=efs-sc

   Where:

   • <releaseName> is a name for this installation instance.
     The name can contain up to 53 characters. Supported characters are lowercase letters, numeric characters, and the hyphen and period characters. Ensure that the first and last characters are alphanumeric.
   • --version switch ensures that you use the proper version of the Helm chart from the Control-M Repository.
   • --set switch is used with string-type parameters. For array-type or object-type parameters, use the --set-json switch.

   For more examples for various use cases, see Agent-Deployment-Scenarios.

Before deployment starts, requirements are verified, including whether the Agent image version matches the Helm chart version. If you receive an error, see Troubleshooting-and-Messages.