Skip to content

Commit

Permalink
wip - maintenance mode doc
Browse files Browse the repository at this point in the history
  • Loading branch information
alexisintech committed Nov 7, 2024
1 parent 78952ae commit 1f1fa64
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/maintenance-mode.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Maintenance Mode
description: Learn about Clerk's Maintenance Mode.
---

Maintenance Mode is a special operational state designed to ensure minimal disruption to signed in users during critical database upgrades or outages.

{/* TODO: the following sentence might not be worth mentioning: */}

When enabled, the system becomes aware that the primary database might be unavailable, but it can still operate using the read replica and Redis to process read requests and maintain session-related functionalities.

Since the majority of requests in production environments are either GET requests or session refresh requests, maintenance mode allows us to serve most users with minimal interruption.

Mutation methods (POST, PATCH, PUT, DELETE) will be rejected with a `503 Service Unavailable` status and an error message informing users that the system is temporarily unavailable.

0 comments on commit 1f1fa64

Please sign in to comment.