CircleCI

CircleCI lets teams build fully-automated pipelines, from testing to deployment.

Use the SEI CircleCI integration to integrate SEI with CircleCI.

Requirements

To use the CircleCI integration, you need a CircleCI Personal API token. Copy the token somewhere that you can retrieve it when you configure the integration. For instructions, go to the CircleCI documentation on Creating a personal API token.

Configure the integration

Cloud

1. Select Integrations under Data Settings.

2. Select Available Integrations, locate the CircleCI integration, and select Install.

3. Select the type of your CircleCI account as Cloud.

1. Configure and save the integration.

   • URL: Enter the URL for your CircleCI platform.

   • Authorization Token: Enter your CircleCI personal API token.
   • Repositories: You can specify repositories to associate with the integration. If unspecified, the integration associates all available repositories.

   • Fetch Action Logs: Select this option if you want SEI to ingest action logs from CircleCI.

   • Name: Enter a name for the integration.

   • Description, Tags, and Timezone are optional.

1. Click on Validate Connection to run the pre-flight checks and validate the connection. Once successful, you'll have the integration set up under the Your Integrations tab.

On-Prem

The steps for configuring the integration using Satellite is similar to configuring the integration on cloud, with the exception of using the Ingestion Satellite to communicate with the Circle CI server.

1. Select Integrations under Data Settings.

2. Select Available Integrations, locate the CircleCI integration, and select Install.

3. Select the type of your CircleCI account as On-Prem.

1. Add the integration details and download the satellite.yaml file:

   • URL: Enter the URL for your CircleCI platform.

   • Authorization Token: Enter your CircleCI personal API token.
   • Repositories: You can specify repositories to associate with the integration. If unspecified, the integration associates all available repositories.

   • Fetch Action Logs: Select this option if you want SEI to ingest action logs from CircleCI.

   • Name: Enter a name for the integration.

   • Description, Tags, and Timezone are optional.

   • Click on the Download YAML File button and update it following the instructions here.

If you experience any issues while configuring the integration using the Ingestion Satellite, refer to the Ingestion Satellite Troubleshooting and FAQs.

Here’s a sample satellite.yml file:

satellite:
  tenant: <ACCOUNT_NAME>
  api_key: <SEI_API_KEY>
  url: 'https://staging.propelo.ai'
integrations:
  - id: '<INTEGRATION_ID>'
    application: circleci
    url: '<CIRCLECI_APP_URL>'
    apikey: <CIRCLECI_API_KEY>
    metadata:
      repos: <REPOSITORY>
      fetch_action_logs: true
      timezone: 'GMT-12:00'
      is_push_based: false