Automatic Deployment Triggers

Last updated

Automatic Deployment Triggers (also known as auto-deploy) let you to define an unattended behavior for your Projects that will cause an automatic deployment of a release into an Environment. This means, you can configure new deployment targets to be just like their counterparts.

Automatic Deployment Triggers can help you:

On the surface Automatic Deployments appear to be simple, however they can grow complex very quickly and we recommend reading our Elastic and Transient Environments guide before getting started with your own implementation.

Defining Automatic Deployment Triggers

Automatic deployments can be triggered by any machine-related event. A scheduled task runs in Octopus every 30 seconds looking for new events to determine whether any automatic deployment triggers need to fire. Each trigger is inspected to see if the recent stream of events should cause the trigger to fire, and if so, the appropriate deployments will be queued and run for the deployment target(s) that caused the trigger to fire.

Events have been placed into the following pre-defined groups:

Event Group Included Events
Machine events Machine cleanup failed, Machine created, Machine deployment-related property modified, Machine disabled, Machine enabled, Machine found healthy, Machine found to be unavailable, Machine found to be unhealthy, Machine found to have warnings
Machine critical-events Machine cleanup failed, Machine found to be unavailable
Machine becomes available for deployment Machine enabled, Machine found healthy, Machine found to have warnings
Machine is no longer available for deployment Machine disabled, Machine found to be unavailable, Machine found to be unhealthy
Machine health changed Machine found healthy, Machine found to be unavailable, Machine found to be unhealthy, Machine found to have warnings

For the majority of cases where you want to auto-deploy your project as new deployment targets become available, we advise you use only the Machine becomes available for deployment event group.

As you define your automatic deployment triggers, you can select the pre-defined event groups or individual events:

  • Machine cleanup failed
  • Machine created
  • Machine deployment-related property modified
  • Machine disabled
  • Machine enabled
  • Machine found healthy
  • Machine found to be unavailable
  • Machine found to be unhealthy
  • Machine found to have warnings

You can restrict automatic deployments further by specifying the following:

  • The Environment(s) the trigger applies to.
  • The Target Roles the trigger applies to.
  • The Environment and Target Roles the trigger applies to.

Add a Deployment Target Trigger

  1. From the Project's Overview page, select Triggers, then ADD TRIGGER ➜ Deployment Target Trigger.
  2. Give the trigger a name.
  3. Specify the event group or individual events that will trigger the releases.
  4. If you want to limit the trigger to specific environments select those environments.
  5. If you want to limit the trigger to specific target roles select those target roles.
  6. Specify whether or not to re-deploy to deployment targets even if they are already up-to date with the current deployment.
  7. Save the trigger.

With the trigger save, Octopus will run a scheduled task every 30 seconds looking for events that machine the automatic deployment trigger.

Unattended Release Behavior

Automatic deployment triggers let you configure unattended deployment behavior that configures new deployment targets to be just like their counterparts.

When an automatic deployment trigger fires, the following rules are applied:

  • By default, Octopus will re-run the currently successful deployment for the project/environment/tenant combination. You can override this behavior by configuring an Auto Deploy Override. Note, if multiple identical deployment targets all become available within the same 30 second polling window, they will all be included in the same automatic deployment. This could happen if you scale your web farm up by four nodes, and all four nodes finish provisioning within the same time window. However, this kind of behavior should not be expected or relied on (one or more of the targets might fall outside the 30 second window).
  • The steps that were run for the currently successful deployment will be run for the deployment targets that triggered the deployment. This includes manual intervention and Guided Failure steps. Note, if you skip steps in a manual deployment, they will be skipped in the subsequent automatic deployment. If you need to run a deployment and skip some steps, there are two ways you can reset the skipped steps:
    1. Re-running the entire deployment of the same Release again (we generally recommend designing your steps so they can be re-run without negative side-effects).
    2. Configuring an Auto Deploy Override for the same Release to the same Environment/Tenant (this will result in a new deployment being generated without the manually skipped steps).
  • If a deployment of a release fails, Octopus will continue deploying the last successful deployment. This ensures auto-deployments will continue, even if a release has been updated and failed.

The Order of Automatic Deployments

Because projects are considered independent in Octopus, and there is no built-in way to define dependencies between Projects or control the order in which Projects are deployed.

We generally recommend catering for application dependencies in the applications themselves, rather than pushing that responsibility to your deployments. This practice will reduce friction between your applications allowing you to reliably deploy your applications independently of each other.

One workaround for this is to create a Project in Octopus with the job of orchestrating the deployment of multiple Projects.

In this case you could:

  1. Create a Project that orchestrates the deployment of multiple projects.
  2. Each step in the deployment process of this project could call the Octopus API to deploy the next project in the dependency chain, waiting for a successful deployment before continuing to the next project.
  3. Optionally create an automatic deployment trigger in the orchestrating project to start the whole process.

The Chain Deployment step template might be a perfect fit for you in this situation, or you may want to customize this step template for more advanced scenarios.

Specifying a Specific Release to be Deployed

If you need to specify a specific release, either because the release hasn't been deployed yet, or Octopus is calculating the wrong release for a particular situation, you can configure an Auto Deploy Override to override the default automatic deployment behavior. This is useful for scenarios like Immutable InfrastructureDeploying to transient targets, and force automatic deployments to use a specific release for a specific environment/tenant.

Automatic Deployment Subscription Notifications

If you want to be notified of automatic deployments events, like blockages or failures, you can configure Subscriptions to notify you by email or use web hooks to create your own notification channels. You can even use web hooks to code your own recovery behavior based on your specific situation.

Troubleshooting Automatic Deployments

There are a number of reasons why automatic deployments may not work the way you expected, some of which we've already discussed earlier. Here are some troubleshooting steps you can take to figure out what is going wrong.

Is the Dashboard Green?

Octopus will attempt to automatically deploy the current releases for the environments that are appropriate for a machine. The current release is the one that was most recently successfully deployed as shown on the project dashboard.

  • Octopus will not automatically deploy a release if the deployment for that release was not successful (this can be a failed deployment or even a canceled deployment)
  • If the initial deployment of a release was successful but an automatic deployment of that release fails, Octopus will stop automatically deploying that release.

You will need you to complete a successful deployment again before auto-deployments can continue for the given release, or configure an Auto Deploy Override.

Investigate the Diagnostic Logs

Go to Configuration ➜ Diagnostics ➜ Auto Deploy Logs. The verbose logs usually contain the reason why a project trigger didn't take any action. For example:

Auto-deploy: Machine 'Local' does not need to run release '2.6.6' for project 'My Project' and tenant '<none>' because it already exists on the machine or is pending deployment.

Investigate the Audit Messages

The automatic deployments are all triggered based on events occurring in Octopus, all of which are logged reliably as audit events. Go to Configuration ➜ Audit and filter down to see the events related to your deployments.