Blackout Windows

Blackout Windows are used to deny project executions (build, deploy, test, or utility executions) and snapshot stage executions from running on a specific environment, or target (a target group in an environment). Only administrator group members can create or modify Blackout Windows. No one can override an execution to run during a Blackout Window. Instead, the Blackout Window would need to be inactivated, ended, or changed if it is determined that deployments need to occur during a scheduled Blackout Window.

Blackout Windows come in two flavors, repeating and one-time. Repeating Blackout Windows use Quartz Cron expressions to define windows of time that are blacked out. While the expression is active, no executions are permitted. Once a window of time completes, the cron calculates the next time that a window would occur and prepares to deny executions again. Each time that this happens, a history is kept.

One-time Blackout Windows are set up with a start and end time and date. During that time, no executions are permitted. Once the time ends, the window is moved into history, but no new window will take it’s place.

All blackout windows are viewed and modified in the menu under Administration → Blackout Windows.

Open

To create a Blackout Window, click +Create. Then select the environment that you wish to blackout. Once that is selected, an option to specify only a certain target group will appear to the right.

Determine if you want to have a One-Time, or Recurring (repeating) Blackout Window.

If you want a Blackout Window that only happens Once, then choose your start and end times and click save.

Open

If you want a Blackout Window that reoccurs on a schedule, then select Recurring and enter a cron expression.

Cron expression examples are available on the right side of the input in the … hamburger button.

Quartz Cron Expressions can be designed and tested using the FlexDeploy UI, but if you would like a more powerful tool, Free Online Cron Expression Generator and Describer - FreeFormatter.com is a great resource.

Historical Blackout Windows can be viewed in the Blackout Window History Report.