Skip to navigation Skip to main content Skip to footer
OctopusDeploy-logo-RGB Docs
  • Introduction
  • Getting started
    • Overview
    • First Deployment
      • First Deployment
      • Define and use variables
      • Approvals with Manual Interventions
      • Add deployment targets
      • Deploy a sample package
    • First Kubernetes deployment
    • First Runbook Run
      • First Runbook Run
      • Configure Runbook Environments
      • Create a Project
      • Create a runbook
      • Defining the runbook process for workers
      • Running a Runbook
      • Runbook specific variables
      • Add runbook deployment targets
      • Defining the runbook process for targets
      • Publishing a runbook
    • Best Practices
      • Best Practices
      • Installation Guidelines
      • Partition Octopus with Spaces
      • Environments, Deployment Targets, and Target Tags
      • Lifecycles and Environments
      • Offload Work to Workers
      • Projects and Project Groups Structure
      • Variable Recommendations
      • Step Templates and Script Modules
      • Users, Roles, and Teams
      • Deployment and Runbook Processes
      • Releases and Deployments
      • Notifications
      • Ongoing Maintenance
      • Configuring Microsoft DFS with Octopus Server
    • Managing Octopus subscriptions
    • Samples
    • Reference architectures
      • Reference architectures
      • EKS reference architecture
      • Web App reference architecture
    • Glossary
  • Octopus Cloud
    • Overview
    • Getting started with Cloud
    • Static IP address
    • Permissions
    • Migrating from Octopus Server to Octopus Cloud
    • Disaster recovery
    • Octopus Cloud Uptime SLO
    • Octopus Cloud Maintenance Window
    • Octopus Cloud Task Cap
  • Installation
    • Overview
    • Installation requirements
    • SQL Server Database
    • Permissions for the Octopus Windows Service
    • Using a Managed Service Account (MSA)
    • Troubleshooting the Octopus installation
    • Automating Octopus installation
    • Octopus Server Linux Container
      • Octopus Server Linux Container
      • Octopus Server Container with Docker Compose
      • Octopus Server Container with systemd
      • Octopus Server in Kubernetes
      • Migration
        • Migration
        • Migrate to Octopus Server Linux Container from Windows Server
        • Migrate to Octopus Server Linux Container from Windows Container
      • Troubleshooting Octopus Server in a Container
    • Isolated Octopus Servers
  • Infrastructure
    • Overview
    • Deployment targets
      • Deployment targets
      • Octopus Tentacle
        • Octopus Tentacle
        • Windows Tentacle
          • Windows Tentacle
          • Tentacle installation requirements
            • Tentacle installation requirements
            • Legacy Tentacle installation requirements
          • Permissions required for the Tentacle Windows Service
          • Running Tentacle under a specific user account
          • Clustered Listening Tentacles
          • Automating Tentacle installation
          • Polling Tentacles over WebSockets
          • Azure virtual machines
            • Azure virtual machines
            • Installing the Tentacle via DSC in an ARM template
            • Installing the Tentacle VM extension via the Azure Portal
            • Installing the Tentacle VM extension via the classic Azure Portal
            • Installing the Tentacle VM extension via PowerShell
            • Installing the Tentacle VM extension via the Azure CLI
            • Installing the Tentacle VM extension via an ARM template
            • Tentacle VM extension configuration structure
            • Diagnosing Tentacle VM extension issues
        • Linux Tentacle
        • Tentacle communication modes
        • Octopus Tentacle in a Container
        • Polling Tentacles over Standard HTTPS Port
        • Troubleshooting Tentacles
      • Linux targets
        • Linux targets
        • SSH target
        • SSH target requirements
        • SSH deployments
        • Sudo commands
      • Amazon ECS cluster
      • Azure targets
        • Azure targets
        • Azure Service Fabric cluster targets
        • Azure Web App targets
        • Azure Cloud Service targets
      • Kubernetes
        • Overview
        • Kubernetes agent
          • Overview
          • Permissions
          • Storage
          • Troubleshooting
          • Automated Installation
          • HA Cluster Support
        • Kubernetes API
          • Kubernetes API
          • OpenShift Kubernetes cluster
          • Rancher Kubernetes cluster
      • Offline package drop
      • Cloud regions
      • Cloud Target Discovery
      • Dynamic infrastructure
        • Dynamic infrastructure
        • Create AWS account command
        • Create Azure Service Principal account command
        • Create token account command
        • Create username/password command
        • Create Azure Web App target command
        • Create Azure Service Fabric target command
        • Create Azure Cloud Service target command
        • Create Kubernetes Target Command
        • New Octopus Target Command
        • Remove Octopus Target Command
      • Machine policies
      • Proxy support
    • Environments
      • Environments
      • Environment recommendations
    • Accounts
      • Accounts
      • Azure
      • AWS accounts
      • Google cloud accounts
      • SSH key pair account
      • Token account
      • Username and password accounts
      • OpenID Connect
    • Workers
      • Workers
      • Built-in Worker
      • Worker pools
      • Dynamic Worker pools
        • Dynamic Worker pools
        • Ubuntu 18.04 End-of-life
        • Windows 2019 End-of-life
      • Worker Tools, Versioning and Caching
    • Signing Keys
  • Packaging applications
    • Overview
    • Create packages
      • Create packages
      • Versioning schemes
      • Create packages with the Octopus CLI
      • Create packages with OctoPack
        • Create packages with OctoPack
        • Include BuildEvent files
        • Troubleshooting OctoPack
    • Build server integration
      • Build server integration
      • Build information
      • AppVeyor integration
      • Azure DevOps
        • Azure DevOps
        • Using the Octopus extension
          • Using the Octopus extension
          • Build versions and packaging in Azure DevOps
          • Azure DevOps and Team Foundation Server Extension Version Compatibility
          • Installing the Octopus CLI as a capability
      • Bamboo
      • BitBucket Pipelines
      • Continua CI
      • GitHub Actions
      • Jenkins
        • Jenkins
        • Jenkins Pipeline projects
      • TeamCity
      • Troubleshooting build server integrations
    • Package repositories
      • Package repositories
      • Built-in Octopus repository
      • Docker Container Registry
        • Docker Container Registry
        • Octopus versioning scheme
      • GitHub Repository feeds
      • Maven feeds
      • NuGet feeds
      • Artifactory Generic Feeds
      • Guides
        • Guides
        • Container registries
          • Container registries
          • Artifactory container registry
          • AWS Elastic Container Registry (ECR)
          • Azure Container Registry
          • Docker Hub
          • GitLab container registry
          • Google Cloud Container Registry (GCR)
          • Nexus Container Registry
          • Oracle Cloud Infrastructure Container Registry
          • ProGet Container Registry
        • NuGet repositories
          • NuGet repositories
          • Artifactory Local NuGet repository
          • Azure DevOps and TFS package management
          • GitHub NuGet repository
          • GitLab NuGet repository
          • Nexus Hosted NuGet repository
          • ProGet NuGet repository
        • Maven repositories
          • Maven repositories
          • Nexus Hosted Maven repository
          • GitLab Maven repository
          • ProGet Maven repository
          • Artifactory Maven repository
        • Cloudsmith Multi-format repositories
      • AWS S3 Bucket feeds
  • Projects
    • Overview
    • Deployment process
      • Deployment process
      • Artifacts
      • Performance
    • Setting up projects and project groups
    • Project recommendations
    • Steps
      • Steps
      • Configuration features
        • Configuration features
        • Custom installation directory
        • IIS websites and application pools
        • Windows Services
        • Structured configuration variables
        • .NET XML configuration variables feature
        • .NET Configuration transforms
          • .NET Configuration transforms
          • Environment specific .NET configuration transforms with sensitive values
          • Troubleshooting .NET configuration transforms
        • Substitute variables in templates
        • NGINX Web Server
      • Conditions
      • Execution containers for workers
    • Built-in Step templates
      • Built-in Step templates
      • Email notification step
      • Manual intervention and approval step
      • Health check step
      • Automatic Step Template Updates
    • Exporting and Importing Projects
    • Community step templates
    • Custom step templates
    • Update step templates
    • Variables
      • Variables
      • Getting started with variables
      • Variable substitutions
      • Variable filters
      • System variables
      • Output variables
      • Prompted variables
      • Sensitive variables
      • Certificate variables
      • Worker Pool variables
      • Google cloud account variables
      • Azure account variables
      • AWS account variables
      • Username and password account variables
      • Tenant variables
      • Library variable sets
    • Tenants
      • Overview
      • Bulk connection
    • Project triggers
      • Project triggers
      • Deployment target triggers
      • Scheduled deployment triggers
      • External feed triggers
      • Built-in package repository triggers
    • Coordinating multiple projects
      • Coordinating multiple projects
      • Project coordination code samples
      • Deploy a release step
    • Configuration as Code
      • Configuration as Code
      • Converting projects to Git
        • Converting projects to Git
        • Migrating variables to Git
      • Configuration as Code reference
      • Editing a project with version control enabled
      • GitHub integration
      • Creating and deploying releases on a version-controlled project
      • Creating releases from a build server plugin on a version-controlled project
      • Unsupported Configuration as Code Scenarios
      • Moving version control
      • OCL Syntax for Config as Code
  • Tenants
    • Overview
    • Tenant types
    • Tenant creation
      • Tenant creation
      • Tenanted deployments
      • Connecting projects
    • Tenant variables
    • Tenant tags
    • Tenant infrastructure
    • Tenant lifecycles
    • Tenant roles and security
    • Multi-tenant deployment guides
      • Multi-tenant deployment guides
      • Multi-tenant regions
        • Multi-tenant regions
        • Creating the tenants
        • Creating tenant tags
        • Manage Tenants and Tag sets
        • Tenant infrastructure
        • Deploying to a Release Ring
        • Region specific workers
      • Multi-tenant SaaS applications
        • Multi-tenant SaaS applications
        • Creating a lifecycle
        • Creating the project
        • Creating new tenant tags
        • Creating new tenants
        • Creating project template variables
        • Creating new infrastructure
        • Creating project deployment process
        • Creating and deploying a release
      • Multi-tenant teams
        • Multi-tenant teams
        • Creating new tenants
        • Assigning a team to a tenant
        • Deploying to a team tenant
      • Tenants sharing machine targets
        • Tenants sharing machine targets
        • Creating the tenant tag set
        • Assign tags to tenants
        • Assign tags to targets
        • Deploying before the concurrency tag is changed
        • Setting the Concurrency Tag
        • Deploying after the concurrency tag is changed
        • Summary and FAQ
    • Multi-tenant deployments FAQ
    • Troubleshooting multi-tenant deployments
  • Releases
    • Overview
    • Creating a release
    • Lifecycles
    • Channels
    • Guided failures
    • Prevent release progression
    • Deleting releases
    • Manually fail a task
    • Issue trackers
      • Issue trackers
      • Jira issue tracking
      • GitHub issue tracking integration
      • Azure DevOps work item tracking integration
    • Release versioning
    • Deployment changes
    • Release notes
  • Deployments
    • Overview
    • Kubernetes
      • Kubernetes
      • Kubernetes Object Status
      • Deploy Kubernetes YAML
      • Deploy with Kustomize
      • Configure and apply Kubernetes resources
      • Configure and apply a Kubernetes Service
      • Configure and apply a Kubernetes Ingress
      • Deploy a Helm chart
      • Automatically tracking third party helm charts
      • Server-Side Apply
      • Glob Pattern Cheat Sheet
      • kubectl
    • AWS
      • AWS
      • Amazon S3 Create Bucket
      • Deploy an AWS CloudFormation template
      • Update Amazon ECS Service
      • Deploy Amazon ECS Service
      • AWS permissions required by Octopus
      • Delete an existing AWS CloudFormation stack
      • Upload to AWS S3 template
    • Google Cloud
      • Google Cloud
      • Google cloud CLI scripts
    • Azure
      • Azure
      • Azure Service Fabric
        • Azure Service Fabric
        • Packaging a Service Fabric application
        • Deploying a package to an Azure Service Fabric cluster
        • Version automation with Service Fabric application packages
        • Connecting securely with client certificates
        • Connecting securely with Azure Active Directory
      • Varying Azure subscription by environment
      • Azure environments
      • Azure app service environments
      • Deploying to Azure via a firewall
      • Azure Cloud Services
        • Azure Cloud Services
        • VIP swap
      • Azure web apps
        • Azure web apps
        • Deploying Web Jobs
        • Using Deployment Slots with Azure Web Apps
      • Running Azure PowerShell
        • Running Azure PowerShell
        • Configuring the version of the Azure CLI
        • Configuring the version of the Azure PowerShell Modules
    • .NET deployments
      • .NET deployments
      • ASP.NET Core webapp
    • Docker Containers
      • Docker Containers
      • Accessing container details
      • Docker run with networking
    • Windows
      • Windows
      • Windows Services
      • IIS Websites and application pools
      • Virtual hard drives
    • Certificates
      • Certificates
      • Add a certificate to Octopus
      • Certificate chains
      • Import certificate to Windows certificate store
      • Import certificates into Tomcat
      • Import certificates into WildFly and JBoss EAP
      • Export a certificate
      • Export a certificate to a Java KeyStore
      • Replace a certificate
      • Archive and delete certificates
      • Troubleshooting invalid certificates
    • Databases
      • Databases
      • Database configuration
        • Database configuration
        • Install Tentacles and Workers for database deployments
        • Recommended database permissions
      • SQL Server deployments
        • SQL Server deployments
        • SQL Server permissions
        • SQL Server DACPAC deployment
        • Deploy to SQL Server using Redgate SQL change automation
      • Common patterns
        • Common patterns
        • Manual approvals
        • Automatic approvals
        • Ad-hoc data change scripts
        • Database backups and rollbacks
      • MySQL flyway deployment
    • Terraform
      • Terraform
      • Preparing your Terraform environment
      • Terraform step configuration
      • Planning changes made by Terraform templates
      • Applying changes from Terraform templates
      • Terraform output variables
      • Terraform plugin cache
    • Java applications
      • Java applications
      • Deploying a sample Java application
      • Java error messages and troubleshooting
    • NGINX deployments
      • NGINX deployments
      • Configuring target machine
      • Create and push an ASP.NET Core project
      • Configure Octopus Deploy project
    • Node deployments
      • Node deployments
      • Deploying Node applications to Linux
    • Packages
      • Packages
      • Dynamically selecting packages at deployment time
      • Delta compression for package transfers
      • Stage package uploads
      • Package deployment feature ordering
      • Deploying packages to your Octopus Server
      • Transfer package
      • Troubleshoot missing packages
    • Custom scripts
      • Custom scripts
      • Run a script step
      • Scripts in packages
        • Scripts in packages
        • Reference files within a package
      • Using variables in scripts
      • Passing parameters to scripts
      • Logging messages from scripts
      • Error handling
      • Output variables
      • Raw scripting
      • Azure CLI and PowerShell Scripts
      • AWS CLI and PowerShell scripts
      • Service Fabric PowerShell scripts
      • PowerShell Core
      • Debugging PowerShell scripts
        • Debugging PowerShell scripts
        • Debugging PowerShell scripts on remote machines
      • Script modules
    • HTML and JavaScript applications
    • Bulk deployment creation
    • Deployment freezes
    • Patterns and practices
      • Patterns and practices
      • Rolling deployments
      • Rollbacks
        • Rollbacks
        • Rollback .NET Application on Windows Server
        • Rollback Kubernetes deployment
        • Rolling back a Tomcat deployment
        • Rolling back an NGINX deployment
      • Multi-region deployment pattern
      • Blue-green deployments
        • Blue-green deployments
        • Blue-green deployments in Octopus using Environments
        • Blue-green deployments in IIS
      • Elastic and transient environments
        • Elastic and transient environments
        • Deploying to Transient Targets
        • Keeping deployment targets up to date
        • Cleaning up Environments
        • Immutable Infrastructure
      • Canary deployments
      • Branching
      • Deployment process as code
  • Runbooks
    • Overview
    • Runbooks vs Deployments
    • Runbooks permissions
    • Runbook variables
    • Runbooks publishing
    • Scheduled runbook triggers
    • Runbooks examples
      • Runbooks examples
      • Routine operations
        • Routine operations
        • IIS Runbooks
        • Install software with Chocolatey
        • Updating Windows
        • Updating Linux
        • Hardening Windows
        • Hardening an Ubuntu server
        • Installing Apache
        • Hardening Apache
        • Install NGINX
        • Installing Tomcat on Ubuntu
        • Restarting a Tomcat Web application
        • Renew Let's Encrypt certificates
        • Services Runbooks
      • Emergency operations
        • Emergency operations
        • Manually failover DNS
        • Automatically failover DNS with monitoring
        • Restart server
      • Database examples
        • Database examples
        • Backup SQL database
        • Restore SQL database
        • Restore SQL database to another environment
        • Create MySQL database
        • Create PaaS MySQL database server
        • Backup MySQL database
        • Backup RDS SQL database to S3
        • Restore RDS SQL database from S3
      • AWS
        • AWS
        • Provision an AWS RDS instance
        • Change AWS load balancer target group
        • Delete an AWS CloudFormation stack
      • Azure
        • Azure
        • Deploy an Azure Resource Manager template
        • Provision an Azure App Service
        • Manage DNS records in Azure
      • GCP
        • GCP
        • Create Network Load Balancer
      • Terraform
        • Terraform
        • Provision AWS resources with Terraform
  • Tasks
    • Overview
    • Prioritize Tasks
  • Approvals
    • Overview
    • Jira Service Management Integration
    • ServiceNow Integration
  • Insights
    • Overview
    • Metrics
    • Trend indicators
    • Project Insights
    • Space Level Insights
    • CSV download
    • API
  • Octopus REST API
    • Overview
    • Getting started with the Octopus REST API
    • How to Create an API Key
    • Octopus.Client
      • Octopus.Client
      • Getting started
      • Working with Resources
      • Working directly with the Client
      • Working with Spaces
      • Using in an Octopus Step
    • Octopus Command Line (CLI)
      • Octopus Command Line (CLI)
      • octopus
      • octopus account
      • octopus account aws
      • octopus account aws create
      • octopus account aws list
      • octopus account azure
      • octopus account azure create
      • octopus account azure list
      • octopus account azure-oidc
      • octopus account azure-oidc create
      • octopus account azure-oidc list
      • octopus account create
      • octopus account delete
      • octopus account gcp
      • octopus account gcp create
      • octopus account gcp list
      • octopus account list
      • octopus account ssh
      • octopus account ssh create
      • octopus account ssh list
      • octopus account token
      • octopus account token create
      • octopus account token list
      • octopus account username
      • octopus account username create
      • octopus account username list
      • octopus config
      • octopus config get
      • octopus config list
      • octopus config set
      • octopus deployment-target
      • octopus deployment-target azure-web-app
      • octopus deployment-target azure-web-app create
      • octopus deployment-target azure-web-app list
      • octopus deployment-target azure-web-app view
      • octopus deployment-target cloud-region
      • octopus deployment-target cloud-region create
      • octopus deployment-target cloud-region list
      • octopus deployment-target cloud-region view
      • octopus deployment-target delete
      • octopus deployment-target kubernetes
      • octopus deployment-target kubernetes create
      • octopus deployment-target kubernetes list
      • octopus deployment-target kubernetes view
      • octopus deployment-target list
      • octopus deployment-target listening-tentacle
      • octopus deployment-target listening-tentacle create
      • octopus deployment-target listening-tentacle list
      • octopus deployment-target listening-tentacle view
      • octopus deployment-target polling-tentacle
      • octopus deployment-target polling-tentacle list
      • octopus deployment-target polling-tentacle view
      • octopus deployment-target ssh
      • octopus deployment-target ssh create
      • octopus deployment-target ssh list
      • octopus deployment-target ssh view
      • octopus deployment-target view
      • octopus environment
      • octopus environment delete
      • octopus environment list
      • octopus login
      • octopus logout
      • octopus package
      • octopus package list
      • octopus package nuget
      • octopus package nuget create
      • octopus package upload
      • octopus package versions
      • octopus package zip
      • octopus package zip create
      • octopus project
      • octopus project branch
      • octopus project branch create
      • octopus project branch list
      • octopus project clone
      • octopus project connect
      • octopus project convert
      • octopus project create
      • octopus project delete
      • octopus project disconnect
      • octopus project list
      • octopus project variables
      • octopus project variables create
      • octopus project variables delete
      • octopus project variables exclude
      • octopus project variables include
      • octopus project variables list
      • octopus project variables update
      • octopus project variables view
      • octopus project view
      • octopus project-group
      • octopus project-group create
      • octopus project-group delete
      • octopus project-group list
      • octopus project-group view
      • octopus release
      • octopus release create
      • octopus release delete
      • octopus release deploy
      • octopus release list
      • octopus runbook
      • octopus runbook list
      • octopus runbook run
      • octopus space
      • octopus space create
      • octopus space delete
      • octopus space list
      • octopus space view
      • octopus task
      • octopus task wait
      • octopus tenant
      • octopus tenant clone
      • octopus tenant connect
      • octopus tenant create
      • octopus tenant delete
      • octopus tenant disconnect
      • octopus tenant list
      • octopus tenant tag
      • octopus tenant variables
      • octopus tenant variables list
      • octopus tenant variables update
      • octopus tenant view
      • octopus user
      • octopus user delete
      • octopus user list
      • octopus worker
      • octopus worker delete
      • octopus worker list
      • octopus worker listening-tentacle
      • octopus worker listening-tentacle create
      • octopus worker listening-tentacle list
      • octopus worker listening-tentacle view
      • octopus worker polling-tentacle
      • octopus worker polling-tentacle list
      • octopus worker polling-tentacle view
      • octopus worker ssh
      • octopus worker ssh create
      • octopus worker ssh list
      • octopus worker ssh view
      • octopus worker view
      • octopus worker-pool
      • octopus worker-pool delete
      • octopus worker-pool dynamic
      • octopus worker-pool dynamic create
      • octopus worker-pool dynamic view
      • octopus worker-pool list
      • octopus worker-pool static
      • octopus worker-pool static create
      • octopus worker-pool static view
      • octopus worker-pool view
    • Using OpenID Connect with the Octopus API
      • Using OpenID Connect with the Octopus API
      • Using OpenID Connect with Octopus and GitHub Actions
      • Using OpenID Connect in Octopus with other issuers
    • API examples
      • API examples
      • Accounts
        • Accounts
        • Create an AWS account
        • Create an Azure service principal
        • Create a Google Cloud account
      • Artifacts
        • Artifacts
        • Upload Artifact to Existing Deployment
        • Download Deployment Artifact
        • Download Runbook Artifact
      • Certificates
        • Certificates
        • Create a certificate
        • Replace existing certificate
      • Channels
        • Channels
        • Create a channel
      • Deployment process
        • Deployment process
        • Add an environment to step
        • Add a run a script step
        • Get all steps that use a package
        • Get all steps using role
      • Deployment targets
        • Deployment targets
        • Add an Azure Web App
        • Add a target role
        • Add Tenants to targets
        • Change target's machine policy
        • Check Tentacles for available upgrades
        • Delete targets by name
        • Delete targets by role
        • Enable/disable machine
        • Find target usage
        • Find unused targets
        • Register Listening Tentacle
        • Register Polling Tentacle
        • Register SSH target
        • Upgrade targets
      • Deployments
        • Deployments
        • Cancel queued deployments
        • Create and deploy a release
        • Deploy existing release with prompted variables
        • Deploy existing release
        • List deployments to environment
      • Environments
        • Environments
        • Adding Environments
      • Events
        • Events
        • Find events by date
      • Feeds
        • Feeds
        • Change feed
        • Create a feed
        • Delete a feed
        • Download package from built-in feed
        • Push package to built-in feed
        • Retrieve all feeds
        • Synchronize packages
      • Lifecycles
        • Lifecycles
        • Create a lifecycle
      • Project Groups
        • Project Groups
        • Create a project group
      • Projects
        • Projects
        • Coordinating multiple projects
        • Create a project
        • Delete a project
        • Delete projects with no process
        • Disable project triggers
        • Enable/disable project
        • Export projects
        • Find unused projects
        • Import projects
      • Releases
        • Releases
        • Create a release with specific version
        • Delete project releases
        • Promote a release not in the destination
        • Update release variable snapshot
      • Reports
        • Reports
        • Deployments Per Deployment Target Role Report
        • Environment permissions report
        • Project permissions report
        • Project Release Deployment Targets Report
      • Runbooks
        • Runbooks
        • Add a script step to runbook
        • Create and publish a new runbook snapshot
        • Create a runbook
        • Create a new scheduled runbook trigger
        • Publish a runbook snapshot
        • Run a runbook with prompted variables
        • Run a published runbook
      • Spaces
        • Spaces
        • Add a Space with environments
        • Delete a Space
      • Step Templates
        • Step Templates
        • Export step templates
      • Tag sets
        • Tag sets
        • Create a tag set
      • Tasks
        • Tasks
        • Reprioritize Tasks
        • Run a health check
      • Tenants
        • Tenants
        • Create a tenant
        • Update tenant variables
      • Users and Teams
        • Users and Teams
        • Add Azure Active Directory login to users
        • Add domain teams
        • Add an environment to a team
        • Change users domain
        • Create an API Key
        • Find teams with role
        • List users with editing roles
        • List users with role
        • List users
        • Remove a project from team
        • Swap AD group with LDAP group
        • Change users AD domain to LDAP
      • Variables
        • Variables
        • Add library set to a project
        • Add or update project variable
        • Clear sensitive variables
        • Find projects using library set
        • Find variable usage
        • Find variable value usage
        • Find library variable set variables usage
        • Update variable set variable value
      • Bulk Operations
        • Bulk Operations
        • Bulk add a project to a list of tenants
        • Rerun all canceled deployments and runbook runs after node shutdown.
    • Octopus.Server.exe command line
      • Octopus.Server.exe command line
      • Admin
      • Check services
      • Configure
      • Create instances
      • Database
      • Delete instances
      • Export certificates
      • Import certificates
      • License
      • List instances
      • Lost Master Key
      • Rotate Master Key
      • Set Master Key
      • Metrics
      • New certificate
      • Node
      • Built-in Worker
      • Path
      • External Worker
      • Proxy
      • Regenerate certificates
      • Run
      • Service
      • Show configuration
      • Show Master Key
      • Show thumbprint
      • SSL certificate
      • Version
      • Watchdog
    • Tentacle.exe command line
      • Tentacle.exe command line
      • Agent
      • Check services
      • Configure
      • Create instance
      • Delete instance
      • Deregister from
      • Deregister Worker
      • Extract
      • Import certificate
      • List instances
      • New certificate
      • Poll server
      • Polling proxy
      • Proxy
      • Register with
      • Register Worker
      • Server comms
      • Service
      • Show configuration
      • Show thumbprint
      • Update trust
      • version
      • watchdog
    • Calamari
    • Octopus.Migrator.exe command line
      • Octopus.Migrator.exe command line
      • Migrator export
      • Migrator import
      • migrate
      • Partial export
      • Version
    • Migration API
    • Octo Command Line (CLI) (Deprecated)
      • Octo Command Line (CLI) (Deprecated)
      • Octopus CLI Global Tool
      • JSON formatted output
      • Allow release progression
      • Build information
      • Clean environments
      • Clean Worker pool
      • Complete
      • Create auto deployment override
      • Create channel
      • Create environment
      • Create project
      • Create release
      • Create Worker pool
      • Delete auto deploy override
      • Delete package
      • Delete project
      • Delete releases
      • Deploy release
      • Disable project
      • Dump deployments
      • Export
      • Import
      • Install autocomplete
      • List deployments
      • List environments
      • List latest deployments
      • List machines
      • List projects
      • List releases
      • List tenants
      • List Worker pools
      • List Workers
      • Pack
      • Prevent release progression
      • Promote release
      • Push metadata
      • Push
      • Run a runbook
      • Version
  • Administration
    • Overview
    • High Availability
      • High Availability
      • How High Availability Works
      • Design
        • Design
        • Designing Octopus HA On-Premises
        • Designing Octopus HA in Azure
        • Designing Octopus HA in AWS
        • Designing Octopus HA in GCP
      • Configuration
        • Configuration
        • Configure Octopus High Availability with Active Directory
        • Configure Octopus High Availability without Active Directory
        • Auto Scaling High Availability Nodes
      • Migration
      • Maintenance
        • Maintenance
        • Maintain High Availability nodes
        • Polling Tentacles and Kubernetes agents with HA
      • Load balancing
        • Load balancing
        • Configuring Netscaler
      • Troubleshooting
    • Data
      • Data
      • Backup and restore
      • Octopus database
        • Octopus database
        • Changing the collation of the Octopus database
      • Data Migration
    • Spaces
    • Upgrading Octopus
      • Upgrading Octopus
      • Upgrading a modern version of Octopus
        • Upgrading a modern version of Octopus
        • Upgrading minor and patch releases of Octopus Deploy
        • Upgrading major releases of Octopus Deploy
        • How to automate Octopus Deploy upgrades
        • Upgrading host OS or .NET
        • Creating a test instance
      • Upgrading old versions of Octopus
        • Upgrading old versions of Octopus
        • Upgrading from Octopus 1.6 to 2.6.5
        • Upgrading from Octopus 2.6.5 to 2018.10 LTS
          • Upgrading from Octopus 2.6.5 to 2018.10 LTS
          • In place upgrade (Install Over 2.6.5)
          • Manual upgrade
          • Upgrade with a new server instance
          • Migrating data from Octopus 2.6.5 to 2018.10 LTS
          • Troubleshooting
          • Minimize the data-migration time
          • Backup v2.6 database
        • Upgrading from Octopus 2.x to 2.6.5
        • Upgrading from Octopus 3.x to the latest version
        • Upgrading from Octopus 4.x / 2018.x to latest version
    • Sync multiple instances
    • Managing infrastructure
      • Managing infrastructure
      • Maintenance Mode
      • Applying Operating System upgrades
      • Recovering after losing your Octopus Server and Master Key
      • Rotating the Master Key
      • Performance
        • Performance
        • Providing database performance metrics
        • Record a performance trace
        • Record memory snapshots
        • Create sanitized database backup
        • Enable web request logging
      • Run multiple processes on a target simultaneously
      • Managing multiple instances
      • Automating infrastructure with DSC
      • Script Console
      • Moving your Octopus components to other servers
        • Moving your Octopus components to other servers
        • Move the Octopus home folder and the Tentacle home and application folders
        • Moving the Octopus Server
        • Moving the Octopus Server database
        • Moving the Octopus Server and database
        • Moving the Octopus home directory
      • Server configuration and file storage
        • Server configuration and file storage
        • Moving Octopus Server folders
        • Manually uninstall Octopus Server
      • Tentacle configuration and file storage
        • Tentacle configuration and file storage
        • Manually uninstall Tentacle
      • Subscriptions
        • Subscriptions
        • Subscription webhook notifications
      • Show configuration
      • Service watchdog
      • Diagnostics
    • Private cloud migration
    • Retention policies
      • Retention policies
      • Retention policy Tentacle cleanup and troubleshooting
    • Reporting
      • Reporting
      • Report on deployments using Excel & XML
      • Report on deployments using SQL
      • Octopus reporting with an excel template
    • Octopus extension for GitHub Copilot
  • Platform Engineering
    • Overview
    • What is platform engineering?
    • Octopus enterprise patterns
    • Managing Octopus with code
    • Managing space resources
    • Managing project resources
    • Managing runbook resources
    • Forking Git repositories
    • Finding drift
    • Merging repos
    • Validating CaC PRs
    • Secret variables
  • Security
    • Overview
    • Script integrity in Octopus Deploy
    • Hardening Octopus
    • Exposing Octopus
      • Exposing Octopus
      • Expose the Octopus Web Portal over HTTPS
      • Use NGINX as a reverse proxy for Octopus Deploy
      • Use IIS as a reverse proxy for Octopus Deploy
      • Let's Encrypt integration
    • Outbound requests
      • Outbound requests
      • Telemetry
    • HTTP Security Headers
    • Octopus - Tentacle communication
      • Octopus - Tentacle communication
      • How to use custom certificates with Octopus Server and Tentacle
      • How to regenerate certificates with Octopus Server and Tentacle
      • Troubleshooting Schannel and TLS
    • Authentication providers
      • Authentication providers
      • Authentication provider compatibility
      • Username and Password
      • Active Directory authentication
        • Active Directory authentication
        • Moving your Octopus Server to another Active Directory domain
        • Specify a custom container for AD authentication
        • Troubleshooting Active Directory integration
      • Azure Active Directory authentication
      • GoogleApps authentication
      • LDAP Authentication
      • Okta authentication
      • Octopus ID authentication
      • Guest login
      • Automatic user creation
      • Authentication automation with OctopusDSC
      • Troubleshooting authentication problems
    • Data encryption
    • Built-in Worker
    • Users and teams
      • Users and teams
      • Resetting passwords
      • Security and unscoped variables
      • Service accounts
      • External groups and roles
      • Teams with mixed environment privileges
      • Auditing
        • Auditing
        • Audit Stream
      • Default permissions for built-in user roles
      • System and space permissions
      • Configurable Timeouts and Session Invalidation
      • User roles
    • FIPS and Octopus Deploy
    • PCI compliance and Octopus Deploy
    • Common security vulnerabilities and exploits
      • Common security vulnerabilities and exploits
      • Cross-Site Request Forgery (CSRF) and Octopus Deploy
      • SHA1 "Shattered" collision and Octopus Deploy
      • Spectre (Speculative Execution Side-Channel Vulnerabilities), Meltdown, and Octopus Deploy
      • Cross-Site Scripting (XSS) and Octopus Deploy
      • ZipBombs and Octopus Deploy
    • Security Self Assessment Questionnaire (CAIQ - Lite)
  • Support
    • Overview
    • Get the Raw Output From a Task
    • Debug problems with Octopus variables
    • Get the raw output from a deployment process
    • Log files
    • Copy the working directory
    • Troubleshooting AWS transport level errors
    • Troubleshooting failed or hanging tasks
    • Troubleshooting Access Denied Starting Http Listener
    • Capture a crash dump
    • Process dumps
    • Send a secret to Octopus
    • Capture and export a HAR file
    • How to turn on variable logging and export the task log
    • How to get a database backup and encrypt your Master Key
    • Record a problem with Octopus Deploy in your web browser
    • Call the Jenkins REST API from PowerShell
    • Compatibility
    • Increase the Octopus Server task cap
  • Credits
  • GitHub Organizations
  • Deprecations
  • Search
Free trial
  1. Introduction
  2. Administration
  3. Data

Data

This section provides details about managing the data in Octopus Deploy.

Help us continuously improve

Please let us know if you have any feedback about this page.

Send feedback

Page updated on Sunday, January 1, 2023

Edit on GitHub
Previous article Troubleshooting
Next article Backup and restore

Navigation

  • Introduction
  • Getting started
    • Overview
    • First Deployment
      • First Deployment
      • Define and use variables
      • Approvals with Manual Interventions
      • Add deployment targets
      • Deploy a sample package
    • First Kubernetes deployment
    • First Runbook Run
      • First Runbook Run
      • Configure Runbook Environments
      • Create a Project
      • Create a runbook
      • Defining the runbook process for workers
      • Running a Runbook
      • Runbook specific variables
      • Add runbook deployment targets
      • Defining the runbook process for targets
      • Publishing a runbook
    • Best Practices
      • Best Practices
      • Installation Guidelines
      • Partition Octopus with Spaces
      • Environments, Deployment Targets, and Target Tags
      • Lifecycles and Environments
      • Offload Work to Workers
      • Projects and Project Groups Structure
      • Variable Recommendations
      • Step Templates and Script Modules
      • Users, Roles, and Teams
      • Deployment and Runbook Processes
      • Releases and Deployments
      • Notifications
      • Ongoing Maintenance
      • Configuring Microsoft DFS with Octopus Server
    • Managing Octopus subscriptions
    • Samples
    • Reference architectures
      • Reference architectures
      • EKS reference architecture
      • Web App reference architecture
    • Glossary
  • Octopus Cloud
    • Overview
    • Getting started with Cloud
    • Static IP address
    • Permissions
    • Migrating from Octopus Server to Octopus Cloud
    • Disaster recovery
    • Octopus Cloud Uptime SLO
    • Octopus Cloud Maintenance Window
    • Octopus Cloud Task Cap
  • Installation
    • Overview
    • Installation requirements
    • SQL Server Database
    • Permissions for the Octopus Windows Service
    • Using a Managed Service Account (MSA)
    • Troubleshooting the Octopus installation
    • Automating Octopus installation
    • Octopus Server Linux Container
      • Octopus Server Linux Container
      • Octopus Server Container with Docker Compose
      • Octopus Server Container with systemd
      • Octopus Server in Kubernetes
      • Migration
        • Migration
        • Migrate to Octopus Server Linux Container from Windows Server
        • Migrate to Octopus Server Linux Container from Windows Container
      • Troubleshooting Octopus Server in a Container
    • Isolated Octopus Servers
  • Infrastructure
    • Overview
    • Deployment targets
      • Deployment targets
      • Octopus Tentacle
        • Octopus Tentacle
        • Windows Tentacle
          • Windows Tentacle
          • Tentacle installation requirements
            • Tentacle installation requirements
            • Legacy Tentacle installation requirements
          • Permissions required for the Tentacle Windows Service
          • Running Tentacle under a specific user account
          • Clustered Listening Tentacles
          • Automating Tentacle installation
          • Polling Tentacles over WebSockets
          • Azure virtual machines
            • Azure virtual machines
            • Installing the Tentacle via DSC in an ARM template
            • Installing the Tentacle VM extension via the Azure Portal
            • Installing the Tentacle VM extension via the classic Azure Portal
            • Installing the Tentacle VM extension via PowerShell
            • Installing the Tentacle VM extension via the Azure CLI
            • Installing the Tentacle VM extension via an ARM template
            • Tentacle VM extension configuration structure
            • Diagnosing Tentacle VM extension issues
        • Linux Tentacle
        • Tentacle communication modes
        • Octopus Tentacle in a Container
        • Polling Tentacles over Standard HTTPS Port
        • Troubleshooting Tentacles
      • Linux targets
        • Linux targets
        • SSH target
        • SSH target requirements
        • SSH deployments
        • Sudo commands
      • Amazon ECS cluster
      • Azure targets
        • Azure targets
        • Azure Service Fabric cluster targets
        • Azure Web App targets
        • Azure Cloud Service targets
      • Kubernetes
        • Overview
        • Kubernetes agent
          • Overview
          • Permissions
          • Storage
          • Troubleshooting
          • Automated Installation
          • HA Cluster Support
        • Kubernetes API
          • Kubernetes API
          • OpenShift Kubernetes cluster
          • Rancher Kubernetes cluster
      • Offline package drop
      • Cloud regions
      • Cloud Target Discovery
      • Dynamic infrastructure
        • Dynamic infrastructure
        • Create AWS account command
        • Create Azure Service Principal account command
        • Create token account command
        • Create username/password command
        • Create Azure Web App target command
        • Create Azure Service Fabric target command
        • Create Azure Cloud Service target command
        • Create Kubernetes Target Command
        • New Octopus Target Command
        • Remove Octopus Target Command
      • Machine policies
      • Proxy support
    • Environments
      • Environments
      • Environment recommendations
    • Accounts
      • Accounts
      • Azure
      • AWS accounts
      • Google cloud accounts
      • SSH key pair account
      • Token account
      • Username and password accounts
      • OpenID Connect
    • Workers
      • Workers
      • Built-in Worker
      • Worker pools
      • Dynamic Worker pools
        • Dynamic Worker pools
        • Ubuntu 18.04 End-of-life
        • Windows 2019 End-of-life
      • Worker Tools, Versioning and Caching
    • Signing Keys
  • Packaging applications
    • Overview
    • Create packages
      • Create packages
      • Versioning schemes
      • Create packages with the Octopus CLI
      • Create packages with OctoPack
        • Create packages with OctoPack
        • Include BuildEvent files
        • Troubleshooting OctoPack
    • Build server integration
      • Build server integration
      • Build information
      • AppVeyor integration
      • Azure DevOps
        • Azure DevOps
        • Using the Octopus extension
          • Using the Octopus extension
          • Build versions and packaging in Azure DevOps
          • Azure DevOps and Team Foundation Server Extension Version Compatibility
          • Installing the Octopus CLI as a capability
      • Bamboo
      • BitBucket Pipelines
      • Continua CI
      • GitHub Actions
      • Jenkins
        • Jenkins
        • Jenkins Pipeline projects
      • TeamCity
      • Troubleshooting build server integrations
    • Package repositories
      • Package repositories
      • Built-in Octopus repository
      • Docker Container Registry
        • Docker Container Registry
        • Octopus versioning scheme
      • GitHub Repository feeds
      • Maven feeds
      • NuGet feeds
      • Artifactory Generic Feeds
      • Guides
        • Guides
        • Container registries
          • Container registries
          • Artifactory container registry
          • AWS Elastic Container Registry (ECR)
          • Azure Container Registry
          • Docker Hub
          • GitLab container registry
          • Google Cloud Container Registry (GCR)
          • Nexus Container Registry
          • Oracle Cloud Infrastructure Container Registry
          • ProGet Container Registry
        • NuGet repositories
          • NuGet repositories
          • Artifactory Local NuGet repository
          • Azure DevOps and TFS package management
          • GitHub NuGet repository
          • GitLab NuGet repository
          • Nexus Hosted NuGet repository
          • ProGet NuGet repository
        • Maven repositories
          • Maven repositories
          • Nexus Hosted Maven repository
          • GitLab Maven repository
          • ProGet Maven repository
          • Artifactory Maven repository
        • Cloudsmith Multi-format repositories
      • AWS S3 Bucket feeds
  • Projects
    • Overview
    • Deployment process
      • Deployment process
      • Artifacts
      • Performance
    • Setting up projects and project groups
    • Project recommendations
    • Steps
      • Steps
      • Configuration features
        • Configuration features
        • Custom installation directory
        • IIS websites and application pools
        • Windows Services
        • Structured configuration variables
        • .NET XML configuration variables feature
        • .NET Configuration transforms
          • .NET Configuration transforms
          • Environment specific .NET configuration transforms with sensitive values
          • Troubleshooting .NET configuration transforms
        • Substitute variables in templates
        • NGINX Web Server
      • Conditions
      • Execution containers for workers
    • Built-in Step templates
      • Built-in Step templates
      • Email notification step
      • Manual intervention and approval step
      • Health check step
      • Automatic Step Template Updates
    • Exporting and Importing Projects
    • Community step templates
    • Custom step templates
    • Update step templates
    • Variables
      • Variables
      • Getting started with variables
      • Variable substitutions
      • Variable filters
      • System variables
      • Output variables
      • Prompted variables
      • Sensitive variables
      • Certificate variables
      • Worker Pool variables
      • Google cloud account variables
      • Azure account variables
      • AWS account variables
      • Username and password account variables
      • Tenant variables
      • Library variable sets
    • Tenants
      • Overview
      • Bulk connection
    • Project triggers
      • Project triggers
      • Deployment target triggers
      • Scheduled deployment triggers
      • External feed triggers
      • Built-in package repository triggers
    • Coordinating multiple projects
      • Coordinating multiple projects
      • Project coordination code samples
      • Deploy a release step
    • Configuration as Code
      • Configuration as Code
      • Converting projects to Git
        • Converting projects to Git
        • Migrating variables to Git
      • Configuration as Code reference
      • Editing a project with version control enabled
      • GitHub integration
      • Creating and deploying releases on a version-controlled project
      • Creating releases from a build server plugin on a version-controlled project
      • Unsupported Configuration as Code Scenarios
      • Moving version control
      • OCL Syntax for Config as Code
  • Tenants
    • Overview
    • Tenant types
    • Tenant creation
      • Tenant creation
      • Tenanted deployments
      • Connecting projects
    • Tenant variables
    • Tenant tags
    • Tenant infrastructure
    • Tenant lifecycles
    • Tenant roles and security
    • Multi-tenant deployment guides
      • Multi-tenant deployment guides
      • Multi-tenant regions
        • Multi-tenant regions
        • Creating the tenants
        • Creating tenant tags
        • Manage Tenants and Tag sets
        • Tenant infrastructure
        • Deploying to a Release Ring
        • Region specific workers
      • Multi-tenant SaaS applications
        • Multi-tenant SaaS applications
        • Creating a lifecycle
        • Creating the project
        • Creating new tenant tags
        • Creating new tenants
        • Creating project template variables
        • Creating new infrastructure
        • Creating project deployment process
        • Creating and deploying a release
      • Multi-tenant teams
        • Multi-tenant teams
        • Creating new tenants
        • Assigning a team to a tenant
        • Deploying to a team tenant
      • Tenants sharing machine targets
        • Tenants sharing machine targets
        • Creating the tenant tag set
        • Assign tags to tenants
        • Assign tags to targets
        • Deploying before the concurrency tag is changed
        • Setting the Concurrency Tag
        • Deploying after the concurrency tag is changed
        • Summary and FAQ
    • Multi-tenant deployments FAQ
    • Troubleshooting multi-tenant deployments
  • Releases
    • Overview
    • Creating a release
    • Lifecycles
    • Channels
    • Guided failures
    • Prevent release progression
    • Deleting releases
    • Manually fail a task
    • Issue trackers
      • Issue trackers
      • Jira issue tracking
      • GitHub issue tracking integration
      • Azure DevOps work item tracking integration
    • Release versioning
    • Deployment changes
    • Release notes
  • Deployments
    • Overview
    • Kubernetes
      • Kubernetes
      • Kubernetes Object Status
      • Deploy Kubernetes YAML
      • Deploy with Kustomize
      • Configure and apply Kubernetes resources
      • Configure and apply a Kubernetes Service
      • Configure and apply a Kubernetes Ingress
      • Deploy a Helm chart
      • Automatically tracking third party helm charts
      • Server-Side Apply
      • Glob Pattern Cheat Sheet
      • kubectl
    • AWS
      • AWS
      • Amazon S3 Create Bucket
      • Deploy an AWS CloudFormation template
      • Update Amazon ECS Service
      • Deploy Amazon ECS Service
      • AWS permissions required by Octopus
      • Delete an existing AWS CloudFormation stack
      • Upload to AWS S3 template
    • Google Cloud
      • Google Cloud
      • Google cloud CLI scripts
    • Azure
      • Azure
      • Azure Service Fabric
        • Azure Service Fabric
        • Packaging a Service Fabric application
        • Deploying a package to an Azure Service Fabric cluster
        • Version automation with Service Fabric application packages
        • Connecting securely with client certificates
        • Connecting securely with Azure Active Directory
      • Varying Azure subscription by environment
      • Azure environments
      • Azure app service environments
      • Deploying to Azure via a firewall
      • Azure Cloud Services
        • Azure Cloud Services
        • VIP swap
      • Azure web apps
        • Azure web apps
        • Deploying Web Jobs
        • Using Deployment Slots with Azure Web Apps
      • Running Azure PowerShell
        • Running Azure PowerShell
        • Configuring the version of the Azure CLI
        • Configuring the version of the Azure PowerShell Modules
    • .NET deployments
      • .NET deployments
      • ASP.NET Core webapp
    • Docker Containers
      • Docker Containers
      • Accessing container details
      • Docker run with networking
    • Windows
      • Windows
      • Windows Services
      • IIS Websites and application pools
      • Virtual hard drives
    • Certificates
      • Certificates
      • Add a certificate to Octopus
      • Certificate chains
      • Import certificate to Windows certificate store
      • Import certificates into Tomcat
      • Import certificates into WildFly and JBoss EAP
      • Export a certificate
      • Export a certificate to a Java KeyStore
      • Replace a certificate
      • Archive and delete certificates
      • Troubleshooting invalid certificates
    • Databases
      • Databases
      • Database configuration
        • Database configuration
        • Install Tentacles and Workers for database deployments
        • Recommended database permissions
      • SQL Server deployments
        • SQL Server deployments
        • SQL Server permissions
        • SQL Server DACPAC deployment
        • Deploy to SQL Server using Redgate SQL change automation
      • Common patterns
        • Common patterns
        • Manual approvals
        • Automatic approvals
        • Ad-hoc data change scripts
        • Database backups and rollbacks
      • MySQL flyway deployment
    • Terraform
      • Terraform
      • Preparing your Terraform environment
      • Terraform step configuration
      • Planning changes made by Terraform templates
      • Applying changes from Terraform templates
      • Terraform output variables
      • Terraform plugin cache
    • Java applications
      • Java applications
      • Deploying a sample Java application
      • Java error messages and troubleshooting
    • NGINX deployments
      • NGINX deployments
      • Configuring target machine
      • Create and push an ASP.NET Core project
      • Configure Octopus Deploy project
    • Node deployments
      • Node deployments
      • Deploying Node applications to Linux
    • Packages
      • Packages
      • Dynamically selecting packages at deployment time
      • Delta compression for package transfers
      • Stage package uploads
      • Package deployment feature ordering
      • Deploying packages to your Octopus Server
      • Transfer package
      • Troubleshoot missing packages
    • Custom scripts
      • Custom scripts
      • Run a script step
      • Scripts in packages
        • Scripts in packages
        • Reference files within a package
      • Using variables in scripts
      • Passing parameters to scripts
      • Logging messages from scripts
      • Error handling
      • Output variables
      • Raw scripting
      • Azure CLI and PowerShell Scripts
      • AWS CLI and PowerShell scripts
      • Service Fabric PowerShell scripts
      • PowerShell Core
      • Debugging PowerShell scripts
        • Debugging PowerShell scripts
        • Debugging PowerShell scripts on remote machines
      • Script modules
    • HTML and JavaScript applications
    • Bulk deployment creation
    • Deployment freezes
    • Patterns and practices
      • Patterns and practices
      • Rolling deployments
      • Rollbacks
        • Rollbacks
        • Rollback .NET Application on Windows Server
        • Rollback Kubernetes deployment
        • Rolling back a Tomcat deployment
        • Rolling back an NGINX deployment
      • Multi-region deployment pattern
      • Blue-green deployments
        • Blue-green deployments
        • Blue-green deployments in Octopus using Environments
        • Blue-green deployments in IIS
      • Elastic and transient environments
        • Elastic and transient environments
        • Deploying to Transient Targets
        • Keeping deployment targets up to date
        • Cleaning up Environments
        • Immutable Infrastructure
      • Canary deployments
      • Branching
      • Deployment process as code
  • Runbooks
    • Overview
    • Runbooks vs Deployments
    • Runbooks permissions
    • Runbook variables
    • Runbooks publishing
    • Scheduled runbook triggers
    • Runbooks examples
      • Runbooks examples
      • Routine operations
        • Routine operations
        • IIS Runbooks
        • Install software with Chocolatey
        • Updating Windows
        • Updating Linux
        • Hardening Windows
        • Hardening an Ubuntu server
        • Installing Apache
        • Hardening Apache
        • Install NGINX
        • Installing Tomcat on Ubuntu
        • Restarting a Tomcat Web application
        • Renew Let's Encrypt certificates
        • Services Runbooks
      • Emergency operations
        • Emergency operations
        • Manually failover DNS
        • Automatically failover DNS with monitoring
        • Restart server
      • Database examples
        • Database examples
        • Backup SQL database
        • Restore SQL database
        • Restore SQL database to another environment
        • Create MySQL database
        • Create PaaS MySQL database server
        • Backup MySQL database
        • Backup RDS SQL database to S3
        • Restore RDS SQL database from S3
      • AWS
        • AWS
        • Provision an AWS RDS instance
        • Change AWS load balancer target group
        • Delete an AWS CloudFormation stack
      • Azure
        • Azure
        • Deploy an Azure Resource Manager template
        • Provision an Azure App Service
        • Manage DNS records in Azure
      • GCP
        • GCP
        • Create Network Load Balancer
      • Terraform
        • Terraform
        • Provision AWS resources with Terraform
  • Tasks
    • Overview
    • Prioritize Tasks
  • Approvals
    • Overview
    • Jira Service Management Integration
    • ServiceNow Integration
  • Insights
    • Overview
    • Metrics
    • Trend indicators
    • Project Insights
    • Space Level Insights
    • CSV download
    • API
  • Octopus REST API
    • Overview
    • Getting started with the Octopus REST API
    • How to Create an API Key
    • Octopus.Client
      • Octopus.Client
      • Getting started
      • Working with Resources
      • Working directly with the Client
      • Working with Spaces
      • Using in an Octopus Step
    • Octopus Command Line (CLI)
      • Octopus Command Line (CLI)
      • octopus
      • octopus account
      • octopus account aws
      • octopus account aws create
      • octopus account aws list
      • octopus account azure
      • octopus account azure create
      • octopus account azure list
      • octopus account azure-oidc
      • octopus account azure-oidc create
      • octopus account azure-oidc list
      • octopus account create
      • octopus account delete
      • octopus account gcp
      • octopus account gcp create
      • octopus account gcp list
      • octopus account list
      • octopus account ssh
      • octopus account ssh create
      • octopus account ssh list
      • octopus account token
      • octopus account token create
      • octopus account token list
      • octopus account username
      • octopus account username create
      • octopus account username list
      • octopus config
      • octopus config get
      • octopus config list
      • octopus config set
      • octopus deployment-target
      • octopus deployment-target azure-web-app
      • octopus deployment-target azure-web-app create
      • octopus deployment-target azure-web-app list
      • octopus deployment-target azure-web-app view
      • octopus deployment-target cloud-region
      • octopus deployment-target cloud-region create
      • octopus deployment-target cloud-region list
      • octopus deployment-target cloud-region view
      • octopus deployment-target delete
      • octopus deployment-target kubernetes
      • octopus deployment-target kubernetes create
      • octopus deployment-target kubernetes list
      • octopus deployment-target kubernetes view
      • octopus deployment-target list
      • octopus deployment-target listening-tentacle
      • octopus deployment-target listening-tentacle create
      • octopus deployment-target listening-tentacle list
      • octopus deployment-target listening-tentacle view
      • octopus deployment-target polling-tentacle
      • octopus deployment-target polling-tentacle list
      • octopus deployment-target polling-tentacle view
      • octopus deployment-target ssh
      • octopus deployment-target ssh create
      • octopus deployment-target ssh list
      • octopus deployment-target ssh view
      • octopus deployment-target view
      • octopus environment
      • octopus environment delete
      • octopus environment list
      • octopus login
      • octopus logout
      • octopus package
      • octopus package list
      • octopus package nuget
      • octopus package nuget create
      • octopus package upload
      • octopus package versions
      • octopus package zip
      • octopus package zip create
      • octopus project
      • octopus project branch
      • octopus project branch create
      • octopus project branch list
      • octopus project clone
      • octopus project connect
      • octopus project convert
      • octopus project create
      • octopus project delete
      • octopus project disconnect
      • octopus project list
      • octopus project variables
      • octopus project variables create
      • octopus project variables delete
      • octopus project variables exclude
      • octopus project variables include
      • octopus project variables list
      • octopus project variables update
      • octopus project variables view
      • octopus project view
      • octopus project-group
      • octopus project-group create
      • octopus project-group delete
      • octopus project-group list
      • octopus project-group view
      • octopus release
      • octopus release create
      • octopus release delete
      • octopus release deploy
      • octopus release list
      • octopus runbook
      • octopus runbook list
      • octopus runbook run
      • octopus space
      • octopus space create
      • octopus space delete
      • octopus space list
      • octopus space view
      • octopus task
      • octopus task wait
      • octopus tenant
      • octopus tenant clone
      • octopus tenant connect
      • octopus tenant create
      • octopus tenant delete
      • octopus tenant disconnect
      • octopus tenant list
      • octopus tenant tag
      • octopus tenant variables
      • octopus tenant variables list
      • octopus tenant variables update
      • octopus tenant view
      • octopus user
      • octopus user delete
      • octopus user list
      • octopus worker
      • octopus worker delete
      • octopus worker list
      • octopus worker listening-tentacle
      • octopus worker listening-tentacle create
      • octopus worker listening-tentacle list
      • octopus worker listening-tentacle view
      • octopus worker polling-tentacle
      • octopus worker polling-tentacle list
      • octopus worker polling-tentacle view
      • octopus worker ssh
      • octopus worker ssh create
      • octopus worker ssh list
      • octopus worker ssh view
      • octopus worker view
      • octopus worker-pool
      • octopus worker-pool delete
      • octopus worker-pool dynamic
      • octopus worker-pool dynamic create
      • octopus worker-pool dynamic view
      • octopus worker-pool list
      • octopus worker-pool static
      • octopus worker-pool static create
      • octopus worker-pool static view
      • octopus worker-pool view
    • Using OpenID Connect with the Octopus API
      • Using OpenID Connect with the Octopus API
      • Using OpenID Connect with Octopus and GitHub Actions
      • Using OpenID Connect in Octopus with other issuers
    • API examples
      • API examples
      • Accounts
        • Accounts
        • Create an AWS account
        • Create an Azure service principal
        • Create a Google Cloud account
      • Artifacts
        • Artifacts
        • Upload Artifact to Existing Deployment
        • Download Deployment Artifact
        • Download Runbook Artifact
      • Certificates
        • Certificates
        • Create a certificate
        • Replace existing certificate
      • Channels
        • Channels
        • Create a channel
      • Deployment process
        • Deployment process
        • Add an environment to step
        • Add a run a script step
        • Get all steps that use a package
        • Get all steps using role
      • Deployment targets
        • Deployment targets
        • Add an Azure Web App
        • Add a target role
        • Add Tenants to targets
        • Change target's machine policy
        • Check Tentacles for available upgrades
        • Delete targets by name
        • Delete targets by role
        • Enable/disable machine
        • Find target usage
        • Find unused targets
        • Register Listening Tentacle
        • Register Polling Tentacle
        • Register SSH target
        • Upgrade targets
      • Deployments
        • Deployments
        • Cancel queued deployments
        • Create and deploy a release
        • Deploy existing release with prompted variables
        • Deploy existing release
        • List deployments to environment
      • Environments
        • Environments
        • Adding Environments
      • Events
        • Events
        • Find events by date
      • Feeds
        • Feeds
        • Change feed
        • Create a feed
        • Delete a feed
        • Download package from built-in feed
        • Push package to built-in feed
        • Retrieve all feeds
        • Synchronize packages
      • Lifecycles
        • Lifecycles
        • Create a lifecycle
      • Project Groups
        • Project Groups
        • Create a project group
      • Projects
        • Projects
        • Coordinating multiple projects
        • Create a project
        • Delete a project
        • Delete projects with no process
        • Disable project triggers
        • Enable/disable project
        • Export projects
        • Find unused projects
        • Import projects
      • Releases
        • Releases
        • Create a release with specific version
        • Delete project releases
        • Promote a release not in the destination
        • Update release variable snapshot
      • Reports
        • Reports
        • Deployments Per Deployment Target Role Report
        • Environment permissions report
        • Project permissions report
        • Project Release Deployment Targets Report
      • Runbooks
        • Runbooks
        • Add a script step to runbook
        • Create and publish a new runbook snapshot
        • Create a runbook
        • Create a new scheduled runbook trigger
        • Publish a runbook snapshot
        • Run a runbook with prompted variables
        • Run a published runbook
      • Spaces
        • Spaces
        • Add a Space with environments
        • Delete a Space
      • Step Templates
        • Step Templates
        • Export step templates
      • Tag sets
        • Tag sets
        • Create a tag set
      • Tasks
        • Tasks
        • Reprioritize Tasks
        • Run a health check
      • Tenants
        • Tenants
        • Create a tenant
        • Update tenant variables
      • Users and Teams
        • Users and Teams
        • Add Azure Active Directory login to users
        • Add domain teams
        • Add an environment to a team
        • Change users domain
        • Create an API Key
        • Find teams with role
        • List users with editing roles
        • List users with role
        • List users
        • Remove a project from team
        • Swap AD group with LDAP group
        • Change users AD domain to LDAP
      • Variables
        • Variables
        • Add library set to a project
        • Add or update project variable
        • Clear sensitive variables
        • Find projects using library set
        • Find variable usage
        • Find variable value usage
        • Find library variable set variables usage
        • Update variable set variable value
      • Bulk Operations
        • Bulk Operations
        • Bulk add a project to a list of tenants
        • Rerun all canceled deployments and runbook runs after node shutdown.
    • Octopus.Server.exe command line
      • Octopus.Server.exe command line
      • Admin
      • Check services
      • Configure
      • Create instances
      • Database
      • Delete instances
      • Export certificates
      • Import certificates
      • License
      • List instances
      • Lost Master Key
      • Rotate Master Key
      • Set Master Key
      • Metrics
      • New certificate
      • Node
      • Built-in Worker
      • Path
      • External Worker
      • Proxy
      • Regenerate certificates
      • Run
      • Service
      • Show configuration
      • Show Master Key
      • Show thumbprint
      • SSL certificate
      • Version
      • Watchdog
    • Tentacle.exe command line
      • Tentacle.exe command line
      • Agent
      • Check services
      • Configure
      • Create instance
      • Delete instance
      • Deregister from
      • Deregister Worker
      • Extract
      • Import certificate
      • List instances
      • New certificate
      • Poll server
      • Polling proxy
      • Proxy
      • Register with
      • Register Worker
      • Server comms
      • Service
      • Show configuration
      • Show thumbprint
      • Update trust
      • version
      • watchdog
    • Calamari
    • Octopus.Migrator.exe command line
      • Octopus.Migrator.exe command line
      • Migrator export
      • Migrator import
      • migrate
      • Partial export
      • Version
    • Migration API
    • Octo Command Line (CLI) (Deprecated)
      • Octo Command Line (CLI) (Deprecated)
      • Octopus CLI Global Tool
      • JSON formatted output
      • Allow release progression
      • Build information
      • Clean environments
      • Clean Worker pool
      • Complete
      • Create auto deployment override
      • Create channel
      • Create environment
      • Create project
      • Create release
      • Create Worker pool
      • Delete auto deploy override
      • Delete package
      • Delete project
      • Delete releases
      • Deploy release
      • Disable project
      • Dump deployments
      • Export
      • Import
      • Install autocomplete
      • List deployments
      • List environments
      • List latest deployments
      • List machines
      • List projects
      • List releases
      • List tenants
      • List Worker pools
      • List Workers
      • Pack
      • Prevent release progression
      • Promote release
      • Push metadata
      • Push
      • Run a runbook
      • Version
  • Administration
    • Overview
    • High Availability
      • High Availability
      • How High Availability Works
      • Design
        • Design
        • Designing Octopus HA On-Premises
        • Designing Octopus HA in Azure
        • Designing Octopus HA in AWS
        • Designing Octopus HA in GCP
      • Configuration
        • Configuration
        • Configure Octopus High Availability with Active Directory
        • Configure Octopus High Availability without Active Directory
        • Auto Scaling High Availability Nodes
      • Migration
      • Maintenance
        • Maintenance
        • Maintain High Availability nodes
        • Polling Tentacles and Kubernetes agents with HA
      • Load balancing
        • Load balancing
        • Configuring Netscaler
      • Troubleshooting
    • Data
      • Data
      • Backup and restore
      • Octopus database
        • Octopus database
        • Changing the collation of the Octopus database
      • Data Migration
    • Spaces
    • Upgrading Octopus
      • Upgrading Octopus
      • Upgrading a modern version of Octopus
        • Upgrading a modern version of Octopus
        • Upgrading minor and patch releases of Octopus Deploy
        • Upgrading major releases of Octopus Deploy
        • How to automate Octopus Deploy upgrades
        • Upgrading host OS or .NET
        • Creating a test instance
      • Upgrading old versions of Octopus
        • Upgrading old versions of Octopus
        • Upgrading from Octopus 1.6 to 2.6.5
        • Upgrading from Octopus 2.6.5 to 2018.10 LTS
          • Upgrading from Octopus 2.6.5 to 2018.10 LTS
          • In place upgrade (Install Over 2.6.5)
          • Manual upgrade
          • Upgrade with a new server instance
          • Migrating data from Octopus 2.6.5 to 2018.10 LTS
          • Troubleshooting
          • Minimize the data-migration time
          • Backup v2.6 database
        • Upgrading from Octopus 2.x to 2.6.5
        • Upgrading from Octopus 3.x to the latest version
        • Upgrading from Octopus 4.x / 2018.x to latest version
    • Sync multiple instances
    • Managing infrastructure
      • Managing infrastructure
      • Maintenance Mode
      • Applying Operating System upgrades
      • Recovering after losing your Octopus Server and Master Key
      • Rotating the Master Key
      • Performance
        • Performance
        • Providing database performance metrics
        • Record a performance trace
        • Record memory snapshots
        • Create sanitized database backup
        • Enable web request logging
      • Run multiple processes on a target simultaneously
      • Managing multiple instances
      • Automating infrastructure with DSC
      • Script Console
      • Moving your Octopus components to other servers
        • Moving your Octopus components to other servers
        • Move the Octopus home folder and the Tentacle home and application folders
        • Moving the Octopus Server
        • Moving the Octopus Server database
        • Moving the Octopus Server and database
        • Moving the Octopus home directory
      • Server configuration and file storage
        • Server configuration and file storage
        • Moving Octopus Server folders
        • Manually uninstall Octopus Server
      • Tentacle configuration and file storage
        • Tentacle configuration and file storage
        • Manually uninstall Tentacle
      • Subscriptions
        • Subscriptions
        • Subscription webhook notifications
      • Show configuration
      • Service watchdog
      • Diagnostics
    • Private cloud migration
    • Retention policies
      • Retention policies
      • Retention policy Tentacle cleanup and troubleshooting
    • Reporting
      • Reporting
      • Report on deployments using Excel & XML
      • Report on deployments using SQL
      • Octopus reporting with an excel template
    • Octopus extension for GitHub Copilot
  • Platform Engineering
    • Overview
    • What is platform engineering?
    • Octopus enterprise patterns
    • Managing Octopus with code
    • Managing space resources
    • Managing project resources
    • Managing runbook resources
    • Forking Git repositories
    • Finding drift
    • Merging repos
    • Validating CaC PRs
    • Secret variables
  • Security
    • Overview
    • Script integrity in Octopus Deploy
    • Hardening Octopus
    • Exposing Octopus
      • Exposing Octopus
      • Expose the Octopus Web Portal over HTTPS
      • Use NGINX as a reverse proxy for Octopus Deploy
      • Use IIS as a reverse proxy for Octopus Deploy
      • Let's Encrypt integration
    • Outbound requests
      • Outbound requests
      • Telemetry
    • HTTP Security Headers
    • Octopus - Tentacle communication
      • Octopus - Tentacle communication
      • How to use custom certificates with Octopus Server and Tentacle
      • How to regenerate certificates with Octopus Server and Tentacle
      • Troubleshooting Schannel and TLS
    • Authentication providers
      • Authentication providers
      • Authentication provider compatibility
      • Username and Password
      • Active Directory authentication
        • Active Directory authentication
        • Moving your Octopus Server to another Active Directory domain
        • Specify a custom container for AD authentication
        • Troubleshooting Active Directory integration
      • Azure Active Directory authentication
      • GoogleApps authentication
      • LDAP Authentication
      • Okta authentication
      • Octopus ID authentication
      • Guest login
      • Automatic user creation
      • Authentication automation with OctopusDSC
      • Troubleshooting authentication problems
    • Data encryption
    • Built-in Worker
    • Users and teams
      • Users and teams
      • Resetting passwords
      • Security and unscoped variables
      • Service accounts
      • External groups and roles
      • Teams with mixed environment privileges
      • Auditing
        • Auditing
        • Audit Stream
      • Default permissions for built-in user roles
      • System and space permissions
      • Configurable Timeouts and Session Invalidation
      • User roles
    • FIPS and Octopus Deploy
    • PCI compliance and Octopus Deploy
    • Common security vulnerabilities and exploits
      • Common security vulnerabilities and exploits
      • Cross-Site Request Forgery (CSRF) and Octopus Deploy
      • SHA1 "Shattered" collision and Octopus Deploy
      • Spectre (Speculative Execution Side-Channel Vulnerabilities), Meltdown, and Octopus Deploy
      • Cross-Site Scripting (XSS) and Octopus Deploy
      • ZipBombs and Octopus Deploy
    • Security Self Assessment Questionnaire (CAIQ - Lite)
  • Support
    • Overview
    • Get the Raw Output From a Task
    • Debug problems with Octopus variables
    • Get the raw output from a deployment process
    • Log files
    • Copy the working directory
    • Troubleshooting AWS transport level errors
    • Troubleshooting failed or hanging tasks
    • Troubleshooting Access Denied Starting Http Listener
    • Capture a crash dump
    • Process dumps
    • Send a secret to Octopus
    • Capture and export a HAR file
    • How to turn on variable logging and export the task log
    • How to get a database backup and encrypt your Master Key
    • Record a problem with Octopus Deploy in your web browser
    • Call the Jenkins REST API from PowerShell
    • Compatibility
    • Increase the Octopus Server task cap
  • Credits
  • GitHub Organizations
  • Deprecations
  • Search

Product

  • Features
  • Tenanted deployments
  • Container deployments
  • What's new
  • Roadmap
  • Octopus vs. Azure DevOps
  • Octopus vs. Jenkins

Learn

  • Getting started
  • Guides
  • DevOps handbook
  • Deployments
  • Runbooks
  • Training videos

Help

  • Contact
  • Help and support
  • Community
  • Discussion forum
  • Upgrade and renew

About us

  • Company
  • Partners
  • Careers
  • Trust center
  • Security
  • Webinars and events
  • Stickers and swag
  • Twitter
  • LinkedIn
  • GitHub
  • YouTube

Copyright © 2024 Octopus Deploy

Back to top