Deployment freezes

Deployment freezes allow you to prevent deployments for a configured amount of time. This is useful when you want to prevent certain projects deploying to certain environments within a specific time frame. Without deployment freezes, you would need to manually disable specific projects or machines to stop the deployments.

An example of how deployment freezes could be used is:

  • Freezing deployments for all projects to the production environment during the holiday shut-down period.

As deployment freezes are scoped to projects and environments, both projects and environments will need to be assigned to the freeze. This will ensure that projects and environments that are not frozen will still deploy.

While a deployment freeze is in place for a project and environment:

  • New deployments are prevented from being created
  • Any existing deployments that start executing during the freeze will fail
  • Automatically triggered deployments fail, except for deployments created by machine triggers

Pre-requisites

As a deployment freeze needs to be scoped to projects and environments, projects and environments will need to be created before a deployment freeze can be created.

Create a deployment freeze

  1. Navigate to Configuration โžœ Deployment Freezes and click ADD DEPLOYMENT FREEZE
  2. Enter a name for your deployment freeze
  3. Set a start and end time for your freeze
  4. Assign projects and environments to your freeze by clicking ASSIGN SCOPE and navigating through the wizard. At least 1 project and 1 environment per project must be selected to create a freeze.
  5. Save

Scoping deployment freezes

Deployment freezes can be scoped in the following ways:

  • Projects
  • Environments

During deployment, Octopus will block deployments for projects to a certain environment if a freeze is scoped to that project and environment. For example, if a freeze is active and is assigned to Project A in Production, Project A will not be deployed to Production but can still be deployed to any other environment according to the lifecycle.

Permissions

To create and edit a deployment freeze, the DeploymentFreezeAdminister system permission is required. In addition, permissions will need to be scoped to all requested projects and environments when creating, editing or overriding a deployment freeze.

For example, imagine a deployment freeze that applies to

  • Car Rental project
  • To the Production environment

You will be allowed to view this deployment freeze on the Deployment Freezes page if your user doesnโ€™t have the DeploymentFreezeAdminister system permission. If your user has the DeploymentFreezeAdminister system permission and permissions scoped to the Car Rental project and Production environment, they will be able to view, edit and override this freeze.

The DeploymentFreezeAdminister permission is included in the System Administrator, System Manager and Space Manager roles.

Overriding a freeze

Following on from the example above, imagine a scenario where a deployment freeze is currently active for the Car Rental project to the Production environment. While the freeze is active, a developer discovers that there is a bug in the production code and a fix needs to be rolled out immediately. In this scenario, the freeze can be overridden to deploy the fix to Production even while the freeze is active. After the fix is deployed, the freeze will still be in place and behave as expected.

To override a freeze:

  • Navigate to the Deploy A Release page of your chosen project.
  • You should see an information box that shows the affected environments in the freeze
  • If you have the correct permissions, the Deploy button should be green.

Override a deployment freeze from deploy a release page

  • Click the DEPLOY button and enter a reason for the override in the dialog box.
  • Click OVERRIDE AND DEPLOY

Override a deployment freeze confirmation dialog

Deployment freezes and automatic deployments

During deployment freezes, automatic deployments based on deployment target triggers are allowed. This ensures that your deployment targets will be updated with the latest deployments when you scale up.

All other automatic deployments, such as scheduled deployment or automatic lifecycle promotions, are blocked by deployment freezes.

Learn more

Help us continuously improve

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

Send feedback

Page updated on Wednesday, May 22, 2024