| layout | src/layouts/Default.astro |
|---|---|
| pubDate | 2025-09-30 |
| modDate | 2025-09-30 |
| title | Overview |
| subtitle | An overview of Process Templates |
| icon | |
| navTitle | Overview |
| navSection | Process Templates |
| description | An overview of Process Templates |
| navOrder | 71 |
Process templates are reusable sets of deployment steps that can be shared across multiple spaces in Octopus Deploy. Instead of copying and pasting deployment processes across teams and applications, which often leads to configuration drift, unnecessary duplication, and operational debt, you create a single source of truth that any project can consume. By abstracting your best practices for deployments into Process Templates, you make it easy for teams to follow standards and accelerate delivery.
:::div{.warning} Process templates are in Public Preview for all Enterprise Cloud Customers. :::
To create or manage your process templates, navigate to Platform Hub. If you haven't set up your Git repository, you must do so first before creating a process template. Similarly, if you've already created templates or are joining an existing team, you'll see the existing templates in the template overview screen.
Before you can define the deployment process for your template, you must create the template first.
- Navigate to Process Templates in Platform Hub.
- Give the process template a NAME and an optional DESCRIPTION
- Create your process template.
You've created your process template; now, define its deployment process.
A deployment process is a set of steps the Octopus Server orchestrates to deploy your software. Each process template has a single deployment process. You can use Octopus's built-in steps to define this process for your process template.
Some steps look different inside a process template. They ask for a parameter rather than allowing you to define a value. These steps ask for a resource that Platform Hub cannot define, such as Worker Pools, and you must define them inside a project. These fields accept parameters so you can define the values the process template needs inside a consuming project.
:::Warning Our initial release of Process Templates does not include support for custom step templates, community step templates, and a few built-in steps. :::
Once you have set up a deployment process, you can use it in any space for a deployment process or runbook.
Parameters are how you easily manage and apply the correct values during a deployment that uses a process template. Using parameters, you can use the same process template across your environments and tailor the inputs based on the projects needs.
Process Templates can manage the following as parameters.
- AWS Account
- Azure Account
- Certificate
- Channels
- Checkbox
- Container Feed
- Drop down
- Environments
- Generic OIDC Account
- Google Cloud Account
- Multi-line text box
- Single-line text box
- Target Tags
- Teams
- Tenant Tags
- Username Password Account
- Worker Pool
- A previous step name
To create a parameter, you can navigate to the parameters tab on a process template and add a new parameter.
The following parameters will allow you to set a default value in Platform Hub:
- Single-line text
- Multi-line text
- Dropdown
- Checkbox
The following parameters will not allow you to set a default value in Platform Hub and must be set inside a project:
- Certificate
- Sensitive
- Worker Pools
- Package
- Previous deployment step name
Only Account parameters will allow you to scope them by environments. You can choose to scope them by any environment across your Octopus instance.
Once you've finished making changes to your process template you can commit them to save the changes to your Git repository. You can either Commit with a description or quick commit without one.
Once you've made your changes, you will have to publish the template to reflect them inside the process template within a project. You will have four options to choose from when publishing changes:
- Major changes (breaking)
- Minor changes (breaking)
- Patch (bug fixes)
- Flag as pre-release
:::hint The first time you publish a template you can only publish a major or pre-release version :::
Selecting any option increments the version number following Semantic Versioning. For minor or patch updates, consuming projects that accept these changes will automatically upgrade to the newly published version.
If you wish to test your changes before publishing a major, minor, or patch version, you can mark a template as a pre-release version.
You must share the process template before it can be consumed by any projects. Process Templates can be shared with all current and future spaces, or a select few spaces.
:::hint Sharing settings can be updated anytime. :::
To define a simple deployment process in Octopus that executes a hello world script on the Octopus Server, complete the following steps:
- Navigate to Platform Hub
- Add a process template
- Name the template, for instance, "Hello World", and add an optional description.
- Add a deployment step.
- Choose the type of step you'd like to add to filter the available steps.
- Find the Run a Script step and add it to your deployment process.
- In the Process Editor, give the step a name, for instance "Run a Hello World script".
- In the Execution Location section use the Run on the worker pool parameter option.
- Create a Worker Pool parameter.
- Add the Worker Pool parameter to the Worker Pool field.
- Paste the following PowerShell script into the Inline Source Code editor:
Write-Host "Hello, World!" - Commit your template.
- Publish and Share your template.
You now have a simple Hello World process template that can be published and shared with any project.