Search documentation
karat

+

K

Create maintenance window overrides

Maintenance window overrides in Apollo provide the flexibility to issue Plans outside of the regular maintenance windows for Environments or specific Entities. This is useful for handling urgent changes or exceptional circumstances that require immediate action. Overrides can be applied at the Environment level or Entity level.

You can view maintenance window overrides for an Environment or Entity by navigating to the Settings tab for the Environment and selecting Maintenance and Suppressions.

Maintenance window overrides

You can view maintenance window overrides for a specific Entity by navigating to the Entity page and selecting Overrides and Suppressions from the Activity tab.

Entity maintenance window overrides

After you create a maintenance window override for an Environment or Entity, banners at the top of the Environment page and the Entity pages will display the active maintenance window overrides for the Environment or Entity. The banner includes a popover that you can select to view details about active maintenance window overrides. The popover also includes an action to remove each maintenance window override.

Maintenance window details in banner.

Create Environment-level maintenance window overrides

Environment editors can create Environment-level maintenance window overrides. To create a maintenance window override, navigate to the Environment Settings tab and select Create maintenance override from the dropdown.

Create maintenance window override

This will open the maintenance window override creation form.

Maintenance window override form

First, you will specify the type of maintenance window override:

  • No downtime required: Select for changes that will not require visible downtime for users.
  • Downtime required: Select for changes that will require visible downtime for users.

Next, you will define the time range for the override. You can select a specific time range or a relative time range.

Last, you will specify the reason for the override. This will be visible to other users and operators.

Create Entity-level maintenance window overrides

Any user with access to the Environment can submit a change request for a temporary Entity-level maintenance window. Approvers for such change requests depend on the type of maintenance window:

  • Downtime maintenance windows: Only Environment editors can approve.
  • No-downtime maintenance windows: Environment operators can approve.

You can create a temporary Entity-level maintenance window by navigating to the Entity home page and selecting Create maintenance override from the Actions dropdown.

This will open the maintenance window override creation form. Configuring the maintenance window override from here is identical to Environment-level maintenance windows.

Remove a maintenance window override

To remove any maintenance window override, navigate to the Maintenance Overrides table for the Environment or Entity and select the delete icon to the right of the maintenance window override.

Remove maintenance window override.

Note that removing an Environment-level maintenance window override from one Entity will remove it from all Entities.

You can also select the banner for the maintenance window override at the top of the Environment or Entity page and then select the delete icon.

Remove maintenance window override.