docs: raccourcit le manuel d'exploitation PostgreSQL et le rend reprenable par tous #58

Merged
florian merged 1 commit from olivier/docs/postgresql-17 into develop 2026-09-02 07:43:51 +00:00
Member

Suite de la #52, déjà fusionnée : le manuel existait, il était trop long pour
servir en panne. 670 lignes → 377, sans rien retirer du périmètre
opérationnel.

Ce qui change

  • Une entrée unique : le tableau de l'essentiel, les trois pièges qui font
    perdre le plus de temps (port 5433, base enervision disparue, journal en
    français), puis les quatre contrôles de trente secondes.
  • Organisé par symptôme, pas par concept. Sections numérotées : le service
    ne démarre pas, c'est lent ou bloqué, le disque se remplit, les courbes ne
    bougent plus. L'arbre de décision est remonté en §4 et renvoie aux numéros.
  • Requêtes de diagnostic réduites aux colonnes qu'on lit vraiment. Les blocs
    de dix colonnes en devenaient illisibles sur un terminal de serveur.
  • Les garde-fous rassemblés en cinq règles (§12) au lieu d'être dilués dans
    le texte : ne jamais toucher à pg_wal, valider la configuration avant un
    restart, un pg_dump avant toute manipulation, restaurer à côté avant
    d'écraser, cancel avant terminate.
  • Incident du 1er septembre résumé en un paragraphe, avec ce qui reste
    ouvert (l'écart n°4, la sauvegarde exacte mais non surveillée). La preuve
    détaillée reste dans le ticket, pas dans le manuel.

Ce qui ne change pas

Toutes les commandes conservées sont celles déjà exécutées sur le serveur.
Connexion, relance, diagnostic, disque, TimescaleDB, sauvegarde et restauration
restent couverts, y compris l'étape 4 de la restauration (rendre les droits à
grafana_ro) et la validation de configuration avant redémarrage.

Les renvois vers docs/POSTGRESQL.md (piège du conf.d/conf.d/, écarts n°4 et
n°5) sont intacts : ce manuel décrit un geste, l'autre décrit un état.

Relecture

Un seul fichier, docs/runbooks/postgresql.md. Le plus utile est de se demander,
section par section : si je tombe dessus à 2 h du matin sans connaître la base,
est-ce que je sais quoi taper ?
Toute section qui demande encore un contexte
absent du document est à signaler.

Suite de la #52, déjà fusionnée : le manuel existait, il était trop long pour servir en panne. **670 lignes → 377**, sans rien retirer du périmètre opérationnel. ## Ce qui change - **Une entrée unique** : le tableau de l'essentiel, les trois pièges qui font perdre le plus de temps (port 5433, base `enervision` disparue, journal en français), puis les quatre contrôles de trente secondes. - **Organisé par symptôme, pas par concept.** Sections numérotées : le service ne démarre pas, c'est lent ou bloqué, le disque se remplit, les courbes ne bougent plus. L'arbre de décision est remonté en §4 et renvoie aux numéros. - **Requêtes de diagnostic réduites** aux colonnes qu'on lit vraiment. Les blocs de dix colonnes en devenaient illisibles sur un terminal de serveur. - **Les garde-fous rassemblés en cinq règles** (§12) au lieu d'être dilués dans le texte : ne jamais toucher à `pg_wal`, valider la configuration avant un `restart`, un `pg_dump` avant toute manipulation, restaurer à côté avant d'écraser, `cancel` avant `terminate`. - **Incident du 1er septembre résumé en un paragraphe**, avec ce qui reste ouvert (l'écart n°4, la sauvegarde exacte mais non surveillée). La preuve détaillée reste dans le ticket, pas dans le manuel. ## Ce qui ne change pas Toutes les commandes conservées sont celles déjà exécutées sur le serveur. Connexion, relance, diagnostic, disque, TimescaleDB, sauvegarde et restauration restent couverts, y compris l'étape 4 de la restauration (rendre les droits à `grafana_ro`) et la validation de configuration avant redémarrage. Les renvois vers `docs/POSTGRESQL.md` (piège du `conf.d/conf.d/`, écarts n°4 et n°5) sont intacts : ce manuel décrit un geste, l'autre décrit un état. ## Relecture Un seul fichier, `docs/runbooks/postgresql.md`. Le plus utile est de se demander, section par section : *si je tombe dessus à 2 h du matin sans connaître la base, est-ce que je sais quoi taper ?* Toute section qui demande encore un contexte absent du document est à signaler.
docs: raccourcit le manuel PostgreSQL et le rend reprenable par tous
All checks were successful
Intégration / Qualité du code Python (pull_request) Successful in 3s
Intégration / Tests unitaires (pull_request) Successful in 3s
Intégration / Aucun secret commité (pull_request) Successful in 3s
0ff75b0b14
Le manuel faisait 670 lignes, illisible en panne. Il en fait 377, organisées
par symptome et numerotees, avec un arbre de decision qui renvoie aux sections.

- entree unique : le tableau de l'essentiel, les trois pieges de depart,
  les quatre controles de trente secondes
- une section par symptome plutot qu'une par concept PostgreSQL
- requetes de diagnostic reduites aux colonnes qu'on lit vraiment
- les garde-fous rassembles en cinq regles, au lieu d'etre dilues dans le texte
- incident du 1er septembre resume en un paragraphe, la preuve detaillee
  restant dans le ticket

Aucune commande retiree du perimetre operationnel : connexion, relance,
diagnostic, disque, TimescaleDB, sauvegarde et restauration sont tous couverts.
olivier added spent time 2026-09-02 07:26:24 +00:00
30 minutes
olivier self-assigned this 2026-09-02 07:26:32 +00:00
olivier added the due date 2026-09-01 2026-09-02 07:26:46 +00:00
olivier added this to the EnerVision project 2026-09-02 07:27:19 +00:00
Member

LGTM

LGTM
florian merged commit 95b594ba04 into develop 2026-09-02 07:43:51 +00:00
florian deleted branch olivier/docs/postgresql-17 2026-09-02 07:43:51 +00:00
gabriel removed this from the EnerVision project 2026-09-03 11:39:44 +00:00
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
2 participants
Notifications
Total time spent: 30 minutes
olivier
30 minutes
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".
2026-09-01
Dependencies

No dependencies set

Reference
g2/enervision!58
No description provided.