Skip to content

Document new options for managing ephemeral envs #2920

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
caitlynstocker merged 1 commit into from
Nov 24, 2025
Merged

Document new options for managing ephemeral envs #2920

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 15 additions & 3 deletions src/pages/docs/projects/ephemeral-environments/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,9 +130,14 @@ Support for providing custom fields is not yet available in the Octopus CLI.

### Manually

If automatic deployments is not selected, ephemeral environments can be created from the Ephemeral Environments page within the project.
If automatic deployment is not selected, ephemeral environments can be created using the:

To create an ephemeral environment manually:
- Octopus Web Portal
- Octopus API
- [`OctopusDeploy/create-ephemeral-environment` GitHub Action](https://github.com/OctopusDeploy/create-ephemeral-environment)
- [Octopus CLI](/docs/octopus-rest-api/cli)

To manually create an ephemeral environment in the Octopus portal, visit the Ephemeral Environments page within the project then:
- Select **Add Ephemeral Environment** from the Ephemeral Environments page.
- Enter a name for the environment.

Expand Down Expand Up @@ -173,7 +178,14 @@ When an ephemeral environment is no longer needed it can be deprovisioned and an
- For projects using runbooks stored in Octopus the published snapshot will be used to run the runbook.
- For projects using runbooks stored in version control, the Git reference used to provision the environment will be used to run the runbook.

To deprovision an environment:
Ephemeral environments can be deprovisioned via the:

- Octopus Web Portal
- Octopus API
- [`OctopusDeploy/deprovision-ephemeral-environment` GitHub Action](https://github.com/OctopusDeploy/deprovision-ephemeral-environment)
- [Octopus CLI](/docs/octopus-rest-api/cli)

To deprovision an ephemeral environment in the Octopus portal:

- Select **Deploy** from the main navigation in the Octopus Web Portal and select your project.
- Select the **Ephemeral Environments** navigation menu in the sidebar.
Expand Down