Class MaintenanceAdminService

constructor

• new MaintenanceAdminService(
      __namedParameters: {
          internalEventPublisher: InternalEventPublisher | null;
          valkeyClient: ValkeyClient | null;
      },
  ): MaintenanceAdminService

  Parameters

  • __namedParameters: {
        internalEventPublisher: InternalEventPublisher | null;
        valkeyClient: ValkeyClient | null;
    }

    • internalEventPublisher: InternalEventPublisher | null

      Publishes backoffice.*Maintenance.*; null publishes nothing (tests).

    • valkeyClient: ValkeyClient | null

  Returns MaintenanceAdminService

Staticinstance

getService

• getService(
      __namedParameters: { serviceId: string },
  ): Promise<ServiceEntry | null>

  Parameters

  • __namedParameters: { serviceId: string }

  Returns Promise<ServiceEntry | null>

isGlobalActive

• isGlobalActive(): Promise<{ ok: true; value: boolean }>

  Global kill-switch state. Distinct from any service's own flag — a service reports on: false from listServices while global is on, because that field is its per-service flag. Effective state is the OR of the two.

  Returns Promise<{ ok: true; value: boolean }>

listInstances

• listInstances(
      __namedParameters: { serviceId: string },
  ): Promise<{ ok: true; value: InstanceEntry[] }>

  Parameters

  • __namedParameters: { serviceId: string }

  Returns Promise<{ ok: true; value: InstanceEntry[] }>

listServices

• listServices(): Promise<{ ok: true; value: ServiceEntry[] }>

  Returns Promise<{ ok: true; value: ServiceEntry[] }>

set

• set(
      input: { on: boolean; serviceId: string },
  ): Promise<{ error: ReadOnlyError; ok: false } | { ok: true; value: void }>

  Flips one service's maintenance flag.

  Parameters

  • input: { on: boolean; serviceId: string }

  Returns Promise<{ error: ReadOnlyError; ok: false } | { ok: true; value: void }>

setGlobal

• setGlobal(
      input: { on: boolean },
  ): Promise<{ error: ReadOnlyError; ok: false } | { ok: true; value: void }>

  Flips the global kill-switch, gating every process that runs the gate — including services that never registered, which no per-service toggle can reach. The control plane (this dashboard) is exempt by construction.

  Parameters

  • input: { on: boolean }

  Returns Promise<{ error: ReadOnlyError; ok: false } | { ok: true; value: void }>