Control-M for CircleCI

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

  • Connect to any CircleCI endpoint.

  • Introduce all Control-M capabilities to Control-M for CircleCI, including advanced scheduling criteria, complex dependencies, Resource Pools, Lock Resources, and variables.

  • Integrate CircleCI jobs with other Control-M jobs into a single scheduling environment.

  • Monitor the status, results, and output of CircleCI jobs.

  • Attach an SLA job to the CircleCI jobs.

Control-M for CircleCI Compatibility

The following table lists the prerequisites that are required to use the CircleCI plug-in, each with its minimum required version.

Component

Version

Control-M/EM

9.0.21.300

Control-M/Agent

9.0.21.300

Control-M Application Integrator

9.0.21.300

Control-M Automation API

9.0.21.300

Control-M for CircleCI is supported on Control-M Web 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 Control-M Web and Automation API.

Integration plug-ins released by BMC require an Application Integrator installation. However, these plug-ins are not editable and you cannot import them into Application Integrator. To deploy these integrations to your Control-M environment, import them directly into Control-M with Control-M Automation API.

Before You Begin

Verify that Automation API is installed, as described in Automation API Installation.

Begin

  1. Create a temporary directory to save the downloaded files.

  2. Download the CircleCI plug-in from the Control-M for CircleCI download page in the EPD site.

  3. Install the CircleCI plug-in with the Automation API Provision service:

    1. Log in to the Control-M/EM Server machine as an Administrator and store the downloaded zip file in the one of the following locations:

      • Linux: $HOME/ctm_em/AUTO_DEPLOY

      • Windows: <EM_HOME>\AUTO_DEPLOY

    2. Log in to the Control-M/Agent machine and run the provision image command, as follows:

      • Linux: ctm provision image CircleCI_plugin.Linux

      • Windows: ctm provision image CircleCI_plugin.Windows

  4. Create a CircleCI connection profile in Control-M Web or Automation API, as follows:

  5. Define a CircleCI job in Control-M Web or Automation API, as follows:

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

Change Log

The following table provides details about changes that were introduced in new versions of this plug-in:

Plug-in Version

Details

1.0.00

Initial version