Community Step Templates

Last updated

Community step templates are publically available step templates that are contributed and updated by the community. There is a growing number (over 200 at the time of writing this) of templates that can help you automate your deployment without writing any scripts yourself. The community step templates are third party code which is licensed under apache.

Octopus community step templates integration is enabled by default but this can be changed in the Features tab in the Configuration area. For more information, see Octopus community step templates integration.

The Community Library is an open source repository of community contributed step templates automating a diverse set of actions.  If you still don't find what you are looking for, don't forget: Octopus can do anything, as long as you can script the instructions. Maybe you could contribute your scripts back to the community?

The Community Library

Is there something Octopus doesn't support out-of-the-box? Take a look at the Community Library which is full of step templates that have been contributed and are maintained by the Octopus community.

Octopus 3.7 introduced integration with the Community Library and community contributed step templates are now synchronized with the Octopus server. This change makes it a quick and easy process to install and add community step templates. The import and export process is still available for older versions of Octopus.

Community library

Installing a community step template into Octopus is quick and easy.

It's also possible to create your own step templates.

Installing a step template from the Community Library

To install a step template from the Community Library, perform the following.

  1. Navigate to Library ➜ Step Templates area and select Install from the community step templates section Install community step template
  2. Search for a specific step template or browse the categories to find the template you want to use Search for community step template
  3. Select Install or view the details of the step Install community step template
  4. To confirm, select install Confirm installation
  5. Now you can add this new kind of step to your deployment process Step template installed

Importing a step template from the Community Library

If you don't have the Community Library feature turned on you can still use community step templates by manually importing the JSON from the Community Library into the step template library within Octopus.

  1. Navigate to the Community Library website, find the template you want to use and click on the Copy to clipboard button. Step Templates are transported as a JSON document containing all of the information required by Octopus. Import from community library
  2. Navigate to Library ➜ Step Templates area within the Octopus web portal and select Import from the custom step templates section.
  3. Paste in the JSON document for the Step Template and click the Import button. Content
  4. Now you can add this new kind of step to your deployment process. Import confirmation