Skip to content
Merged
Show file tree
Hide file tree
Changes from 13 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions dictionary-octopus.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ accounttest
actionid
actiontemplates
advfirewall
agentic
ALLUSERSPROFILE
anglin
anotherdir
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"width":2391,"height":1936,"updated":"2025-09-18T06:53:41.862Z"}
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
layout: src/layouts/Redirect.astro
title: Redirect
redirect: https://octopus.com/docs/octopus-ai/assistant/cookbook
pubDate: 2025-07-16
navSearch: false
navSitemap: false
navMenu: false
---
48 changes: 8 additions & 40 deletions src/pages/docs/octopus-ai-assistant/cookbook/index.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,9 @@
---
layout: src/layouts/Default.astro
pubDate: 2025-07-16
modDate: 2025-07-22
title: Octopus AI Assistant Cookbook
navTitle: Overview
navSection: Cookbook
description: A collection of prompt-based automation examples for Octopus Deploy
navOrder: 4
---

This cookbook includes ready-to-use prompts that help automate and optimize your work with Octopus Deploy.

## Available Recipes

- [Analyze step template usage](/docs/octopus-ai-assistant/cookbook/analyze-step-template-usage)
- [Audit environment naming and counts](/docs/octopus-ai-assistant/cookbook/audit-environment-naming-and-counts)
- [Audit PCI deployments](/docs/octopus-ai-assistant/cookbook/audit-pci-deployments)
- [Audit target role distribution](/docs/octopus-ai-assistant/cookbook/audit-target-role-distribution)
- [Check retention policy consistency](/docs/octopus-ai-assistant/cookbook/check-retention-policy-consistency)
- [Create a .NET Azure App deployment process](/docs/octopus-ai-assistant/cookbook/create-a-net-azure-app-deployment-process)
- [Detect overlapping variable names](/docs/octopus-ai-assistant/cookbook/detect-overlapping-variable-names)
- [Detect unused variables](/docs/octopus-ai-assistant/cookbook/detect-unused-variables)
- [Evaluate deployment frequency](/docs/octopus-ai-assistant/cookbook/evaluate-deployment-frequency)
- [Fix variable binding errors](/docs/octopus-ai-assistant/cookbook/fix-variable-binding-errors)
- [Generate deployment rollback plan](/docs/octopus-ai-assistant/cookbook/generate-deployment-rollback-plan)
- [Improve multi-tenant deployments](/docs/octopus-ai-assistant/cookbook/improve-multi-tenant-deployments)
- [Investigate production deployment failure](/docs/octopus-ai-assistant/cookbook/investigate-production-deployment-failure)
- [Kubernetes deployment pipeline](/docs/octopus-ai-assistant/cookbook/kubernetes-deployment-pipeline)
- [List failed deployments](/docs/octopus-ai-assistant/cookbook/list-failed-deployments)
- [Recommend variable scoping](/docs/octopus-ai-assistant/cookbook/recommend-variable-scoping)
- [Report runbook scheduling](/docs/octopus-ai-assistant/cookbook/report-runbook-scheduling)
- [Report skipped steps](/docs/octopus-ai-assistant/cookbook/report-skipped-steps)
- [Resolve rolling deployment timeouts](/docs/octopus-ai-assistant/cookbook/resolve-rolling-deployment-timeouts)
- [Restart Windows services Runbook](/docs/octopus-ai-assistant/cookbook/restart-windows-services-runbook)
- [Review runbook usage](/docs/octopus-ai-assistant/cookbook/review-runbook-usage)
- [Security best practices check](/docs/octopus-ai-assistant/cookbook/security-best-practices-check)
- [Speed up Lifecycle phases](/docs/octopus-ai-assistant/cookbook/speed-up-lifecycle-phases)
- [Summarize Ops Runbooks](/docs/octopus-ai-assistant/cookbook/summarize-ops-runbooks)
- [Summarize tag set coverage](/docs/octopus-ai-assistant/cookbook/summarize-tag-set-coverage)
- [Summarize worker pool health](/docs/octopus-ai-assistant/cookbook/summarize-worker-pool-health)
layout: src/layouts/Redirect.astro
title: Redirect
redirect: https://octopus.com/docs/octopus-ai/assistant/cookbook
pubDate: 2025-07-16
navSearch: false
navSitemap: false
navMenu: false
---
41 changes: 41 additions & 0 deletions src/pages/docs/octopus-ai/assistant/cookbook/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
layout: src/layouts/Default.astro
pubDate: 2025-07-16
modDate: 2025-07-22
title: Octopus AI Assistant Cookbook
navTitle: Overview
navSection: Cookbook
description: A collection of prompt-based automation examples for Octopus Deploy
navOrder: 4
---

This cookbook includes ready-to-use prompts that help automate and optimize your work with Octopus Deploy.

## Available Recipes

- [Analyze step template usage](/docs/octopus-ai/assistant/cookbook/analyze-step-template-usage)
- [Audit environment naming and counts](/docs/octopus-ai/assistant/cookbook/audit-environment-naming-and-counts)
- [Audit PCI deployments](/docs/octopus-ai/assistant/cookbook/audit-pci-deployments)
- [Audit target role distribution](/docs/octopus-ai/assistant/cookbook/audit-target-role-distribution)
- [Check retention policy consistency](/docs/octopus-ai/assistant/cookbook/check-retention-policy-consistency)
- [Create a .NET Azure App deployment process](/docs/octopus-ai/assistant/cookbook/create-a-net-azure-app-deployment-process)
- [Detect overlapping variable names](/docs/octopus-ai/assistant/cookbook/detect-overlapping-variable-names)
- [Detect unused variables](/docs/octopus-ai/assistant/cookbook/detect-unused-variables)
- [Evaluate deployment frequency](/docs/octopus-ai/assistant/cookbook/evaluate-deployment-frequency)
- [Fix variable binding errors](/docs/octopus-ai/assistant/cookbook/fix-variable-binding-errors)
- [Generate deployment rollback plan](/docs/octopus-ai/assistant/cookbook/generate-deployment-rollback-plan)
- [Improve multi-tenant deployments](/docs/octopus-ai/assistant/cookbook/improve-multi-tenant-deployments)
- [Investigate production deployment failure](/docs/octopus-ai/assistant/cookbook/investigate-production-deployment-failure)
- [Kubernetes deployment pipeline](/docs/octopus-ai/assistant/cookbook/kubernetes-deployment-pipeline)
- [List failed deployments](/docs/octopus-ai/assistant/cookbook/list-failed-deployments)
- [Recommend variable scoping](/docs/octopus-ai/assistant/cookbook/recommend-variable-scoping)
- [Report runbook scheduling](/docs/octopus-ai/assistant/cookbook/report-runbook-scheduling)
- [Report skipped steps](/docs/octopus-ai/assistant/cookbook/report-skipped-steps)
- [Resolve rolling deployment timeouts](/docs/octopus-ai/assistant/cookbook/resolve-rolling-deployment-timeouts)
- [Restart Windows services Runbook](/docs/octopus-ai/assistant/cookbook/restart-windows-services-runbook)
- [Review runbook usage](/docs/octopus-ai/assistant/cookbook/review-runbook-usage)
- [Security best practices check](/docs/octopus-ai/assistant/cookbook/security-best-practices-check)
- [Speed up Lifecycle phases](/docs/octopus-ai/assistant/cookbook/speed-up-lifecycle-phases)
- [Summarize Ops Runbooks](/docs/octopus-ai/assistant/cookbook/summarize-ops-runbooks)
- [Summarize tag set coverage](/docs/octopus-ai/assistant/cookbook/summarize-tag-set-coverage)
- [Summarize worker pool health](/docs/octopus-ai/assistant/cookbook/summarize-worker-pool-health)
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Below is a basic example of how the Deployment Failure Analyzer works in practic

## Adding business logic using custom prompts

For organizations with specific internal processes and troubleshooting procedures, you can enhance the Deployment Failure Analyzer with custom business logic using [custom prompts](/docs/octopus-ai-assistant/custom-prompts). Custom prompts are defined as variables in Library Variable Sets within Octopus Deploy, allowing you to embed organization-specific guidance and next steps directly into the failure analysis responses.
For organizations with specific internal processes and troubleshooting procedures, you can enhance the Deployment Failure Analyzer with custom business logic using [custom prompts](/docs/octopus-ai/assistant/custom-prompts). Custom prompts are defined as variables in Library Variable Sets within Octopus Deploy, allowing you to embed organization-specific guidance and next steps directly into the failure analysis responses.

Custom prompts work by combining a user-facing prompt (`PageName[#].Prompt`) with an optional system prompt (`PageName[#].SystemPrompt`) that contains your business logic. The `.Prompt` variable defines what users see and interact with, while the `.SystemPrompt` variable provides behind-the-scenes instructions that guide the AI's analysis without being visible to users.

Expand All @@ -69,4 +69,4 @@ In this example, when the analyzer detects an issue related to a missing Azure R

This approach ensures users get immediate, actionable guidance that follows your organization's established support processes, reducing resolution time and ensuring consistency across teams.

For detailed instructions on setting up custom prompts, including variable naming conventions and supported pages, see the [custom prompts documentation](/docs/octopus-ai-assistant/custom-prompts).
For detailed instructions on setting up custom prompts, including variable naming conventions and supported pages, see the [custom prompts documentation](/docs/octopus-ai/assistant/custom-prompts).
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: Octopus AI Assistant
navTitle: Overview
navSection: Octopus AI Assistant
description: How to use Octopus AI Assistant to create projects, analyze deployments, optimize configurations, and get instant help with Octopus Deploy
navOrder: 26
navOrder: 1
---

Octopus AI Assistant integrates AI functionality directly into the Octopus Deploy interface to accelerate your DevOps workflows. Whether you're getting started with Octopus Deploy, troubleshooting deployment failures, or optimizing existing configurations, the AI Assistant provides context-aware guidance and automation to help you work more efficiently.
Expand All @@ -17,7 +17,7 @@ The Octopus AI Assistant Alpha is a feature released to an audience who has opte

![Octopus AI Assistant Screenshot](/docs/img/octopus-ai-assistant/octopus-ai-assistant.png)

To begin, see our [Getting Started](/docs/octopus-ai-assistant/getting-started) guide for setup instructions.
To begin, see our [Getting Started](/docs/octopus-ai/assistant/getting-started) guide for setup instructions.

## Core capabilities

Expand Down Expand Up @@ -52,7 +52,7 @@ Example prompts:
- `Create an Azure Web App project called "My Web App"`
- `Generate an AWS Lambda project with QA and Production environments`

[Learn more about project creation.](/docs/octopus-ai-assistant/project-creation)
[Learn more about project creation.](/docs/octopus-ai/assistant/project-creation)

### Deployment failure analysis

Expand All @@ -63,7 +63,7 @@ Example prompts:
- `Why did the deployment fail?`
- `Help me understand this deployment error`

[Learn more about deployment failure analysis.](/docs/octopus-ai-assistant/deployment-failure-analyzer)
[Learn more about deployment failure analysis.](/docs/octopus-ai/assistant/deployment-failure-analyzer)

### Best practices optimization

Expand All @@ -75,11 +75,11 @@ Example prompts:
- `Check for duplicate project variables`
- `Suggest tenant tags to make tenants more manageable`

[Learn more about the best practices adviser.](/docs/octopus-ai-assistant/best-practices-adviser)
[Learn more about the best practices adviser.](/docs/octopus-ai/assistant/best-practices-adviser)

## Custom prompts for organizational needs

For teams with specific internal processes, you can enhance any AI Assistant capability with [custom prompts](/docs/octopus-ai-assistant/custom-prompts) that embed your organization's knowledge, procedures, and support channels directly into the AI responses.
For teams with specific internal processes, you can enhance any AI Assistant capability with [custom prompts](/docs/octopus-ai/assistant/custom-prompts) that embed your organization's knowledge, procedures, and support channels directly into the AI responses.

## We want your feedback

Expand Down
72 changes: 72 additions & 0 deletions src/pages/docs/octopus-ai/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
layout: src/layouts/Default.astro
pubDate: 2025-04-04
modDate: 2025-08-01
title: Octopus AI
navTitle: Overview
navSection: Octopus AI
description: An overview of the AI powered devops capabilities provided by Octopus Deploy
navOrder: 26
---

# AI-Powered DevOps with Octopus Deploy

Artificial intelligence, and GenAI technologies in particular, are transforming our technology landscape.

For continuous delivery, AI allows us to solve previously-unsolvable problems. Parsing complex log files and diagnosing root cause failures and providing intelligent remediation; natural-language exploration of your software landscape, simplifying auditing, compliance, and standardization; agentic workflows providing intelligent glue between your essential software services.

At Octopus, we are bringing these capabilities to the best continuous delivery tool on the market, lowering risk, improving efficiency, and accelerating your software delivery.

Our AI capabilities span three complementary areas, each designed to address different aspects of your deployment lifecycle - from interactive assistance and troubleshooting to fully autonomous DevOps operations.

## Current Capabilities

### Octopus AI Assistant

The Octopus AI Assistant is your intelligent companion to your existing Octopus Deploy instance, providing context-aware guidance and automation directly where you work. Currently in Early Access, this feature offers immediate value through four core capabilities that streamline your deployment workflows.

The AI Assistant excels at providing instant tier-0 support by drawing from comprehensive Octopus Deploy documentation to answer questions in natural language. Whether you're exploring the difference between environments and tenants or learning how to set up automated deployments, the Assistant provides immediate, contextual answers without disrupting your workflow.

Beyond answering questions, the AI Assistant can generate complete deployment projects from simple text descriptions. Describe what you want to deploy - whether it's an Azure Web App or AWS Lambda function - and the Assistant creates fully configured projects following established best practices.

When deployments encounter issues, the Assistant's failure analysis capability examines logs, configurations, and error details to provide specific troubleshooting guidance and actionable resolution steps.

The Assistant also helps monitor your Octopus Deploy instance for optimization opportunities, identifying unused variables, suggesting organizational improvements through tenant tags, and helping maintain healthy configurations that scale with your needs.

[Learn more about Octopus AI Assistant](/docs/octopus-ai/assistant)

### Octopus MCP Server

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.

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

- You can use it with your client and model of choice.
- It can work alongside other MCP servers to accomplish more complex orchestrations across Octopus and your other essential software services.

The MCP server provides tools designed to solve key use-cases within change management, troubleshooting, and administration audit & compliance.

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.

[Learn more about Octopus MCP Server](/docs/octopus-ai/mcp)

## Coming Soon

### Octopus AI Recovery Agent

One of the most important aspects of continuous delivery is being able to rapidly recover when something goes wrong. There are many tools that can be used to boost recovery - feature toggles, blue/green deployments, canary deployments, rollbacks. A short mean time to recovery is the hallmark of an elite software delivery engine.

Our AI assistant and our MCP server can help you understand the cause of failure, and suggest corrective actions that should get you back on track. But you are still in control, and need to be in the drivers seat making recovery happen.

The Octopus AI Recovery Agent is designed to help you recover from failure, fast. It will provide analysis of the cause of failure and suggest potential diagnosis and remediation steps, and then execute those steps for you. You are in the loop and in control, but the recovery agent takes care of the heavy lifting in the heat of the moment.

## Getting Started

Begin your AI-powered DevOps journey today with the Octopus AI Assistant, or the Octopus MCP Server. As an Early Access participant, you'll help shape these features while gaining early access to capabilities that will transform how teams deploy software.

- [Getting Started with Octopus AI Assistant](/docs/octopus-ai-assistant/getting-started)
- [Getting Started with Octopus MCP Server](https://github.com/OctopusDeploy/mcp-server?tab=readme-ov-file#-installation)

## Security and Privacy

All AI capabilities in Octopus Deploy are built with security and privacy as foundational principles. We never use customer data to train AI models, all sensitive values remain protected through our existing security model, and AI features respect your current permission boundaries. The AI Assistant backend is [open source](https://github.com/OctopusSolutionsEngineering/OctopusCopilot) and has been independently audited, with results available through our [trust center](https://trust.octopus.com/).
Loading
Loading