Skip to content

Commit 6161168

Browse files
committed
Merge remote-tracking branch 'origin/main' into bobjwalker/m1-platform-hub-recommendations
2 parents 1c50b2f + e3f4333 commit 6161168

File tree

8 files changed

+159
-37
lines changed

8 files changed

+159
-37
lines changed

src/pages/docs/approvals/jira-service-management/index.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -241,6 +241,22 @@ The following list assumes the linked change is in an **approved** state.
241241

242242
**If at any time a `Planned end` is exceeded and the linked change request is not approved, the deployment will be terminated.**
243243

244+
## Available Variables in a Deployment or Runbook
245+
246+
:::div{.info}
247+
The following variables are only available in version 2025.4 and later
248+
:::
249+
250+
| Variable | Notes |
251+
|--|--|
252+
| `Octopus.JiraServiceManagement.ChangeRequest.Number` | The number of the matched or created change request |
253+
| `Octopus.JiraServiceManagement.ChangeRequest.Id` | The system identifier of the matched or created change request |
254+
| `Octopus.JiraServiceManagement.Connection.Id` | |
255+
| `Octopus.JiraServiceManagement.Connection.Name` | |
256+
| `Octopus.JiraServiceManagement.Connection.BaseUrl` | |
257+
| `Octopus.JiraServiceManagement.Connection.Username` | |
258+
| `Octopus.JiraServiceManagement.Connection.Token` | |
259+
244260
## Known issues and limitations
245261

246262
- Once an Issue is deemed to be related to a deployment, then only this Issue will be evaluated for

src/pages/docs/approvals/servicenow/index.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,6 @@ The expected ServiceNow value doesn't always align with the displayed value. In
273273

274274
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).
275275

276-
277276
### Respecting change windows
278277

279278
:::div{.warning}
@@ -293,6 +292,24 @@ The following list assumes the linked change is in an **approved** state.
293292

294293
**If at any time a `Planned end date` is exceeded and the linked change request is not approved, the deployment will be terminated.**
295294

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 |
305+
| `Octopus.ServiceNow.Connection.Id` | |
306+
| `Octopus.ServiceNow.Connection.Name` | |
307+
| `Octopus.ServiceNow.Connection.BaseUrl` | |
308+
| `Octopus.ServiceNow.Connection.OAuthClientId` | |
309+
| `Octopus.ServiceNow.Connection.OAuthClientSecret` | |
310+
| `Octopus.ServiceNow.Connection.Username` | |
311+
| `Octopus.ServiceNow.Connection.Password` | |
312+
296313
## Known Issues and limitations
297314

298315
- 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.

src/pages/docs/kubernetes/targets/kubernetes-agent/index.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -79,11 +79,11 @@ The Kubernetes agent follows [semantic versioning](https://semver.org/), so a ma
7979
| ---------------- | ------------------------ | -------------------- |
8080
| 1.0.0 - 1.16.1 | **2024.2.6580** or newer | **1.26** to **1.29** |
8181
| 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** |
8383
| 1.22.0 - 1.\*.\* | **2024.2.6580** or newer | **1.29** to **1.32** |
8484
| 2.0.0 - 2.2.1 | **2024.2.9396** or newer | **1.26** to **1.29** |
8585
| 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** |
8787
| 2.12.0 - 2.25.1 | **2024.2.9396** or newer | **1.29** to **1.32** |
8888
| 2.26.0 - 2.\*.\* | **2024.2.9396** or newer | **1.30** to **1.33** |
8989

@@ -243,12 +243,29 @@ MII...
243243
-----END CERTIFICATE-----
244244
```
245245

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.
247247

248248
To include this in the installation command, add the following to the generated installation command:
249249

250250
```bash
251-
--set agent.serverCertificate="<base64-encoded-cert>"
251+
--set global.serverCertificate="<base64-encoded-cert>"
252+
```
253+
254+
You can also opt to use an existing secret containing your certificate under the `octopus-server-certificate.pem` key with the following addition:
255+
256+
```bash
257+
--set global.serverCertificateSecretName="octopus-server-certificate"
258+
```
259+
260+
The referenced secret should take the form:
261+
262+
```yaml
263+
apiVersion: v1
264+
kind: Secret
265+
metadata:
266+
name: octopus-server-certificate
267+
data:
268+
octopus-server-certificate.pem: "<base64-encoded-cert>"
252269
```
253270
254271
## Agent tooling

src/pages/docs/octopus-ai/mcp/index.mdx

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ navOrder: 2
1111

1212
### Octopus MCP Server
1313

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.
1515

1616
The Octopus MCP server provides similar capabilities to the Octopus AI Assistant, but provides further benefits:
1717

@@ -22,12 +22,18 @@ The MCP server provides tools designed to solve key use-cases within change mana
2222

2323
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.
2424

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)
2626

2727
:::div{.info}
2828
This project is currently in Early Access, and subject to breaking changes.
2929
:::
3030

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.
36+
3137
## 🚀 Installation
3238

3339
### Requirements

src/pages/docs/octopus-cloud/index.mdx

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -22,31 +22,32 @@ We recommend Octopus Cloud over Octopus Server for the following reasons:
2222

2323
## Minimize downtime and increase resilience
2424

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.
2828

2929
## Secure and compliant out-of-the-box
3030

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.
3738

3839
## Increase team efficiency
3940

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.
4344

4445
## Effortlessly scale your deployments
4546

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.
5051

5152
:::figure
5253
![Octopus Cloud architecture diagram](/docs/img/octopus-cloud/images/octopus-cloud-architecture-diagram.png)

src/pages/docs/octopus-rest-api/examples/bulk-operations/index.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,7 @@ All the scripts in this section will include:
1515
- A list of what would've changed (when what-if is `True`), or what just changed (when what-if is `False`).
1616
- 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.
1717

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)

src/pages/docs/platform-hub/process-templates/troubleshooting.md

Lines changed: 64 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,32 +3,78 @@ layout: src/layouts/Default.astro
33
pubDate: 2025-09-23
44
modDate: 2025-09-23
55
title: Troubleshooting
6-
subtitle: Common issues that you may run into
6+
subtitle: Known issues that you may run into
77
icon: fa-solid fa-layer-group
88
navTitle: Troubleshooting
99
navSection: Process Templates
10-
description: Common issues and their fixes for process templates
10+
description: Known issues and limitations for process templates
1111
navOrder: 151
1212
---
1313

1414
## Troubleshooting common issues
1515

1616
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.
1717

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+
1822
### Step support
1923

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:
2125

2226
1. Deploy a Bicep Template
2327
2. AWS S3 Create Bucket
2428
3. AWS ECS
2529
4. All Custom Step Templates
2630
5. All Community Step Templates
2731

32+
This document will be updated as additional step support is added.
33+
2834
### Parameters and Variables
2935

3036
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.
3137

38+
For example, consider this script that directly references project and system variables via `OctopusParameters`.
39+
40+
```
41+
$packagePath = $OctopusParameters["Octopus.Action.Package[Trident.Database].ExtractedPath"]
42+
$connectionString = $OctopusParameters["Project.Connection.String"]
43+
$environmentName = $OctopusParameters["Octopus.Environment.Name"]
44+
$reportPath = $OctopusParameters["Project.Database.Report.Path"]
45+
46+
cd $packagePath
47+
$appToRun = ".\Octopus.Trident.Database.DbUp"
48+
$generatedReport = "$reportPath\UpgradeReport.html"
49+
50+
& $appToRun --ConnectionString="$connectionString" --PreviewReportPath="$reportPath"
51+
52+
New-OctopusArtifact -Path "$generatedReport" -Name "$environmentName.UpgradeReport.html"
53+
```
54+
55+
The following variables should be updated to reference process templates parameters instead of project variables:
56+
57+
1. `$packagePath`
58+
2. `$connectionString`
59+
3. `$reportPath`
60+
61+
The `$environmentName` variable is fine, as system variables will continue to work as normal. The updated script will be:
62+
63+
```
64+
$packagePath = $OctopusParameters["Octopus.Action.Package[Template.Database.Package].ExtractedPath"]
65+
$connectionString = $OctopusParameters["Template.Database.ConnectionString"]
66+
$environmentName = $OctopusParameters["Octopus.Environment.Name"]
67+
$reportPath = $OctopusParameters["Template.Database.ChangeReportDirectory"]
68+
69+
cd $packagePath
70+
$appToRun = ".\Octopus.Trident.Database.DbUp"
71+
$generatedReport = "$reportPath\UpgradeReport.html"
72+
73+
& $appToRun --ConnectionString="$connectionString" --PreviewReportPath="$reportPath"
74+
75+
New-OctopusArtifact -Path "$generatedReport" -Name "$environmentName.UpgradeReport.html"
76+
```
77+
3278
### Parameter scoping
3379

3480
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
75121

76122
- You cannot configure **Edit YAML** on the **Configure and apply Kubernetes resource** step.
77123
- 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.
79125

80126
### Cloning process templates
81127

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.
83136

84137
### Platform Hub account limitations
85138

@@ -95,7 +148,12 @@ Platform Hub accounts cannot be used in the following situations:
95148

96149
### Public API
97150

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.
99157

100158
### GitHub Connections
101159

0 commit comments

Comments
 (0)