Plan de Documentation – Socle V4
Version : 4.0.0 Date : 2025-01-25
Structure de la documentation
| # | Document | Description | Statut |
|---|---|---|---|
| 00 | PLAN-DOCUMENTATION | Ce document – Index de la documentation | Done |
| 01 | INTRODUCTION | Présentation du Socle V4 et philosophie | Done |
| 02 | ARCHITECTURE | Architecture technique et composants | Done |
| 03 | QUICKSTART | Guide de démarrage rapide (5 min) | Done |
| 04 | CONFIGURATION | Référence complète de configuration | Done |
| 05 | WORKERS | Guide des Workers et lifecycle | Done |
| 06 | KV-BUS | Guide du Key-Value Bus | Done |
| 07 | SHARED-DATA | Guide du SharedDataRegistry | Done |
| 08 | SUPERVISOR | Supervision et heartbeats | Done |
| 09 | PIPELINE | Pipeline Engine V1 et V2 (Queue/Claim/Ack, DLQ) | Done |
| 10 | SECURITY | Sécurité, Auth, Rate Limiting | Done |
| 11 | RESILIENCE | Circuit Breaker et Retry | Done |
| 12 | SCHEDULER | Scheduling cron et interval | Done |
| 13 | TLS-HTTPS | Configuration TLS/HTTPS | Done |
| 14 | ADMIN-API | API REST d’administration | Done |
| 15 | METRICS | Métriques et Prometheus | Done |
| 16 | KUBERNETES | Déploiement Kubernetes | Done |
| 17 | HOWTO | Guides pratiques | Done |
| 18 | TROUBLESHOOTING | Résolution de problèmes | Done |
| 19 | EXEMPLES | Exemples de code | Done |
| 20 | PLUGINS | Système de plugins | Done |
| 21 | H2-TECHDB | Base technique H2 (V4) | Done |
| 22 | LOG4J2-LOGFORWARDER | Log4j2 et LogForwarder (V4) | Done |
| 23 | AUTH-CLIENT | Client authentification JWT (V4) | Done |
| 24 | WORKER-REGISTRY | Client Worker Registry (V4) | Done |
| 25 | MIGRATION-V3-V4 | Guide de migration V3 → V4 | Done |
| 26 | GRAALVM-JAVASCRIPT | GraalVM CE et GraalJS pour scripts JS | Done |
| 27 | STATUS-DASHBOARD | Dashboard HTML de supervision (port 9374) | Done |
| 29 | JANINO | Scripts Java compiles dynamiquement | Done |
| 30 | EVENTBUS-WORKERS | Workers event-driven | Done |
| 31 | GRPC-INTER-SOCLES | Communication gRPC entre Socles | Done |
Nouveautés V4
Les documents 21 à 30 sont spécifiques au Socle V4 :
- 21-H2-TECHDB : Base embarquée H2 pour état technique
- 22-LOG4J2-LOGFORWARDER : Migration Logback → Log4j2 + centralisation logs
- 23-AUTH-CLIENT : Client JWT pour services centraux
- 24-WORKER-REGISTRY : Auto-enregistrement des workers
- 25-MIGRATION-V3-V4 : Guide de migration depuis V3
- 26-GRAALVM-JAVASCRIPT : GraalVM CE 21 et GraalJS pour exécution JavaScript
- 27-STATUS-DASHBOARD : Dashboard HTML de supervision temps réel sur port 9374
- 29-JANINO : Compilation dynamique de scripts Java
- 30-EVENTBUS-WORKERS : Workers orientés événements
- 31-GRPC-INTER-SOCLES : Communication gRPC bidirectionnelle entre Socles
Guide Méthodologique
Un guide méthodologique complet est disponible pour aider les développeurs à implémenter leurs solutions :
- GUIDE-METHODOLOGIQUE : Bonnes pratiques, patterns, cas d’usage
Ce document répond à la question : « Je dois implémenter X, comment je fais ? »
Conventions
- Tous les fichiers sont en Markdown
- Les exemples de code sont en Java 21
- Les configurations sont en YAML
- Les commandes sont pour Linux/macOS (adaptables Windows)
Laisser un commentaire