Skip to Content

Control-M for CircleCI

The CircleCI CI/CD platform automates software development build, test, and deployment processes.

Control-M for CircleCI enables you to do the following:

  • Execute one or more of the following CircleCI job actions:

    • Launch CircleCI pipelines.
    • Re-run CircleCI workflows.
    • Retrieve CircleCI workflow definitions for review.* Manage CircleCI credentials in a secure connection profile.
  • Integrate CircleCI jobs with other Control-M jobs into a single scheduling environment.
  • Introduce all Control-M capabilities to Control-M for CircleCI, including advanced scheduling criteria, complex dependencies, Resource Pools, Lock Resources, and variables.
  • Monitor the job status, results, and output of CircleCI jobs in the Monitoring domain.
  • Attach an SLA job to a CircleCI job.

Control-M for CircleCI is supported on Helix Control-M and Control-M Automation API, but not on the Control-M client.

To download the required installation files for each prerequisite, see Obtaining-Control-M-Installation-Files.

Setting up Control-M for CircleCI

This procedure describes how to deploy the CircleCI plug-in, create a connection profile, and define a CircleCI job in Helix Control-M and Automation API.

Before You Begin

  • Verify that Automation API is installed, as described in Automation API Installation.
  • Verify that Agent version 9.0.21.080 or later is installed.

Begin

  1. On the Agent host, set the Java environment variable by running one of the following commands through a command line:
    • Linux:
      • Bourne shell/bash: export BMC_INST_JAVA_HOME=<java_11_directory>
      • csh/tcsh: setenv BMC_INST_JAVA_HOME <java_11_directory>
    • Windows: set BMC_INST_JAVA_HOME="<java_11_directory>"
  2. Run one of the following API commands:
    • For a fresh installation, use the provision image command:
      • Linux: ctm provision image CircleCI_plugin.Linux
      • Windows: ctm provision image CircleCI_plugin.Windows
    • For an upgrade, use the following command:
      ctm provision agent::update
  3. Create a CircleCI connection profile in Helix Control-M or Automation API, as follows:
  4. Define a CircleCI job in Helix Control-M or Automation API, as follows:
Warning

Note

To remove this plug-in from an Agent, see in Removing a Plug-in. The plug-in ID is CCI012025.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

Control-M