-
Notifications
You must be signed in to change notification settings - Fork 99
Document include and exclude by target tag for deployments and runbook runs #3105
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.
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
Open
bec-callow-oct
wants to merge
3
commits into
main
Choose a base branch
from
bec/include-exclude-by-target-tag
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+74
−9
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | ||
|  | ||
| ::: | ||
| 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 | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some of this is already covered in
getting-started/first-runbook-run/running-a-runbook.md. I've created a new file for the advanced options to avoid adding confusing info to the getting-started section