> ## Documentation Index
> Fetch the complete documentation index at: https://aidocs.ethanbragdon.icu/llms.txt
> Use this file to discover all available pages before exploring further.

# Maintenance Mode Runbook

> Use Starfire AI maintenance mode deliberately, coordinate incidents and communication, verify recovery, and avoid leaving the platform in partial maintenance state.

# Maintenance mode runbook

Maintenance mode is an explicit operational state for planned or emergency work. It should not be used as a generic response to every isolated bug.

## Before planned maintenance

1. Define affected components and expected user impact.
2. Schedule the maintenance window.
3. Prepare rollback or abort criteria.
4. Confirm the operator permissions needed.
5. Communicate planned impact through the supported status/user channels.

## Enable maintenance

Use the Control Center configuration surface when the current deployment supports maintenance mode.

Confirm whether the setting affects:

* web workspace
* Developer Platform
* background runs/builds
* new sign-ins
* all components or only selected surfaces

Do not assume one maintenance toggle safely pauses every subsystem.

## During maintenance

Monitor:

* health checks
* database/cache/queue dependencies
* deployment/migration progress
* background jobs
* error rate
* user/API traffic behavior

Avoid starting unrelated configuration changes while the platform is intentionally in a reduced state.

## Exit maintenance

1. Confirm the change/migration completed.
2. Run health checks.
3. Verify representative user and API workflows.
4. Re-enable normal traffic/access.
5. Confirm error and latency metrics remain healthy.
6. Close or update the associated incident/maintenance communication.

## Emergency maintenance

For active platform degradation, maintenance mode can be a mitigation—not the final incident resolution. Keep the incident timeline and root-cause investigation separate.

<Warning>
  Always verify maintenance mode is actually cleared in the intended environment. A successful deployment does not automatically restore traffic if the maintenance setting remains active.
</Warning>