Skip to content

Commit 15c6d6d

Browse files
Add updated docs for octopus approvals (#3101)
* Add updated docs for octopus approvals * Adjust wording * Formatting of configuration items * Add how it works summary * Minor spelling and grammer fixes --------- Co-authored-by: Steve Fenton <99181436+steve-fenton-octopus@users.noreply.github.com>
1 parent dbbfc62 commit 15c6d6d

4 files changed

Lines changed: 161 additions & 41 deletions

File tree

src/pages/docs/approvals/index.md

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: src/layouts/Default.astro
33
pubDate: 2023-01-01
4-
modDate: 2025-04-28
4+
modDate: 2026-04-15
55
title: Approvals
66
subtitle: Defining your change approval process
77
icon: fa-solid fa-square-check
@@ -14,15 +14,39 @@ hideInThisSection: true
1414

1515
Managing deployment pipelines at scale is complex and time-consuming for DevOps teams, and it's more complicated when you add in change management. Manually filling out change requests takes time and is prone to error. It's also common to have strict change processes needing thorough reviews to get approval to ship new releases of applications. Change advisory boards can be perceived as roadblocks that slow development teams.
1616

17-
When CI/CD systems create change requests automatically, you can work towards best practices with less friction. We want to make change management easier by helping you integrate Octopus with ServiceNow to reduce friction and simplify your development teams' lives.
17+
When CI/CD systems create change requests automatically, you can work towards best practices with less friction. We want to make change management easier by helping you integrate Octopus with IT service management (ITSM) systems to reduce friction and simplify your development teams' lives.
1818

19-
Octopus Deploy includes ITSM integrations for ServiceNow and Jira Service Management that let you balance audit and compliance requirements with team productivity.
19+
Octopus Deploy includes ITSM integrations for ServiceNow and Jira Service Management that let you balance audit and compliance requirements with team productivity.
20+
21+
:::div{.hint}
22+
Octopus Approvals is a built-in approval system that works without an external ITSM tool. This feature is currently in Alpha, available to a small set of customers. If you are interested in this feature please register your interest on the [roadmap card](https://roadmap.octopus.com/c/243-approvals-for-deployments) and we'll keep you updated.
23+
:::
2024

2125
Our support focuses on:
2226

23-
1. **Productive teams** - Automatically create change requests and associate them with Octopus deployments or runbook runs so you can work with the right stakeholders to ensure your changes are compliant and approved. Octopus can also prevent deployments and runbook runs from executing until all approvals are complete.
27+
1. **Productive teams** - Automatically create change requests and associate them with Octopus deployments or runbook runs so you can work with the right stakeholders to ensure your changes are compliant and approved. Octopus can also prevent deployments and runbook runs from executing until all approvals are complete.
2428
2. **Compliant DevOps** - Be sure that no one is deploying unapproved changes to production. Your audits become a smooth process as you can demonstrate your company's processes are being adhered to with system reports.
2529

30+
## Built-in change management with Octopus Approvals
31+
32+
Octopus Approvals is a built-in change approval system that lets you gate deployments and runbook runs on approvals from designated users or teams - no external ITSM tool required. When a controlled deployment is created, Octopus automatically creates a change request (formatted as `OCT-{number}`) and pauses execution. Once the minimum number of approvals is reached, Octopus allows the task to proceed. If any approver rejects the request, Octopus terminates the task immediately.
33+
34+
What's included in Octopus Approvals?
35+
36+
- Octopus manages the full approval workflow with no external dependencies.
37+
- Approval policies define which users or teams can approve and how many approvals Octopus requires before proceeding.
38+
- Octopus creates change requests automatically at deployment time.
39+
- Octopus supports change windows — the task waits until an approved time period before Octopus allows execution.
40+
- Octopus records an audit trail of approvals and rejections in the task log.
41+
42+
:::div{.hint}
43+
Octopus Feature Toggles are currently in Alpha, available to a small set of customers.
44+
45+
If you are interested in this feature please register your interest on the [roadmap card](https://roadmap.octopus.com/c/121-feature-toggles) and we'll keep you updated.
46+
:::
47+
48+
Learn more about [Octopus Approvals](/docs/approvals/octopus-approvals).
49+
2650
## ServiceNow change management without friction
2751

2852
:::figure
@@ -37,7 +61,7 @@ What's included in our ServiceNow support?
3761
- Automatically create normal and emergency change requests at execution time. Octopus pauses the execution until the appropriate approvals are complete.
3862
- Let Octopus do the work for you by automating the transition between stages in the change request once created, leaving a deployment or runbook run record in ServiceNow.
3963
- Use change templates to auto-create standard change requests to reduce manual work and control what information is populated.
40-
- Ensure Change Windows are honored on existing change requests so deployments or runbook runs won't execute until the specified time window.
64+
- Ensure "Change Windows" are honored on existing change requests so deployments or runbook runs won't execute until the specified time window.
4165
- Add work notes to change requests with information about deployment or runbook run start and finish time and whether it was successful or not.
4266
- Create change requests with pre-populated fields through variables.
4367
- View and export audit logs of controlled deployments and runbook runs for easy compliance and post-execution reconciliation.
@@ -56,9 +80,9 @@ ServiceNow integration is available to customers with an [enterprise subscriptio
5680

5781
To build on our ITSM change management support further, we are also pleased to announce our Jira Service Management integration.
5882

59-
The Jira Service Management integration ensures that teams using this platform can access the benefits of creating change requests automatically in Octopus. It makes it easier to manage deployment pipelines at scale, reducing the complexity of change management. Integrating Octopus with Jira Service Management reduces the need for manually filling out change requests, making it faster and less prone to error. By using Octopus to create change requests automatically, you can create best practice change management easily.
83+
The Jira Service Management integration ensures that teams using this platform can access the benefits of creating change requests automatically in Octopus. It makes it easier to manage deployment pipelines at scale, reducing the complexity of change management. Integrating Octopus with Jira Service Management reduces the need for manually filling out change requests, making it faster and less prone to error. By using Octopus to create change requests automatically, you can create best practice change management easily.
6084

61-
This new integration links Octopus deployments and runbook runs to Jira Service Management change requests and automatically creates pre-populated Request for change change requests. You get improved traceability out-of-the-box, and you can prove to auditors that every controlled deployment and runbook has a change request. This ensures your CI/CD and release management processes are compliant with company policies and regulations.
85+
This new integration links Octopus deployments and runbook runs to Jira Service Management change requests and automatically creates pre-populated "Request for change" change requests. You get improved traceability out-of-the-box, and you can prove to auditors that every controlled deployment and runbook has a change request. This ensures your CI/CD and release management processes are compliant with company policies and regulations.
6286

6387
What's included in our Jira Service Management support?
6488

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
---
2+
layout: src/layouts/Default.astro
3+
pubDate: 2026-04-15
4+
modDate: 2026-04-15
5+
title: Octopus Approvals
6+
description: Octopus Approvals is a built-in change approval system that gates deployments and runbook runs on sign-off from designated users or teams, without requiring an external ITSM tool.
7+
navOrder: 5
8+
---
9+
10+
:::div{.hint}
11+
Octopus Approvals is currently in Alpha, available to a small set of customers. If you are interested in this feature please register your interest on the [roadmap card](https://roadmap.octopus.com/c/243-approvals-for-deployments) and we'll keep you updated.
12+
:::
13+
14+
## Overview
15+
16+
Octopus Approvals is a built-in change approval system for Octopus Deploy. Octopus blocks deployments and runbook runs until designated approvers sign off directly within Octopus. This means you don't need any external ITSM tools to manage your changes.
17+
18+
When a controlled deployment or runbook run triggers, Octopus automatically creates a change request (with the format `OCT-{number}`) and pauses execution. Designated users or team members can then approve or reject the request. Once the minimum number of approvals is reached, Octopus allows execution to proceed. If any approver rejects the request, Octopus terminates the task.
19+
20+
## Getting started
21+
22+
Enable Octopus Approvals on your Octopus instance by navigating to **Configuration ➜ Settings ➜ Octopus Approvals** and tick **Is Enabled** and save.
23+
24+
Once Octopus Approvals is enabled, navigate to **Library ➜ Approvals ➜ Manage Approvals** to create your first approval policy, then configure scope to apply it to the relevant projects and environments.
25+
26+
## Configuring an approval policy
27+
28+
Navigate to **Library ➜ Approvals ➜ Manage Approvals** and select **Add Approval Policy**. Each policy includes the following settings:
29+
30+
- **Name**: A short, memorable, unique name for this approval policy.
31+
- **Description**: An optional description for this approval policy.
32+
- **Scope**: The projects and environments that this approval policy should apply to. Octopus will require approvals for deployments and runbook runs that match the selected project and environment combination.
33+
34+
You can scope the approval policy by project and environment tags or individual project and environments.
35+
36+
- **Approvers**: Select the Octopus teams or individual users who are authorized to approve change requests under this policy. Any member of an approving team counts toward the minimum approvers total.
37+
38+
Octopus can optionally block the deployment creator from approving their own change request. Enable **Block approvals by the deployment creator** to enforce this separation of duties.
39+
40+
- **Minimum approvers required** The number of approvals Octopus requires before allowing execution to proceed. If any approver rejects the change request before this threshold is reached, Octopus immediately terminates the task.
41+
42+
## How it works
43+
44+
Octopus will generate a change request depending on the configured approval policies. If the required number of approvals is reached, the deployment will continue according to change windows. If the change request is rejected, the task is terminated.
45+
46+
### Change request creation
47+
48+
When a deployment or runbook run triggers and it is in scope for an approval policy, Octopus automatically creates a change request with a unique reference number in the format `OCT-{number}` (for example, `OCT-42`). Octopus immediately pauses execution and displays the change request status in the task log.
49+
50+
If multiple approval policies match, the policies are merged to a resultant policy.
51+
52+
- Approvers are merged as a union of the approvers from each policy that has a matching scope.
53+
- The minimum approvers required will be equal to the highest value from all approval policies with matching scope.
54+
55+
### Change windows
56+
57+
Octopus supports change windows. Change windows are scheduled time periods during which a deployment is allowed to run. If a change request is approved but the change window has not yet opened, Octopus keeps execution paused. If the change window closes before the deployment runs (whether the request is approved or still pending), Octopus terminates the task.
58+
59+
### Rejection
60+
61+
If any designated approver rejects the change request, Octopus immediately terminates the task. You cannot retry a rejected task; you must trigger a deployment of a new release or runbook run, which will create a fresh change request.
62+
63+
## Reviewing change requests
64+
65+
Octopus surfaces change requests in several places so approvers can act on them without leaving their current context.
66+
67+
### Approvals
68+
69+
Navigate to **Library ➜ Approvals** for a complete list of all change requests. The list is divided into three tabs:
70+
71+
- **Needs Approval**: Change requests that are still pending the required number of approvals.
72+
- **Completed**: Change requests that have been approved or rejected.
73+
- **All**: All change requests regardless of state.
74+
75+
Each row shows the **Change Request** number (as a link). Select the change request link to open the **Review change request** page, where you can see the full approval details and submit your approval or rejection.
76+
77+
### Tasks Page
78+
79+
Navigate to **Tasks** and select the **Needs Approval** tab for a filtered view of all tasks currently waiting on an approval. If the task is waiting for an Octopus Approval, the row will have a button to review the change request associated with this task.
80+
81+
Select **Review** to open the drawer to view the change request details and submit your approval or rejection.
82+
83+
### Deployment or Runbook Run Page
84+
85+
When a deployment or runbook run is blocked on an Octopus Approval, a warning callout appears at the top of the task page:
86+
87+
> **Approval needed to continue this deployment**
88+
> This deployment is blocked by change request OCT-n and requires approval from N approvers.
89+
90+
Select **Review** to open the drawer to view the change request details and submit your approval or rejection.
91+
92+
### Release Page
93+
94+
When viewing a release, under **Progression** you will see a list of deployments to the environments in your lifecycle and lifecycle phases. If a deployment to an environment is blocked on an Octopus Approval, the environment will have a button to review the change request associated with this task.
95+
96+
Select **Review** to open the drawer to view the change request details and submit your approval or rejection.

src/pages/docs/installation/load-balancers/aws-load-balancers.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ gRPC traffic can be routed with either the Application Load Balancer which provi
2727

2828
If you choose to use the Application Load Balancer you might come across certain errors like the following from our gRPC clients(Kubernetes Monitor/Argo CD Gateway)
2929

30-
```golang
30+
```go
3131
stream terminated by RST_STREAM with error code: PROTOCOL_ERROR
3232
```
3333

0 commit comments

Comments
 (0)