Samples

Our samples instance contains real-world deployment and runbook examples.

Each one highlights one or more available Octopus features, from deploying Java applications to upgrading a Helm chart in a Kubernetes cluster.

This page acts as a directory of features found in our samples instance.

Deployment features

This section contains Octopus features that are found in Project deployment processes in the samples instance. Each feature list is categorized by the Octopus Space and Project in which it can be found.

AWS

Explore examples of Octopus Deploy’s AWS integration, including EC2, AWS RDS database, AWS CLI, Lambda and ECS deployments.

Pattern - Blue-Green

• Random Quotes Java: Deploys the Java version of Random Quotes to Tomcat using the Blue/Green environment pattern. Build definition
• Random Quotes .NET: Deploys the .NET version of Random Quotes using the Blue/Green environment pattern. Build definition

Secrets Management

• AWS Secrets Manager: Sample project retrieving secrets from AWS Secrets Manager using the Retrieve Secrets step template.

Target - Containers

• AWS ECS: Deploys the OctoPetShop application to AWS ECS Fargate using AWS ECR. Build definition

Target - MariaDB

• Grate - AWS RDS: Example project for automated database deployments using RoundhousE against an AWS RDS MariaDB instance. Build definition RoundhousE has been deprecated and no longer compatible with the latest version of MariaDB.
• DBUp - AWS RDS: Example project for automated database deployments using Dbup against an AWS RDS MariaDB instance. Build definition At this time, DBuP is not compatible with the latest version of MariaDB.
• Flyway - AWS RDS: Example project for automated database deployments using Flyway against an AWS RDS MariaDB instance. Build definition
• RoundhousE - AWS RDS: Example project for automated database deployments using RoundhousE against an AWS RDS MariaDB instance. Build definition RoundhousE has been deprecated and no longer compatible with the latest version of MariaDB.
• Liquibase - AWS RDS: Sample project that creates and deploys the sakila database to an AWS RDS MariaDB instance using Liquibase. Build definition

Target - MySQL

• Grate - AWS RDS: Example project for automated database deployments using grate against an AWS RDS MySQL instance. Build definition
• Dbup - AWS RDS: Example project for automated database deployments using Dbup against an AWS RDS MySQL instance. Build definition
• Flyway - AWS RDS: Example project for automated database deployments using Flyway against an AWS RDS MySQL instance. Build definition
• RoundhousE - AWS RDS: Example project for automated database deployments using RoundhousE against an AWS RDS MySQL instance. Build definition
• Liquibase - AWS RDS: Sample project that creates and deploys the sakila database to an AWS RDS MySQL instance using Liquibase. Build definition

Target - Oracle

• Flyway RDS: Sample project that deploys the sakila database to an AWS RDS Oracle instance using Flyway. Build definition
• Liquibase RDS: Sample project that deploys the sakila database to an AWS RDS Oracle instance using Liquibase. Build definition
• DBUp RDS: Sample project that creates and deploys the Sakila database to an Oracle database server in AWS using DBUp. Build definition

Target - PostgreSQL

• Grate - AWS RDS
• DBUp - AWS RDS: Example project for automated database deployments using Dbup against an AWS RDS PostgreSQL instance. Build definition
• Flyway - AWS RDS: Example project for automated database deployments using Flyway against an AWS RDS PostgreSQL instance. Build definition
• RoundhousE - AWS RDS: Example project for automated database deployments using RoundhousE against an AWS RDS PosgreSQL instance. Build definition
• Liquibase - AWS RDS: Sample project that creates and deploys the sakila database to Postgres using Liquibase. Build definition

Target - Serverless

• AWS SAM: AWS SAM deployment based on the blog post using code in the AWSSamExample repo.
• AWS OctoSubscriber: A Lambda Function that accepts and processes Octopus Deploy Subscription Guided Failure or Manual Intervention Events. Build definition
• AWS Subscriber S3: A Lambda Function that accepts and processes Octopus Deploy Subscription Events
• Sample AWS Lambda

Target - SQL Server

• Redgate - Feature Branch Example: Sample project for deploying a database using Redgate SQL Change Automation with feature branches

Target - Tomcat

• Pet Clinic AWS: Deploy Java PetClinic to AWS Linux Build definition

Azure

Explore ways to use Octopus Deploy’s built-in Azure steps, including Azure WebApp, Azure CLI, ARM template and Azure SQL deployments.

Octopus Admin

• AzFuncNotifySlack: Azure Function App that consumes Octopus subscription webhook and send message to Slack

Pattern - Canary

• Deploy Web App: A sample project showing canary deployments of RandomQuotes to Azure WebApps.

Pattern - Monolith

• Pitstop: Sample project of a monolithic deployment process.
• Pitstop - Customer Management: Project for the Customer Management API of the Pitstop application. Build definition
• Pitstop - Vehicle Management: Project for the Vehicle Management API for the Pitstop application. Build definition
• Pitstop - Workshop Management: Project for the Workshop Management API for the Pitstop application. Build definition
• Pitstop - Web: Project for the Web front-end of the Pitstop application. Build definition

Pattern - Rolling

• Private Web App: Sample project for Azure Web App deployments using a private endpoint.

Pattern - Tenants

• Vet Clinic: A project that deploys the VetClinic application for multiple customers modeled as tenants.
• Car Rental: A sample car rental application utilizing PHP, Linux, and MySQL. Build definition
• OctoPetShop: A project that deploys the OctoPetShop application for different teams modeled as tenants.
• OctoHR: A sample version-controlled project illustrating a single codebase (web app) with multiple separate customer (tenant) databases that users can access. Source code available on GitHub.

Pattern-AutoScaling

• Azure VMSS Orchestration: A sample project showing how to use an orchestration project to deploy child applications with an Azure Virtual Machine scale set (VMSS).
• App + VMSS: A sample project showing how to deploy an application when using an Azure Virtual Machine scale set (VMSS).

Secrets Management

• Azure Key Vault: Sample project retrieving secrets from Azure Key Vault using the Retrieve Secrets step template.

Target - Hybrid

• Octo Pet Shop: Sample project that uses the Deploy to IIS step to deploy to both IIS on a VM and an Azure Web App. Build definition

Target - MySQL

• Flyway - Azure PaaS: Demonstrates how to perform automated database updates using Flyway against MySQL. Build definition
• Liquibase - Azure PaaS: Sample project that creates and deploys the sakila database to a MySQL container hosted in Azure using Liquibase. Build definition
• Grate - Azure PaaS: Example project for automated database deployments using grate against an Azure MySQL instance. Build definition

Target - PaaS

• OctoPetShop: A .NET Core Sample application used by Octopus to sample deployments and Runbooks. This example deploys OctoPetShop to Azure PaaS. The Product, Shopping Cart and Web App are deployed to Azure Web Apps and the Database to an empty Azure SQL server - Build

Target - PostgreSQL

• Flyway - Azure PaaS: Demonstrates how to perform automated database updates using Flyway against PostgreSQL. Build definition
• Liquibase - Azure PaaS: Sample project that creates and deploys the sakila database to a PosgreSQL container hosted in Azure using Liquibase. Build definition
• Grate - Azure PaaS

Target - Serverless

• Azure OctoSubscriber: Azure Functions that accept and process an Octopus Deploy Subscription and notify users via slack when a variable has changed. Build definition
• Sample Azure Function: A sample project that deploys an Azure function using the Deploy to Azure App Service step.

Target - Tomcat

• Pet Clinic - Azure Web App: Deploy the Java PetClinic application to Tomcat hosted in an Azure Web App.
• PetClinic - Demo: Deploy the Java PetClinic application to Tomcat hosted in an Azure Web App.

Google Cloud

Find out more about the new Octopus dedicated Google Cloud support, including gcloud CLI, Google Container Registry (GCR), Terraform and Kubernetes deployments.

Pattern - Rolling

• PetClinic - rolling deploy: The PetClinic project converted to use the rolling deployments pattern

Secrets Management

• GCP Secret Manager: Sample project retrieving secrets from GCP Secrets Manager using the Retrieve Secrets step template.

Target - Containers

• Cloud Run - Hello: A simple deployment of a pre-built Google container Hello World Service using the gcloud CLI. The code for the sample is available on GitHub.

Target - MySQL

• Flyway - GCP Service Account: Example project for automated database deployments using Flyway against a GCP MySQL instance. Build definition
• Liquibase - GCP Service Account: Sample project that creates and deploys the sakila database to an AWS RDS MySQL instance using Liquibase. Build definition
• Grate - GCP Service Account

Target - PostgreSQL

• Liquibase - GCP Service Account: Sample project that creates and deploys the sakila database to a PosgreSQL instance hosted in GCP using Liquibase and using a GCP Service Account for authentication. Build definition
• Flyway - GCP Service Account: Demonstrates how to perform automated database updates using Flyway against PostgreSQL. Build definition
• Grate - GCP Service Account

Target - SQL Server

• Liquibase - GCP: Sample project that creates and deploys the Sakila database to Microsoft SQL Server using Liquibase. Build definition
• Flyway - GCP: Sample project that creates and deploys the Sakila database to Microsoft SQL Server using Flyway. Build definition
• RoundhousE - GCP: Sample project that creates and deploys the Sakila database to Microsoft SQL Server using RoundhousE. Build definition
• DBUp - GCP: Sample project for deploying to SQL Server using DBUp by using the worker pool variable type. Build definition
• Grate - GCP: Sample project that creates and deploys the Sakila database to Microsoft SQL Server using Grate. Build definition

IIS

Learn more about the IIS support that Octopus has to offer, including IIS deployments, and community step templates that allow fine-grain control of your IIS Websites and applications.

Pattern - Blue-Green

• Random Quotes .NET IIS: Deploys the .NET version of Random Quotes using the Blue/Green environment pattern to a single server with multiple applications. Build definition
• Random Quotes .NET: Deploys the .NET version of Random Quotes using the Blue/Green environment pattern. Build definition

Pattern - IaC

• Random Quotes - Azure: Uses runbooks to create Azure virtual machines using Terraform code for hosting an application and backing database, then deploys the Random Quotes database and application to those machines.
• Random Quotes AWS: This is a sample project that showcases the use of Terraform with runbooks to create the infrastructure that is needed for a projects deployments. The runbooks in this project spin up two EC2 instances within AWS that are then used to deploy the Random Quotes web application and database to.

Pattern - Rollbacks

• 03 OctoFX - Complex Rollback: A sample .NET project showing deployments to Windows with a complex set of rollback functionality added.
• 01 OctoFx - Original: A sample .NET project showing deployments to Windows without any rollback functionality.
• 02 OctoFX - Simple Rollback: A sample .NET project showing deployments to Windows with a simple set of rollback functionality added.

Pattern-AutoScaling

• To Do Web Application: A sample child application used with the Azure VMSS orchestration project.
• App + VMSS: A sample project showing how to deploy an application when using an Azure Virtual Machine scale set (VMSS).

Target - Hybrid

• Octo Pet Shop: Sample project that uses the Deploy to IIS step to deploy to both IIS on a VM and an Azure Web App. Build definition

Target - Windows

• eShopOnWeb: Microsoft ASP.NET Core 5.0 Reference Application
• OctoFX: Build Server: Azure DevOps Webinar: YouTube

Java

Octopus has a range of Java application deployment examples, from deploying to Tomcat via Manager, deployments to Wildfly EAP and community step templates that offer first-class database deployment options like Flyway.

Pattern - Blue-Green

• Random Quotes Java: Deploys the Java version of Random Quotes to Tomcat using the Blue/Green environment pattern. Build definition
• Random Quotes - Tenanted: Deploys the Java version of Random Quotes to Tomcat using the Blue/Green tenant pattern.

Pattern - Rollbacks

• 01 PetClinic - Original: PetClinic Java Springboot application deploying to MySQL, Wildfly, and Tomcat
• 02 PetClinic - SimpleRollback: PetClinic Java Springboot application deploying to MySQL, Wildfly, and Tomcat
• 03 PetClinic - ComplexRollback: PetClinic Java Springboot application deploying to MySQL, Wildfly, and Tomcat

Pattern - Rolling

• PetClinic - no rolling deploy: A project showing a deployment process which doesn’t use the rolling deployments pattern

Target - Tomcat

• Pet Clinic AWS: Deploy Java PetClinic to AWS Linux Build definition

Target - Wildfly

• PetClinic: A sample project deploying the Java PetClinic app to a Linux VM in Azure.

Kubernetes

View practical Kubernetes examples, including deployment, service, ingress resources, and helm chart upgrades.

Pattern - Rollbacks

• 01 Kubernetes Original: A sample project showing deployments of PetClinic to Kubernetes without any rollback functionality.
• 02 Kubernetes - Simple Rollback: A sample project showing deployments of PetClinic to Kubernetes with a simple set of rollback functionality added.
• 03 Kubernetes - Complex Rollback: A sample project showing deployments of PetClinic to Kubernetes with a complex set of rollback functionality added.

Target - Kubernetes

• Rancher: A sample project that deploys the PetClinic application to a Rancher-managed Kubernetes cluster.
• OctopusDeploy: Setup an AWS EKS Cluster and target within Octopus Resources: AWS EKS Configuration eksctrl
• Multi-Cloud PetClinic: Setup AWS EKS, GCP GKE, and Azure AKS Clusters and targets within Octopus
• Database: A sample project that deploys the database component of the Octo Pet Shop application to Kubernetes.
• Product API: A sample project that deploys the Product API component of the Octo Pet Shop application to Kubernetes.
• Shopping Cart API: A sample project that deploys the Shopping Cart API component of the Octo Pet Shop application to Kubernetes.
• Web App: A sample project that deploys the main Web app component of the Octo Pet Shop application to Kubernetes.
• Migrations: A sample project that deploys the database migrations of the Octo Pet Shop application to Kubernetes.
• Octo Pet Shop - Raw YAML: A sample project that uses the Deploy RAW YAML step to deploy the OctoPetShop app to a Kubernetes cluster.
• PetClinic Helm Chart: Sample showing how to deploy the PetClinic application using a Helm Chart. Source code located here
• PetClinic: Setup an AWS EKS Cluster and target within Octopus Resources: AWS EKS Configuration eksctrl
• nginx+httpd: A sample project showing deployment of nginx and httpd as described in this blog post.

Runbook features

This section contains features that are found in Octopus runbooks in our samples instance. Each feature list is categorized by the Octopus Space, Project and runbook in which it can be found.

AWS

Explore examples of Octopus Deploy’s AWS integration, including EC2, AWS RDS database, AWS CLI, Lambda and ECS deployments.

Pattern - Blue-Green

• Random Quotes .NET
  • Change Production Group: Changes the blue-green designation.
  • Create Infrastructure: Creates environment-specific infrastructure.
  • Destroy Infrastructure: Destroys environment-specific infrastructure.
  • Destroy the Kraken: Destroys project infrastructure and calls Destroy Infrastructure for each environment.
  • Unleash the Kraken: Creates project infrastructure and calls Create Infrastructure for each Environment.
• Random Quotes .NET IIS
  • Change Production Group: Changes the blue-green designation.
  • Destroy Infrastructure: Destroys environment-specific infrastructure.
  • Destroy the Kraken: Destroys project infrastructure and calls Destroy Infrastructure for each environment.
  • Unleash the Kraken: Creates project infrastructure and calls Create Infrastructure for each Environment.
• Random Quotes Java
  • Change Production Group: Runbook that will switch traffic to one of the two load-balancer listener options for the Octopus Environment; Blue, or Green.
  • Create Infrastructure: Runbook that will spin up the Random Quotes Java project infrastructure in AWS for an Octopus Environment.
  • Destroy Infrastructure: Runbook that will tear down the Random Quotes Java project infrastructure in AWS for an Octopus Environment.
  • Destroy the Kraken: Runbook that will tear down all the Random Quotes Java project infrastructure in AWS.
  • Unleash the Kraken: Runbook that will spin up all the required Random Quotes Java project infrastructure in AWS.

Pattern - IaC

• Dynamic worker army
  • Create Infrastructure: Spins up the worker army

Pattern - Rolling

• AWS - Rolling Deploy
  • Spin up Environment Resources
  • Tear Down AWS Infrastructure

Pattern-AutoScaling

• AWS ASG
  • Scale Down ASG
  • Scale Up ASG

Secrets Management

• AWS Secrets Manager
  • Retrieve Secrets: This runbook retrieves secrets from AWS Secrets Manager and creates sensitive output variables to use in deployments and runbooks.

Target - Containers

• AWS ECS
  • Deregister task definitions: Removes the task definitions from ECS

Target - Kubernetes

• Multi-Cloud PetClinic
  • Create EKS Cluster: Create an Elastic Kubernetes Service cluster on AWS.
  • Destroy EKS Cluster: Destroy the AWS Elastic Kubernetes Service cluster.
• OctopusDeploy
  • Create Cluster: Creating a two node Kubernetes cluster in AWS using eksctl. Rather than the default configuration eksctl will use this cluster config.
  • Delete Cluster: Delete Kubernetes cluster and node groups from AWS
• PetClinic
  • Create Cluster: Creating a two node Kubernetes cluster in AWS using eksctl. Rather than the default configuration eksctl will use this cluster config.

This creates a single cluster in the Production environment, and then copies it as a target to all environments

• Delete Cluster: Delete Kubernetes cluster and node groups from AWS

Target - Oracle

• DBUp RDS
  • Temp
• Flyway RDS
  • Test

Target - Serverless

• AWS OctoSubscriber
  • Delete S3 bucket
  • Get Canonical ID
  • Get role arn
  • Spin Up Subscriber Infrastructure
  • Tear Down AWS Subscriber Infrastructure
• AWS Subscriber S3
  • Get Canonical ID
  • Spin Up Subscriber Infrastructure

Target - SQL Server

• AWS Backup and Restore S3
  • Backup Database
  • Restore Database
• Redgate - Feature Branch Example
  • Create AWS Redgate Masked Database Backup: Runbook that will create a masked copy of production so developers and testing can use it.
  • Delete AWS Redgate Feature Branch Database: Runbook that will backup and then delete the feature branch database.
  • Delete AWS Redgate RDS Snapshots: Runbook to delete old rds snapshots, as the max allowed is 100
  • Restore AWS Redgate Masked Backup for Feature Branches: Runbook that will create a feature branch database on test using the masked production database backup stored in s3
  • Spin Up AWS Redgate SQL Server RDS Server: Runbook to spin up a database in AWS for the Redgate Sample
  • Tear Down AWS Redgate SQL Server RDS Server: Runbook to tear down the database in AWS for Redgate sample

Target - Tomcat

• Pet Clinic AWS
  • Create Infrastructure
  • Destroy Infrastructure

Azure

Explore ways to use Octopus Deploy’s built-in Azure steps, including Azure WebApp, Azure CLI, ARM template and Azure SQL deployments.

Octopus Admin

• Artifactory Sample Management
  • Renew and Deploy SSL Certificate: Runbook which renews and stores LetsEncrypt certificates in the Octopus Certificate library and deploys to the target machine
  • Start Artifactory VM: Starts the Artifactory VM running in Azure
  • Stop Artifactory VM: Stops the Artifactory VM running in Azure
• Azure VM management
  • Check for Premium LRS SSDs: This runbook uses the Azure CLI to check all virtual machines in a subscription for the presence of Premium_LRS on either the OS or Data disk
• Lets Encrypt Certificates
  • Renew LetsEncrypt Certificates: Runbook which renews and stores LetsEncrypt certificates in the Octopus Certificate library
• Provision SQL Server
  • Destroy Azure SQL IaaS
  • Destroy Azure SQL PaaS
  • Provision Azure SQL IaaS
  • Provision Azure SQL PaaS
• Samples build servers
  • Renew Lets Encrypt certificates
  • Shutdown Samples build server VMs
  • Start Samples build server VMs
• Windows Server Admin
  • Create hardened Windows Azure VM: - Create an Azure Windows virtual machine.
    • Configure that machine as an Octopus tentacle
    • Run hardening script (Windows Server 2016 Hardening runbook)
  • Tear down hardened Windows Azure VM: Remove the Deployment Target from Octopus and then tear down the Resource Group containing the VM from Azure.

Pattern - IaC

• PowerShell DSC IIS Server
  • Create Infrastructure: Creates infrastructure for the PowerShell DSC IIS Server project.
  • Destroy Infrastructure: Tears down infrastructure for the PowerShell DSC IIS Server project.
• Random Quotes - Azure
  • Create and Configure Terraform Infrastructure: Creates necessary infrastructure in Azure using Terraform and configures it for application deployment.

Pattern - Rolling

• Azure VMSS
  • Spin Up Azure Resources
  • Tear Down Azure Resources
• PetClinic Infrastructure
  • 3-Create GCP PetClinic Project Infrastructure: Runbook that will spin up the Rolling Deploy - Conversion projects infrastructure
  • 4-Destroy the GCP Kraken: Runbook that will tear down ALL the Rolling Deploy - Conversion projects GCP infrastructure, using execution containers for workers

Pattern - Tenants

• Car Rental
  • Create Azure Web Apps
  • Destroy Azure Web Apps
• OctoHR
  • Create Infrastructure: Create environment-specific infrastructure.
  • Destroy Infrastructure: Destroy environment-specific infrastructure.
  • Test enable app_offline
• OctoPetShop
  • Create Azure Web Apps
  • Destroy Azure Database
  • Destroy Azure Web Apps
• Vet Clinic
  • Create Azure Web Apps
  • Destroy Azure Web Apps

Pattern-AutoScaling

• Azure VMSS Orchestration
  • Reconcile VMSS Provisioning: Runbook that will ensure Octopus Deploy and the VMSS VMs are in sync.
  • Scale Down VMSS: Step template to scale down the VMSS to be used on a schedule
  • Scale VMSS: Runbook to scale a VMSS
  • Spin Up VMSS: Runbook to create a new VMSS
  • Tear Down VMSS: Runbook to delete the VMSS

Secrets Management

• Azure Key Vault
  • Create Azure Key Vault: This runbook creates the infrastructure required for retrieving secrets from Azure Key Vault.
  • Retrieve Secrets: This runbook retrieves secrets from Azure Key Vault and creates sensitive output variables to use in deployments and runbooks.
• HashiCorp Vault
  • Create HashiCorp Vault Server: This runbook creates the infrastructure required to retrieve secrets from a HashiCorp Vault server.

Target - Kubernetes

• Multi-Cloud PetClinic
  • Create AKS Cluster: Create an Azure Kubernetes Service cluster.
  • Destroy AKS Cluster: Destroy the Azure Kubernetes Service cluster and resource group.
• Octo Pet Shop - Raw YAML
  • Create Octo Pet Shop Azure K8s Cluster: Runbook to Spin Up a K8s Cluster
  • Destroy Octo Pet Shop Azure K8s Cluster: Runbook to Destroy the K8s Cluster
• PetClinic Helm Chart
  • Create Infrastructure: Runbook to Spin Up a K8s Cluster
  • Destroy Infrastructure: Runbook to Destroy the K8s Cluster

Target - Payara

• PetClinic
  • Create Infrastructure: Create project specific infrastructure.
  • Destroy Infrastructure: Destroys project specific infrastructure.

Target - Serverless

• Azure OctoSubscriber
  • Create Infrastructure: Creates infrastructure specific to this project.
  • Test

Target - SQL Server

• DACPAC - Azure SQL
  • Spin up OctoFX-DACPAC Azure database
  • Teardown OctoFX-DACPAC Azure database
• DBUp - Azure SQL
  • Delete Azure SQL Server Database: Runbook to tear down the database in Azure
  • Export Azure SQL Server Database
  • Spin Up Azure SQL Server Database: Runbook to spin up a database in Azure
• DBUp - GCP
  • Delete Azure SQL Server Database: Runbook to tear down the database in Azure
  • Export Azure SQL Server Database
  • Spin Up Azure SQL Server Database: Runbook to spin up a database in Azure
• Flyway - Azure SQL
  • Destroy Infrastructure: Drops database for the environment.
• Flyway - Azure SQL Execution Containers
  • Destroy Infrastructure: Drops database for the environment.
• Grate - Azure SQL
  • Destroy Infrastructure: Destroys the RoundhousE database for the environment.
• Liquibase - Azure SQL
  • Destroy Infrastructure: Destroys liquibase database for environment.
• Redgate - Real World Example
  • Delete Redgate SQL Server Database: Runbook to tear down the database in Azure for Redgate sample
  • Delete Resource Group deployment: Deletes deployments to the resource group so we don’t go over quota.
  • Spin Up Redgate SQL Server Database: Runbook to spin up a database in Azure for the Redgate Sample
• RoundhousE - Azure SQL
  • Destroy Infrastructure: Destroys the RoundhousE database for the environment.

Target - Tomcat

• Pet Clinic - Azure Web App
  • Create Infrastructure: Creates project-specific infrastructure.
  • Destroy Infrastructure: Destroys project-specific infrastructure
• PetClinic - Demo
  • Create Infrastructure: Creates project-specific infrastructure.
  • Destroy Infrastructure: Destroys project-specific infrastructure

Target - WebSphere

• PetClinic
  • Create Infrastructure: Creates project specific infrastructure.
  • Destroy Infrastructure: Destroys environment specific infrastructure.

Target - Windows

• OctoFX
  • Manual Failover to Primary: This is a Runbook designed to failover back from Disaster Recovery in UK South to Western Europe. Please check all resources are healthy before running this Runbook:
    • Must be run in the context of Production for URL testing to work successfully.
  • Monitor Primary Website & Failover to DR if offline: This is to be run in the context of Disaster Recovery so it can spin up the correct machines and then failover:
    • Checks Production URL
    • Starts DR SQL & Web
    • Switches DNS over. 60s TTL
  • Start Environment: Starts the Web and SQL Server for specified environments. This is the template for the scheduled triggers turning on Infrastructure
  • Stop Environment: Stops the Web and SQL Server for specified environments. This is the template for the scheduled triggers turning off Infrastructure

Google Cloud

Find out more about the new Octopus dedicated Google Cloud support, including gcloud CLI, Google Container Registry (GCR), Terraform and Kubernetes deployments.

Pattern - Rolling

• PetClinic Infrastructure
  • 1-Create GCP Ubuntu 20.04 Worker: Runbook that will spin up the Rolling Deploy - Conversion projects GCP worker.
  • 2-Configure GCP NLB Target Pools: Runbook that will configure a Network Load Balancer with target pools for the PetClinic project
  • 3-Create GCP PetClinic Project Infrastructure: Runbook that will spin up the Rolling Deploy - Conversion projects infrastructure
  • 4-Destroy the GCP Kraken: Runbook that will tear down ALL the Rolling Deploy - Conversion projects GCP infrastructure, using execution containers for workers
  • 5-Destroy GCP Ubuntu 20.04 Worker: Unregister the worker from Octopus and delete the machine.
  • Create GCP Cloud MySQL instance: A Runbook that will spin up a MySQL instance for use with PetClinic projects. This can be as a one-off.

Secrets Management

• GCP Secret Manager
  • Retrieve Secrets: This runbook retrieves secrets from Google Cloud Secret Manager and creates sensitive output variables to use in deployments and runbooks.

Target - Kubernetes

• Multi-Cloud PetClinic
  • Create GKE Cluster: Create a Google Kubernetes Engine cluster.
  • Destroy GKE Cluster: Destroy the Google Kubernetes Engine cluster.
• Rancher
  • Create Infrastructure: Creates VM in GCP that runs Rancher.
  • Destroy Infrastructure: Tears down VM hosting Rancher and removes clusters from Deployment Targets.

Target - SQL Server

• Flyway - GCP
  • Destroy Infrastructure: Drops database for the environment.
• Grate - GCP
  • Destroy Infrastructure: Destroys the RoundhousE database for the environment.
• Liquibase - GCP
  • Destroy Infrastructure: Destroys liquibase database for environment.
• RoundhousE - GCP
  • Destroy Infrastructure: Destroys the RoundhousE database for the environment.

IIS

Learn more about the IIS support that Octopus has to offer, including IIS deployments, and community step templates that allow fine-grain control of your IIS Websites and applications.

Pattern - Blue-Green

• Random Quotes .NET
  • Create Infrastructure: Creates environment-specific infrastructure.

Target - Windows

• Computer Provisioning
  • Install Developer Machine Dependencies
• OctoFX

  • Backup & Restore SQL Backup from Production to Environment: Back up Production Database and Restore to Environment picked during running.

    • If you select Production, it will overwrite Production (Only to be used for Restoring backups to Production)
    • If you select Test, it will restore to Test
    • If you select Development, it will restore to Development
    • If you select Disaster Recovery, it will restore to Disaster Recovery

  • Install Dependencies: Installs Dependencies for the application to run. It installs the following:

    • Chocolatey
    • Chocolatey VSCode Install
    • Chocolatey .NET 4.7.2
    • Chocolatey .NET 4.8
    • Installs IIS & Dependencies
    • Checks for Pending Restarts and Restarts if required.

  • Restart IIS AppPool: Restarts an IIS AppPool in required environment

  • Restart IIS Website: Runbook that restarts a named IIS Website

  • Start IIS AppPool: Starts IIS App Pool on Web Servers

  • Stop IIS AppPool: Stops an IIS AppPool in required environment

Java

Octopus has a range of Java application deployment examples, from deploying to Tomcat via Manager, deployments to Wildfly EAP and community step templates that offer first-class database deployment options like Flyway.

Pattern - Rollbacks

• 03 PetClinic - ComplexRollback
  • Undeploy Application from Tomcat: Undeploy an application from a Tomcat server.

Kubernetes

View practical Kubernetes examples, including deployment, service, ingress resources, and helm chart upgrades.

Pattern - Rollbacks

• 03 PetClinic - ComplexRollback
  • Undeploy Application from Tomcat: Undeploy an application from a Tomcat server.

Terraform

See how to use Octopus built-in Terraform steps to manage your infrastructure and resources in a convention-based, templated way. Our samples instance includes terraform plan, apply and destroy terraform steps.

Pattern - IaC

• Dynamic worker army
  • Create Infrastructure: Spins up the worker army
  • Destroy Infrastructure: Tears down the worker army.
• Octopus Deploy Terraform Provider

  • Configure Existing Octopus Deploy Instance Using the Octopus Terraform Provider: This Runbook will configure basic settings within an existing Octopus Deploy instance using data resources for the Octopus Deploy Terraform provider. These include octopusdeploy_project_groups, octopusdeploy_environments, octopusdeploy_lifecycles and octopusdeploy_teams. This will also create the following resources:

    • Project With A Deployment Process
    • Tenant
    • Tenant Tag Set
    • Tenant Project Variable

  • Configure New (Blank) Octopus Deploy Instance Using The Octopus Terraform Provider: This Runbook will configure basic settings within a new (blank) Octopus Deploy instance. The Octopus Terraform Provider will set up the following:

    • Octopus Project Group
    • Project examples with variables and deployment processes for Tenanted and Untenanted deployments.
    • Deployment Environments.
    • Worker Pools
    • Tenants
    • Deployment Lifecycle
    • Tenant Tag Set
    • Octopus Teams
• Random Quotes - Azure
  • Create and Configure Terraform Infrastructure: Creates necessary infrastructure in Azure using Terraform and configures it for application deployment.
  • Destroy Terraform Resources and Delete Deployment Targets: Destroys created Terraform resources and removes registered deployment targets.
• Random Quotes AWS
  • Create Infrastructure: Creates EC2 instances using Terraform, registers them as deployment targets with Octopus, and then provisions them with the necessary tooling for application deployment.
  • Destroy Infrastructure: Destroys created EC2 instances and all supporting resources created through Terraform along with deregistering them as targets within Octopus.

Target - Serverless

• AWS OctoSubscriber
  • Spin Up Subscriber Infrastructure
  • Tear Down AWS Subscriber Infrastructure
• AWS Subscriber S3
  • Spin Up Subscriber Infrastructure
  • Tear Down AWS Subscriber Infrastructure

Target - Windows

• eShopOnWeb
  • Create Infrastructure: Stands up an Azure VM with IIS and SQL Server Express using Terraform for eShopOnWeb to be deployed on to.
  • Destroy Infrastructure: Destroys the Azure VM and infrastructure created for this project.

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