You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/pages/docs/approvals/servicenow/index.md
+18-1Lines changed: 18 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -273,7 +273,6 @@ The expected ServiceNow value doesn't always align with the displayed value. In
273
273
274
274
For a full list of available fields and values refer to the [ServiceNow docs](https://developer.servicenow.com/dev.do#!/reference/api/utah/rest/change-management-api).
275
275
276
-
277
276
### Respecting change windows
278
277
279
278
:::div{.warning}
@@ -293,6 +292,24 @@ The following list assumes the linked change is in an **approved** state.
293
292
294
293
**If at any time a `Planned end date` is exceeded and the linked change request is not approved, the deployment will be terminated.**
295
294
295
+
## Available Variables in a Deployment or Runbook
296
+
297
+
:::div{.info}
298
+
The following variables are only available in version 2025.4 and later
299
+
:::
300
+
301
+
| Variable | Notes |
302
+
|--|--|
303
+
|`Octopus.ServiceNow.ChangeRequest.Number`| The number of the matched or created change request |
304
+
|`Octopus.ServiceNow.ChangeRequest.SysId`| The system identifier of the matched or created change request |
- Once a CR is deemed to be related to a deployment, then only this CR will be evaluated for the deployment to proceed. If the CR is incorrect, you will need to cancel the deployment, close the CR and try the deployment again.
| 1.0.0 - 1.16.1 |**2024.2.6580** or newer |**1.26** to **1.29**|
81
81
| 1.17.0 - 1.19.2 |**2024.2.6580** or newer |**1.27** to **1.30**|
82
-
| 1.20.0 - 1.21.0 |**2024.2.6580** or newer |**1.28** to **1.31**|
82
+
| 1.20.0 - 1.21.0 |**2024.2.6580** or newer |**1.28** to **1.31**|
83
83
| 1.22.0 - 1.\*.\*|**2024.2.6580** or newer |**1.29** to **1.32**|
84
84
| 2.0.0 - 2.2.1 |**2024.2.9396** or newer |**1.26** to **1.29**|
85
85
| 2.3.0 - 2.8.2 |**2024.2.9396** or newer |**1.27** to **1.30**|
86
-
| 2.9.0 - 2.11.3 |**2024.2.9396** or newer |**1.28** to **1.31**|
86
+
| 2.9.0 - 2.11.3 |**2024.2.9396** or newer |**1.28** to **1.31**|
87
87
| 2.12.0 - 2.25.1 |**2024.2.9396** or newer |**1.29** to **1.32**|
88
88
| 2.26.0 - 2.\*.\*|**2024.2.9396** or newer |**1.30** to **1.33**|
89
89
@@ -243,12 +243,29 @@ MII...
243
243
-----END CERTIFICATE-----
244
244
```
245
245
246
-
Once encoded, this string can be provided as part of the agent installation helm command via the `agent.serverCertificate` helm value.
246
+
Once encoded, this string can be provided as part of the agent installation helm command via the `global.serverCertificate` (or `agent.ServerCertificate`) helm value.
247
247
248
248
To include this in the installation command, add the following to the generated installation command:
Copy file name to clipboardExpand all lines: src/pages/docs/octopus-ai/mcp/index.mdx
+8-2Lines changed: 8 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ navOrder: 2
11
11
12
12
### Octopus MCP Server
13
13
14
-
The upcoming Octopus MCP ([Model Context Protocol](https://modelcontextprotocol.io/)) server represents a significant leap forward in AI integration capabilities. Built on Anthropic's open standard for connecting AI assistants to external data sources and tools, the MCP server will enable AI assistants like Claude to interact directly with your Octopus Deploy infrastructure.
14
+
The Octopus MCP ([Model Context Protocol](https://modelcontextprotocol.io/)) server represents a significant leap forward in AI integration capabilities. Built on Anthropic's open standard for connecting AI assistants to external data sources and tools, the MCP server enables AI assistants like Claude to interact directly with your Octopus Deploy infrastructure.
15
15
16
16
The Octopus MCP server provides similar capabilities to the Octopus AI Assistant, but provides further benefits:
17
17
@@ -22,12 +22,18 @@ The MCP server provides tools designed to solve key use-cases within change mana
22
22
23
23
The MCP server architecture ensures that your deployment data remains secure while enabling powerful AI-assisted workflows. All interactions are logged and auditable, maintaining the compliance and governance standards your organization requires.
24
24
25
-
We are releasing the MCP server as an open source tool that anyone can contribute to. It is available for free on Github at [https://github.com/OctopusDeploy/mcp-server](https://github.com/OctopusDeploy/mcp-server)
25
+
The Octopus MCP Server is open source, and anyone can contribute to it. It's available for free on Github at [https://github.com/OctopusDeploy/mcp-server](https://github.com/OctopusDeploy/mcp-server)
26
26
27
27
:::div{.info}
28
28
This project is currently in Early Access, and subject to breaking changes.
29
29
:::
30
30
31
+
## Security
32
+
33
+
The Octopus MCP Server works by communicating with your Octopus instance's REST API via a secure HTTPS connection. It leverages Octopus Server's existing API Key security mechanism, ensuring all interactions are authenticated, authorized for the permissions associated with the API Key, and audited.
34
+
35
+
To learn more, read our [Octopus REST API](/docs/octopus-rest-api) documentation.
Copy file name to clipboardExpand all lines: src/pages/docs/octopus-cloud/index.mdx
+17-16Lines changed: 17 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,31 +22,32 @@ We recommend Octopus Cloud over Octopus Server for the following reasons:
22
22
23
23
## Minimize downtime and increase resilience
24
24
25
-
- We take care of any issues that arise so you don't have to worry about downtime, data loss, or disruptions
26
-
- Our 24x7 monitoring and alerting and proactive issue detection means problems get addressed before they impact your operations
27
-
- Automatic recovery with comprehensive [disaster recovery](https://octopus.com/docs/octopus-cloud/disaster-recovery#disaster-recovery-procedure) procedures means your data is safe and quickly recoverable in case of a failure
25
+
- We take care of any issues that arise so you don't have to worry about downtime, data loss, or disruptions.
26
+
- Our 24x7 monitoring and alerting and proactive issue detection means problems get addressed before they impact your operations.
27
+
- Automatic recovery with comprehensive [disaster recovery](https://octopus.com/docs/octopus-cloud/disaster-recovery#disaster-recovery-procedure) procedures means your data is safe and quickly recoverable in case of a failure.
28
28
29
29
## Secure and compliant out-of-the-box
30
30
31
-
- Peace of mind with internationally recognized security standards, ensuring business compliance and protecting your reputation
32
-
- ISO 27001 and SOC II certifications with regular audits, ensuring your deployments and data are safe and secure
33
-
- Data and application layer isolation per customer, so there are no noisy neighbors or cross-talk
34
-
- OpenID Connect (OIDC) support so you can integrate with other services securely and without needing to manage credentials
35
-
- Network security and static IP addresses
36
-
- Flexibility of hosting region choices
31
+
- Peace of mind with internationally recognized security standards, ensuring business compliance and protecting your reputation.
32
+
- ISO 27001 and SOC II certifications with regular audits, ensuring your deployments and data are safe and secure.
33
+
- Data and application layer isolation per customer, so there are no noisy neighbors or cross-talk.
34
+
- OpenID Connect (OIDC) support so you can integrate with other services securely and without needing to manage credentials.
35
+
- Network security and static IP addresses.
36
+
- Flexibility of hosting region choices.
37
+
- With IP allow listing, you can control who can reach Octopus Cloud, securing your entry points and enhancing compliance. With Azure Private Links, communication is routed via a secure, private network path, ensuring the data doesn’t traverse the public internet. When combined, these controls eliminate external exposure, reduce attack surface, and align with stringent compliance and security policies.
37
38
38
39
## Increase team efficiency
39
40
40
-
- Stay ahead of the competition with less time maintaining software and more time shipping new features
41
-
- Automatic upgrades to the latest version of Octopus, including improvements, bug fixes, security enhancements, and [new features](https://octopus.com/whatsnew) before they’re released on Octopus Server
42
-
- Expert support by experienced Octopus Support and Cloud Operations teams who swiftly resolve issues and provide regular maintenance
41
+
- Stay ahead of the competition with less time maintaining software and more time shipping new features.
42
+
- Automatic upgrades to the latest version of Octopus, including improvements, bug fixes, security enhancements, and [new features](https://octopus.com/whatsnew) before they’re released on Octopus Server.
43
+
- Expert support by experienced Octopus Support and Cloud Operations teams who swiftly resolve issues and provide regular maintenance.
43
44
44
45
## Effortlessly scale your deployments
45
46
46
-
- Your teams can scale their use without the hassle of resource management and additional infrastructure costs
47
-
- We provide appropriate resources and automatic scaling for seamless performance
48
-
- Ample bandwidth and storage resources to handle your data and traffic without additional costs
49
-
- Windows and Linux dynamic workers provide flexible and scalable deployment options
47
+
- Your teams can scale their use without the hassle of resource management and additional infrastructure costs.
48
+
- We provide appropriate resources and automatic scaling for seamless performance.
49
+
- Ample bandwidth and storage resources to handle your data and traffic without additional costs.
50
+
- Windows and Linux dynamic workers provide flexible and scalable deployment options.
Copy file name to clipboardExpand all lines: src/pages/docs/octopus-rest-api/examples/bulk-operations/index.md
+4-1Lines changed: 4 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,4 +15,7 @@ All the scripts in this section will include:
15
15
- A list of what would've changed (when what-if is `True`), or what just changed (when what-if is `False`).
16
16
- A "limiter" parameter that will limit the number of changes per run. If you have 25 items to change, and the limit is set to 5, it will only change five items per run. You'd need to run the script five times to change all 25 items. This was added so you can do some test runs and spot-check the results.
17
17
18
-
Provided sample bulk operations are:
18
+
Provided sample bulk operations are:
19
+
20
+
-[Bulk add a project to a list of tenants](/docs/octopus-rest-api/examples/bulk-operations/bulk-add-projects-to-tenants)
21
+
-[Rerun all canceled deployments and runbook runs after node shutdown](/docs/octopus-rest-api/examples/bulk-operations/rerun-deployments-and-runbooks-after-node-shutdown)
description: Common issues and their fixes for process templates
10
+
description: Known issues and limitations for process templates
11
11
navOrder: 151
12
12
---
13
13
14
14
## Troubleshooting common issues
15
15
16
16
You may run into a few issues when setting up your process templates. We've put together this page to help you diagnose and fix common issues.
17
17
18
+
:::div{.warning}
19
+
Process Templates is in Public Preview for all Enterprise Tier Customers. Below are known limitations with the public preview.
20
+
:::
21
+
18
22
### Step support
19
23
20
-
We have support for most Octopus steps, except for the following:
24
+
Process templates currently supports most Octopus steps. It currently doesn't support the following:
21
25
22
26
1. Deploy a Bicep Template
23
27
2. AWS S3 Create Bucket
24
28
3. AWS ECS
25
29
4. All Custom Step Templates
26
30
5. All Community Step Templates
27
31
32
+
This document will be updated as additional step support is added.
33
+
28
34
### Parameters and Variables
29
35
30
36
If you are migrating an existing process to be used as a process template, you may run into a few issues when using parameters and variables in scripts. When copying a script from a step in a project into a process template step, you must convert project variables to use process template parameters. System variables will still work as normal.
31
37
38
+
For example, consider this script that directly references project and system variables via `OctopusParameters`.
Project supplied values for parameters will always take precedence over process template supplied ones.
@@ -75,11 +121,18 @@ When deploying to the **Development** environment, **Account-124** would be used
75
121
76
122
- You cannot configure **Edit YAML** on the **Configure and apply Kubernetes resource** step.
77
123
- You cannot configure cloud target discovery on steps. You must use project variables when consuming a process template in a project instead.
78
-
-You cannot pick the project Git repository source on any step.
124
+
-When referencing a file from a Git repo, for example, script, manifest, Kustomize, etc., you cannot pick the project Git repository as the source. You must supply the Git repository URL. The URL can be passed in via a parameter or hardcoded in the template itself. Hardcoding is not recommended.
79
125
80
126
### Cloning process templates
81
127
82
-
You cannot clone a process template in Platform Hub through the Octopus UI. If you need to copy a deployment process from a process template, you can copy the OCL definition of the deployment process, and use it in another file to copy an existing process.
128
+
You cannot clone a process template in Platform Hub through the Octopus UI. The process for cloning a process template is:
129
+
130
+
1. Clone the process template OCL file in the Platform Hub Git repository.
131
+
2. Change the name of the cloned OCL file to the desired name.
132
+
3. Change the name of the process template in the OCL file.
133
+
4. Commit and push the changes.
134
+
5. Refresh the process template list in the Octopus Deploy UI and find the newly created template.
135
+
6. Publish the template and configure the Spaces that have access to it.
83
136
84
137
### Platform Hub account limitations
85
138
@@ -95,7 +148,12 @@ Platform Hub accounts cannot be used in the following situations:
95
148
96
149
### Public API
97
150
98
-
We do not currently have support for creating or managing process templates through the API, CLI or the Terraform provider. You should use the Octopus UI as much as possible to create or manage your process templates.
151
+
We do not currently have support for creating or managing process templates through the API, CLI or the Terraform provider.
152
+
153
+
- Process templates are stored as code in the configured Git repository. The OCL files store all relevant information about the template - including the parameters, the steps, name, description and other settings.
154
+
- The published versions and Spaces configured are stored and managed via the database.
155
+
156
+
We recommend all users use the Octopus Deploy UI to manage process templates during the public preview. Any processes or workflows you build outside of the Octopus Deploy UI is subject to change and without warning.
0 commit comments