You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/pages/docs/deployments/deployment-freezes/index.md
+27-7
Original file line number
Diff line number
Diff line change
@@ -5,9 +5,15 @@ modDate: 2024-05-22
5
5
title: Deployment freezes
6
6
description: Deployment freezes allow you to pause deployments for a specified time range
7
7
navOrder: 170
8
+
hideInThisSectionHeader: true
8
9
---
9
10
10
-
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.
11
+
:::div{.warning}
12
+
**Deployment Freezes is currently in early access.** When the feature becomes generally available, only enterprise customers will be able to create Deployment Freezes that apply to multiple projects.
13
+
However, all customers will be able to create freezes on a per-project basis. Any freezes created prior to this change will be carried forward.
14
+
:::
15
+
16
+
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.
11
17
12
18
Examples of how deployment freezes could be used:
13
19
@@ -18,16 +24,17 @@ Examples of how deployment freezes could be used:
18
24
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.
19
25
20
26
While a deployment freeze is in place for a project and environment:
27
+
21
28
- New deployments are prevented from being created
22
29
- Any existing deployments that start executing during the freeze will fail
23
30
- Automatically triggered deployments fail, except for deployments created by machine triggers
24
31
25
-
26
32
## Pre-requisites
27
-
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. If you plan to use tenant-scoped freezes, you'll need to have tenants configured as well.
28
33
34
+
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. If you plan to use tenant-scoped freezes, you'll need to have tenants configured as well.
29
35
30
36
## Create a deployment freeze
37
+
31
38
1. Navigate to **Configuration ➜ Deployment Freezes** and click **ADD DEPLOYMENT FREEZE**
32
39
2. Enter a name for your deployment freeze
33
40
3. Set a start and end time for your freeze
@@ -40,16 +47,18 @@ As a deployment freeze needs to be scoped to projects and environments, projects
40
47
41
48
Note: You must have at least one type of scope (project or tenant) configured before you can save the deployment freeze.
42
49
43
-
44
50
## Scoping deployment freezes
51
+
45
52
Deployment freezes can be scoped in the following ways:
53
+
46
54
- Projects
47
55
- Environments
48
56
- Tenants
49
57
50
58
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.
51
59
52
60
### Tenant scope
61
+
53
62
When using tenant scoping, deployments will only be blocked for the specific tenants included in the freeze while other tenants can still receive deployments. In the tenant scope section of the freeze configuration:
54
63
55
64
1. Click **Assign Tenants** to select the tenants to include in the freeze
@@ -61,34 +70,41 @@ When using tenant scoping, deployments will only be blocked for the specific ten
61
70
The tenant scope table will show you all assigned tenants and their associated project and environment combinations.
62
71
63
72
## Recurring freezes
73
+
64
74
You can set up deployment freezes that automatically repeat on a schedule. This is useful for:
75
+
65
76
- Daily protection windows during business hours
66
77
- Weekly maintenance windows
67
78
- Monthly release cycles
68
79
- Annual business events
69
80
70
81
The system supports these recurring patterns:
82
+
71
83
- Daily
72
84
- Weekly
73
85
- Monthly
74
86
- Annual
75
87
- Custom... (for more complex recurrence patterns)
76
88
77
89
## Permissions
90
+
78
91
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.
79
92
80
93
For example, imagine a deployment freeze that applies to
81
-
* Car Rental project
82
-
* To the Production environment
94
+
95
+
- Car Rental project
96
+
- To the Production environment
83
97
84
98
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.
85
99
86
100
The DeploymentFreezeAdminister permission is included in the System Administrator, System Manager and Space Manager roles.
87
101
88
102
## Overriding a freeze
89
-
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.
103
+
104
+
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.
90
105
91
106
To override a freeze:
107
+
92
108
- Navigate to the **Deploy A Release** page of your chosen project.
93
109
- You should see an information box that shows the affected environments in the freeze
94
110
- If you have the correct permissions, the Deploy button should be green.
@@ -105,16 +121,20 @@ To override a freeze:
105
121
:::
106
122
107
123
## Deployment freezes and automatic deployments
124
+
108
125
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.
109
126
110
127
All other automatic deployments, such as scheduled deployment or automatic lifecycle promotions, are blocked by deployment freezes.
111
128
112
129
## Automation and integration
130
+
113
131
You can automate and integrate deployment freezes into your workflows using:
132
+
114
133
- The Octopus REST API with the Go client
115
134
- The Terraform provider with the `octopusdeploy_deployment_freeze` resource
116
135
117
136
For examples and detailed information, refer to:
137
+
118
138
-[Octopus REST API - Go Client](https://github.com/OctopusDeploy/go-octopusdeploy)
description: Project deployment freezes allow you to pause deployments in a project for a specified time range
8
+
---
9
+
10
+
:::div{.hint}
11
+
With multi-project deployment freezes becoming an **Enterprise** license feature, we are introducing per-project deployment freezes for **all customers** in Octopus Server version **2025.2**
12
+
:::
13
+
14
+
Project deployment freezes allow you to prevent deployments for a configured amount of time. This is useful when you want to prevent a project from 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.
15
+
16
+
Examples of how deployment freezes could be used:
17
+
18
+
- Freezing deployments for all projects to the production environment during the holiday shut-down period
19
+
- Preventing deployments to production during business hours using recurring freezes
20
+
- Blocking deployments to specific tenants during their critical business periods
21
+
22
+
As deployment freezes are scoped to environments and tenants, both environments and tenants will need to be assigned to the freeze. This will ensure that environments and tenants that are not frozen will still deploy.
23
+
24
+
While a deployment freeze is in place for a project and environment:
25
+
26
+
- New deployments are prevented from being created
27
+
- Any existing deployments that start executing during the freeze will fail
28
+
- Automatically triggered deployments fail, except for deployments created by machine triggers
29
+
30
+
## Pre-requisites
31
+
32
+
As a deployment freeze needs to be scoped to environments, these environments will need to be created before a deployment freeze can be created. If you plan to use tenant-scoped freezes, you'll need to have tenants configured as well.
33
+
34
+
## Create a deployment freeze
35
+
36
+
1. From a project, navigate to **Freezes** and click **Add Deployment Freeze**
37
+
2. Enter a name for your deployment freeze
38
+
3. Set a start and end time for your freeze
39
+
4. (Optional) Configure recurring schedules if you want the freeze to repeat automatically
40
+
5. (Optional) Select at least one environment that should be frozen
41
+
6. (Optional) Set up the scope for your freeze by clicking **Assign Tenants**. Select at least one tenant with its associated environment.
42
+
7. Save
43
+
44
+
Note: You must have at least one type of scope (environment or tenant) configured before you can save the deployment freeze.
45
+
46
+
## Scoping deployment freezes
47
+
48
+
Deployment freezes can be scoped in the following ways:
49
+
50
+
- Environments
51
+
- Tenants
52
+
53
+
During deployment, Octopus will block deployments to a certain environment if a freeze is scoped to that environment. For example, if a freeze is active and is assigned to Production, the project will not be deployed to Production but can still be deployed to any other environment according to the lifecycle.
54
+
55
+
### Tenant scope
56
+
57
+
When using tenant scoping, deployments will only be blocked for the specific tenants included in the freeze while other tenants can still receive deployments. In the tenant scope section of the freeze configuration:
58
+
59
+
1. Click **Assign Tenants** to select the tenants to include in the freeze
60
+
2. For each tenant, you can specify:
61
+
- The tenant it applies to
62
+
- The environment where the freeze will be active
63
+
64
+
The tenant scope table will show you all assigned tenants and their associated environments.
65
+
66
+
## Recurring freezes
67
+
68
+
You can set up deployment freezes that automatically repeat on a schedule. This is useful for:
69
+
70
+
- Daily protection windows during business hours
71
+
- Weekly maintenance windows
72
+
- Monthly release cycles
73
+
- Annual business events
74
+
75
+
The system supports these recurring patterns:
76
+
77
+
- Daily
78
+
- Weekly
79
+
- Monthly
80
+
- Annual
81
+
- Custom... (for more complex recurrence patterns)
82
+
83
+
## Permissions
84
+
85
+
To create and edit a project deployment freeze, the **ProjectEdit** permission is required. In addition, permissions will need to be scoped to all requested environments when creating, editing or overriding a project deployment freeze.
86
+
87
+
For example, imagine a deployment freeze that applies to
88
+
89
+
- Car Rental tenant
90
+
- To the Production environment
91
+
92
+
You will be allowed to view this deployment freeze on the **Freezes** page if your user doesn't have the **ProjectEdit** permission. If your user has the **ProjectEdit** permission and permissions scoped to the Car Rental tenant and Production environment, they will be able to view, edit and override this freeze.
93
+
94
+
## Overriding a freeze
95
+
96
+
Following on from the example above, imagine a scenario where a deployment freeze is currently active for the Car Rental tenant 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.
97
+
98
+
To override a freeze:
99
+
100
+
- Navigate to the **Deploy A Release** page of your chosen project.
101
+
- You should see an information box that shows the affected environments in the freeze
102
+
- If you have the correct permissions, the Deploy button should be green.
103
+
104
+
:::figure
105
+
106
+
:::
107
+
108
+
- Click the **DEPLOY** button and enter a reason for the override in the dialog box.
109
+
- Click **OVERRIDE AND DEPLOY**
110
+
111
+
:::figure
112
+
113
+
:::
114
+
115
+
## Project deployment freezes and automatic deployments
116
+
117
+
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.
118
+
119
+
All other automatic deployments, such as scheduled deployment or automatic lifecycle promotions, are blocked by deployment freezes.
120
+
121
+
## Automation and integration
122
+
123
+
You can automate and integrate deployment freezes into your workflows using:
124
+
125
+
- The Octopus REST API with the Go client
126
+
- The Terraform provider with the `octopusdeploy_project_deployment_freeze` resource
127
+
128
+
For examples and detailed information, refer to:
129
+
130
+
-[Octopus REST API - Go Client](https://github.com/OctopusDeploy/go-octopusdeploy)
0 commit comments