From f8e13af412cf162506c0ba48b6dbb72477c9b74b Mon Sep 17 00:00:00 2001 From: Bec Callow Date: Thu, 16 Apr 2026 15:00:46 +1000 Subject: [PATCH 1/2] Add include and exclude by target tag --- .../first-runbook-run/running-a-runbook.md | 3 +- src/pages/docs/releases/creating-a-release.md | 13 +++-- src/pages/docs/runbooks/index.mdx | 3 +- src/pages/docs/runbooks/running-a-runbook.md | 58 +++++++++++++++++++ 4 files changed, 71 insertions(+), 6 deletions(-) create mode 100644 src/pages/docs/runbooks/running-a-runbook.md diff --git a/src/pages/docs/getting-started/first-runbook-run/running-a-runbook.md b/src/pages/docs/getting-started/first-runbook-run/running-a-runbook.md index 8e2544b06f..39efb912ae 100644 --- a/src/pages/docs/getting-started/first-runbook-run/running-a-runbook.md +++ b/src/pages/docs/getting-started/first-runbook-run/running-a-runbook.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-07-30 +modDate: 2026-04-16 title: Running a Runbook description: Step by step guide on how to run a runbook in Octopus Deploy. navOrder: 50 @@ -33,6 +33,7 @@ The next step will cover [how to configure and use variables in runbooks](/docs/ For further reading on running a Runbook please see: +- [Running a runbook](/docs/runbooks/running-a-runbook) - [Runbook vs Deployments](/docs/runbooks/runbooks-vs-deployments) - [Runbook Documentation](/docs/runbooks) - [Runbook Examples](/docs/runbooks/runbook-examples) diff --git a/src/pages/docs/releases/creating-a-release.md b/src/pages/docs/releases/creating-a-release.md index 637bb3d00b..d69153bc62 100644 --- a/src/pages/docs/releases/creating-a-release.md +++ b/src/pages/docs/releases/creating-a-release.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2024-04-29 -modDate: 2025-09-23 +modDate: 2026-04-16 title: Creating a release description: Learn how to create a release in Octopus Deploy navOrder: 2 @@ -68,7 +68,7 @@ Guide failure mode asks for users to intervene when a deployment encounters an e 1. Expand the **Failure mode** section, and select the mode you want to use. 1. Click **SAVE**. -### Deploy to a specific subset of deployment target +### Deploy to a specific subset of deployment targets You can deploy releases to a specific subset of deployment targets. @@ -76,8 +76,13 @@ You can deploy releases to a specific subset of deployment targets. 1. Click **DEPLOY TO (Environment)**. 1. Expand the **Preview and customize** section. 1. Expand the **Deployment Targets** section. -1. Select whether you would like to include or exclude specific deployment targets. The default is to include all applicable deployment targets. -1. Select the deployment targets to include or exclude, and click **DEPLOY**. +1. Select your target selection method: + - **Include all applicable deployment targets** (default) + - **Include specific deployment targets**: Choose individual targets to include + - **Exclude specific deployment targets**: Choose individual targets to exclude + - **Include specific target tags**: Include targets with selected tags + - **Exclude specific target tags**: Exclude targets with selected tags +1. Click **DEPLOY**. ### Variable snapshot diff --git a/src/pages/docs/runbooks/index.mdx b/src/pages/docs/runbooks/index.mdx index 3e27ca14da..7b0b5071ae 100644 --- a/src/pages/docs/runbooks/index.mdx +++ b/src/pages/docs/runbooks/index.mdx @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2026-02-05 +modDate: 2026-04-16 title: Runbooks subtitle: Automate routine maintenance and emergency operations tasks icon: fa-solid fa-repeat @@ -79,5 +79,6 @@ Learn more about [tag sets](/docs/tenants/tag-sets), including tag set types, sc - [Runbooks permissions](/docs/runbooks/runbook-permissions) - Understand how to manage permissions - [Runbooks variables](/docs/runbooks/runbook-variables) - Learn how to manage variables - [Runbooks publishing](https://octopus.com/docs/runbooks/runbook-publishing) - Learn about snapshots for runbooks +- [Running a runbook](/docs/runbooks/running-a-runbook) - Learn how to execute runbooks - [Scheduled runbook triggers](https://octopus.com/docs/runbooks/scheduled-runbook-trigger) - Define an unattended behavior for your runbook - [Runbook examples](https://octopus.com/docs/runbooks/runbook-examples) - Learn about the ways you can use runbooks diff --git a/src/pages/docs/runbooks/running-a-runbook.md b/src/pages/docs/runbooks/running-a-runbook.md new file mode 100644 index 0000000000..8c1ee55a7a --- /dev/null +++ b/src/pages/docs/runbooks/running-a-runbook.md @@ -0,0 +1,58 @@ +--- +layout: src/layouts/Default.astro +pubDate: 2026-04-16 +modDate: 2026-04-16 +title: Running a runbook +description: Learn how to run a runbook in Octopus Deploy +navOrder: 15 +--- + +## How to run a runbook in Octopus Deploy + +1. Navigate to your project and select **Runbooks**. +1. Select the runbook you want to run. +1. Click **RUN...**. + :::figure + ![run runbook basic options](/docs/img/getting-started/first-runbook-run/images/run-runbook-basic-options.png) + ::: +1. Select one more more environments for the execution. +1. Click **RUN** to run now, or select **Show advanced** to display advanced configuration options. + +### Schedule a runbook run + +1. After expanding the advanced options on your runbook run, expand the **WHEN** section and select **later**. +1. Specify the time and date you would like the runbook to run. +1. Click **RUN**. + +### Exclude steps from runbook runs + +1. After expanding the advanced options on your runbook run, expand the **Excluded steps** section and use the check-box to select steps to exclude from the runbook run. +1. Click **RUN**. + +### Modify the guided failure mode + +Guided failure mode asks for users to intervene when a runbook encounters an error. Learn more about [guided failures](/docs/releases/guided-failures). + +1. After expanding the advanced options on your runbook run, expand the **Failure mode** section, and select the mode you want to use. +1. Click **RUN**. + +### Run on a specific subset of deployment targets + +You can run a runbook on a specific subset of deployment targets. + +1. After expanding the advanced options on your runbook run, expand the **Preview and customize** section. +1. Expand the **Deployment Targets** section. +1. Select your target selection method: + - **Include all applicable deployment targets** (default) + - **Include specific deployment targets**: Choose individual targets to include + - **Exclude specific deployment targets**: Choose individual targets to exclude + - **Include specific target tags**: Include targets with selected tags + - **Exclude specific target tags**: Exclude targets with selected tags +1. Click **RUN**. + +## Further reading + +- [Runbooks vs Deployments](/docs/runbooks/runbooks-vs-deployments) - Understand the key differences +- [Runbook Variables](/docs/runbooks/runbook-variables) - Learn about variable management +- [Runbook Permissions](/docs/runbooks/runbook-permissions) - Configure access control +- [Tag Sets](/docs/tenants/tag-sets) - Learn about creating and managing tags \ No newline at end of file From 71dcac47f8cd85d60ffd776a69d500d27f6456e5 Mon Sep 17 00:00:00 2001 From: Bec Callow Date: Thu, 16 Apr 2026 15:12:17 +1000 Subject: [PATCH 2/2] Fix lint --- .../getting-started/first-runbook-run/running-a-runbook.md | 6 +++--- src/pages/docs/runbooks/running-a-runbook.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/pages/docs/getting-started/first-runbook-run/running-a-runbook.md b/src/pages/docs/getting-started/first-runbook-run/running-a-runbook.md index 39efb912ae..4900b80b87 100644 --- a/src/pages/docs/getting-started/first-runbook-run/running-a-runbook.md +++ b/src/pages/docs/getting-started/first-runbook-run/running-a-runbook.md @@ -18,8 +18,8 @@ This screen provides the details of the Runbook you are about to run. ![run runbook basic options](/docs/img/getting-started/first-runbook-run/images/run-runbook-basic-options.png) ::: -2. Select an environment. -3. Click **RUN**. +1. Select an environment. +1. Click **RUN**. :::figure ![run runbook results](/docs/img/getting-started/first-runbook-run/images/run-hello-runbook-results.png) @@ -29,7 +29,7 @@ Because we didn't define any deployment targets for the target environment, Octo The next step will cover [how to configure and use variables in runbooks](/docs/getting-started/first-runbook-run/runbook-specific-variables). -**Further Reading** +## Further reading For further reading on running a Runbook please see: diff --git a/src/pages/docs/runbooks/running-a-runbook.md b/src/pages/docs/runbooks/running-a-runbook.md index 8c1ee55a7a..640a67e803 100644 --- a/src/pages/docs/runbooks/running-a-runbook.md +++ b/src/pages/docs/runbooks/running-a-runbook.md @@ -55,4 +55,4 @@ You can run a runbook on a specific subset of deployment targets. - [Runbooks vs Deployments](/docs/runbooks/runbooks-vs-deployments) - Understand the key differences - [Runbook Variables](/docs/runbooks/runbook-variables) - Learn about variable management - [Runbook Permissions](/docs/runbooks/runbook-permissions) - Configure access control -- [Tag Sets](/docs/tenants/tag-sets) - Learn about creating and managing tags \ No newline at end of file +- [Tag Sets](/docs/tenants/tag-sets) - Learn about creating and managing tags