Skip to content

Commit

Permalink
updates
Browse files Browse the repository at this point in the history
  • Loading branch information
alexisintech committed Nov 7, 2024
1 parent 1f1fa64 commit 499afe0
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions docs/maintenance-mode.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,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.
**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: */}
## Production instances

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.
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. This includes all sign-up and sign-in attempts. Clerk's prebuilt components and the Clerk hosted Account Portal will display errors for these requests.

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.
GET requests, as well as session refresh requests ([`/touch`](/docs/reference/frontend-api/tag/Sessions#operation/touchSession) and [`/tokens`](/docs/reference/frontend-api/tag/Sessions#operation/createSessionToken) endpoints), are not affected. Users who have active sessions (are already signed in) will not be signed out, and will continue to have access to your application, however, any mutations to their user or organization data will return the same `503` error as above.

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.
## Development instances

Development instances will experience full downtime during this period - users will not be able to sign up or sign in, and already signed in users will be signed out.

0 comments on commit 499afe0

Please sign in to comment.