Maintenance Mode

Maintenance mode allows platform administrators to temporarily put the platform in a restricted state during planned upgrades or outages.

Configuration

Maintenance mode is configured through the Helm chart’s global values:

values.yaml

global:
  maintenance:
    enabled: false
    banner:
      message:
      variant: "info"

Property	Type	Default	Description
global.maintenance.enabled	boolean	false	Whether maintenance mode is enabled.
global.maintenance.banner.message	string	—	The message displayed to users. Leave unset to hide the banner.
global.maintenance.banner.variant	string	"info"	The severity of the banner. Can be "info", "warning", or "error".

What happens when maintenance mode is enabled

When maintenance mode is enabled, the following actions occur:

Workloads are scaled down

Backup workloads are scaled down to zero, to avoid conflicts with maintenance operations. No new workloads can be scheduled while maintenance mode is active.

Maintenance condition

A Maintenance condition is set on workload resources. This condition is removed once maintenance mode is disabled.

status:
  conditions:
    - type: Maintenance
      status: "True"
      reason: MaintenanceEnabled
      message: Platform is in maintenance mode
      lastTransitionTime: "2026-05-01T12:00:00Z"
      observedGeneration: 1

API becomes unavailable

The API returns a 503 Service Unavailable response for all GraphQL and REST endpoints, preventing any operations that require API access.

The console shows a maintenance page

The console detects the maintenance status at startup and redirects users to a dedicated maintenance page.

Note

The banner is displayed to users regardless of whether maintenance mode is enabled. You can use it to announce upcoming maintenance or communicate after an upgrade, without pausing operations.

Examples

Announce an upcoming upgrade

Show users a banner before the maintenance window starts, while keeping operations running:

values.yaml

global:
  maintenance:
    # Operations keep running, banner only
    enabled: false
    banner:
      # Show a warning before maintenance
      message: "Upgrade planned on 31/07/2026. Contact @Tom for more info."
      variant: "info"

Enable maintenance mode during an upgrade

Pause all operations and inform users:

values.yaml

global:
  maintenance:
    # Enable maintenance mode
    enabled: true
    banner:
      # Inform users during the upgrade
      message: "Upgrade is running, we will be back shortly."
      variant: "info"

Notify users after an upgrade

Keep a banner visible after re-enabling operations:

values.yaml

global:
  maintenance:
    # Banner only
    enabled: false
    banner:
      # Post-maintenance informational banner
      message: "Upgrade complete! Contact @Tom if you encounter any problems."
      variant: "info"

Communicate an outage

Signal an active outage with an error-level banner:

values.yaml

global:
  maintenance:
    # Enable maintenance mode
    enabled: true
    banner:
      # Outage notification
      message: "We are experiencing an outage. Our team is investigating."
      variant: "error"