Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions src/pages/docs/platform-hub/templates/parameters.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: src/layouts/Default.astro
pubDate: 2026-03-05
modDate: 2026-03-06
modDate: 2026-05-28
title: Template parameters
subtitle: A reference for parameters in Platform Hub templates
icon: fa-solid fa-layer-group
Expand Down Expand Up @@ -39,9 +39,9 @@ Templates can manage the following as parameters:
- Worker Pool
- Package
- Project
- A previous step name
- A previous step name (process templates only)

To create a parameter, navigate to the **Parameters** tab on a template and add a new parameter.
To create a parameter, navigate to **Parameters** on a template and add a new parameter.

## Parameter values

Expand All @@ -57,10 +57,10 @@ You can set an optional default value for these parameters:
- Generic OIDC Account
- Google Cloud Account
- Username Password Account
- Certificate

You cannot set a default value for these parameters, they must be set inside a project:

- Certificate
- Worker Pool
- Package
- A previous step name
Comment thread
felixi-octopus marked this conversation as resolved.
Expand All @@ -81,5 +81,5 @@ Some parameter behavior differs between template types.
:::

:::div{.hint}
**Project templates** do not support parameter scoping or sensitive parameter values in the Alpha release. The following parameter types are not available for project templates: Multi-line text, Dropdown, Checkbox, and Sensitive/password box. For more information, see [Project template parameters](/docs/platform-hub/templates/project-templates#parameters).
**Project templates** don't yet support parameter scoping or sensitive parameter values. For more information, see [Project template parameters](/docs/platform-hub/templates/project-templates#parameters).
:::
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ modDate: 2025-09-11
title: Process Templates best practices
subtitle: Best practices for creating process templates within Platform Hub
icon: fa-solid fa-lock
navTitle: Best Practices
navTitle: Best practices
navSection: Process Templates
description: Best practices for creating process templates within Platform Hub
navOrder: 160
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: src/layouts/Default.astro
pubDate: 2026-03-05
modDate: 2026-03-16
modDate: 2026-05-28
title: Project template best practices
subtitle: Best practices for creating project templates in Platform Hub
icon: fa-solid fa-layer-group
Expand All @@ -12,7 +12,7 @@ navOrder: 180
---

:::div{.warning}
Project templates are in Alpha. The feature is incomplete and standard SLAs do not apply. Don't use it for production workloads. It is available to Enterprise customers on Cloud. Self-hosted customers can access it as an early preview via Octopus 2026.2. We're actively developing this feature and would love your feedback.
Project templates are in Public Preview. The feature is still evolving and standard SLAs don't apply. We don't recommend it for production workloads yet. It's available to Enterprise customers on Cloud and to self-hosted customers running Octopus 2026.2. We'd love your feedback as we work towards General Availability, [tell us what you think](https://roadmap.octopus.com/c/263-project-templates).
:::

This document uses **Producer** and **Consumer** frequently. To avoid confusion, use these definitions:
Expand Down
52 changes: 41 additions & 11 deletions src/pages/docs/platform-hub/templates/project-templates/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: src/layouts/Default.astro
pubDate: 2026-03-05
modDate: 2026-03-16
modDate: 2026-05-28
title: Project templates
subtitle: An overview of project templates
icon: fa-solid fa-layer-group
Expand All @@ -12,14 +12,14 @@ navOrder: 170
---

:::div{.warning}
Project templates are in Alpha. The feature is incomplete and standard SLAs do not apply. Don't use it for production workloads. It is available to Enterprise customers on Cloud. Self-hosted customers can access it as an early preview via Octopus 2026.2. We're actively developing this feature and would love your feedback.
Project templates are in Public Preview. The feature is still evolving and standard SLAs don't apply. We don't recommend it for production workloads yet. It's available to Enterprise customers on Cloud and to self-hosted customers running Octopus 2026.2. We'd love your feedback as we work towards General Availability, [tell us what you think](https://roadmap.octopus.com/c/263-project-templates).
:::

## Overview

Project templates are reusable project blueprints that can be shared across multiple spaces in Octopus Deploy. Instead of manually configuring each new project from scratch, defining deployment steps and variables every time, you create a single template that any space can use as a starting point. This ensures teams follow the same standards and removes the risk of configuration drift.

To create or manage your project templates, navigate to the Platform Hub. If you haven't set up your Git repository, you must do so before creating a project template.
To create or manage your project templates, navigate to Platform Hub. If you haven't set up your [Git repository](/docs/platform-hub#git-credentials-in-platform-hub), you must do so before creating a project template.

1. Navigate to **Project Templates** in Platform Hub.
2. Give the project template a **Name** and an optional **Description**.
Expand Down Expand Up @@ -50,24 +50,28 @@ Some steps behave differently inside the project template editor. Instead of let
:::

:::div{.hint}
Unlike standard projects, project templates validate the deployment process when you publish, not when you commit. You can save an incomplete process and continue configuring parameters and variables before publishing. This will change once we add inline parameter and variable configuration to the deployment process editor.
Unlike standard projects, project templates validate the deployment process when you publish, not when you commit. You can save an incomplete process and continue configuring parameters and variables before publishing. This will change once we add inline variable configuration to the deployment process editor.
:::

:::div{.hint}
If your deployment process includes a process template configured to auto-update on patch or minor versions, those updates flow through to templated projects automatically, even without you publishing a new version of the project template. This means two releases created on different days could use different versions of the process template, without anyone making any change to the project template or the project itself. We're interested in your [feedback](#feedback) on whether this behavior meets your expectations.
If your deployment process includes a process template configured to auto-update on patch or minor versions, those updates flow through to templated projects automatically, even without you publishing a new version of the project template. This means two releases created on different days could use different versions of the process template, without anyone making any change to the project template or the project itself.

The project template process editor shows a warning callout when included process templates have received automatic updates since the template was last published. Use it to review the changes before publishing a new version.

We're interested in your [feedback](https://roadmap.octopus.com/c/263-project-templates) on whether this behavior meets your expectations.
:::

## Parameters

Parameters let you define the inputs a user must supply when they create a project from the template. They're the mechanism for making a template flexible. Rather than hardcoding values that differ between teams or spaces, you expose them as parameters.

:::div{.warning}
In the Alpha release, project templates don't support parameter scoping or sensitive parameter values. We're still working out how parameters, variables, and scoping should work in project templates and expect this to evolve throughout Alpha. We'd love your [feedback](#feedback).
Project templates don't yet support parameter scoping or sensitive parameter default values. We're still shaping how parameters, variables, and scoping work together and expect this area to evolve. We'd love your [feedback](#feedback).
:::

For a full reference of supported parameter types and default values, see [Template parameters](/docs/platform-hub/templates/parameters).

To create a parameter, navigate to the **Parameters** tab on your project template and add a new parameter.
To create a parameter, navigate to **Parameters** on your project template and add a new parameter.

:::figure
![The Parameters tab in a project template](/docs/img/platform-hub/project-templates/project-templates-parameters.png)
Expand All @@ -81,14 +85,40 @@ Unlike parameters, users can't change the variables defined in a template when c

Variable values can reference parameters, letting you combine fixed template-level values with project-supplied inputs where needed.

:::div{.warning}
In the Alpha release, the variable types you can use are limited to text, sensitive, and resources currently available in Platform Hub, such as Accounts. Variable scoping is also not supported. We're adding support for additional resource types throughout Alpha. We'd love your [feedback](#feedback) on what you need.
:::
### Variable types

Project template variables support the following types:

- **Text**: plain string values.
- **Sensitive**: encrypted values like passwords and API keys.
- **Account**: references to accounts defined in Platform Hub. Add the account in Platform Hub before using it in a template.
- **Certificate**: references to certificates defined in Platform Hub.

### Variable scoping

You can scope a project template variable to any combination of the following:

- Specific steps in the deployment process.
- Process template usages, when the template's deployment process includes one or more.
- Environment parameters, target tag parameters, or tenant tag parameters defined on the template. Whatever the project's parameter value resolves to determines the scope.

Scoping is fixed at the template level. The same scoping rules apply to every project created from the template.

:::figure
![The Variables tab in a project template](/docs/img/platform-hub/project-templates/project-templates-variables.png)
:::

## Project settings

Project templates let you set a few project-level defaults that flow through to every project created from the template. Configure these in **Settings** on the project template.

- **Multi-tenant Deployments**: choose whether projects created from the template require tenants, allow tenants, or run untenanted. Users can't change this on a project created from the template.
- **Project Persistence**: choose the preferred storage for projects created from the template, either in Octopus or backed by Git. The project creation flow defaults to your recommendation and lets users pick a different option if they need to.

:::div{.hint}
We're planning to add more template-level settings, including default lifecycle and channel configuration, once those features are available in project templates.
:::

## Git repository structure

Octopus stores each project template as a folder in the Platform Hub Git repository. The folder name is a slug derived from the template name. Each folder contains four [OCL](/docs/projects/version-control) files:
Expand Down Expand Up @@ -118,4 +148,4 @@ After you publish and share a template, users in a space can create a new projec

## Feedback

Project templates are in Alpha and we're actively shaping how the feature works. If you run into something unexpected or have thoughts on how parameters, variables, scoping, or anything else should work, we'd love to hear from you. [Share your feedback](https://oc.to/feedback) to help us build this the right way.
Project templates are in Public Preview and we're actively shaping how the feature works. If you run into something unexpected or have thoughts on how parameters, variables, scoping, or anything else should work, we'd love to hear from you. [Share your feedback](https://oc.to/feedback) to help us build this the right way.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Project templates are in Public Preview and we're actively shaping how the feature works. If you run into something unexpected or have thoughts on how parameters, variables, scoping, or anything else should work, we'd love to hear from you. [Share your feedback](https://oc.to/feedback) to help us build this the right way.
Project templates are in Public Preview and we're actively shaping how the feature works. If you run into something unexpected or have thoughts on how parameters, variables, scoping, or anything else should work, we'd love to hear from you. [Share your feedback](https://roadmap.octopus.com/c/263-project-templates) to help us build this the right way.

Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
---
layout: src/layouts/Default.astro
pubDate: 2026-03-16
modDate: 2026-03-16
title: Installing the Alpha preview of project templates
subtitle: Guide for installing a preview version of Octopus Server with project templates
modDate: 2026-05-28
title: Installing the Public Preview of project templates
subtitle: Guide for installing the Public Preview of Octopus Server with project templates
icon: fa-solid fa-layer-group
navTitle: Installation guide
navSection: Project Templates
description: Installation guide for self-hosted Octopus Server customers who want to access the project templates Alpha
description: Installation guide for self-hosted Octopus Server customers who want to access the project templates Public Preview
navOrder: 172
---

:::div{.warning}
Project templates are in Alpha. The feature is incomplete and standard SLAs do not apply. Don't use it for production workloads. It is available to Enterprise customers on Cloud. Self-hosted customers can access it as an early preview via Octopus 2026.2. We're actively developing this feature and would love your feedback.
Project templates are in Public Preview. The feature is still evolving and standard SLAs don't apply. We don't recommend it for production workloads yet. It's available to Enterprise customers on Cloud and to self-hosted customers running Octopus 2026.2. We'd love your feedback as we work towards General Availability.
:::

## License requirements
Expand All @@ -21,16 +21,13 @@ Project templates require an Octopus Enterprise license with the project templat

## How to install Octopus Server 2026.2

Project templates are available to Cloud customers without any additional setup. Self-hosted customers can access project templates as an early preview by installing the latest Octopus Server 2026.2.
Project templates are available to Cloud customers without any additional setup. Self-hosted customers can access project templates as a Public Preview by installing the latest Octopus Server 2026.2.

:::div{.warning}
You should only install a preview version of Octopus Server if you are comfortable adopting a feature before it's fully complete. Any issues or bugs you encounter with preview features may take longer to fix than normal. For other features, we provide the same level of support as for LTS versions. Contact <sales@octopus.com> with any questions about whether this approach is right for you.
:::

1. Download Octopus Server 2026.2.

- If you are running Octopus on Windows, you can [download the installer](https://download.octopusdeploy.com/octopus/Octopus.2026.2.2311-x64.msi) directly.
- If you are running Octopus on Linux, you can pull the Docker image. The preview version is `2026.2.2311-PublicPreview` — see the [Docker Hub page](https://hub.docker.com/repository/docker/octopusdeploy/octopusdeploy/tags/2026.2.2311-PublicPreview/sha256-b81bd5d752b22f25137306086a4ea76168e9a7e17f7d573116c509c6bfa23469) for the full image details.
1. Download Octopus Server 2026.2 from [octopus.com/downloads](https://octopus.com/downloads).

1. After downloading, upgrade your Octopus instance using the [upgrading guide](/docs/administration/upgrading).

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: src/layouts/Default.astro
pubDate: 2026-03-05
modDate: 2026-03-16
modDate: 2026-05-28
title: Troubleshooting
subtitle: Known issues and limitations for project templates
icon: fa-solid fa-layer-group
Expand All @@ -12,39 +12,42 @@ navOrder: 173
---

:::div{.warning}
Project templates are in Alpha. The feature is incomplete and standard SLAs do not apply. Don't use it for production workloads. It is available to Enterprise customers on Cloud. Self-hosted customers can access it as an early preview via Octopus 2026.2. We're actively developing this feature and would love your feedback.
Project templates are in Public Preview. The feature is still evolving and standard SLAs don't apply. We don't recommend it for production workloads yet. It's available to Enterprise customers on Cloud and to self-hosted customers running Octopus 2026.2. We'd love your feedback as we work towards General Availability.
:::

## Alpha limitations
## Public Preview limitations

Project templates are in Alpha. The following features are not yet supported and are planned for future releases:
Project templates are in Public Preview. The following features are not yet supported and are planned for future releases:

- Channels
- Lifecycles
- Environments
- Ephemeral environments
- Cloud target discovery on steps. Use project variables in the project instead
- Cloud target discovery on steps (see below)
- Cloning a project template through the Octopus UI
- Creating and managing project templates through the REST API, CLI, or Terraform provider
- Feeds
- Project settings
- Project settings, except for Multi-tenant Deployments and Project Persistence
- Runbooks
- Triggers
- Import and export of templated projects
- Git Credentials
- Inline variable and parameter configuration within the deployment process editor
- Inline variable configuration within the deployment process editor

We'll update this page as the feature evolves.

## Cloud target discovery

Project templates can't supply the account that cloud target discovery uses on a step. To use cloud target discovery in a templated project, configure it on the templated project itself. See [cloud target discovery](/docs/infrastructure/deployment-targets/cloud-target-discovery) for more information.

## Step support

Project templates support most Octopus steps. The following step package framework steps are not supported:
Project templates support most Octopus steps. The following steps are not supported:

- Deploy a Bicep Template
- AWS S3 Create Bucket
- AWS ECS

These steps are being migrated away from the step package framework and will be supported in the future.
These steps will be supported in the future.

## Cloning project templates

Expand Down
Loading