01. Introducción¶
Propósito de esta Documentación¶
Esta documentación cubre la plataforma AClimate v3 — un ecosistema modular para la gestión, procesamiento y visualización de datos agroclimáticos. Sirve como fuente de verdad única para desarrolladores, ingenieros de datos, equipos de operaciones y partes interesadas del producto.
Qué Cubre esta Documentación¶
- Arquitectura del Sistema: Relaciones entre componentes, modelo de despliegue, puntos de integración
- Modelo de Datos: Catálogo completo de entidades, relaciones y convenciones de base de datos derivadas de aclimate_v3_orm
- Contratos API: Especificaciones de endpoints, autenticación, esquemas de solicitud/respuesta
- Pipelines ETL: Flujos de procesamiento de datos, orquestación, controles de calidad
- Frontend: Arquitectura de interfaz de usuario, gestión de estado, configuración
- Admin: Portal administrativo para configuración y gestión del sistema
- Keycloak: Autenticación y autorización centralizadas
- GeoServer: Servicios de datos espaciales y capas de mapa
- Experiencia de Desarrollo: Configuración local, estándares de codificación, estrategias de prueba
Audiencias Objetivo¶
| Audiencia | Áreas de Enfoque |
|---|---|
| Desarrolladores | Contratos API, modelos ORM, guías de instalación, estándares dev |
| Ingenieros de Datos | Tuberías ETL, calidad de datos, convenciones ORM |
| DevOps / Ops | Despliegue, CI/CD, monitoreo, runbooks |
| Producto / Admin | Funcionalidades del portal admin, configuración, flujos operativos |
Cómo Navegar¶
Si eres nuevo en AClimate v3, recomendamos el siguiente orden de lectura:
- Arquitectura — Comprende el panorama general: repos, componentes y sus interacciones
- Modelo de Datos — Explora las entidades ORM como base del sistema
- API — Aprende cómo se exponen los datos a través de endpoints
- Pipeline ETL — Comprende los flujos de datos desde la ingesta hasta el consumo
- Frontend — Ve cómo los usuarios finales interactúan con la plataforma
- Admin — Aprende cómo configurar y gestionar el sistema
- Experiencia de Desarrollo — Prepara tu entorno local
Relación con la Versión Anterior¶
Esta documentación para AClimate v3 sigue la misma estructura base de la versión anterior, manteniendo consistencia de secciones, navegación, nivel de detalle y estilo editorial. Las nuevas secciones de v3 se añaden respetando esa organización.