Octopus Deploy plugin use cases

2 minute readExtensibilityDeveloper productivity

The following examples illustrate how to use this plugin to integrate Octopus Deploy with CloudBees CD/RO to deploy and release applications.

Deploy and release applications

This example shows how to deploy and release applications. To deploy and release applications, you must:

Configure Octopus Deploy

You must first configure Octopus Deploy to prepare the deployment.

For a deployment example, refer to the Octopus Deploy HTML and JavaScript applications example.

To configure Octopus Deploy:

  1. Create an API key in Octopus Deploy. For more information, refer to How to Create an API Key.

  2. Configure an environment in Octopus Deploy. For more information, refer to Configure Runbook Environments.

  3. Upload the package to the built-in Octopus repository. For more information, refer to Built-in Octopus repository.

  4. Add the deployment target. For more information, refer to Add deployment targets.

  5. Create the project. For more information, refer to Projects.

    1. Specify the project variables. For more information, refer to Variables.

    2. Create the project’s step. For more information, refer to Steps.

Create a release task

After configuring Octopus Deploy, you must create a release task in CloudBees CD/RO.

To create a release task:

  1. In CloudBees CD/RO, create a plugin configuration. For more information, refer to Create Octopus Deploy plugin configurations.

  2. Create a new pipeline. For more information, refer to Create a pipeline.

  3. For the Pipeline stage, select Add task.

  4. Give the new task a name, and then select Define.

  5. For the Task type, select Plugin.

  6. For the Plugin, select EC-OctopusDeploy.

  7. For the Procedure, select Create Or Update Release.

  8. Select Input parameters.

  9. In the Configuration name field, add the EC-OctopusDeploy plugin configuration that you created.

  10. Specify the parameters, as required for your project. For more information, refer to Create Or Update Release.

Create a deploy task

After creating the release task, you must create a deploy task.

  1. For the Pipeline stage, select Add task.

  2. Give the new task a name, and then select Define.

  3. For the Task type, select Plugin.

  4. For the Plugin, select EC-OctopusDeploy.

  5. For the Procedure, select Deploy Release.

  6. Select Input parameters.

  7. In the Configuration name field, add the EC-OctopusDeploy plugin configuration that you created.

  8. Specify the parameters, as required for your project. For more information, refer to Deploy Release.

  9. Run the pipeline. The release is deployed to Octopus Deploy.