Octopus Deploy Integration

OpsLevel’s deploy integration lets you capture information about services’ deploys from your CI/CD systems.

This native Octopus Deploy integration makes it even easier to get started with OpsLevel and keep track of the deploy info coming from your Octopus Deploy instance. You can track deploys as well as fully customize what deploy data is sent from the community step.

This integration leverages our OpsLevel CLI to perform deploy event submission. You can read more about how it works on our GitHub repository and even download the CLI and test it out locally yourself.

We have written 2 version of the Octopus Deploy community step to support both Windows and Linux runner environments. Please make sure you install the correct Community Step for the Octopus runner type you are using.

Add an Octopus Deploy Integration

1. In the OpsLevel app, Click Integrations in the left sidebar.
2. Click on the + New Integration button.
3. Add the Octopus Deploy Integration.

Install the OpsLevel Community Step

1. From your Octopus instance, navigate to Library (requires admin permissions).
2. From the sidebar, navigate to Step Templates.
3. Press Browse Library.
4. Search for OpsLevel.
5. Click on the box to install the correct OpsLevel community step. Note: Octopus Deploy supports both Windows and Linux step runners. Select the correct community step depending on the runner you are using.

Add a Variable Set for OpsLevel

1. From your Octopus instance, navigate to Library (requires admin permissions).
2. From the sidebar, navigate to Variable Sets.
3. Click Add New Variable Set.
4. Give a name to the set i.e OpsLevel.
5. Click Save.

Inside the Octopus Deploy Variable Set configuration

1. Create a new variable with the name OL_INTEGRATION_ID.

2. Copy the Octopus Deploy integration URL from the OpsLevel Octopus Deploy integration page and set as the variable value.

3. Click Save.

Add the OpsLevel CLI as a Package

1. Download the latest OpsLevel CLI package from the Github repository releases page for your runner type (Windows or Linux).
2. Octopus Deploy packages require a valid semver version on the file that is uploaded - so rename the downloaded file with a version. i.e. opslevel-windows-amd64.0.0.1.zip.
3. From your Octopus instance, navigate to Library (requires admin permissions).
4. From the sidebar, navigate to Packages.
5. Click on Upload Package.
6. Follow the instructions in Octopus Deploy to upload the OpsLevel CLI package.

Add the OpsLevel step to your deploy process

Note: This step assumes you have performed all of the above instructions.

1. Navigate to the project you wish to add the OpsLevel deploy step to.
2. From the sidebar, navigate to Process.
3. Click Add Step.
4. Search for OpsLevel.
5. Click on the OpsLevel step you wish to add to your project.
6. The step has defaults set for every parameter but you can configure differently if needed.