Skip to content

Commit dcaa8d3

Browse files
Update ephemeral environment docs with automatic deployments (#2871)
* Update ephemeral environment docs with automatic deployments * Update document pictures and wording
1 parent 999bc09 commit dcaa8d3

File tree

7 files changed

+39
-12
lines changed

7 files changed

+39
-12
lines changed
-115 KB
Loading
-124 KB
Loading
-154 KB
Loading
-179 KB
Loading
-129 KB
Loading
-112 KB
Loading

src/pages/docs/projects/ephemeral-environments/index.md

Lines changed: 39 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: src/layouts/Default.astro
3-
pubDate: 2025-09-08
4-
modDate: 2025-09-08
3+
pubDate: 2025-10-17
4+
modDate: 2025-10-17
55
title: Ephemeral Environments
66
navTitle: Ephemeral Environments
77
navSection: Ephemeral Environments
@@ -17,7 +17,7 @@ Support for Ephemeral Environments is rolling out as an Early Access Preview to
1717

1818
Ephemeral environments integrate smoothly into your existing development workflows by building on existing Octopus features such as [Releases](/docs/releases), [Channels](/docs/releases/channels) and [Runbooks](/docs/runbooks).
1919

20-
Octopus will automatically create and deploy to an ephemeral environment from releases created within a specifically configured channel in a project, and supports provisioning and deprovisioning of associated infrastructure using Runbooks.
20+
Octopus can automatically create and deploy to an ephemeral environment from releases created within a specifically configured channel in a project, and supports provisioning and deprovisioning of associated infrastructure using Runbooks.
2121

2222
## Getting started
2323

@@ -41,11 +41,19 @@ Enter the name for a new parent environment or select an existing parent environ
4141
Give your parent environment a recognizable name that describes what you intend to use ephemeral environments for. Examples might include "Pull request environments" or "Test environments".
4242
:::
4343

44-
### Naming
44+
### Auto Deploy
4545

46-
Octopus will automatically provision a new ephemeral environment for you from releases in your project. The name of each environment can be configured using an Environment Name Template. Templates support the same powerful syntax as Variables. Any [system variable for a release](/docs/projects/variables/system-variables#release) can be used as part of the template.
46+
You can choose to automatically deploy releases to ephemeral environments when they created. This can help to streamline your workflows by reducing the number of manual steps required to get your changes deployed.
4747

48-
Enter a template and click Next.
48+
When auto deployment is configured, Octopus will automatically create a new ephemeral environment for you from releases in your project. The name of each environment can be configured using an Environment Name Template. Templates support the same powerful syntax as Variables. Any [system variable for a release](/docs/projects/variables/system-variables#release) can be used as part of the template.
49+
50+
When auto deployment is not configured, you need to manually create ephemeral environments and deploy releases to them. You can do this using the Octopus Portal, API and CLI.
51+
You can also select to manually create and deploy to an environment.
52+
53+
Select whether to automatically deploy releases to ephemeral environments.
54+
If you select to automatically deploy, you will also have to provide an environment name template that will be used to name the environment.
55+
56+
#### Environment Name Template
4957

5058
:::div{.hint}
5159
**Tips:**
@@ -56,7 +64,7 @@ Enter a template and click Next.
5664

5765
:::
5866

59-
#### Custom Fields
67+
##### Custom Fields
6068

6169
Releases support Custom Fields which can be used to configure the name of an ephemeral environment. See [Using custom fields in releases](/docs/releases/creating-a-release#custom-fields) for more information.
6270

@@ -90,15 +98,19 @@ Review the selected configuration and click Confirm. You can go back and adjust
9098

9199
![Confirming the configuration of ephemeral environments for a project](/docs/projects/ephemeral-environments/confirm-ephemeral-environments-configuration.png)
92100

93-
Ephemeral environments are now configured for your project. A new channel has been created in the project which will automatically create and deploy to a new environment for each release.
101+
Ephemeral environments are now configured for your project. A new channel has been created in the project to manage the creation and deployment of ephemeral environments.
94102

95103
Click **Got it** to continue to creating a new environment from a release.
96104

97105
![Ephemeral environments successfully configured for a project](/docs/projects/ephemeral-environments/ephemeral-environments-configured.png)
98106

99107
## Creating an ephemeral environment
100108

101-
To create an ephemeral environment, create a release in the new channel configured within the project. Octopus will automatically create a new environment and deploy the release to it.
109+
### Automatically
110+
111+
Octopus can automatically create an ephemeral environment when a release is created in the channel configured for ephemeral environments if automatic deployments is selected.
112+
113+
To create an ephemeral environment, create a release in the new channel configured within the project. Octopus will create a new environment and deploy the release to it.
102114

103115
A release can be created using the:
104116

@@ -116,6 +128,16 @@ Remember to provide any custom fields with the release that are used in the envi
116128
Support for providing custom fields is not yet available in the Octopus CLI.
117129
:::
118130

131+
### Manually
132+
133+
If automatic deployments is not selected, ephemeral environments can be created from the Ephemeral Environments page within the project.
134+
135+
To create an ephemeral environment manually:
136+
- Select **Add Ephemeral Environment** from the Ephemeral Environments page.
137+
- Enter a name for the environment.
138+
139+
The environment will now be created in the Not Provisioned state, ready for a release to be deployed to it. Provisioning will be performed automatically by the configured runbook when a release is deployed to the environment.
140+
119141
## Provisioning infrastructure
120142

121143
Infrastructure required for an ephemeral environment can be provisioned using a runbook. Octopus will automatically run this runbook before the first deployment to the environment.
@@ -136,7 +158,13 @@ Environments can be filtered by name and by the current state of the environment
136158

137159
## Updating an existing environment
138160

139-
To update an existing ephemeral environment, create another release that results in the same environment name based on the template. The release will be automatically deployed into the environment.
161+
### Automatic Deployments
162+
163+
Create another release that results in the same environment name based on the environment name template. The release will be automatically deployed into the environment.
164+
165+
### Manual Deployments
166+
167+
Create a new release, then deploy it and select the existing environment in the Deploy to step. Octopus deploys the release to that environment without creating a new one.
140168

141169
## Deprovisioning an environment
142170

@@ -157,7 +185,7 @@ To deprovision an environment:
157185

158186
### Automatic deprovisioning of environments
159187

160-
Ephemeral environments can be automatically deprovisioned if they are inactive after after a configurable time period. Deploying a release to an environment or running a runbook against an environment marks the environment as still being active.
188+
Ephemeral environments can be automatically deprovisioned if they are inactive after a configurable time period. Deploying a release to an environment or running a runbook against an environment marks the environment as still being active.
161189

162190
:::div{.hint}
163191
By default, ephemeral environments are removed after 7 days of inactivity.
@@ -206,4 +234,3 @@ The following limitations currently apply to the use of the Ephemeral Environmen
206234
- Ephemeral environments cannot be deployed to tenants.
207235
- Parent environments cannot be connected to tenants.
208236
- Ephemeral environments and parent environments cannot be used within lifecycles, deployment freezes and insights reports.
209-
- Ephemeral environments cannot be manually created outside of releases.

0 commit comments

Comments
 (0)