Search documentation
karat

+

K

Suppression windows and cancelling Plans

This section describes how to create and remove suppression windows for Entities and Environments.

Creating an Environment-wide manual suppression window

Environment editors can create suppression windows for Entities and for the Environment. To create a suppression window, navigate to the Environment home page and select the Create suppression... option under the Actions dropdown menu.

Creating an environment-wide suppression window

Once you click on that, the override creation form will open up.

Suppression window configuration

Once created, navigate to any Entity in the Environment to see the suppression at the top.

Suppression in place

Creating an Entity-specific manual suppression window

Environment and Entity editors and operators can set Entity-specific suppression windows.

To create a suppression window, navigate to the Entity home page and select the Suppress helm-chart option under the Actions dropdown menu.

Creating an entity-specific suppression window

Configuring the suppression window from here is identical to Environment-wide suppression windows.

Cancelling active Plans

In the suppression window configuration menu, you can check the Cancel active plans box, which will cancel all active Plans in the suppression window's scope (Entity or Environment).

Cancel plans

Cancelling a Plan might not be immediate as Apollo cannot terminate a Plan without the agent’s consent. Apollo will communicate to the agent that the Plan should be aborted, but in cases where the agent is down or unresponsive, this could take a long time or never happen.

Using a suppression window is currently the only way to cancel active plans. If you just want to cancel active plans you can create a short window or remove it after creation

Removing a suppression window

To remove any suppression window, whether created manually or automatically, navigate to the relevant Entity for an Entity-specific window or to any Entity for an Environment-wide window. Select the banner for the suppression window at the top and then select Remove. Removing an Environment-wide suppression window from one Entity will remove it from all Entities.

Removing a suppression window

(Optional) Override the required number of auto suppressed Entities for Environment-wide auto suppression

Apollo will automatically create a suppression window for a whole Environment if the number of Entities in the Environment that are under automated suppression windows exceeds the configured threshold.

You can set this optional flag in your Environment settings:

suppress-deployment-after-num-autosuppressions: 30