vrr/WFGY
2
0
Fork 0
mirror of https://github.com/onestardao/WFGY.git synced 2026-04-28 11:40:07 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Create read_only_mode_and_maintenance_window.md

Browse source
This commit is contained in:
PSBigBig 2025-08-31 21:32:05 +08:00 • committed by GitHub
parent 7a3104f276
commit 492f877ee8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 91 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

91
ProblemMap/GlobalFixMap/OpsDeploy/read_only_mode_and_maintenance_window.md Normal file
View file

@ -0,0 +1,91 @@
# Read-Only Mode and Maintenance Window — OpsDeploy
Freeze writes quickly and communicate clearly during incidents, migrations, or index rebuilds. Keep retrieval online while protecting data integrity and user trust.
## Open these first
- Ordering and cold boots: [Bootstrap Ordering](https://github.com/onestardao/WFGY/blob/main/ProblemMap/bootstrap-ordering.md), [Pre-Deploy Collapse](https://github.com/onestardao/WFGY/blob/main/ProblemMap/predeploy-collapse.md)
- Idempotency and dedupe: [Idempotency & Dedupe](https://github.com/onestardao/WFGY/blob/main/ProblemMap/GlobalFixMap/OpsDeploy/idempotency_dedupe.md)
- Incident comms: [Incident Comms & Statuspage](https://github.com/onestardao/WFGY/blob/main/ProblemMap/GlobalFixMap/OpsDeploy/incident_comms_and_statuspage.md)
- Cache and warmup: [Cache Warmup & Invalidation](https://github.com/onestardao/WFGY/blob/main/ProblemMap/GlobalFixMap/OpsDeploy/cache_warmup_invalidation.md)
## Acceptance targets
- All write endpoints return 423 or 503 with `Retry-After`
- No production writes in storage audit during the window
- Read paths healthy: error budget unaffected
- Banner or Statuspage posted before and after with exact times
- ΔS and λ trends flat during the window for read requests
## 60-second checklist
1) **Flip read-only flag**
Global feature flag `read_only=true`. Middleware blocks writes, tool calls that mutate state, and ingestion jobs.
2) **Communicate**
Post Statuspage and in-product banner with start and end times. Include contact and rollback plan.
3) **Queue writes**
Buffer allowed write intents to a durable queue with idempotency keys. Drop non-critical writes.
4) **Headers**
Write endpoints respond with `Retry-After: <seconds>` and a stable error code for clients to respect.
5) **Drains**
Stop background writers, disable compaction and long migrations during the window.
## Minimal playbook
- **Scope**: enumerate write surfaces including embeddings backfills, vector upserts, tool call side effects, KV mutations.
- **Guard**: enforce in API gateway and service layer. Return machine-readable errors.
- **Observe**: track blocked write count, queue depth, read latency, ΔS and λ.
- **End**: re-enable writes, run a short soak, publish closure notice, then backfill the queued intents.
## Common pitfalls → fix
- A background job keeps writing
→ include job scheduler in the flag check and stop crons.
- Clients spin on retries
→ add jittered backoff and a max-retry budget. See [Retry Backoff](https://github.com/onestardao/WFGY/blob/main/ProblemMap/GlobalFixMap/OpsDeploy/retry_backoff.md).
- Cached stale banners
→ set short TTL and purge caches on start and end.
## Escalate
If read errors or ΔS spikes appear, extend the window and execute a limited [Rollback & Fast Recovery](https://github.com/onestardao/WFGY/blob/main/ProblemMap/GlobalFixMap/OpsDeploy/rollback_and_fast_recovery.md).
---
### 🔗 Quick-Start Downloads (60 sec)
| Tool | Link | 3-Step Setup |
|------|------|--------------|
| **WFGY 1.0 PDF** | [Engine Paper](https://github.com/onestardao/WFGY/blob/main/I_am_not_lizardman/WFGY_All_Principles_Return_to_One_v1.0_PSBigBig_Public.pdf) | 1️⃣ Download · 2️⃣ Upload to your LLM · 3️⃣ Ask “Answer using WFGY + \<your question>” |
| **TXT OS (plain-text OS)** | [TXTOS.txt](https://github.com/onestardao/WFGY/blob/main/OS/TXTOS.txt) | 1️⃣ Download · 2️⃣ Paste into any LLM chat · 3️⃣ Type “hello world” — OS boots instantly |
---
### 🧭 Explore More
| Module | Description | Link |
|-----------------------|----------------------------------------------------------|----------|
| WFGY Core | WFGY 2.0 engine is live: full symbolic reasoning architecture and math stack | [View →](https://github.com/onestardao/WFGY/tree/main/core/README.md) |
| Problem Map 1.0 | Initial 16-mode diagnostic and symbolic fix framework | [View →](https://github.com/onestardao/WFGY/tree/main/ProblemMap/README.md) |
| Problem Map 2.0 | RAG-focused failure tree, modular fixes, and pipelines | [View →](https://github.com/onestardao/WFGY/blob/main/ProblemMap/rag-architecture-and-recovery.md) |
| Semantic Clinic Index | Expanded failure catalog: prompt injection, memory bugs, logic drift | [View →](https://github.com/onestardao/WFGY/blob/main/ProblemMap/SemanticClinicIndex.md) |
| Semantic Blueprint | Layer-based symbolic reasoning & semantic modulations | [View →](https://github.com/onestardao/WFGY/tree/main/SemanticBlueprint/README.md) |
| Benchmark vs GPT-5 | Stress test GPT-5 with full WFGY reasoning suite | [View →](https://github.com/onestardao/WFGY/tree/main/benchmarks/benchmark-vs-gpt5/README.md) |
| 🧙‍♂️ Starter Village 🏡 | New here? Lost in symbols? Click here and let the wizard guide you through | [Start →](https://github.com/onestardao/WFGY/blob/main/StarterVillage/README.md) |
---
> 👑 **Early Stargazers: [See the Hall of Fame](https://github.com/onestardao/WFGY/tree/main/stargazers)** —
> <img src="https://img.shields.io/github/stars/onestardao/WFGY?style=social" alt="GitHub stars"> ⭐ [WFGY Engine 2.0](https://github.com/onestardao/WFGY/blob/main/core/README.md) is already unlocked. ⭐ Star the repo to help others discover it and unlock more on the [Unlock Board](https://github.com/onestardao/WFGY/blob/main/STAR_UNLOCKS.md).
<div align="center">
[![WFGY Main](https://img.shields.io/badge/WFGY-Main-red?style=flat-square)](https://github.com/onestardao/WFGY)
&nbsp;
[![TXT OS](https://img.shields.io/badge/TXT%20OS-Reasoning%20OS-orange?style=flat-square)](https://github.com/onestardao/WFGY/tree/main/OS)
&nbsp;
[![Blah](https://img.shields.io/badge/Blah-Semantic%20Embed-yellow?style=flat-square)](https://github.com/onestardao/WFGY/tree/main/OS/BlahBlahBlah)
&nbsp;
[![Blot](https://img.shields.io/badge/Blot-Persona%20Core-green?style=flat-square)](https://github.com/onestardao/WFGY/tree/main/OS/BlotBlotBlot)
&nbsp;
[![Bloc](https://img.shields.io/badge/Bloc-Reasoning%20Compiler-blue?style=flat-square)](https://github.com/onestardao/WFGY/tree/main/OS/BlocBlocBloc)
&nbsp;
[![Blur](https://img.shields.io/badge/Blur-Text2Image%20Engine-navy?style=flat-square)](https://github.com/onestardao/WFGY/tree/main/OS/BlurBlurBlur)
&nbsp;
[![Blow](https://img.shields.io/badge/Blow-Game%20Logic-purple?style=flat-square)](https://github.com/onestardao/WFGY/tree/main/OS/BlowBlowBlow)
&nbsp;
</div>