Generate UUID/GUID

Follow the steps to generate a Universally Unique Identifier (UUID) for custom Continuous Integration/Continuous Deployment (CI/CD) integrations. A UUID is used to uniquely identify and link your custom integration within Propel.

Prerequisites

• Access to Propel API with a valid access token.

• A CI/CD integration (e.g., Jenkins) that you want to associate with a UUID.

Step 1: Create a CI/CD integration

We need to create a placeholder Custom integration that will be the container for the data. We recommend using Custom as the integration type. Go to Integrations under Settings, select the Custom integration, and click Install. Fill in the following details and Save the integration. This will automatically download the satellite.yml file with the <INTEGRATION_ID>.

Field	Description
Name	Add a name to the integration
Description	Add a description (optional)
Tags	Add tags if needed (optional)

Step 2: Generate a CI/CD Instance GUID associated with that integration

We need to generate a CI/CD instance GUID associated with that integration. This needs to be done with a request to the SEI API. Here is an example using a cURL command:

curl --location 'https://api.levelops.io/v1/cicd/instances' \
--header 'Authorization: API KEY <SEI_API_KEY>' \
--header 'Content-Type: application/json' \
--data '{
    "integration_id": "<INTEGRATION_ID>",
    "name": "Custom CICD Integration",
    "type": "jenkins",
}' 

Use the <INTEGRATION_ID> of the placeholder Custom integration created during Step 1. It can be found in the satellite.yml file. This will generate a GUID for the integration named Custom CI/CD Integration.

Please note that the Propel API endpoint URL mentioned in the command above is relative to the environment you are using. You will need to replace it with the actual URL that are specific to your environment.

Step 3: Integrate directly with the CI/CD Webhook API

You can directly integrate using webhooks as documented above. Make sure to provide the CI/CD instance GUID and name generated in the previous step.

Another option is to integrate using Propels, which allows you to run custom automated workflows directly in SEI. Continue to Step 4 to use this approach.

Step 4: Import a Propel from the Templates GitHub repository

SEI provides templates for using Propels, which can be imported from this GitHub repository. You can customize these templates to suit your specific CI/CD tool, such as Jenkins.

Step 5: Configure the Propel​

Once you have generated a GUID in step 2, make sure to update it in the Propel. This is required to identify and link your custom CI/CD integration.

Step 6: Automate the Propel to run on a schedule​

Edit the first node of the Propel to configure a schedule for automation tasks for your custom CI/CD integration. You can use automation to trigger CI/CD jobs, manage deployments, and monitor the integration's performance.