DOCUMENTACIÓN // ARRECIFE

Visión general

Plataforma
Arrecife

Visión general del sistema y sus componentes explicada de forma accesible.

Esta documentación está escrita para que pueda entenderse sin conocimientos avanzados. Los términos técnicos se explican cuando son necesarios.

Nucleo

01. ¿Qué es esta plataforma?

Una explicación sencilla antes de entrar en la parte técnica.

En pocas palabras

Es un panel web personal que reúne varios servicios que funcionan en un servidor. En lugar de entrar por separado a cada aplicación, la idea es tener un único lugar desde el que ver qué está funcionando, consultar información y administrar los distintos proyectos.

ORION

Sensores e IoT

Recibe datos de sensores, muestra ciudades en un globo 3D y controla alertas, histórico y disponibilidad.

Overlord

Control Docker

Permite ver y administrar los contenedores y proyectos que están ejecutándose en el servidor.

Cobbleverse

Minecraft

Documenta y administra la infraestructura asociada al servidor de juego.

Idea principal

La plataforma intenta ocultar buena parte de la complejidad del servidor. Una persona puede ver el estado general y entender qué ocurre sin conocer Docker, MQTT, Redis o PostgreSQL.

Nucleo

02. Cómo está montado

Del navegador al servidor, explicado sin jerga innecesaria.

01

El usuario entra en la web

El navegador abre proyectodcd.duckdns.org mediante HTTPS.

02

Nginx recibe la petición

Nginx actúa como puerta de entrada y decide a qué servicio interno debe enviar cada petición.

03

El Dashboard muestra la interfaz

La web está desarrollada con Next.js y presenta los paneles de ORION, Overlord y el resto de módulos.

04

Docker mantiene los servicios separados

Cada componente importante se ejecuta en su propio contenedor para que sea más fácil actualizarlo, reiniciarlo o aislar problemas.

05

Los datos permanecen guardados

PostgreSQL conserva información permanente y Redis mantiene datos rápidos y temporales que ayudan al funcionamiento en tiempo real.

Internet
   │
   ▼
proyectodcd.duckdns.org
   │
   ▼
 Nginx
   │
   ├──── Dashboard Next.js
   │
   ├──── ORION API
   │
   └──── WebSocket en tiempo real
            │
            ▼
     PostgreSQL · Redis · MQTT
Despliegue

03. Infraestructura

Los bloques principales que mantienen la plataforma en funcionamiento.

Servidor

La plataforma está desplegada en un VPS. Es el ordenador remoto que permanece encendido y ejecuta los servicios.

Docker

Se usa para separar aplicaciones. Si un servicio necesita reiniciarse, no es necesario detener toda la plataforma.

PostgreSQL

Es la base de datos principal. Guarda sensores, coordenadas, telemetría, alertas y eventos de disponibilidad.

Redis

Guarda información que debe consultarse con mucha rapidez, como heartbeats y datos recientes de sensores.

MQTT

Es el canal ligero utilizado por los sensores para enviar estados y telemetría a ORION.

Prometheus y Grafana

Recogen métricas técnicas y permiten observar el comportamiento interno del sistema.

Operaciones

04. Qué puede hacer hoy

Resumen de funciones disponibles en la versión actual.

Consultar el estado de los servicios del servidor.

Administrar proyectos y contenedores Docker desde Overlord.

Visualizar sensores meteorológicos de distintos lugares del mundo.

Crear, editar y retirar sensores desde la interfaz de ORION.

Consultar temperatura, humedad, proveedor y hora real de recepción.

Ver el histórico de un sensor durante 24 horas, 7 días o 30 días.

Detectar sensores sin conexión y registrar incidencias.

Calcular disponibilidad y tiempo fuera de servicio.

Cambiar automáticamente entre Open-Meteo y MET Norway si es necesario.

Ver los sensores sobre un Atlas 3D usando coordenadas guardadas en PostgreSQL.

Calidad

05. Glosario rápido

Los términos técnicos más importantes explicados de forma simple.

API

La parte de una aplicación que permite que otros programas le pidan o le envíen información.

Contenedor Docker

Una aplicación empaquetada con lo que necesita para funcionar, separada del resto.

PostgreSQL

La base de datos donde ORION guarda información de forma permanente.

Redis

Una memoria rápida utilizada para información temporal y consultas frecuentes.

MQTT

Un sistema de mensajería ligero pensado especialmente para dispositivos y sensores.

WebSocket

Una conexión que permanece abierta para que la web reciba cambios al instante sin tener que recargarse.

Heartbeat

Una señal periódica que indica que un dispositivo sigue vivo y conectado.

Uptime

El porcentaje de tiempo durante el cual un servicio o sensor ha estado disponible.