diff --git a/CHANGELOG.md b/CHANGELOG.md index 4e080a0..d60ed6a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,10 @@ # Changelog +## [0.26.0] - 2025-10-09 +### Added +- Se han añadido nueva documentacion en swagger para facilitar la integracion de ogCore +- Se ha añadido y completado el README y la documentacion funcional + +--- ## [0.25.1] - 2025-10-01 ### Fixed - Se han corregido varios errores con respecto a las tareas programadas. diff --git a/README.md b/README.md index 31e23ec..1a52c11 100644 --- a/README.md +++ b/README.md @@ -1,144 +1,1828 @@ -# ogCore project +# ogCore - Documentación Técnica y Funcional -## Descripción +## Tabla de Contenidos -ogCore es el servicio central de OpenGnsys, diseñado para proporcionar funcionalidades a través de una API RESTful. Esta herramienta utiliza tecnología PHP, aprovechando el framework Symfony y el ORM Doctrine para gestionar la base de datos. -A continuación, se detallan los pasos necesarios para desplegar el proyecto en un entorno de desarrollo. +1. [Introducción](#1-introducción) +2. [Descripción del Proyecto](#2-descripción-del-proyecto) +3. [Arquitectura del Sistema](#3-arquitectura-del-sistema) +4. [Tecnologías Utilizadas](#4-tecnologías-utilizadas) +5. [Requisitos del Sistema](#5-requisitos-del-sistema) +6. [Instalación y Configuración](#6-instalación-y-configuración) +7. [Modelo de Datos](#7-modelo-de-datos) +8. [Componentes del Sistema](#8-componentes-del-sistema) +9. [API RESTful](#9-api-restful) +10. [Seguridad y Autenticación](#10-seguridad-y-autenticación) +11. [Servicios Principales](#11-servicios-principales) +12. [Comandos de Consola](#12-comandos-de-consola) +13. [Migraciones de Datos](#13-migraciones-de-datos) +14. [Testing](#14-testing) +15. [Despliegue](#15-despliegue) +16. [Mantenimiento y Operaciones](#16-mantenimiento-y-operaciones) +17. [Integración con Otros Servicios](#17-integración-con-otros-servicios) +18. [Roadmap y Changelog](#18-roadmap-y-changelog) +19. [Contribución](#19-contribución) +20. [Soporte y Contacto](#20-soporte-y-contacto) -## Versiones y tecnologías utilizadas +--- -- PHP 8.3 -- Symfony 6.4 -- Doctrine 2.19 -- API Platform 3.2 -- MariaDB 10.11 +## 1. Introducción -## Requisitos +**ogCore** es el servicio central de **OpenGnsys**, una plataforma de código abierto diseñada para la gestión centralizada de aulas de informática, laboratorios y entornos educativos. Este servicio proporciona una API RESTful robusta que permite administrar de manera eficiente clientes (equipos), imágenes de sistemas operativos, perfiles de hardware y software, tareas programadas, y mucho más. -Antes de comenzar, asegúrate de tener los siguientes requisitos: +### 1.1 Propósito del Sistema -- Docker -- Docker compose +El propósito principal de ogCore es: -## Instalación +- **Centralizar la gestión** de equipos informáticos en entornos educativos y corporativos +- **Automatizar el despliegue** de sistemas operativos e imágenes +- **Gestionar inventarios** de hardware y software +- **Programar y ejecutar tareas** de manera automática +- **Proporcionar trazabilidad** de todas las operaciones realizadas +- **Facilitar la migración** desde versiones anteriores de OpenGnsys -### Desplegar contenedores +### 1.2 Alcance -Para que no haya conflictos entre los puertos, asegúrate de que no tienes ningún servicio corriendo en los puertos 8080 y 3306. +ogCore gestiona: +- Clientes (equipos físicos) +- Imágenes de sistemas operativos +- Repositorios de imágenes +- Perfiles de hardware y software +- Unidades organizativas (aulas, grupos) +- Redes y subredes +- Plantillas PXE +- Menús de arranque +- Comandos y tareas programadas +- Trazas de ejecución +- Calendarios remotos +- Integración con sistemas externos (UDS, ogRepository, ogDhcp, ogBoot) -```sh +--- + +## 2. Descripción del Proyecto + +### 2.1 ¿Qué es ogCore? + +ogCore es el núcleo central de OpenGnsys desarrollado con tecnologías modernas de PHP. Actúa como backend que expone una API RESTful completa, permitiendo la gestión de todos los aspectos relacionados con la administración de aulas informáticas. + +### 2.2 Características Principales + +- **API RESTful completa** con documentación Swagger/OpenAPI +- **Autenticación JWT** con refresh tokens +- **Arquitectura basada en eventos** con notificaciones en tiempo real (Mercure) +- **Sistema de colas** para la ejecución de tareas programadas +- **Integración con múltiples servicios** externos +- **Migraciones automatizadas** desde OpenGnsys 1.1 +- **Versionado de imágenes** con integración Git +- **Sistema de trazabilidad** completo +- **Gestión de hardware** con inventario automático +- **Despliegues masivos** de imágenes (unicast, multicast, torrent, p2p) +- **Gestión de particiones** automática +- **Sistema de validación** robusto + +### 2.3 Versión Actual + +- **Versión**: 0.5.0 +- **Estado**: En desarrollo activo +- **Última actualización**: Octubre 2025 + +--- + +## 3. Arquitectura del Sistema + +### 3.1 Arquitectura General + +ogCore sigue una arquitectura de **microservicios** basada en el patrón **API-First**: + +``` ++-------------------------------------------------------------+ +| Frontend (Web UI) | ++---------------------------+----------------------------------+ + | + | HTTP/REST + | ++---------------------------v---------------------------------+ +| ogCore API (Symfony) | +| +------------------------------------------------------+ | +| | Controllers | States | DTOs | Validators | Filters | | +| +------------------------------------------------------+ | +| +------------------------------------------------------+ | +| | Business Logic (Services) | | +| +------------------------------------------------------+ | +| +------------------------------------------------------+ | +| | Entities | Repositories | Doctrine ORM | | +| +------------------------------------------------------+ | ++---------------------------+----------------+----------------+ + | | + +------------------v--+ +--------v--------+ + | MariaDB | | Mercure | + | Database | | (WebSocket) | + +---------------------+ +-----------------+ + ++-------------------------------------------------------------+ +| Servicios Externos Integrados | ++--------------+--------------+--------------+----------------+ +| ogRepository | ogDhcp | ogBoot | UDS/Git | ++--------------+--------------+--------------+----------------+ +``` + +### 3.2 Capas de la Aplicación + +#### 3.2.1 Capa de Presentación (API) +- **API Platform**: Framework para crear APIs REST +- **Controllers**: Controladores personalizados (102 controladores) +- **DTOs (Data Transfer Objects)**: 93 objetos de transferencia de datos +- **OpenAPI/Swagger**: Documentación automática de la API + +#### 3.2.2 Capa de Negocio +- **Services**: Lógica de negocio (13 servicios principales) +- **Handlers**: Manejadores de eventos (2 handlers) +- **EventSubscribers**: Suscriptores de eventos (8 suscriptores) +- **Validators**: Validadores personalizados (18 validadores) + +#### 3.2.3 Capa de Datos +- **Entities**: 35 entidades del modelo de datos +- **Repositories**: 32 repositorios personalizados +- **Doctrine ORM**: Mapeo objeto-relacional +- **Migrations**: 85 migraciones de base de datos + +#### 3.2.4 Capa de Infraestructura +- **Docker**: Contenedorización de servicios +- **Nginx**: Servidor web reverse proxy +- **PHP-FPM**: Procesador de PHP +- **MariaDB**: Sistema de gestión de base de datos +- **Mercure**: Sistema de notificaciones en tiempo real + +### 3.3 Patrones de Diseño Utilizados + +1. **Repository Pattern**: Para abstracción de acceso a datos +2. **DTO Pattern**: Para transferencia de datos entre capas +3. **Factory Pattern**: Para creación de entidades complejas +4. **Event-Driven Architecture**: Para notificaciones y reactividad +5. **State Pattern**: Para gestión de estados de procesamiento +6. **Service Layer**: Para encapsulación de lógica de negocio + +--- + +## 4. Tecnologías Utilizadas + +### 4.1 Backend + +| Tecnología | Versión | Propósito | +|------------|---------|-----------| +| **PHP** | 8.3 | Lenguaje de programación principal | +| **Symfony** | 6.4 | Framework web principal | +| **Doctrine ORM** | 2.19 | Mapeo objeto-relacional | +| **API Platform** | 3.2 | Creación de APIs REST | +| **Lexik JWT** | 3.0 | Autenticación JWT | +| **Gesdinet JWT Refresh Token** | 1.3 | Refresh tokens | +| **Stof Doctrine Extensions** | 1.10 | Extensiones de Doctrine (timestampable, etc.) | +| **Ramsey UUID** | 2.0 | Generación de UUIDs | + +### 4.2 Base de Datos + +| Tecnología | Versión | Propósito | +|------------|---------|-----------| +| **MariaDB** | 10.11 | Sistema de gestión de base de datos | +| **Doctrine DBAL** | 3.x | Capa de abstracción de base de datos | +| **Doctrine Migrations** | 3.3 | Gestión de migraciones | + +### 4.3 Infraestructura + +| Tecnología | Versión | Propósito | +|------------|---------|-----------| +| **Docker** | Latest | Contenedorización | +| **Docker Compose** | Latest | Orquestación de contenedores | +| **Nginx** | Latest | Servidor web / Reverse proxy | +| **PHP-FPM** | 8.3 | Procesador FastCGI | +| **Mercure** | 0.3.9 | Hub de notificaciones en tiempo real | + +### 4.4 Testing + +| Tecnología | Versión | Propósito | +|------------|---------|-----------| +| **PHPUnit** | 9.5 | Framework de testing | +| **Symfony PHPUnit Bridge** | 7.0 | Integración con Symfony | +| **DAMA Doctrine Test Bundle** | 8.1 | Transacciones de prueba | +| **Zenstruck Foundry** | 1.37 | Factories para testing | + +### 4.5 Desarrollo + +| Tecnología | Versión | Propósito | +|------------|---------|-----------| +| **Symfony Maker Bundle** | 1.59 | Generación de código | +| **Symfony Web Profiler** | 6.4 | Debugging y profiling | +| **Monolog** | 3.x | Logging | +| **PHPStan** | Latest | Análisis estático | + +--- + +## 5. Requisitos del Sistema + +### 5.1 Requisitos de Hardware (Producción) + +- **CPU**: Mínimo 4 cores, recomendado 8+ cores +- **RAM**: Mínimo 8GB, recomendado 16GB+ +- **Disco**: + - Sistema: 20GB SSD + - Base de datos: 50GB+ SSD + - Logs: 10GB +- **Red**: 1Gbps mínimo + +### 5.2 Requisitos de Software + +- **Sistema Operativo**: Linux (Ubuntu 20.04+, Debian 11+, CentOS 8+) +- **Docker**: >= 20.10 +- **Docker Compose**: >= 2.0 +- **Git**: >= 2.25 (para gestión de código) + +### 5.3 Puertos Requeridos + +| Puerto | Servicio | Propósito | +|--------|----------|-----------| +| 8080 | Nginx/HTTP | API y documentación | +| 3306 | MariaDB | Base de datos | +| 9000 | PHP-FPM | Procesador PHP | +| 3000 | Mercure | WebSocket/SSE | + +--- + +## 6. Instalación y Configuración + +### 6.1 Instalación con Docker (Recomendado) + +#### 6.1.1 Clonar el Repositorio + +```bash +git clone ogcore +cd ogcore +``` + +#### 6.1.2 Verificar Puertos Disponibles + +Asegúrate de que los puertos 8080 y 3306 no estén en uso: + +```bash +sudo lsof -i :8080 +sudo lsof -i :3306 +``` + +#### 6.1.3 Desplegar Contenedores + +```bash docker compose up --build -d ``` -Comprobamos que se han levantado correctamente bien los 3 contenedores de la aplicación: +#### 6.1.4 Verificar Contenedores -```sh +```bash docker ps ``` -Y deberiamos ver algo parecido a : +Deberías ver tres contenedores activos: +- `ogcore-nginx` +- `ogcore-php` +- `ogcore-database` -- ogcore-nginx -- ogcore-php -- ogcore-database +#### 6.1.5 Instalar Dependencias - -### Instalamos dependencias - -```sh +```bash docker exec ogcore-php composer install +``` + +#### 6.1.6 Generar Claves JWT + +```bash docker exec ogcore-php php bin/console lexik:jwt:generate-keypair --overwrite ``` -Comprobamos, que el contenedor de Nginx, tiene el puerto 8080 levantado correctamente, asi que tan solo tendremos que -acceder a la siguiente URL: +#### 6.1.7 Inicializar Base de Datos -```sh -http://127.0.0.1:8080/docs -``` -Si todo ha ido bien, deberiamos ver la documentación de la API de ogCore. - -Para poder actualizar la base de datos: - -Para inicializar la base de datos: - -```sh +```bash +# Ejecutar migraciones docker exec ogcore-php php bin/console doctrine:migrations:migrate --no-interaction -``` -```sh +# Cargar datos iniciales (fixtures) docker exec ogcore-php php bin/console doctrine:fixtures:load --no-interaction -docker exec ogcore-php php bin/console app:load-default-user-groups #cargamos los grupos por defecto -docker exec ogcore-php php bin/console app:load-default-commands #cargamos los commands por defecto + +# Cargar grupos de usuarios por defecto +docker exec ogcore-php php bin/console app:load-default-user-groups + +# Cargar comandos por defecto +docker exec ogcore-php php bin/console app:load-default-commands ``` -## UX Api Platform +#### 6.1.8 Acceder a la Aplicación -Api Platform proporciona una interfaz de usuario para interactuar con la API de ogCore. Para acceder a la interfaz de usuario, accede a la siguiente URL: +Abre tu navegador y accede a: -```sh +``` http://127.0.0.1:8080/docs ``` -Para poder autenticarte, necesitas un token JWT. Para obtenerlo, accedemos al endpoint de autenticación "auth/login": +Deberías ver la documentación Swagger de la API de ogCore. -![img.png](swagger-assets/img.png) -![img.png](swagger-assets/img2.png) -Obtenemos el token y lo introducimos en la interfaz de usuario de Api Platform de la siguiente manera: +### 6.2 Configuración -![img.png](swagger-assets/img3.png) +#### 6.2.1 Variables de Entorno -Ahora, ya podemos interactuar con la API de ogCore. Para comprobar que todo está correcto, podemos fijarnos en los headers de las llamadas Curl, y ver que el token JWT se ha introducido correctamente. +El archivo `.env` contiene las variables de configuración principales: -## Test +```bash +# Entorno +APP_ENV=dev +APP_SECRET= -Para ejecutar los test, ejecutamos el siguiente comando: +# Base de datos +DATABASE_URL="mysql://user:password@ogcore-database:3306/ogcore" -```sh -docker compose exec php bin/phpunit +# JWT +JWT_SECRET_KEY=%kernel.project_dir%/config/jwt/private.pem +JWT_PUBLIC_KEY=%kernel.project_dir%/config/jwt/public.pem +JWT_PASSPHRASE= + +# Mercure +MERCURE_URL=http://mercure:3000/.well-known/mercure +MERCURE_PUBLIC_URL=http://127.0.0.1:8080/.well-known/mercure +MERCURE_JWT_SECRET= + +# Servicios externos +REMOTE_PC_URL= +REMOTE_PC_AUTH_LOGIN= +REMOTE_PC_AUTH_USERNAME= +REMOTE_PC_AUTH_PASSWORD= + +# SSL/TLS +SSL_ENABLED=false ``` -## Reiniciar base de datos +#### 6.2.2 Configuración de CORS -Es posible que en momentos de desarrollo, sea necesario volver a cargar la base de datos y actualizar los esquemas de la misma, para ello, ejecutamos el siguiente comando: +Edita `config/packages/nelmio_cors.yaml` para configurar CORS según tus necesidades. -```sh -docker exec ogcore-php php bin/console doctrine:database:drop --force -docker exec ogcore-php php bin/console doctrine:database:create +#### 6.2.3 Configuración de API Platform + +La configuración de API Platform se encuentra en `config/packages/api_platform.yaml`. + +### 6.3 Instalación en Producción + +Para entornos de producción, utiliza el archivo `docker-compose-deploy.yml`: + +```bash +docker compose -f docker-compose-deploy.yml up -d ``` -## Migraciones de datos +Asegúrate de: +- Cambiar todas las contraseñas por defecto +- Configurar SSL/TLS +- Configurar backups automáticos de base de datos +- Configurar monitoreo y alertas +- Revisar los límites de recursos de Docker -Para poder migrar los datos desde la base de datos "antigua", previamente necesitamos poder tener un esquema de base de datos con un dump de OpenGnsys. Es decir: +--- - - Creamos una base de datos temporal simulando una insancia de OpenGnsys 1.1. La solicitaremos al equipo de desarrollo de las universidades - - Necesitaremos un dump de la base de datos de OpenGnsys 1.1. +## 7. Modelo de Datos -Mediante doctrine, creamos la base de datos temporal: +### 7.1 Diagrama de Entidades -```sh +El sistema cuenta con 35 entidades principales agrupadas en los siguientes dominios: + +### 7.2 Entidades Principales + +#### 7.2.1 Client (Cliente) + +Representa un equipo físico en el sistema. + +**Campos principales:** +- `id`: UUID único +- `name`: Nombre del cliente +- `serialNumber`: Número de serie +- `mac`: Dirección MAC (única) +- `ip`: Dirección IP (única) +- `status`: Estado del cliente (active, inactive, busy, windows, linux, etc.) +- `netiface`: Interfaz de red +- `netDriver`: Driver de red +- `validation`: Estado de validación +- `maintenance`: Modo mantenimiento +- `position`: Posición en el aula (x, y) +- `firmwareType`: Tipo de firmware (BIOS/UEFI) +- `agentJobId`: ID del trabajo del agente en ejecución +- `pxeSync`: Sincronización PXE +- `token`: Token de autenticación del cliente + +**Relaciones:** +- `organizationalUnit`: Pertenece a una unidad organizativa (aula/grupo) +- `partitions`: Tiene múltiples particiones +- `menu`: Menú de arranque asignado +- `hardwareProfile`: Perfil de hardware asociado +- `template`: Plantilla PXE asignada +- `repository`: Repositorio de imágenes +- `subnet`: Subred a la que pertenece +- `ogLive`: Imagen Live asignada + +#### 7.2.2 OrganizationalUnit (Unidad Organizativa) + +Representa aulas o grupos de equipos. + +**Campos principales:** +- `id`: UUID único +- `name`: Nombre de la unidad +- `description`: Descripción +- `type`: Tipo (aula, grupo, etc.) + +**Relaciones:** +- `parent`: Unidad organizativa padre (jerarquía) +- `children`: Unidades hijas +- `clients`: Clientes pertenecientes +- `networkSettings`: Configuración de red heredable +- `remoteCalendar`: Calendario remoto asociado + +#### 7.2.3 Image (Imagen) + +Representa una imagen de sistema operativo. + +**Campos principales:** +- `id`: UUID único +- `name`: Nombre de la imagen +- `description`: Descripción +- `type`: Tipo de imagen +- `size`: Tamaño en bytes +- `partition`: Partición de origen +- `status`: Estado (creating, success, failed, etc.) +- `isGlobal`: Imagen global compartida +- `isVirtual`: Imagen virtual +- `version`: Versión de la imagen + +**Relaciones:** +- `operativeSystem`: Sistema operativo +- `softwareProfile`: Perfil de software +- `repositories`: Repositorios que contienen la imagen +- `originClient`: Cliente origen de la imagen + +#### 7.2.4 Command (Comando) + +Comandos ejecutables en el sistema. + +**Campos principales:** +- `id`: UUID único +- `name`: Nombre del comando +- `description`: Descripción +- `script`: Script a ejecutar + +**Relaciones:** +- `commandGroups`: Grupos de comandos a los que pertenece + +#### 7.2.5 CommandTask (Tarea de Comando) + +Tarea programada para ejecutar comandos. + +**Campos principales:** +- `id`: UUID único +- `datetime`: Fecha y hora de ejecución +- `parameters`: Parámetros de ejecución +- `status`: Estado de la tarea + +**Relaciones:** +- `commands`: Comandos a ejecutar +- `commandGroups`: Grupos de comandos +- `clients`: Clientes objetivo +- `schedule`: Programación recurrente + +#### 7.2.6 Trace (Traza) + +Registro de ejecución de comandos. + +**Campos principales:** +- `id`: UUID único +- `command`: Nombre del comando ejecutado +- `input`: Parámetros de entrada +- `output`: Resultado de ejecución +- `status`: Estado (pending, processing, success, failed, cancelled) +- `executedAt`: Fecha de ejecución +- `finishedAt`: Fecha de finalización +- `cancelled`: Indica si fue cancelada +- `jobId`: ID del trabajo en el agente + +**Relaciones:** +- `client`: Cliente donde se ejecutó + +#### 7.2.7 HardwareProfile (Perfil de Hardware) + +Inventario de hardware de un cliente. + +**Campos principales:** +- `id`: UUID único +- `cpu`: Información de CPU +- `ram`: Memoria RAM +- `storage`: Almacenamiento +- `networkCards`: Tarjetas de red + +**Relaciones:** +- `client`: Cliente asociado +- `hardwareTypes`: Tipos de hardware detectados + +#### 7.2.8 SoftwareProfile (Perfil de Software) + +Software instalado en una imagen. + +**Campos principales:** +- `id`: UUID único +- `name`: Nombre del perfil + +**Relaciones:** +- `software`: Software incluido +- `images`: Imágenes que usan este perfil + +#### 7.2.9 ImageRepository (Repositorio de Imágenes) + +Servidor de almacenamiento de imágenes. + +**Campos principales:** +- `id`: UUID único +- `name`: Nombre del repositorio (único) +- `ip`: Dirección IP o DNS (único) +- `port`: Puerto +- `sshPort`: Puerto SSH +- `sshUser`: Usuario SSH +- `apiKey`: Clave API +- `status`: Estado del repositorio + +**Relaciones:** +- `images`: Imágenes almacenadas + +#### 7.2.10 Subnet (Subred) + +Configuración de red. + +**Campos principales:** +- `id`: UUID único +- `name`: Nombre de la subred +- `cidr`: Notación CIDR +- `gateway`: Puerta de enlace +- `dns`: Servidores DNS +- `dhcpStart`: Inicio rango DHCP +- `dhcpEnd`: Fin rango DHCP + +**Relaciones:** +- `clients`: Clientes en la subred + +#### 7.2.11 Partition (Partición) + +Partición de disco de un cliente. + +**Campos principales:** +- `id`: UUID único +- `partitionNumber`: Número de partición +- `partitionType`: Tipo de partición +- `partitionSize`: Tamaño +- `partitionCode`: Código de partición +- `usedSize`: Tamaño usado +- `filesystem`: Sistema de archivos + +**Relaciones:** +- `client`: Cliente propietario +- `image`: Imagen desplegada +- `operativeSystem`: Sistema operativo instalado + +#### 7.2.12 PxeTemplate (Plantilla PXE) + +Plantilla de arranque PXE. + +**Campos principales:** +- `id`: UUID único +- `name`: Nombre de la plantilla +- `content`: Contenido de la plantilla +- `default`: Plantilla por defecto + +**Relaciones:** +- `clients`: Clientes que usan la plantilla + +#### 7.2.13 RemoteCalendar (Calendario Remoto) + +Integración con sistemas de reservas remotas. + +**Campos principales:** +- `id`: UUID único +- `name`: Nombre del calendario +- `url`: URL del servicio +- `available`: Disponibilidad + +**Relaciones:** +- `organizationalUnits`: Unidades organizativas asociadas +- `rules`: Reglas del calendario + +#### 7.2.14 User (Usuario) + +Usuario del sistema. + +**Campos principales:** +- `id`: UUID único +- `username`: Nombre de usuario (único) +- `password`: Contraseña (hasheada) +- `email`: Correo electrónico +- `roles`: Roles del usuario + +**Relaciones:** +- `userGroups`: Grupos de usuarios +- `view`: Vista preferida + +#### 7.2.15 GitRepository (Repositorio Git) + +Repositorio Git para versionado de imágenes. + +**Campos principales:** +- `id`: UUID único +- `name`: Nombre del repositorio +- `url`: URL del repositorio +- `branch`: Rama +- `credentials`: Credenciales de acceso + +### 7.3 Índices y Optimizaciones + +La base de datos está optimizada con índices en: +- Campos de búsqueda frecuente (status, updatedAt) +- Campos únicos (IP, MAC, username) +- Claves foráneas +- Índices compuestos para consultas complejas + +--- + +## 8. Componentes del Sistema + +### 8.1 Controllers (Controladores) + +El sistema cuenta con **102 controladores** organizados por dominio: + +#### Controladores principales: +- **ClientController**: Gestión de clientes +- **ImageController**: Gestión de imágenes +- **OrganizationalUnitController**: Gestión de unidades organizativas +- **CommandController**: Gestión de comandos +- **TraceController**: Gestión de trazas +- **UserController**: Gestión de usuarios +- **SubnetController**: Gestión de subredes +- **RepositoryController**: Gestión de repositorios + +### 8.2 States (Procesadores de Estado) + +Los States implementan el patrón State de API Platform: + +#### States principales (55 procesadores): +- **Providers**: Obtención de datos +- **Processors**: Procesamiento de escritura +- **Custom States**: Lógica personalizada + +### 8.3 DTOs (Data Transfer Objects) + +**93 DTOs** para transferencia de datos: + +#### Tipos de DTOs: +- **Input DTOs**: Para recepción de datos +- **Output DTOs**: Para envío de datos +- **Transformation DTOs**: Para transformaciones + +### 8.4 Validators (Validadores) + +**18 validadores personalizados** para: +- Validación de IPs y MACs +- Validación de rangos DHCP +- Validación de particiones +- Validación de imágenes +- Validación de comandos +- Validación de usuarios + +### 8.5 EventSubscribers (Suscriptores de Eventos) + +**8 suscriptores** para: +- Publicación en Mercure al cambiar estados +- Limpieza de recursos +- Validaciones pre/post persistencia +- Logging de eventos + +### 8.6 Factories (Fábricas) + +**24 factories** para testing con Foundry: +- Creación de entidades para tests +- Datos de prueba realistas +- Estados predefinidos + +--- + +## 9. API RESTful + +### 9.1 Documentación + +La API está completamente documentada con **OpenAPI 3.0** y accesible en: + +``` +http://127.0.0.1:8080/docs +``` + +### 9.2 Formato de Respuestas + +#### Formato estándar (JSON-LD): + +```json +{ + "@context": "/contexts/Client", + "@id": "/clients/123e4567-e89b-12d3-a456-426614174000", + "@type": "Client", + "id": "123e4567-e89b-12d3-a456-426614174000", + "name": "PC-01", + "mac": "00:11:22:33:44:55", + "ip": "192.168.1.100", + "status": "active" +} +``` + +#### Formato alternativo (JSON): + +```json +{ + "id": "123e4567-e89b-12d3-a456-426614174000", + "name": "PC-01", + "mac": "00:11:22:33:44:55", + "ip": "192.168.1.100", + "status": "active" +} +``` + +### 9.3 Paginación + +Todas las colecciones soportan paginación: + +``` +GET /clients?page=1&itemsPerPage=30 +``` + +Respuesta: + +```json +{ + "@context": "/contexts/Client", + "@id": "/clients", + "@type": "hydra:Collection", + "hydra:member": [...], + "hydra:totalItems": 150, + "hydra:view": { + "@id": "/clients?page=1", + "@type": "hydra:PartialCollectionView", + "hydra:first": "/clients?page=1", + "hydra:last": "/clients?page=5", + "hydra:next": "/clients?page=2" + } +} +``` + +### 9.4 Filtrado + +Soporta filtros avanzados: + +``` +GET /clients?status=active +GET /clients?organizationalUnit.name=Aula1 +GET /traces?client.id=123&status=pending +``` + +### 9.5 Ordenamiento + +``` +GET /clients?order[name]=asc +GET /traces?order[createdAt]=desc +``` + +### 9.6 Endpoints Principales + +#### 9.6.1 Autenticación + +``` +POST /auth/login +POST /auth/refresh +``` + +#### 9.6.2 Clientes + +``` +GET /clients +POST /clients +GET /clients/{id} +PUT /clients/{id} +PATCH /clients/{id} +DELETE /clients/{id} +POST /clients/batch +POST /clients/{id}/power-on +POST /clients/{id}/power-off +POST /clients/{id}/reboot +``` + +#### 9.6.3 Imágenes + +``` +GET /images +POST /images +GET /images/{id} +PUT /images/{id} +DELETE /images/{id} +POST /images/{id}/deploy +POST /images/{id}/create +POST /images/{id}/backup +``` + +#### 9.6.4 Comandos y Tareas + +``` +GET /commands +POST /commands +GET /command-tasks +POST /command-tasks +PUT /command-tasks/{id} +DELETE /command-tasks/{id} +``` + +#### 9.6.5 Trazas + +``` +GET /traces +GET /traces/{id} +PUT /traces/{id} +PATCH /traces/{id}/complete +PATCH /traces/{id}/cancel +``` + +### 9.7 Códigos de Estado HTTP + +| Código | Significado | +|--------|-------------| +| 200 | OK - Operación exitosa | +| 201 | Created - Recurso creado | +| 204 | No Content - Eliminación exitosa | +| 400 | Bad Request - Datos inválidos | +| 401 | Unauthorized - No autenticado | +| 403 | Forbidden - Sin permisos | +| 404 | Not Found - Recurso no encontrado | +| 409 | Conflict - Conflicto (cliente ocupado, constraint violation) | +| 422 | Unprocessable Entity - Validación fallida | +| 500 | Internal Server Error - Error del servidor | + +--- + +## 10. Seguridad y Autenticación + +### 10.1 Sistema de Autenticación JWT + +ogCore utiliza **JSON Web Tokens (JWT)** para autenticación: + +#### 10.1.1 Obtener Token + +```bash +POST /auth/login +Content-Type: application/json + +{ + "username": "admin", + "password": "password" +} +``` + +Respuesta: + +```json +{ + "token": "eyJ0eXAiOiJKV1QiLCJhbGc...", + "refresh_token": "def50200a54b7b..." +} +``` + +#### 10.1.2 Usar Token + +Incluir el token en el header `Authorization`: + +```bash +GET /clients +Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGc... +``` + +#### 10.1.3 Refresh Token + +```bash +POST /auth/refresh +Content-Type: application/json + +{ + "refresh_token": "def50200a54b7b..." +} +``` + +### 10.2 Control de Acceso + +#### Rutas Públicas: +- `/auth/login` +- `/auth/refresh` +- `/docs` +- `/opengnsys/rest/*` (webhooks) +- `/og-repository/webhook` +- `/menu-browser` + +#### Rutas Protegidas: +- Todo lo demás requiere `IS_AUTHENTICATED_FULLY` + +### 10.3 Roles de Usuario + +Los roles se gestionan en la entidad `User`: + +```php +$user->setRoles(['ROLE_USER']); +$user->setRoles(['ROLE_ADMIN']); +``` + +### 10.4 Seguridad de Contraseñas + +- Hashing con **bcrypt** automático +- Validación de fortaleza +- Cambio de contraseña seguro + +### 10.5 CORS (Cross-Origin Resource Sharing) + +Configurado en `nelmio_cors.yaml` para permitir acceso desde frontend. + +### 10.6 SSL/TLS + +Para producción, habilitar SSL: + +```bash +SSL_ENABLED=true +``` + +Configurar certificados en `/certs/`. + +--- + +## 11. Servicios Principales + +### 11.1 CreatePartitionService + +**Propósito**: Crear y actualizar particiones de clientes. + +**Funcionalidad**: +- Recibe información de particiones del agente +- Crea/actualiza particiones en base de datos +- Detecta tipo de firmware (BIOS/UEFI) +- Calcula códigos de partición + +### 11.2 CreateTraceService + +**Propósito**: Crear trazas de ejecución para tareas programadas. + +**Funcionalidad**: +- Genera trazas para cada combinación cliente-comando +- Gestiona comandos agrupados +- Establece estado inicial y fecha de ejecución + +### 11.3 ChangeClientNetworkSettingsService + +**Propósito**: Cambiar configuración de red de clientes. + +**Funcionalidad**: +- Actualiza subnet, IP, configuración de red +- Sincroniza con servicios externos (DHCP) + +### 11.4 ExternalGitRepositoryService + +**Propósito**: Gestión de repositorios Git para imágenes. + +**Funcionalidad**: +- Backup de imágenes a Git +- Versionado de imágenes +- Sincronización con repositorios remotos + +### 11.5 StatusService (OgBoot/OgDhcp/OgRepository) + +**Propósito**: Verificar estado de servicios externos. + +**Funcionalidad**: +- Health checks de servicios +- Manejo de errores de conexión +- Logging de estado + +### 11.6 UDSClient + +**Propósito**: Integración con UDS (Universal Desktop Services). + +**Funcionalidad**: +- Autenticación con UDS +- Obtención de service pools +- Cálculo de asientos disponibles +- Gestión de calendarios remotos + +### 11.7 Trace/CreateService + +**Propósito**: Servicio especializado para creación de trazas. + +**Funcionalidad**: +- Validación de parámetros de entrada +- Creación de trazas individuales o masivas + +### 11.8 Utils/GetPartitionCodeService + +**Propósito**: Obtener código de partición según tipo y filesystem. + +### 11.9 Utils/SimplifyOgLiveFilenameService + +**Propósito**: Simplificar nombres de archivos OgLive para mostrar al usuario. + +### 11.10 Utils/GetIpAddressAndNetmaskFromCIDRService + +**Propósito**: Convertir notación CIDR a IP y máscara de red. + +--- + +## 12. Comandos de Consola + +ogCore incluye **18 comandos de consola** para tareas administrativas: + +### 12.1 Comandos de Inicialización + +#### 12.1.1 Cargar Grupos de Usuario por Defecto + +```bash +php bin/console app:load-default-user-groups +``` + +Crea los grupos de usuarios predeterminados del sistema. + +#### 12.1.2 Cargar Comandos por Defecto + +```bash +php bin/console app:load-default-commands +``` + +Carga los comandos básicos del sistema. + +#### 12.1.3 Cargar Usuario Admin + +```bash +php bin/console app:load-default-user-admin +``` + +Crea el usuario administrador por defecto. + +#### 12.1.4 Cargar Menú por Defecto + +```bash +php bin/console app:load-default-menu +``` + +Carga menús de arranque predeterminados. + +#### 12.1.5 Cargar Tipos de Hardware + +```bash +php bin/console app:load-hardware-types +``` + +Inicializa la tabla de tipos de hardware. + +#### 12.1.6 Cargar Unidad Organizativa por Defecto + +```bash +php bin/console app:load-organizational-unit-default +``` + +Crea la unidad organizativa raíz. + +### 12.2 Comandos de Operación + +#### 12.2.1 Verificar Disponibilidad de Clientes + +```bash +php bin/console app:check-client-availability +``` + +**Ejecución**: Cada 1 minuto (cron) + +Verifica el estado de conectividad de los clientes y actualiza su estado si no responden en un tiempo determinado. + +#### 12.2.2 Ejecutar Trazas Pendientes + +```bash +php bin/console app:execute-pending-traces +``` + +**Ejecución**: Cada 1 minuto (cron) + +Procesa las trazas en estado `PENDING` y las ejecuta en los clientes correspondientes. + +#### 12.2.3 Ejecutar Tareas Programadas + +```bash +php bin/console app:run-scheduled-command-tasks +``` + +**Ejecución**: Cada 1 minuto (cron) + +Ejecuta tareas programadas que han llegado a su hora de ejecución. + +### 12.3 Comandos de Migración + +Comandos para migrar datos desde OpenGnsys 1.1: + +#### 12.3.1 Migrar Unidades Organizativas + +```bash +php bin/console opengnsys:migration:organizational-unit +``` + +#### 12.3.2 Migrar Perfiles de Hardware + +```bash +php bin/console opengnsys:migration:hardware-profile +``` + +#### 12.3.3 Migrar Clientes + +```bash +php bin/console opengnsys:migration:clients +``` + +#### 12.3.4 Migrar Sistemas Operativos + +```bash +php bin/console opengnsys:migration:os +``` + +#### 12.3.5 Migrar Imágenes + +```bash +php bin/console opengnsys:migration:image +``` + +#### 12.3.6 Migrar Perfiles de Software + +```bash +php bin/console opengnsys:migration:software-profile +``` + +#### 12.3.7 Migrar Particiones de Clientes + +```bash +php bin/console opengnsys:migration:partition-client +``` + +### 12.4 Comandos de Desarrollo + +#### 12.4.1 Crear Repositorios de Imágenes + +```bash +php bin/console app:create-image-repositories +``` + +Crea repositorios de imágenes para desarrollo/testing. + +#### 12.4.2 Cargar Trazas de Ejemplo + +```bash +php bin/console app:charge-example-trace +``` + +Carga trazas de ejemplo para testing. + +### 12.5 Configuración de Cron + +Agregar al crontab: + +```bash +* * * * * docker exec ogcore-php php bin/console app:check-client-availability +* * * * * docker exec ogcore-php php bin/console app:execute-pending-traces +* * * * * docker exec ogcore-php php bin/console app:run-scheduled-command-tasks +``` + +--- + +## 13. Migraciones de Datos + +### 13.1 Sistema de Migraciones de Doctrine + +ogCore utiliza Doctrine Migrations para gestionar cambios en el esquema de base de datos. + +#### 13.1.1 Crear una Migración + +```bash +docker exec ogcore-php php bin/console make:migration +``` + +#### 13.1.2 Ejecutar Migraciones + +```bash +docker exec ogcore-php php bin/console doctrine:migrations:migrate +``` + +#### 13.1.3 Ver Estado de Migraciones + +```bash +docker exec ogcore-php php bin/console doctrine:migrations:status +``` + +#### 13.1.4 Revertir Migración + +```bash +docker exec ogcore-php php bin/console doctrine:migrations:migrate prev +``` + +### 13.2 Migración desde OpenGnsys 1.1 + +Para migrar datos desde una instalación de OpenGnsys 1.1: + +#### 13.2.1 Crear Base de Datos Temporal + +```bash docker exec ogcore-php php bin/console doctrine:database:create --connection=og_1 ``` -![img.png](swagger-assets/img_bbdd.png) +#### 13.2.2 Cargar Dump de OpenGnsys 1.1 -Aqui podemos ver como tenemos las 2 bases de datos. OgCore es la actual, donde estamos desarrollando, y ogcore_old_og es la base de datos temporal que acabamos de crear. - -Aqui vendria el paso de cargar el dump en dicha base de datos, ya que contiene informacion sensible, no se aloja en el repositorio, por eso tendremos que solicitarla al equipo correspondiente. -Una vez tengamos la base de datos cargada, podremos ejecutar las migraciones de datos: - -```sh ---- Migraciones de OpenGnsys. --- -docker exec ogcore-php php bin/console opengnsys:migration:organizational-unit #cargamos las unidades organizativas -docker exec ogcore-php php bin/console opengnsys:migration:hardware-profile #cargamos los perfiles de hardware -docker exec ogcore-php php bin/console opengnsys:migration:clients #cargamos los clientes -docker exec ogcore-php php bin/console opengnsys:migration:os #cargamos los sistemas operativos -docker exec ogcore-php php bin/console opengnsys:migration:image #cargamos las imagenes -docker exec ogcore-php php bin/console opengnsys:migration:software-profile #cargamos los software profiles +```bash +docker exec -i ogcore-database mysql -u user -p ogcore_old_og < dump_og_1.1.sql ``` -## Objetos de interés +#### 13.2.3 Ejecutar Migraciones -Se ha incluido un .zip con las colecciones de de API de ogCore para poder trabajar, hacer pruebas, y demás en Postman. Para importarlos, tan solo tendremos que ir a la pestaña de importar, y seleccionar el archivo .zip. +Ejecutar los comandos de migración en orden: -Visualizar [coleccion Postman](swagger-assets/ogCore.postman_collection.zip) +```bash +docker exec ogcore-php php bin/console opengnsys:migration:organizational-unit +docker exec ogcore-php php bin/console opengnsys:migration:hardware-profile +docker exec ogcore-php php bin/console opengnsys:migration:clients +docker exec ogcore-php php bin/console opengnsys:migration:os +docker exec ogcore-php php bin/console opengnsys:migration:image +docker exec ogcore-php php bin/console opengnsys:migration:software-profile +``` + +### 13.3 Backup y Restauración + +#### 13.3.1 Backup de Base de Datos + +```bash +docker exec ogcore-database mysqldump -u user -p ogcore > backup_$(date +%Y%m%d).sql +``` + +#### 13.3.2 Restaurar Base de Datos + +```bash +docker exec -i ogcore-database mysql -u user -p ogcore < backup_20251008.sql +``` + +--- + +## 14. Testing + +### 14.1 Framework de Testing + +ogCore utiliza **PHPUnit** con integración de Symfony y Doctrine. + +### 14.2 Ejecutar Tests + +#### 14.2.1 Todos los Tests + +```bash +docker compose exec php bin/phpunit +``` + +#### 14.2.2 Tests Específicos + +```bash +docker compose exec php bin/phpunit tests/Functional/ClientTest.php +``` + +#### 14.2.3 Tests con Coverage + +```bash +docker compose exec php bin/phpunit --coverage-html coverage/ +``` + +### 14.3 Tipos de Tests + +#### 14.3.1 Tests Funcionales + +Ubicación: `tests/Functional/` + +20 archivos de tests funcionales que prueban: +- Endpoints de API +- Flujos completos +- Integraciones + +Ejemplo: + +```php +public function testCreateClient(): void +{ + $client = static::createClient(); + $client->request('POST', '/clients', [ + 'json' => [ + 'name' => 'Test Client', + 'mac' => '00:11:22:33:44:55', + 'ip' => '192.168.1.100' + ] + ]); + + $this->assertResponseStatusCodeSame(201); +} +``` + +### 14.4 Factories para Testing + +Se utilizan **Zenstruck Foundry** factories (24 factories) para crear datos de prueba: + +```php +ClientFactory::createOne([ + 'name' => 'Test PC', + 'status' => 'active' +]); +``` + +### 14.5 Base de Datos de Testing + +Los tests utilizan **DAMA Doctrine Test Bundle** para: +- Ejecutar cada test en una transacción +- Rollback automático después de cada test +- Aislamiento completo entre tests + +--- + +## 15. Despliegue + +### 15.1 Despliegue con Docker Compose + +#### 15.1.1 Desarrollo + +```bash +docker compose up -d +``` + +#### 15.1.2 Producción + +```bash +docker compose -f docker-compose-deploy.yml up -d +``` + +### 15.2 Despliegue con Jenkins + +El proyecto incluye **Jenkinsfile** para CI/CD. + +#### Pipeline stages: +1. **Checkout**: Clonar repositorio +2. **Build**: Construir imagen Docker +3. **Test**: Ejecutar tests +4. **Package**: Crear paquete Debian +5. **Deploy**: Desplegar en servidor + +### 15.3 Paquete Debian + +El proyecto puede empaquetarse como `.deb`: + +```bash +./package.sh +``` + +Estructura del paquete en `debian/`: +- Control files +- Postinst/preinst scripts +- Systemd service file +- Configuración + +### 15.4 Configuración de Producción + +#### 15.4.1 Variables de Entorno + +Crear `.env.local` con configuración de producción: + +```bash +APP_ENV=prod +APP_DEBUG=0 +DATABASE_URL="mysql://user:pass@localhost:3306/ogcore" +# ... más configuración +``` + +#### 15.4.2 Optimizaciones + +```bash +# Limpiar caché +docker exec ogcore-php php bin/console cache:clear --env=prod + +# Calentar caché +docker exec ogcore-php php bin/console cache:warmup --env=prod + +# Optimizar autoloader +docker exec ogcore-php composer dump-autoload --optimize --classmap-authoritative +``` + +### 15.5 Monitoreo + +#### 15.5.1 Logs + +Logs ubicados en `var/log/`: +- `dev.log` / `prod.log`: Logs de aplicación +- `nginx/access.log`: Accesos a nginx +- `nginx/error.log`: Errores de nginx + +#### 15.5.2 Syslog + +Los logs también se envían a syslog para centralización. + +### 15.6 Escalabilidad + +Para escalar horizontalmente: + +1. **Base de datos**: Usar MariaDB con replicación master-slave +2. **PHP**: Aumentar réplicas de contenedor PHP +3. **Load Balancer**: Usar nginx como balanceador de carga +4. **Caché**: Implementar Redis para sesiones y caché +5. **Mercure**: Escalar hub de Mercure + +--- + +## 16. Mantenimiento y Operaciones + +### 16.1 Reiniciar Base de Datos + +```bash +docker exec ogcore-php php bin/console doctrine:database:drop --force +docker exec ogcore-php php bin/console doctrine:database:create +docker exec ogcore-php php bin/console doctrine:migrations:migrate --no-interaction +docker exec ogcore-php php bin/console doctrine:fixtures:load --no-interaction +``` + +### 16.2 Limpiar Caché + +```bash +docker exec ogcore-php php bin/console cache:clear +docker exec ogcore-php php bin/console cache:warmup +``` + +### 16.3 Actualizar Dependencias + +```bash +docker exec ogcore-php composer update +``` + +### 16.4 Regenerar Claves JWT + +```bash +docker exec ogcore-php php bin/console lexik:jwt:generate-keypair --overwrite +``` + +### 16.5 Backups Automáticos + +Script ejemplo para backup automático: + +```bash +#!/bin/bash +DATE=$(date +%Y%m%d_%H%M%S) +BACKUP_DIR="/backups" + +# Backup de base de datos +docker exec ogcore-database mysqldump -u user -p password ogcore > $BACKUP_DIR/db_$DATE.sql + +# Backup de archivos +tar -czf $BACKUP_DIR/files_$DATE.tar.gz /var/www/html/ogcore/var + +# Limpiar backups antiguos (>30 días) +find $BACKUP_DIR -name "*.sql" -mtime +30 -delete +find $BACKUP_DIR -name "*.tar.gz" -mtime +30 -delete +``` + +### 16.6 Monitoreo de Salud + +#### Health Check Endpoint + +```bash +GET /health +``` + +#### Verificar Estado de Servicios + +```bash +# PHP +docker exec ogcore-php php -v + +# Nginx +docker exec ogcore-nginx nginx -t + +# MariaDB +docker exec ogcore-database mysqladmin -u user -p status +``` + +### 16.7 Rotación de Logs + +Configurar logrotate: + +```bash +/var/www/html/ogcore/var/log/*.log { + daily + rotate 14 + compress + delaycompress + notifempty + create 0640 www-data www-data + sharedscripts +} +``` + +--- + +## 17. Integración con Otros Servicios + +### 17.1 ogRepository + +**Propósito**: Gestión de repositorios de imágenes. + +**Endpoints integrados**: +- Crear imagen +- Desplegar imagen +- Backup imagen +- Eliminar imagen +- Convertir a imagen virtual +- Importar imagen externa +- Verificar integridad +- Imagen global + +**Webhook**: `/og-repository/webhook` + +### 17.2 ogDhcp + +**Propósito**: Gestión de DHCP dinámico. + +**Funcionalidades**: +- Agregar clientes a DHCP +- Eliminar clientes de DHCP +- Actualizar configuración +- Gestión de subredes + +### 17.3 ogBoot + +**Propósito**: Gestión de archivos de arranque PXE. + +**Funcionalidades**: +- Crear archivos de arranque +- Actualizar plantillas PXE +- Eliminar configuraciones +- Sincronización de menús + +### 17.4 ogAgent + +**Propósito**: Agente instalado en clientes para ejecutar comandos. + +**Operaciones**: +- Power on/off/reboot +- Crear/desplegar imágenes +- Particionar discos +- Ejecutar scripts +- Obtener inventario hardware +- Verificar tamaño de particiones +- Kill jobs + +### 17.5 UDS (Universal Desktop Services) + +**Propósito**: Integración con sistema de escritorios remotos. + +**Funcionalidades**: +- Autenticación +- Obtener service pools +- Calcular disponibilidad +- Gestión de reservas + +### 17.6 Git (Versionado de Imágenes) + +**Propósito**: Versionado de imágenes con Git. + +**Funcionalidades**: +- Backup a repositorio Git +- Versionado automático +- Recuperación de versiones +- Sincronización + +### 17.7 Mercure (Notificaciones en Tiempo Real) + +**Propósito**: Notificaciones push en tiempo real. + +**Eventos publicados**: +- Cambio de estado de clientes +- Actualización de trazas +- Cambios en comandos +- Alertas y notificaciones + +**Suscripción del cliente**: + +```javascript +const eventSource = new EventSource('http://localhost:8080/.well-known/mercure?topic=/clients/{id}'); +eventSource.onmessage = event => { + const data = JSON.parse(event.data); + console.log('Client updated:', data); +}; +``` + +--- + +## 18. Roadmap y Changelog + +### 18.1 Versión Actual: 0.5.0 + +### 18.2 Últimas Características (v0.25.1 - Octubre 2025) + +- **Tareas programadas**: Sistema completo de colas y scheduling +- **Inventario hardware**: Obtención automática de inventario +- **Clonado de imágenes**: Mejoras en el servicio de clonado +- **Repositorios Git**: Backup y gestión de repositorios +- **Particionado**: Integración con agente para scripts de particionado +- **Gestión de trazas**: Marcar como completadas, cancelación +- **Estados de cliente**: Nuevo estado "enviado" para Windows/Linux +- **Validación de particiones**: Comprobación de tamaños +- **Imagen versionada**: Sistema de versionado de imágenes +- **Calendario remoto**: Integración con UDS +- **Mercure**: Notificaciones en tiempo real +- **Despliegue multicast**: Modos torrent y UDPCAST + +### 18.3 Próximas Características (Roadmap) + +#### v0.6.0 (Q4 2025) +- [ ] Dashboard de administración mejorado +- [ ] Reportes y estadísticas avanzadas +- [ ] API GraphQL complementaria +- [ ] Mejoras en rendimiento de queries + +#### v0.7.0 (Q1 2026) +- [ ] Soporte para múltiples lenguajes (i18n completo) +- [ ] Sistema de plugins +- [ ] Mejoras en clustering +- [ ] API de webhooks salientes + +#### v1.0.0 (Q2 2026) +- [ ] Versión estable de producción +- [ ] Documentación completa de API +- [ ] Guías de migración finalizadas +- [ ] Certificación de seguridad + +### 18.4 Changelog Resumido + +Ver `CHANGELOG.md` para el historial completo de cambios. + +**Versiones destacadas**: + +- **0.25.1** (2025-10-01): Correcciones en tareas programadas +- **0.25.0** (2025-09-23): Inventario hardware +- **0.24.0** (2025-09-09): Servicio de eliminación de repositorios Git +- **0.23.0** (2025-09-08): Backups a repositorios Git +- **0.20.0** (2025-08-25): Sistema de colas y tareas +- **0.15.0** (2025-06-26): Integración ogGit y sistema de cola +- **0.14.0** (2025-06-02): Mover equipos, imagen cache, inicio sesión +- **0.13.0** (2025-05-20): Comunicación TLS con agente +- **0.12.0** (2025-05-13): Tareas programadas, integración ogGit +- **0.11.0** (2025-04-11): Versionado de imágenes, ejecución de scripts +- **0.10.0** (2025-03-25): Imagen virtual, importar imágenes +- **0.9.0** (2025-03-04): Mercure, notificaciones en tiempo real +- **0.8.0** (2025-01-10): Imagen global, jerarquía de aulas +- **0.7.3** (2025-01-03): Multiselección, import/export, torrent/udpcast + +--- + +## 19. Contribución + +### 19.1 Guía de Contribución + +Para contribuir al proyecto: + +1. **Fork** el repositorio +2. Crea una **rama** para tu feature: `git checkout -b feature/nueva-funcionalidad` +3. **Commit** tus cambios: `git commit -am 'Añade nueva funcionalidad'` +4. **Push** a la rama: `git push origin feature/nueva-funcionalidad` +5. Crea un **Pull Request** + +### 19.2 Estándares de Código + +- Seguir **PSR-12** para PHP +- Usar **Type Hints** en PHP 8.3 +- Documentar con **PHPDoc** +- Tests para nuevas funcionalidades +- Commits descriptivos en español + +### 19.3 Proceso de Revisión + +1. CI/CD ejecuta tests automáticamente +2. Revisión de código por maintainers +3. Aprobación requerida antes de merge +4. Merge a rama develop +5. Release periódicos a main + +### 19.4 Reportar Bugs + +Usar el sistema de Issues del repositorio: + +**Template de Bug**: +``` +**Descripción del bug** +Descripción clara y concisa del bug. + +**Pasos para reproducir** +1. Ir a '...' +2. Hacer clic en '...' +3. Ver error + +**Comportamiento esperado** +Lo que esperabas que sucediera. + +**Screenshots** +Si aplica, añadir screenshots. + +**Entorno** +- OS: [ej. Ubuntu 22.04] +- Versión: [ej. 0.5.0] +- Browser: [ej. Firefox 118] +``` + +--- + +## 20. Soporte y Contacto + +### 20.1 Documentación Adicional + +- **API Docs**: http://localhost:8080/docs +- **Postman Collection**: `swagger-assets/ogCore.postman_collection.zip` +- **Diagramas**: `swagger-assets/img_bbdd.png` + +### 20.2 Recursos + +- **Repositorio**: [URL del repositorio] +- **Wiki**: [URL de la wiki] +- **Issues**: [URL de issues] + +### 20.3 Equipo de Desarrollo + +Proyecto desarrollado por el equipo de OpenGnsys en colaboración con universidades participantes. + +### 20.4 Licencia + +Proyecto propietario. Ver archivo `LICENSE` para más información. + +--- + +## Apéndices + +### Apéndice A: Glosario de Términos + +- **Cliente**: Equipo físico gestionado por el sistema +- **Imagen**: Copia bit a bit de una partición de disco +- **Traza**: Registro de ejecución de un comando +- **Unidad Organizativa**: Agrupación lógica de clientes (aula, grupo) +- **PXE**: Preboot Execution Environment, arranque por red +- **ogLive**: Imagen Live de arranque de OpenGnsys +- **Partición**: División lógica de un disco duro +- **Repositorio**: Servidor de almacenamiento de imágenes + +### Apéndice B: Puertos y Servicios + +| Puerto | Servicio | Protocolo | Descripción | +|--------|----------|-----------|-------------| +| 8080 | nginx | HTTP | API y docs | +| 3306 | MariaDB | MySQL | Base de datos | +| 9000 | PHP-FPM | FastCGI | Procesador PHP | +| 3000 | Mercure | HTTP/SSE | Notificaciones | + +### Apéndice C: Estructura de Directorios + +``` +ogcore/ +|-- bin/ # Ejecutables (console, phpunit) +|-- config/ # Configuración de Symfony +| |-- api_platform/ # Configuración de entidades API +| |-- packages/ # Configuración de bundles +| +-- routes/ # Rutas +|-- migrations/ # Migraciones de base de datos +|-- public/ # Punto de entrada web +|-- src/ # Código fuente +| |-- Command/ # Comandos de consola +| |-- Controller/ # Controladores +| |-- Dto/ # Data Transfer Objects +| |-- Entity/ # Entidades Doctrine +| |-- EventListener/# Event Listeners +| |-- EventSubscriber/ # Event Subscribers +| |-- Factory/ # Factories para testing +| |-- Filter/ # Filtros de API Platform +| |-- Repository/ # Repositorios Doctrine +| |-- Security/ # Seguridad y autenticación +| |-- Service/ # Servicios de negocio +| |-- State/ # States de API Platform +| +-- Validator/ # Validadores personalizados +|-- tests/ # Tests +|-- translations/ # Traducciones +|-- var/ # Archivos variables (cache, logs) ++-- vendor/ # Dependencias + +``` + +### Apéndice D: Variables de Entorno Completas + +Ver archivo `.env` para todas las variables de entorno disponibles. + +--- + +**Fecha de actualización**: Octubre 2025 +**Versión del documento**: 1.0 +**Mantenedor**: Equipo OpenGnsys diff --git a/config/packages/api_platform.yaml b/config/packages/api_platform.yaml index b957e6a..c86b079 100644 --- a/config/packages/api_platform.yaml +++ b/config/packages/api_platform.yaml @@ -1,7 +1,7 @@ api_platform: title: 'OgCore Api' description: 'Api Documentation for OgCore' - version: 0.5.0 + version: 1.0.0 path_segment_name_generator: api_platform.path_segment_name_generator.dash defaults: pagination_client_items_per_page: true diff --git a/ogCore_Documentacion_Tecnica.html b/ogCore_Documentacion_Tecnica.html new file mode 100644 index 0000000..6ccf54d --- /dev/null +++ b/ogCore_Documentacion_Tecnica.html @@ -0,0 +1,2451 @@ + + + + + + + + ogCore - Documentación Técnica y Funcional + + + + +
+

ogCore - Documentación Técnica y Funcional

+

Equipo OpenGnsys

+

Octubre 2025

+
+ +

1 ogCore - Documentación Técnica y +Funcional

+

1.1 Tabla de Contenidos

+
    +
  1. Introducción
  2. +
  3. Descripción del +Proyecto
  4. +
  5. Arquitectura del +Sistema
  6. +
  7. Tecnologías Utilizadas
  8. +
  9. Requisitos del Sistema
  10. +
  11. Instalación y +Configuración
  12. +
  13. Modelo de Datos
  14. +
  15. Componentes del +Sistema
  16. +
  17. API RESTful
  18. +
  19. Seguridad y +Autenticación
  20. +
  21. Servicios Principales
  22. +
  23. Comandos de Consola
  24. +
  25. Migraciones de Datos
  26. +
  27. Testing
  28. +
  29. Despliegue
  30. +
  31. Mantenimiento y +Operaciones
  32. +
  33. Integración con Otros +Servicios
  34. +
  35. Roadmap y Changelog
  36. +
  37. Contribución
  38. +
  39. Soporte y Contacto
  40. +
+
+

1.2 1. Introducción

+

ogCore es el servicio central de +OpenGnsys, una plataforma de código abierto diseñada +para la gestión centralizada de aulas de informática, laboratorios y +entornos educativos. Este servicio proporciona una API RESTful robusta +que permite administrar de manera eficiente clientes (equipos), imágenes +de sistemas operativos, perfiles de hardware y software, tareas +programadas, y mucho más.

+

1.2.1 1.1 Propósito del +Sistema

+

El propósito principal de ogCore es:

+
    +
  • Centralizar la gestión de equipos informáticos en +entornos educativos y corporativos
  • +
  • Automatizar el despliegue de sistemas operativos e +imágenes
  • +
  • Gestionar inventarios de hardware y software
  • +
  • Programar y ejecutar tareas de manera +automática
  • +
  • Proporcionar trazabilidad de todas las operaciones +realizadas
  • +
  • Facilitar la migración desde versiones anteriores +de OpenGnsys
  • +
+

1.2.2 1.2 Alcance

+

ogCore gestiona: - Clientes (equipos físicos) - Imágenes de sistemas +operativos - Repositorios de imágenes - Perfiles de hardware y software +- Unidades organizativas (aulas, grupos) - Redes y subredes - Plantillas +PXE - Menús de arranque - Comandos y tareas programadas - Trazas de +ejecución - Calendarios remotos - Integración con sistemas externos +(UDS, ogRepository, ogDhcp, ogBoot)

+
+

1.3 2. Descripción del +Proyecto

+

1.3.1 2.1 ¿Qué es ogCore?

+

ogCore es el núcleo central de OpenGnsys desarrollado con tecnologías +modernas de PHP. Actúa como backend que expone una API RESTful completa, +permitiendo la gestión de todos los aspectos relacionados con la +administración de aulas informáticas.

+

1.3.2 2.2 Características +Principales

+
    +
  • API RESTful completa con documentación +Swagger/OpenAPI
  • +
  • Autenticación JWT con refresh tokens
  • +
  • Arquitectura basada en eventos con notificaciones +en tiempo real (Mercure)
  • +
  • Sistema de colas para la ejecución de tareas +programadas
  • +
  • Integración con múltiples servicios externos
  • +
  • Migraciones automatizadas desde OpenGnsys 1.1
  • +
  • Versionado de imágenes con integración Git
  • +
  • Sistema de trazabilidad completo
  • +
  • Gestión de hardware con inventario automático
  • +
  • Despliegues masivos de imágenes (unicast, +multicast, torrent, p2p)
  • +
  • Gestión de particiones automática
  • +
  • Sistema de validación robusto
  • +
+

1.3.3 2.3 Versión Actual

+
    +
  • Versión: 0.5.0
  • +
  • Estado: En desarrollo activo
  • +
  • Última actualización: Octubre 2025
  • +
+
+

1.4 3. Arquitectura del +Sistema

+

1.4.1 3.1 Arquitectura General

+

ogCore sigue una arquitectura de microservicios +basada en el patrón API-First:

+
┌─────────────────────────────────────────────────────────────┐
+│                      Frontend (Web UI)                       │
+└────────────────────────┬────────────────────────────────────┘
+                         │
+                         │ HTTP/REST
+                         │
+┌────────────────────────▼────────────────────────────────────┐
+│                     ogCore API (Symfony)                     │
+│  ┌──────────────────────────────────────────────────────┐   │
+│  │  Controllers │ States │ DTOs │ Validators │ Filters  │   │
+│  └──────────────────────────────────────────────────────┘   │
+│  ┌──────────────────────────────────────────────────────┐   │
+│  │              Business Logic (Services)                │   │
+│  └──────────────────────────────────────────────────────┘   │
+│  ┌──────────────────────────────────────────────────────┐   │
+│  │        Entities │ Repositories │ Doctrine ORM         │   │
+│  └──────────────────────────────────────────────────────┘   │
+└────────────────────┬───────────────┬───────────────────────┘
+                     │               │
+         ┌───────────▼──┐    ┌──────▼──────┐
+         │   MariaDB    │    │   Mercure   │
+         │   Database   │    │  (WebSocket)│
+         └──────────────┘    └─────────────┘
+
+┌─────────────────────────────────────────────────────────────┐
+│              Servicios Externos Integrados                   │
+├──────────────┬──────────────┬──────────────┬────────────────┤
+│  ogRepository│   ogDhcp     │   ogBoot     │   UDS/Git      │
+└──────────────┴──────────────┴──────────────┴────────────────┘
+

1.4.2 3.2 Capas de la +Aplicación

+

1.4.2.1 3.2.1 Capa de Presentación +(API)

+
    +
  • API Platform: Framework para crear APIs REST
  • +
  • Controllers: Controladores personalizados (102 +controladores)
  • +
  • DTOs (Data Transfer Objects): 93 objetos de +transferencia de datos
  • +
  • OpenAPI/Swagger: Documentación automática de la +API
  • +
+

1.4.2.2 3.2.2 Capa de Negocio

+
    +
  • Services: Lógica de negocio (13 servicios +principales)
  • +
  • Handlers: Manejadores de eventos (2 handlers)
  • +
  • EventSubscribers: Suscriptores de eventos (8 +suscriptores)
  • +
  • Validators: Validadores personalizados (18 +validadores)
  • +
+

1.4.2.3 3.2.3 Capa de Datos

+
    +
  • Entities: 35 entidades del modelo de datos
  • +
  • Repositories: 32 repositorios personalizados
  • +
  • Doctrine ORM: Mapeo objeto-relacional
  • +
  • Migrations: 85 migraciones de base de datos
  • +
+

1.4.2.4 3.2.4 Capa de +Infraestructura

+
    +
  • Docker: Contenedorización de servicios
  • +
  • Nginx: Servidor web reverse proxy
  • +
  • PHP-FPM: Procesador de PHP
  • +
  • MariaDB: Sistema de gestión de base de datos
  • +
  • Mercure: Sistema de notificaciones en tiempo +real
  • +
+

1.4.3 3.3 Patrones de Diseño +Utilizados

+
    +
  1. Repository Pattern: Para abstracción de acceso a +datos
  2. +
  3. DTO Pattern: Para transferencia de datos entre +capas
  4. +
  5. Factory Pattern: Para creación de entidades +complejas
  6. +
  7. Event-Driven Architecture: Para notificaciones y +reactividad
  8. +
  9. State Pattern: Para gestión de estados de +procesamiento
  10. +
  11. Service Layer: Para encapsulación de lógica de +negocio
  12. +
+
+

1.5 4. Tecnologías Utilizadas

+

1.5.1 4.1 Backend

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TecnologíaVersiónPropósito
PHP8.3Lenguaje de programación principal
Symfony6.4Framework web principal
Doctrine ORM2.19Mapeo objeto-relacional
API Platform3.2Creación de APIs REST
Lexik JWT3.0Autenticación JWT
Gesdinet JWT Refresh Token1.3Refresh tokens
Stof Doctrine Extensions1.10Extensiones de Doctrine (timestampable, etc.)
Ramsey UUID2.0Generación de UUIDs
+

1.5.2 4.2 Base de Datos

+ + + + + + + + + + + + + + + + + + + + + + + + + +
TecnologíaVersiónPropósito
MariaDB10.11Sistema de gestión de base de datos
Doctrine DBAL3.xCapa de abstracción de base de datos
Doctrine Migrations3.3Gestión de migraciones
+

1.5.3 4.3 Infraestructura

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TecnologíaVersiónPropósito
DockerLatestContenedorización
Docker ComposeLatestOrquestación de contenedores
NginxLatestServidor web / Reverse proxy
PHP-FPM8.3Procesador FastCGI
Mercure0.3.9Hub de notificaciones en tiempo real
+

1.5.4 4.4 Testing

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TecnologíaVersiónPropósito
PHPUnit9.5Framework de testing
Symfony PHPUnit Bridge7.0Integración con Symfony
DAMA Doctrine Test Bundle8.1Transacciones de prueba
Zenstruck Foundry1.37Factories para testing
+

1.5.5 4.5 Desarrollo

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TecnologíaVersiónPropósito
Symfony Maker Bundle1.59Generación de código
Symfony Web Profiler6.4Debugging y profiling
Monolog3.xLogging
PHPStanLatestAnálisis estático
+
+

1.6 5. Requisitos del Sistema

+

1.6.1 5.1 Requisitos de Hardware +(Producción)

+
    +
  • CPU: Mínimo 4 cores, recomendado 8+ cores
  • +
  • RAM: Mínimo 8GB, recomendado 16GB+
  • +
  • Disco: +
      +
    • Sistema: 20GB SSD
    • +
    • Base de datos: 50GB+ SSD
    • +
    • Logs: 10GB
    • +
  • +
  • Red: 1Gbps mínimo
  • +
+

1.6.2 5.2 Requisitos de +Software

+
    +
  • Sistema Operativo: Linux (Ubuntu 20.04+, Debian +11+, CentOS 8+)
  • +
  • Docker: >= 20.10
  • +
  • Docker Compose: >= 2.0
  • +
  • Git: >= 2.25 (para gestión de código)
  • +
+

1.6.3 5.3 Puertos Requeridos

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PuertoServicioPropósito
8080Nginx/HTTPAPI y documentación
3306MariaDBBase de datos
9000PHP-FPMProcesador PHP
3000MercureWebSocket/SSE
+
+

1.7 6. Instalación y +Configuración

+

1.7.1 6.1 Instalación con Docker +(Recomendado)

+

1.7.1.1 6.1.1 Clonar el +Repositorio

+
git clone <url-del-repositorio> ogcore
+cd ogcore
+

1.7.1.2 6.1.2 Verificar Puertos +Disponibles

+

Asegúrate de que los puertos 8080 y 3306 no estén en uso:

+
sudo lsof -i :8080
+sudo lsof -i :3306
+

1.7.1.3 6.1.3 Desplegar +Contenedores

+
docker compose up --build -d
+

1.7.1.4 6.1.4 Verificar +Contenedores

+
docker ps
+

Deberías ver tres contenedores activos: - ogcore-nginx - +ogcore-php - ogcore-database

+

1.7.1.5 6.1.5 Instalar +Dependencias

+
docker exec ogcore-php composer install
+

1.7.1.6 6.1.6 Generar Claves +JWT

+
docker exec ogcore-php php bin/console lexik:jwt:generate-keypair --overwrite
+

1.7.1.7 6.1.7 Inicializar Base de +Datos

+
# Ejecutar migraciones
+docker exec ogcore-php php bin/console doctrine:migrations:migrate --no-interaction
+
+# Cargar datos iniciales (fixtures)
+docker exec ogcore-php php bin/console doctrine:fixtures:load --no-interaction
+
+# Cargar grupos de usuarios por defecto
+docker exec ogcore-php php bin/console app:load-default-user-groups
+
+# Cargar comandos por defecto
+docker exec ogcore-php php bin/console app:load-default-commands
+

1.7.1.8 6.1.8 Acceder a la +Aplicación

+

Abre tu navegador y accede a:

+
http://127.0.0.1:8080/docs
+

Deberías ver la documentación Swagger de la API de ogCore.

+

1.7.2 6.2 Configuración

+

1.7.2.1 6.2.1 Variables de +Entorno

+

El archivo .env contiene las variables de configuración +principales:

+
# Entorno
+APP_ENV=dev
+APP_SECRET=<tu-secreto>
+
+# Base de datos
+DATABASE_URL="mysql://user:password@ogcore-database:3306/ogcore"
+
+# JWT
+JWT_SECRET_KEY=%kernel.project_dir%/config/jwt/private.pem
+JWT_PUBLIC_KEY=%kernel.project_dir%/config/jwt/public.pem
+JWT_PASSPHRASE=<tu-passphrase>
+
+# Mercure
+MERCURE_URL=http://mercure:3000/.well-known/mercure
+MERCURE_PUBLIC_URL=http://127.0.0.1:8080/.well-known/mercure
+MERCURE_JWT_SECRET=<tu-secreto-mercure>
+
+# Servicios externos
+REMOTE_PC_URL=<url-uds>
+REMOTE_PC_AUTH_LOGIN=<login>
+REMOTE_PC_AUTH_USERNAME=<username>
+REMOTE_PC_AUTH_PASSWORD=<password>
+
+# SSL/TLS
+SSL_ENABLED=false
+

1.7.2.2 6.2.2 Configuración de +CORS

+

Edita config/packages/nelmio_cors.yaml para configurar +CORS según tus necesidades.

+

1.7.2.3 6.2.3 Configuración de API +Platform

+

La configuración de API Platform se encuentra en +config/packages/api_platform.yaml.

+

1.7.3 6.3 Instalación en +Producción

+

Para entornos de producción, utiliza el archivo +docker-compose-deploy.yml:

+
docker compose -f docker-compose-deploy.yml up -d
+

Asegúrate de: - Cambiar todas las contraseñas por defecto - +Configurar SSL/TLS - Configurar backups automáticos de base de datos - +Configurar monitoreo y alertas - Revisar los límites de recursos de +Docker

+
+

1.8 7. Modelo de Datos

+

1.8.1 7.1 Diagrama de +Entidades

+

El sistema cuenta con 35 entidades principales agrupadas en los +siguientes dominios:

+

1.8.2 7.2 Entidades +Principales

+

1.8.2.1 7.2.1 Client (Cliente)

+

Representa un equipo físico en el sistema.

+

Campos principales: - id: UUID único - +name: Nombre del cliente - serialNumber: +Número de serie - mac: Dirección MAC (única) - +ip: Dirección IP (única) - status: Estado del +cliente (active, inactive, busy, windows, linux, etc.) - +netiface: Interfaz de red - netDriver: Driver +de red - validation: Estado de validación - +maintenance: Modo mantenimiento - position: +Posición en el aula (x, y) - firmwareType: Tipo de firmware +(BIOS/UEFI) - agentJobId: ID del trabajo del agente en +ejecución - pxeSync: Sincronización PXE - +token: Token de autenticación del cliente

+

Relaciones: - organizationalUnit: +Pertenece a una unidad organizativa (aula/grupo) - +partitions: Tiene múltiples particiones - +menu: Menú de arranque asignado - +hardwareProfile: Perfil de hardware asociado - +template: Plantilla PXE asignada - repository: +Repositorio de imágenes - subnet: Subred a la que pertenece +- ogLive: Imagen Live asignada

+

1.8.2.2 7.2.2 OrganizationalUnit +(Unidad Organizativa)

+

Representa aulas o grupos de equipos.

+

Campos principales: - id: UUID único - +name: Nombre de la unidad - description: +Descripción - type: Tipo (aula, grupo, etc.)

+

Relaciones: - parent: Unidad +organizativa padre (jerarquía) - children: Unidades hijas - +clients: Clientes pertenecientes - +networkSettings: Configuración de red heredable - +remoteCalendar: Calendario remoto asociado

+

1.8.2.3 7.2.3 Image (Imagen)

+

Representa una imagen de sistema operativo.

+

Campos principales: - id: UUID único - +name: Nombre de la imagen - description: +Descripción - type: Tipo de imagen - size: +Tamaño en bytes - partition: Partición de origen - +status: Estado (creating, success, failed, etc.) - +isGlobal: Imagen global compartida - +isVirtual: Imagen virtual - version: Versión +de la imagen

+

Relaciones: - operativeSystem: Sistema +operativo - softwareProfile: Perfil de software - +repositories: Repositorios que contienen la imagen - +originClient: Cliente origen de la imagen

+

1.8.2.4 7.2.4 Command +(Comando)

+

Comandos ejecutables en el sistema.

+

Campos principales: - id: UUID único - +name: Nombre del comando - description: +Descripción - script: Script a ejecutar

+

Relaciones: - commandGroups: Grupos de +comandos a los que pertenece

+

1.8.2.5 7.2.5 CommandTask (Tarea de +Comando)

+

Tarea programada para ejecutar comandos.

+

Campos principales: - id: UUID único - +datetime: Fecha y hora de ejecución - +parameters: Parámetros de ejecución - status: +Estado de la tarea

+

Relaciones: - commands: Comandos a +ejecutar - commandGroups: Grupos de comandos - +clients: Clientes objetivo - schedule: +Programación recurrente

+

1.8.2.6 7.2.6 Trace (Traza)

+

Registro de ejecución de comandos.

+

Campos principales: - id: UUID único - +command: Nombre del comando ejecutado - input: +Parámetros de entrada - output: Resultado de ejecución - +status: Estado (pending, processing, success, failed, +cancelled) - executedAt: Fecha de ejecución - +finishedAt: Fecha de finalización - cancelled: +Indica si fue cancelada - jobId: ID del trabajo en el +agente

+

Relaciones: - client: Cliente donde se +ejecutó

+

1.8.2.7 7.2.7 HardwareProfile +(Perfil de Hardware)

+

Inventario de hardware de un cliente.

+

Campos principales: - id: UUID único - +cpu: Información de CPU - ram: Memoria RAM - +storage: Almacenamiento - networkCards: +Tarjetas de red

+

Relaciones: - client: Cliente asociado +- hardwareTypes: Tipos de hardware detectados

+

1.8.2.8 7.2.8 SoftwareProfile +(Perfil de Software)

+

Software instalado en una imagen.

+

Campos principales: - id: UUID único - +name: Nombre del perfil

+

Relaciones: - software: Software +incluido - images: Imágenes que usan este perfil

+

1.8.2.9 7.2.9 ImageRepository +(Repositorio de Imágenes)

+

Servidor de almacenamiento de imágenes.

+

Campos principales: - id: UUID único - +name: Nombre del repositorio (único) - ip: +Dirección IP o DNS (único) - port: Puerto - +sshPort: Puerto SSH - sshUser: Usuario SSH - +apiKey: Clave API - status: Estado del +repositorio

+

Relaciones: - images: Imágenes +almacenadas

+

1.8.2.10 7.2.10 Subnet +(Subred)

+

Configuración de red.

+

Campos principales: - id: UUID único - +name: Nombre de la subred - cidr: Notación +CIDR - gateway: Puerta de enlace - dns: +Servidores DNS - dhcpStart: Inicio rango DHCP - +dhcpEnd: Fin rango DHCP

+

Relaciones: - clients: Clientes en la +subred

+

1.8.2.11 7.2.11 Partition +(Partición)

+

Partición de disco de un cliente.

+

Campos principales: - id: UUID único - +partitionNumber: Número de partición - +partitionType: Tipo de partición - +partitionSize: Tamaño - partitionCode: Código +de partición - usedSize: Tamaño usado - +filesystem: Sistema de archivos

+

Relaciones: - client: Cliente +propietario - image: Imagen desplegada - +operativeSystem: Sistema operativo instalado

+

1.8.2.12 7.2.12 PxeTemplate +(Plantilla PXE)

+

Plantilla de arranque PXE.

+

Campos principales: - id: UUID único - +name: Nombre de la plantilla - content: +Contenido de la plantilla - default: Plantilla por +defecto

+

Relaciones: - clients: Clientes que +usan la plantilla

+

1.8.2.13 7.2.13 RemoteCalendar +(Calendario Remoto)

+

Integración con sistemas de reservas remotas.

+

Campos principales: - id: UUID único - +name: Nombre del calendario - url: URL del +servicio - available: Disponibilidad

+

Relaciones: - organizationalUnits: +Unidades organizativas asociadas - rules: Reglas del +calendario

+

1.8.2.14 7.2.14 User (Usuario)

+

Usuario del sistema.

+

Campos principales: - id: UUID único - +username: Nombre de usuario (único) - +password: Contraseña (hasheada) - email: +Correo electrónico - roles: Roles del usuario

+

Relaciones: - userGroups: Grupos de +usuarios - view: Vista preferida

+

1.8.2.15 7.2.15 GitRepository +(Repositorio Git)

+

Repositorio Git para versionado de imágenes.

+

Campos principales: - id: UUID único - +name: Nombre del repositorio - url: URL del +repositorio - branch: Rama - credentials: +Credenciales de acceso

+

1.8.3 7.3 Índices y +Optimizaciones

+

La base de datos está optimizada con índices en: - Campos de búsqueda +frecuente (status, updatedAt) - Campos únicos (IP, MAC, username) - +Claves foráneas - Índices compuestos para consultas complejas

+
+

1.9 8. Componentes del Sistema

+

1.9.1 8.1 Controllers +(Controladores)

+

El sistema cuenta con 102 controladores organizados +por dominio:

+

1.9.1.1 Controladores +principales:

+
    +
  • ClientController: Gestión de clientes
  • +
  • ImageController: Gestión de imágenes
  • +
  • OrganizationalUnitController: Gestión de unidades +organizativas
  • +
  • CommandController: Gestión de comandos
  • +
  • TraceController: Gestión de trazas
  • +
  • UserController: Gestión de usuarios
  • +
  • SubnetController: Gestión de subredes
  • +
  • RepositoryController: Gestión de repositorios
  • +
+

1.9.2 8.2 States (Procesadores de +Estado)

+

Los States implementan el patrón State de API Platform:

+

1.9.2.1 States principales (55 +procesadores):

+
    +
  • Providers: Obtención de datos
  • +
  • Processors: Procesamiento de escritura
  • +
  • Custom States: Lógica personalizada
  • +
+

1.9.3 8.3 DTOs (Data Transfer +Objects)

+

93 DTOs para transferencia de datos:

+

1.9.3.1 Tipos de DTOs:

+
    +
  • Input DTOs: Para recepción de datos
  • +
  • Output DTOs: Para envío de datos
  • +
  • Transformation DTOs: Para transformaciones
  • +
+

1.9.4 8.4 Validators +(Validadores)

+

18 validadores personalizados para: - Validación de +IPs y MACs - Validación de rangos DHCP - Validación de particiones - +Validación de imágenes - Validación de comandos - Validación de +usuarios

+

1.9.5 8.5 EventSubscribers +(Suscriptores de Eventos)

+

8 suscriptores para: - Publicación en Mercure al +cambiar estados - Limpieza de recursos - Validaciones pre/post +persistencia - Logging de eventos

+

1.9.6 8.6 Factories (Fábricas)

+

24 factories para testing con Foundry: - Creación de +entidades para tests - Datos de prueba realistas - Estados +predefinidos

+
+

1.10 9. API RESTful

+

1.10.1 9.1 Documentación

+

La API está completamente documentada con OpenAPI +3.0 y accesible en:

+
http://127.0.0.1:8080/docs
+

1.10.2 9.2 Formato de +Respuestas

+

1.10.2.1 Formato estándar +(JSON-LD):

+
{
+  "@context": "/contexts/Client",
+  "@id": "/clients/123e4567-e89b-12d3-a456-426614174000",
+  "@type": "Client",
+  "id": "123e4567-e89b-12d3-a456-426614174000",
+  "name": "PC-01",
+  "mac": "00:11:22:33:44:55",
+  "ip": "192.168.1.100",
+  "status": "active"
+}
+

1.10.2.2 Formato alternativo +(JSON):

+
{
+  "id": "123e4567-e89b-12d3-a456-426614174000",
+  "name": "PC-01",
+  "mac": "00:11:22:33:44:55",
+  "ip": "192.168.1.100",
+  "status": "active"
+}
+

1.10.3 9.3 Paginación

+

Todas las colecciones soportan paginación:

+
GET /clients?page=1&itemsPerPage=30
+

Respuesta:

+
{
+  "@context": "/contexts/Client",
+  "@id": "/clients",
+  "@type": "hydra:Collection",
+  "hydra:member": [...],
+  "hydra:totalItems": 150,
+  "hydra:view": {
+    "@id": "/clients?page=1",
+    "@type": "hydra:PartialCollectionView",
+    "hydra:first": "/clients?page=1",
+    "hydra:last": "/clients?page=5",
+    "hydra:next": "/clients?page=2"
+  }
+}
+

1.10.4 9.4 Filtrado

+

Soporta filtros avanzados:

+
GET /clients?status=active
+GET /clients?organizationalUnit.name=Aula1
+GET /traces?client.id=123&status=pending
+

1.10.5 9.5 Ordenamiento

+
GET /clients?order[name]=asc
+GET /traces?order[createdAt]=desc
+

1.10.6 9.6 Endpoints +Principales

+

1.10.6.1 9.6.1 Autenticación

+
POST /auth/login
+POST /auth/refresh
+

1.10.6.2 9.6.2 Clientes

+
GET    /clients
+POST   /clients
+GET    /clients/{id}
+PUT    /clients/{id}
+PATCH  /clients/{id}
+DELETE /clients/{id}
+POST   /clients/batch
+POST   /clients/{id}/power-on
+POST   /clients/{id}/power-off
+POST   /clients/{id}/reboot
+

1.10.6.3 9.6.3 Imágenes

+
GET    /images
+POST   /images
+GET    /images/{id}
+PUT    /images/{id}
+DELETE /images/{id}
+POST   /images/{id}/deploy
+POST   /images/{id}/create
+POST   /images/{id}/backup
+

1.10.6.4 9.6.4 Comandos y +Tareas

+
GET    /commands
+POST   /commands
+GET    /command-tasks
+POST   /command-tasks
+PUT    /command-tasks/{id}
+DELETE /command-tasks/{id}
+

1.10.6.5 9.6.5 Trazas

+
GET    /traces
+GET    /traces/{id}
+PUT    /traces/{id}
+PATCH  /traces/{id}/complete
+PATCH  /traces/{id}/cancel
+

1.10.7 9.7 Códigos de Estado +HTTP

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CódigoSignificado
200OK - Operación exitosa
201Created - Recurso creado
204No Content - Eliminación exitosa
400Bad Request - Datos inválidos
401Unauthorized - No autenticado
403Forbidden - Sin permisos
404Not Found - Recurso no encontrado
409Conflict - Conflicto (cliente ocupado, constraint violation)
422Unprocessable Entity - Validación fallida
500Internal Server Error - Error del servidor
+
+

1.11 10. Seguridad y +Autenticación

+

1.11.1 10.1 Sistema de +Autenticación JWT

+

ogCore utiliza JSON Web Tokens (JWT) para +autenticación:

+

1.11.1.1 10.1.1 Obtener Token

+
POST /auth/login
+Content-Type: application/json
+
+{
+  "username": "admin",
+  "password": "password"
+}
+

Respuesta:

+
{
+  "token": "eyJ0eXAiOiJKV1QiLCJhbGc...",
+  "refresh_token": "def50200a54b7b..."
+}
+

1.11.1.2 10.1.2 Usar Token

+

Incluir el token en el header Authorization:

+
GET /clients
+Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGc...
+

1.11.1.3 10.1.3 Refresh Token

+
POST /auth/refresh
+Content-Type: application/json
+
+{
+  "refresh_token": "def50200a54b7b..."
+}
+

1.11.2 10.2 Control de Acceso

+

1.11.2.1 Rutas Públicas:

+
    +
  • /auth/login
  • +
  • /auth/refresh
  • +
  • /docs
  • +
  • /opengnsys/rest/* (webhooks)
  • +
  • /og-repository/webhook
  • +
  • /menu-browser
  • +
+

1.11.2.2 Rutas Protegidas:

+
    +
  • Todo lo demás requiere IS_AUTHENTICATED_FULLY
  • +
+

1.11.3 10.3 Roles de Usuario

+

Los roles se gestionan en la entidad User:

+
$user->setRoles(['ROLE_USER']);
+$user->setRoles(['ROLE_ADMIN']);
+

1.11.4 10.4 Seguridad de +Contraseñas

+
    +
  • Hashing con bcrypt automático
  • +
  • Validación de fortaleza
  • +
  • Cambio de contraseña seguro
  • +
+

1.11.5 10.5 CORS (Cross-Origin +Resource Sharing)

+

Configurado en nelmio_cors.yaml para permitir acceso +desde frontend.

+

1.11.6 10.6 SSL/TLS

+

Para producción, habilitar SSL:

+
SSL_ENABLED=true
+

Configurar certificados en /certs/.

+
+

1.12 11. Servicios Principales

+

1.12.1 11.1 +CreatePartitionService

+

Propósito: Crear y actualizar particiones de +clientes.

+

Funcionalidad: - Recibe información de particiones +del agente - Crea/actualiza particiones en base de datos - Detecta tipo +de firmware (BIOS/UEFI) - Calcula códigos de partición

+

1.12.2 11.2 CreateTraceService

+

Propósito: Crear trazas de ejecución para tareas +programadas.

+

Funcionalidad: - Genera trazas para cada combinación +cliente-comando - Gestiona comandos agrupados - Establece estado inicial +y fecha de ejecución

+

1.12.3 11.3 +ChangeClientNetworkSettingsService

+

Propósito: Cambiar configuración de red de +clientes.

+

Funcionalidad: - Actualiza subnet, IP, configuración +de red - Sincroniza con servicios externos (DHCP)

+

1.12.4 11.4 +ExternalGitRepositoryService

+

Propósito: Gestión de repositorios Git para +imágenes.

+

Funcionalidad: - Backup de imágenes a Git - +Versionado de imágenes - Sincronización con repositorios remotos

+

1.12.5 11.5 StatusService +(OgBoot/OgDhcp/OgRepository)

+

Propósito: Verificar estado de servicios +externos.

+

Funcionalidad: - Health checks de servicios - Manejo +de errores de conexión - Logging de estado

+

1.12.6 11.6 UDSClient

+

Propósito: Integración con UDS (Universal Desktop +Services).

+

Funcionalidad: - Autenticación con UDS - Obtención +de service pools - Cálculo de asientos disponibles - Gestión de +calendarios remotos

+

1.12.7 11.7 +Trace/CreateService

+

Propósito: Servicio especializado para creación de +trazas.

+

Funcionalidad: - Validación de parámetros de entrada +- Creación de trazas individuales o masivas

+

1.12.8 11.8 +Utils/GetPartitionCodeService

+

Propósito: Obtener código de partición según tipo y +filesystem.

+

1.12.9 11.9 +Utils/SimplifyOgLiveFilenameService

+

Propósito: Simplificar nombres de archivos OgLive +para mostrar al usuario.

+

1.12.10 11.10 +Utils/GetIpAddressAndNetmaskFromCIDRService

+

Propósito: Convertir notación CIDR a IP y máscara de +red.

+
+

1.13 12. Comandos de Consola

+

ogCore incluye 18 comandos de consola para tareas +administrativas:

+

1.13.1 12.1 Comandos de +Inicialización

+

1.13.1.1 12.1.1 Cargar Grupos de +Usuario por Defecto

+
php bin/console app:load-default-user-groups
+

Crea los grupos de usuarios predeterminados del sistema.

+

1.13.1.2 12.1.2 Cargar Comandos por +Defecto

+
php bin/console app:load-default-commands
+

Carga los comandos básicos del sistema.

+

1.13.1.3 12.1.3 Cargar Usuario +Admin

+
php bin/console app:load-default-user-admin
+

Crea el usuario administrador por defecto.

+

1.13.1.4 12.1.4 Cargar Menú por +Defecto

+
php bin/console app:load-default-menu
+

Carga menús de arranque predeterminados.

+

1.13.1.5 12.1.5 Cargar Tipos de +Hardware

+
php bin/console app:load-hardware-types
+

Inicializa la tabla de tipos de hardware.

+

1.13.1.6 12.1.6 Cargar Unidad +Organizativa por Defecto

+
php bin/console app:load-organizational-unit-default
+

Crea la unidad organizativa raíz.

+

1.13.2 12.2 Comandos de +Operación

+

1.13.2.1 12.2.1 Verificar +Disponibilidad de Clientes

+
php bin/console app:check-client-availability
+

Ejecución: Cada 1 minuto (cron)

+

Verifica el estado de conectividad de los clientes y actualiza su +estado si no responden en un tiempo determinado.

+

1.13.2.2 12.2.2 Ejecutar Trazas +Pendientes

+
php bin/console app:execute-pending-traces
+

Ejecución: Cada 1 minuto (cron)

+

Procesa las trazas en estado PENDING y las ejecuta en +los clientes correspondientes.

+

1.13.2.3 12.2.3 Ejecutar Tareas +Programadas

+
php bin/console app:run-scheduled-command-tasks
+

Ejecución: Cada 1 minuto (cron)

+

Ejecuta tareas programadas que han llegado a su hora de +ejecución.

+

1.13.3 12.3 Comandos de +Migración

+

Comandos para migrar datos desde OpenGnsys 1.1:

+

1.13.3.1 12.3.1 Migrar Unidades +Organizativas

+
php bin/console opengnsys:migration:organizational-unit
+

1.13.3.2 12.3.2 Migrar Perfiles de +Hardware

+
php bin/console opengnsys:migration:hardware-profile
+

1.13.3.3 12.3.3 Migrar +Clientes

+
php bin/console opengnsys:migration:clients
+

1.13.3.4 12.3.4 Migrar Sistemas +Operativos

+
php bin/console opengnsys:migration:os
+

1.13.3.5 12.3.5 Migrar +Imágenes

+
php bin/console opengnsys:migration:image
+

1.13.3.6 12.3.6 Migrar Perfiles de +Software

+
php bin/console opengnsys:migration:software-profile
+

1.13.3.7 12.3.7 Migrar Particiones +de Clientes

+
php bin/console opengnsys:migration:partition-client
+

1.13.4 12.4 Comandos de +Desarrollo

+

1.13.4.1 12.4.1 Crear Repositorios +de Imágenes

+
php bin/console app:create-image-repositories
+

Crea repositorios de imágenes para desarrollo/testing.

+

1.13.4.2 12.4.2 Cargar Trazas de +Ejemplo

+
php bin/console app:charge-example-trace
+

Carga trazas de ejemplo para testing.

+

1.13.5 12.5 Configuración de +Cron

+

Agregar al crontab:

+
* * * * * docker exec ogcore-php php bin/console app:check-client-availability
+* * * * * docker exec ogcore-php php bin/console app:execute-pending-traces
+* * * * * docker exec ogcore-php php bin/console app:run-scheduled-command-tasks
+
+

1.14 13. Migraciones de Datos

+

1.14.1 13.1 Sistema de Migraciones +de Doctrine

+

ogCore utiliza Doctrine Migrations para gestionar cambios en el +esquema de base de datos.

+

1.14.1.1 13.1.1 Crear una +Migración

+
docker exec ogcore-php php bin/console make:migration
+

1.14.1.2 13.1.2 Ejecutar +Migraciones

+
docker exec ogcore-php php bin/console doctrine:migrations:migrate
+

1.14.1.3 13.1.3 Ver Estado de +Migraciones

+
docker exec ogcore-php php bin/console doctrine:migrations:status
+

1.14.1.4 13.1.4 Revertir +Migración

+
docker exec ogcore-php php bin/console doctrine:migrations:migrate prev
+

1.14.2 13.2 Migración desde +OpenGnsys 1.1

+

Para migrar datos desde una instalación de OpenGnsys 1.1:

+

1.14.2.1 13.2.1 Crear Base de Datos +Temporal

+
docker exec ogcore-php php bin/console doctrine:database:create --connection=og_1
+

1.14.2.2 13.2.2 Cargar Dump de +OpenGnsys 1.1

+
docker exec -i ogcore-database mysql -u user -p ogcore_old_og < dump_og_1.1.sql
+

1.14.2.3 13.2.3 Ejecutar +Migraciones

+

Ejecutar los comandos de migración en orden:

+
docker exec ogcore-php php bin/console opengnsys:migration:organizational-unit
+docker exec ogcore-php php bin/console opengnsys:migration:hardware-profile
+docker exec ogcore-php php bin/console opengnsys:migration:clients
+docker exec ogcore-php php bin/console opengnsys:migration:os
+docker exec ogcore-php php bin/console opengnsys:migration:image
+docker exec ogcore-php php bin/console opengnsys:migration:software-profile
+

1.14.3 13.3 Backup y +Restauración

+

1.14.3.1 13.3.1 Backup de Base de +Datos

+
docker exec ogcore-database mysqldump -u user -p ogcore > backup_$(date +%Y%m%d).sql
+

1.14.3.2 13.3.2 Restaurar Base de +Datos

+
docker exec -i ogcore-database mysql -u user -p ogcore < backup_20251008.sql
+
+

1.15 14. Testing

+

1.15.1 14.1 Framework de +Testing

+

ogCore utiliza PHPUnit con integración de Symfony y +Doctrine.

+

1.15.2 14.2 Ejecutar Tests

+

1.15.2.1 14.2.1 Todos los +Tests

+
docker compose exec php bin/phpunit
+

1.15.2.2 14.2.2 Tests +Específicos

+
docker compose exec php bin/phpunit tests/Functional/ClientTest.php
+

1.15.2.3 14.2.3 Tests con +Coverage

+
docker compose exec php bin/phpunit --coverage-html coverage/
+

1.15.3 14.3 Tipos de Tests

+

1.15.3.1 14.3.1 Tests +Funcionales

+

Ubicación: tests/Functional/

+

20 archivos de tests funcionales que prueban: - Endpoints de API - +Flujos completos - Integraciones

+

Ejemplo:

+
public function testCreateClient(): void
+{
+    $client = static::createClient();
+    $client->request('POST', '/clients', [
+        'json' => [
+            'name' => 'Test Client',
+            'mac' => '00:11:22:33:44:55',
+            'ip' => '192.168.1.100'
+        ]
+    ]);
+    
+    $this->assertResponseStatusCodeSame(201);
+}
+

1.15.4 14.4 Factories para +Testing

+

Se utilizan Zenstruck Foundry factories (24 +factories) para crear datos de prueba:

+
ClientFactory::createOne([
+    'name' => 'Test PC',
+    'status' => 'active'
+]);
+

1.15.5 14.5 Base de Datos de +Testing

+

Los tests utilizan DAMA Doctrine Test Bundle para: - +Ejecutar cada test en una transacción - Rollback automático después de +cada test - Aislamiento completo entre tests

+
+

1.16 15. Despliegue

+

1.16.1 15.1 Despliegue con Docker +Compose

+

1.16.1.1 15.1.1 Desarrollo

+
docker compose up -d
+

1.16.1.2 15.1.2 Producción

+
docker compose -f docker-compose-deploy.yml up -d
+

1.16.2 15.2 Despliegue con +Jenkins

+

El proyecto incluye Jenkinsfile para CI/CD.

+

1.16.2.1 Pipeline stages:

+
    +
  1. Checkout: Clonar repositorio
  2. +
  3. Build: Construir imagen Docker
  4. +
  5. Test: Ejecutar tests
  6. +
  7. Package: Crear paquete Debian
  8. +
  9. Deploy: Desplegar en servidor
  10. +
+

1.16.3 15.3 Paquete Debian

+

El proyecto puede empaquetarse como .deb:

+
./package.sh
+

Estructura del paquete en debian/: - Control files - +Postinst/preinst scripts - Systemd service file - Configuración

+

1.16.4 15.4 Configuración de +Producción

+

1.16.4.1 15.4.1 Variables de +Entorno

+

Crear .env.local con configuración de producción:

+
APP_ENV=prod
+APP_DEBUG=0
+DATABASE_URL="mysql://user:pass@localhost:3306/ogcore"
+# ... más configuración
+

1.16.4.2 15.4.2 Optimizaciones

+
# Limpiar caché
+docker exec ogcore-php php bin/console cache:clear --env=prod
+
+# Calentar caché
+docker exec ogcore-php php bin/console cache:warmup --env=prod
+
+# Optimizar autoloader
+docker exec ogcore-php composer dump-autoload --optimize --classmap-authoritative
+

1.16.5 15.5 Monitoreo

+

1.16.5.1 15.5.1 Logs

+

Logs ubicados en var/log/: - dev.log / +prod.log: Logs de aplicación - +nginx/access.log: Accesos a nginx - +nginx/error.log: Errores de nginx

+

1.16.5.2 15.5.2 Syslog

+

Los logs también se envían a syslog para centralización.

+

1.16.6 15.6 Escalabilidad

+

Para escalar horizontalmente:

+
    +
  1. Base de datos: Usar MariaDB con replicación +master-slave
  2. +
  3. PHP: Aumentar réplicas de contenedor PHP
  4. +
  5. Load Balancer: Usar nginx como balanceador de +carga
  6. +
  7. Caché: Implementar Redis para sesiones y caché
  8. +
  9. Mercure: Escalar hub de Mercure
  10. +
+
+

1.17 16. Mantenimiento y +Operaciones

+

1.17.1 16.1 Reiniciar Base de +Datos

+
docker exec ogcore-php php bin/console doctrine:database:drop --force
+docker exec ogcore-php php bin/console doctrine:database:create
+docker exec ogcore-php php bin/console doctrine:migrations:migrate --no-interaction
+docker exec ogcore-php php bin/console doctrine:fixtures:load --no-interaction
+

1.17.2 16.2 Limpiar Caché

+
docker exec ogcore-php php bin/console cache:clear
+docker exec ogcore-php php bin/console cache:warmup
+

1.17.3 16.3 Actualizar +Dependencias

+
docker exec ogcore-php composer update
+

1.17.4 16.4 Regenerar Claves +JWT

+
docker exec ogcore-php php bin/console lexik:jwt:generate-keypair --overwrite
+

1.17.5 16.5 Backups +Automáticos

+

Script ejemplo para backup automático:

+
#!/bin/bash
+DATE=$(date +%Y%m%d_%H%M%S)
+BACKUP_DIR="/backups"
+
+# Backup de base de datos
+docker exec ogcore-database mysqldump -u user -p password ogcore > $BACKUP_DIR/db_$DATE.sql
+
+# Backup de archivos
+tar -czf $BACKUP_DIR/files_$DATE.tar.gz /var/www/html/ogcore/var
+
+# Limpiar backups antiguos (>30 días)
+find $BACKUP_DIR -name "*.sql" -mtime +30 -delete
+find $BACKUP_DIR -name "*.tar.gz" -mtime +30 -delete
+

1.17.6 16.6 Monitoreo de Salud

+

1.17.6.1 Health Check Endpoint

+
GET /health
+

1.17.6.2 Verificar Estado de +Servicios

+
# PHP
+docker exec ogcore-php php -v
+
+# Nginx
+docker exec ogcore-nginx nginx -t
+
+# MariaDB
+docker exec ogcore-database mysqladmin -u user -p status
+

1.17.7 16.7 Rotación de Logs

+

Configurar logrotate:

+
/var/www/html/ogcore/var/log/*.log {
+    daily
+    rotate 14
+    compress
+    delaycompress
+    notifempty
+    create 0640 www-data www-data
+    sharedscripts
+}
+
+

1.18 17. Integración con Otros +Servicios

+

1.18.1 17.1 ogRepository

+

Propósito: Gestión de repositorios de imágenes.

+

Endpoints integrados: - Crear imagen - Desplegar +imagen - Backup imagen - Eliminar imagen - Convertir a imagen virtual - +Importar imagen externa - Verificar integridad - Imagen global

+

Webhook: /og-repository/webhook

+

1.18.2 17.2 ogDhcp

+

Propósito: Gestión de DHCP dinámico.

+

Funcionalidades: - Agregar clientes a DHCP - +Eliminar clientes de DHCP - Actualizar configuración - Gestión de +subredes

+

1.18.3 17.3 ogBoot

+

Propósito: Gestión de archivos de arranque PXE.

+

Funcionalidades: - Crear archivos de arranque - +Actualizar plantillas PXE - Eliminar configuraciones - Sincronización de +menús

+

1.18.4 17.4 ogAgent

+

Propósito: Agente instalado en clientes para +ejecutar comandos.

+

Operaciones: - Power on/off/reboot - Crear/desplegar +imágenes - Particionar discos - Ejecutar scripts - Obtener inventario +hardware - Verificar tamaño de particiones - Kill jobs

+

1.18.5 17.5 UDS (Universal Desktop +Services)

+

Propósito: Integración con sistema de escritorios +remotos.

+

Funcionalidades: - Autenticación - Obtener service +pools - Calcular disponibilidad - Gestión de reservas

+

1.18.6 17.6 Git (Versionado de +Imágenes)

+

Propósito: Versionado de imágenes con Git.

+

Funcionalidades: - Backup a repositorio Git - +Versionado automático - Recuperación de versiones - Sincronización

+

1.18.7 17.7 Mercure (Notificaciones +en Tiempo Real)

+

Propósito: Notificaciones push en tiempo real.

+

Eventos publicados: - Cambio de estado de clientes - +Actualización de trazas - Cambios en comandos - Alertas y +notificaciones

+

Suscripción del cliente:

+
const eventSource = new EventSource('http://localhost:8080/.well-known/mercure?topic=/clients/{id}');
+eventSource.onmessage = event => {
+    const data = JSON.parse(event.data);
+    console.log('Client updated:', data);
+};
+
+

1.19 18. Roadmap y Changelog

+

1.19.1 18.1 Versión Actual: +0.5.0

+

1.19.2 18.2 Últimas Características +(v0.25.1 - Octubre 2025)

+
    +
  • Tareas programadas: Sistema completo de colas y +scheduling
  • +
  • Inventario hardware: Obtención automática de +inventario
  • +
  • Clonado de imágenes: Mejoras en el servicio de +clonado
  • +
  • Repositorios Git: Backup y gestión de +repositorios
  • +
  • Particionado: Integración con agente para scripts +de particionado
  • +
  • Gestión de trazas: Marcar como completadas, +cancelación
  • +
  • Estados de cliente: Nuevo estado “enviado” para +Windows/Linux
  • +
  • Validación de particiones: Comprobación de +tamaños
  • +
  • Imagen versionada: Sistema de versionado de +imágenes
  • +
  • Calendario remoto: Integración con UDS
  • +
  • Mercure: Notificaciones en tiempo real
  • +
  • Despliegue multicast: Modos torrent y UDPCAST
  • +
+

1.19.3 18.3 Próximas +Características (Roadmap)

+

1.19.3.1 v0.6.0 (Q4 2025)

+
    +
  • +
  • +
  • +
  • +
+

1.19.3.2 v0.7.0 (Q1 2026)

+
    +
  • +
  • +
  • +
  • +
+

1.19.3.3 v1.0.0 (Q2 2026)

+
    +
  • +
  • +
  • +
  • +
+

1.19.4 18.4 Changelog Resumido

+

Ver CHANGELOG.md para el historial completo de +cambios.

+

Versiones destacadas:

+
    +
  • 0.25.1 (2025-10-01): Correcciones en tareas +programadas
  • +
  • 0.25.0 (2025-09-23): Inventario hardware
  • +
  • 0.24.0 (2025-09-09): Servicio de eliminación de +repositorios Git
  • +
  • 0.23.0 (2025-09-08): Backups a repositorios +Git
  • +
  • 0.20.0 (2025-08-25): Sistema de colas y tareas
  • +
  • 0.15.0 (2025-06-26): Integración ogGit y sistema de +cola
  • +
  • 0.14.0 (2025-06-02): Mover equipos, imagen cache, +inicio sesión
  • +
  • 0.13.0 (2025-05-20): Comunicación TLS con +agente
  • +
  • 0.12.0 (2025-05-13): Tareas programadas, +integración ogGit
  • +
  • 0.11.0 (2025-04-11): Versionado de imágenes, +ejecución de scripts
  • +
  • 0.10.0 (2025-03-25): Imagen virtual, importar +imágenes
  • +
  • 0.9.0 (2025-03-04): Mercure, notificaciones en +tiempo real
  • +
  • 0.8.0 (2025-01-10): Imagen global, jerarquía de +aulas
  • +
  • 0.7.3 (2025-01-03): Multiselección, import/export, +torrent/udpcast
  • +
+
+

1.20 19. Contribución

+

1.20.1 19.1 Guía de +Contribución

+

Para contribuir al proyecto:

+
    +
  1. Fork el repositorio
  2. +
  3. Crea una rama para tu feature: +git checkout -b feature/nueva-funcionalidad
  4. +
  5. Commit tus cambios: +git commit -am 'Añade nueva funcionalidad'
  6. +
  7. Push a la rama: +git push origin feature/nueva-funcionalidad
  8. +
  9. Crea un Pull Request
  10. +
+

1.20.2 19.2 Estándares de +Código

+
    +
  • Seguir PSR-12 para PHP
  • +
  • Usar Type Hints en PHP 8.3
  • +
  • Documentar con PHPDoc
  • +
  • Tests para nuevas funcionalidades
  • +
  • Commits descriptivos en español
  • +
+

1.20.3 19.3 Proceso de +Revisión

+
    +
  1. CI/CD ejecuta tests automáticamente
  2. +
  3. Revisión de código por maintainers
  4. +
  5. Aprobación requerida antes de merge
  6. +
  7. Merge a rama develop
  8. +
  9. Release periódicos a main
  10. +
+

1.20.4 19.4 Reportar Bugs

+

Usar el sistema de Issues del repositorio:

+

Template de Bug:

+
**Descripción del bug**
+Descripción clara y concisa del bug.
+
+**Pasos para reproducir**
+1. Ir a '...'
+2. Hacer clic en '...'
+3. Ver error
+
+**Comportamiento esperado**
+Lo que esperabas que sucediera.
+
+**Screenshots**
+Si aplica, añadir screenshots.
+
+**Entorno**
+- OS: [ej. Ubuntu 22.04]
+- Versión: [ej. 0.5.0]
+- Browser: [ej. Firefox 118]
+
+

1.21 20. Soporte y Contacto

+

1.21.1 20.1 Documentación +Adicional

+
    +
  • API Docs: http://localhost:8080/docs
  • +
  • Postman Collection: +swagger-assets/ogCore.postman_collection.zip
  • +
  • Diagramas: +swagger-assets/img_bbdd.png
  • +
+

1.21.2 20.2 Recursos

+
    +
  • Repositorio: [URL del repositorio]
  • +
  • Wiki: [URL de la wiki]
  • +
  • Issues: [URL de issues]
  • +
+

1.21.3 20.3 Equipo de +Desarrollo

+

Proyecto desarrollado por el equipo de OpenGnsys en colaboración con +universidades participantes.

+

1.21.4 20.4 Licencia

+

Proyecto propietario. Ver archivo LICENSE para más +información.

+
+

1.22 Apéndices

+

1.22.1 Apéndice A: Glosario de +Términos

+
    +
  • Cliente: Equipo físico gestionado por el +sistema
  • +
  • Imagen: Copia bit a bit de una partición de +disco
  • +
  • Traza: Registro de ejecución de un comando
  • +
  • Unidad Organizativa: Agrupación lógica de clientes +(aula, grupo)
  • +
  • PXE: Preboot Execution Environment, arranque por +red
  • +
  • ogLive: Imagen Live de arranque de OpenGnsys
  • +
  • Partición: División lógica de un disco duro
  • +
  • Repositorio: Servidor de almacenamiento de +imágenes
  • +
+

1.22.2 Apéndice B: Puertos y +Servicios

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PuertoServicioProtocoloDescripción
8080nginxHTTPAPI y docs
3306MariaDBMySQLBase de datos
9000PHP-FPMFastCGIProcesador PHP
3000MercureHTTP/SSENotificaciones
+

1.22.3 Apéndice C: Estructura de +Directorios

+
ogcore/
+├── bin/              # Ejecutables (console, phpunit)
+├── config/           # Configuración de Symfony
+│   ├── api_platform/ # Configuración de entidades API
+│   ├── packages/     # Configuración de bundles
+│   └── routes/       # Rutas
+├── migrations/       # Migraciones de base de datos
+├── public/           # Punto de entrada web
+├── src/              # Código fuente
+│   ├── Command/      # Comandos de consola
+│   ├── Controller/   # Controladores
+│   ├── Dto/          # Data Transfer Objects
+│   ├── Entity/       # Entidades Doctrine
+│   ├── EventListener/# Event Listeners
+│   ├── EventSubscriber/ # Event Subscribers
+│   ├── Factory/      # Factories para testing
+│   ├── Filter/       # Filtros de API Platform
+│   ├── Repository/   # Repositorios Doctrine
+│   ├── Security/     # Seguridad y autenticación
+│   ├── Service/      # Servicios de negocio
+│   ├── State/        # States de API Platform
+│   └── Validator/    # Validadores personalizados
+├── tests/            # Tests
+├── translations/     # Traducciones
+├── var/              # Archivos variables (cache, logs)
+└── vendor/           # Dependencias
+
+

1.22.4 Apéndice D: Variables de +Entorno Completas

+

Ver archivo .env para todas las variables de entorno +disponibles.

+
+

Fecha de actualización: Octubre 2025
+Versión del documento: 1.0
+Mantenedor: Equipo OpenGnsys

+ + diff --git a/ogCore_Documentacion_Tecnica.pdf b/ogCore_Documentacion_Tecnica.pdf new file mode 100644 index 0000000..a3c6a00 Binary files /dev/null and b/ogCore_Documentacion_Tecnica.pdf differ diff --git a/src/Controller/OgBoot/PxeBootFile/PostAction.php b/src/Controller/OgBoot/PxeBootFile/PostAction.php index 97c5575..1c172b9 100644 --- a/src/Controller/OgBoot/PxeBootFile/PostAction.php +++ b/src/Controller/OgBoot/PxeBootFile/PostAction.php @@ -3,11 +3,8 @@ namespace App\Controller\OgBoot\PxeBootFile; use App\Controller\OgBoot\AbstractOgBootController; -use App\Dto\Input\PxeTemplateSyncClientInput; use App\Entity\Client; use App\Entity\PxeTemplate; -use Doctrine\ORM\EntityManagerInterface; -use Symfony\Bundle\FrameworkBundle\Controller\AbstractController; use Symfony\Component\HttpFoundation\JsonResponse; use Symfony\Component\HttpFoundation\Response; use Symfony\Component\HttpKernel\Attribute\AsController; @@ -15,7 +12,6 @@ use Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface; use Symfony\Contracts\HttpClient\Exception\RedirectionExceptionInterface; use Symfony\Contracts\HttpClient\Exception\ServerExceptionInterface; use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface; -use Symfony\Contracts\HttpClient\HttpClientInterface; #[AsController] class PostAction extends AbstractOgBootController diff --git a/src/Dto/Input/BackupImageInput.php b/src/Dto/Input/BackupImageInput.php index 32542ee..b269163 100644 --- a/src/Dto/Input/BackupImageInput.php +++ b/src/Dto/Input/BackupImageInput.php @@ -3,22 +3,21 @@ namespace App\Dto\Input; use ApiPlatform\Metadata\ApiProperty; -use App\Dto\Output\ClientOutput; -use App\Dto\Output\ImageOutput; -use App\Dto\Output\PartitionOutput; -use App\Validator\Constraints\ClientsHaveSamePartitionCount; -use App\Validator\Constraints\OrganizationalUnitMulticastMode; -use App\Validator\Constraints\OrganizationalUnitMulticastPort; -use App\Validator\Constraints\OrganizationalUnitP2PMode; use Symfony\Component\Serializer\Annotation\Groups; final class BackupImageInput { #[Groups(['image-image-repository:write'])] - #[ApiProperty(description: 'The repository ip', example: "")] + #[ApiProperty( + description: 'La IP del repositorio de destino', + example: '192.168.1.100' + )] public ?string $repoIp = null; #[Groups(['image-image-repository:write'])] - #[ApiProperty(description: 'The remote path', example: "")] + #[ApiProperty( + description: 'La ruta remota donde guardar el backup', + example: '/backups/images/' + )] public ?string $remotePath = null; } \ No newline at end of file diff --git a/src/Dto/Input/BootClientsInput.php b/src/Dto/Input/BootClientsInput.php index a430967..7defc7d 100644 --- a/src/Dto/Input/BootClientsInput.php +++ b/src/Dto/Input/BootClientsInput.php @@ -2,6 +2,7 @@ namespace App\Dto\Input; +use ApiPlatform\Metadata\ApiProperty; use App\Dto\Output\ClientOutput; use App\Dto\Output\PartitionOutput; use Symfony\Component\Serializer\Annotation\Groups; @@ -12,10 +13,17 @@ final class BootClientsInput * @var ClientOutput[] */ #[Groups(['client:write'])] + #[ApiProperty( + description: 'Los clientes a arrancar', + example: [] + )] public array $clients = []; - #[Groups(['client:write'])] + #[ApiProperty( + description: 'La partición desde la que arrancar', + example: null + )] public ?PartitionOutput $partition = null; } diff --git a/src/Dto/Input/CancelMultipleTracesInput.php b/src/Dto/Input/CancelMultipleTracesInput.php index 825d804..c252370 100644 --- a/src/Dto/Input/CancelMultipleTracesInput.php +++ b/src/Dto/Input/CancelMultipleTracesInput.php @@ -2,6 +2,7 @@ namespace App\Dto\Input; +use ApiPlatform\Metadata\ApiProperty; use App\Dto\Output\TraceOutput; use Symfony\Component\Serializer\Annotation\Groups; use Symfony\Component\Validator\Constraints as Assert; @@ -13,5 +14,9 @@ final class CancelMultipleTracesInput */ #[Assert\NotNull] #[Groups(['trace:write'])] + #[ApiProperty( + description: 'Las trazas a cancelar', + example: [] + )] public array $traces = []; } diff --git a/src/Dto/Input/ChangeOrganizationalUnitInput.php b/src/Dto/Input/ChangeOrganizationalUnitInput.php index 922e66b..0addc49 100644 --- a/src/Dto/Input/ChangeOrganizationalUnitInput.php +++ b/src/Dto/Input/ChangeOrganizationalUnitInput.php @@ -2,9 +2,9 @@ namespace App\Dto\Input; +use ApiPlatform\Metadata\ApiProperty; use App\Dto\Output\ClientOutput; use App\Dto\Output\OrganizationalUnitOutput; -use App\Entity\Client; use Symfony\Component\Serializer\Annotation\Groups; use Symfony\Component\Validator\Constraints as Assert; @@ -15,9 +15,17 @@ final class ChangeOrganizationalUnitInput */ #[Assert\GreaterThan(1)] #[Groups(['client:write'])] + #[ApiProperty( + description: 'Los clientes a mover (mínimo 2)', + example: [] + )] public ?array $clients = []; #[Assert\NotNull] #[Groups(['client:write'])] + #[ApiProperty( + description: 'La nueva unidad organizativa de destino', + example: null + )] public ?OrganizationalUnitOutput $organizationalUnit = null; } \ No newline at end of file diff --git a/src/Dto/Input/CheckPartitionSizesInput.php b/src/Dto/Input/CheckPartitionSizesInput.php index f2fd184..88a3919 100644 --- a/src/Dto/Input/CheckPartitionSizesInput.php +++ b/src/Dto/Input/CheckPartitionSizesInput.php @@ -2,7 +2,7 @@ namespace App\Dto\Input; -use App\Dto\Output\ClientOutput; +use ApiPlatform\Metadata\ApiProperty; use Symfony\Component\Serializer\Annotation\Groups; final class CheckPartitionSizesInput @@ -11,6 +11,10 @@ final class CheckPartitionSizesInput * @var PartitionInput[] */ #[Groups(['client:write'])] + #[ApiProperty( + description: 'Las particiones a verificar', + example: [] + )] public array $partitions = []; } diff --git a/src/Dto/Input/ClientInput.php b/src/Dto/Input/ClientInput.php index f8cdac7..feb3a26 100644 --- a/src/Dto/Input/ClientInput.php +++ b/src/Dto/Input/ClientInput.php @@ -44,7 +44,7 @@ final class ClientInput description: 'El driver de red del cliente', example: 'e1000e' )] - public ?string $netDriver = null; + public ?string $netDriver = 'generic'; #[Groups(['client:write'])] #[ApiProperty( @@ -85,13 +85,7 @@ final class ClientInput #[ApiProperty( description: 'La plantilla PXE del cliente' )] - public ?PxeTemplateOutput $pxeTemplate = null; - - #[Groups(['client:write'])] - #[ApiProperty( - description: 'El perfil de hardware del cliente' - )] - public ?HardwareProfileOutput $hardwareProfile = null; + public ?PxeTemplateOutput $pxeTemplate = null; #[Groups(['client:write'])] #[ApiProperty( @@ -146,10 +140,6 @@ final class ClientInput $this->pxeTemplate = new PxeTemplateOutput($client->getTemplate()); } - if ($client->getHardwareProfile()) { - $this->hardwareProfile = new HardwareProfileOutput($client->getHardwareProfile()); - } - if ($client->getRepository()) { $this->repository = new ImageRepositoryOutput($client->getRepository()); } @@ -163,7 +153,6 @@ final class ClientInput $menu = $this->menu?->getEntity() ?? $client->getOrganizationalUnit()?->getNetworkSettings()?->getMenu(); $ogLive = $this->ogLive?->getEntity() ?? $client->getOrganizationalUnit()?->getNetworkSettings()?->getOgLive(); - $hardwareProfile = $this->hardwareProfile?->getEntity() ?? $client->getOrganizationalUnit()?->getNetworkSettings()?->getHardwareProfile(); $repository = $this->repository?->getEntity() ?? $client->getOrganizationalUnit()?->getNetworkSettings()?->getRepository(); $template = $this->pxeTemplate?->getEntity() ?? $client->getOrganizationalUnit()?->getNetworkSettings()?->getPxeTemplate(); @@ -176,7 +165,6 @@ final class ClientInput $client->setIp($this->ip); $client->setMenu($menu); $client->setOgLive($ogLive); - $client->setHardwareProfile($hardwareProfile); $client->setRepository($repository); $client->setTemplate($template); $client->setPosition($this->position); diff --git a/src/Dto/Input/CommandExecuteInput.php b/src/Dto/Input/CommandExecuteInput.php index eb21710..4f71b31 100644 --- a/src/Dto/Input/CommandExecuteInput.php +++ b/src/Dto/Input/CommandExecuteInput.php @@ -2,6 +2,7 @@ namespace App\Dto\Input; +use ApiPlatform\Metadata\ApiProperty; use App\Dto\Output\ClientOutput; use Symfony\Component\Serializer\Annotation\Groups; use Symfony\Component\Validator\Constraints as Assert; @@ -13,13 +14,24 @@ final class CommandExecuteInput */ #[Assert\NotNull] #[Groups(['command:write'])] + #[ApiProperty( + description: 'Los clientes donde ejecutar el comando', + example: [] + )] public array $clients = []; - #[Assert\NotNull] #[Groups(['command:write'])] + #[ApiProperty( + description: 'El script a ejecutar', + example: 'echo "Hello World"' + )] public string $script = ''; #[Groups(['command:write'])] + #[ApiProperty( + description: 'Si encolar la ejecución del comando', + example: false + )] public bool $queue = false; } \ No newline at end of file diff --git a/src/Dto/Input/CommandGroupAddCommandsInput.php b/src/Dto/Input/CommandGroupAddCommandsInput.php index 2b14a7b..0cc9964 100644 --- a/src/Dto/Input/CommandGroupAddCommandsInput.php +++ b/src/Dto/Input/CommandGroupAddCommandsInput.php @@ -2,6 +2,7 @@ namespace App\Dto\Input; +use ApiPlatform\Metadata\ApiProperty; use App\Dto\Output\CommandOutput; use Symfony\Component\Serializer\Annotation\Groups; use Symfony\Component\Validator\Constraints as Assert; @@ -13,5 +14,9 @@ final class CommandGroupAddCommandsInput */ #[Assert\NotNull] #[Groups(['command-group:write'])] + #[ApiProperty( + description: 'Los comandos a añadir al grupo', + example: [] + )] public array $commands = []; } \ No newline at end of file diff --git a/src/Dto/Input/CommandGroupExecuteInput.php b/src/Dto/Input/CommandGroupExecuteInput.php index 19dd317..17aca16 100644 --- a/src/Dto/Input/CommandGroupExecuteInput.php +++ b/src/Dto/Input/CommandGroupExecuteInput.php @@ -2,6 +2,7 @@ namespace App\Dto\Input; +use ApiPlatform\Metadata\ApiProperty; use App\Dto\Output\ClientOutput; use Symfony\Component\Serializer\Annotation\Groups; use Symfony\Component\Validator\Constraints as Assert; @@ -13,5 +14,9 @@ final class CommandGroupExecuteInput */ #[Assert\NotNull] #[Groups(['command-group:write'])] + #[ApiProperty( + description: 'Los clientes donde ejecutar el grupo de comandos', + example: [] + )] public array $clients = []; } \ No newline at end of file diff --git a/src/Dto/Input/CommandTaskScheduleInput.php b/src/Dto/Input/CommandTaskScheduleInput.php index afb0fde..5802b88 100644 --- a/src/Dto/Input/CommandTaskScheduleInput.php +++ b/src/Dto/Input/CommandTaskScheduleInput.php @@ -2,29 +2,53 @@ namespace App\Dto\Input; +use ApiPlatform\Metadata\ApiProperty; use App\Dto\Output\CommandTaskOutput; -use App\Dto\Output\CommandTaskScheduleOutput; use App\Entity\CommandTaskSchedule; use Symfony\Component\Serializer\Annotation\Groups; final class CommandTaskScheduleInput { #[Groups(['command-task-schedule:write'])] + #[ApiProperty( + description: 'La tarea de comando a programar', + example: null + )] public ?CommandTaskOutput $commandTask = null; #[Groups(['command-task-schedule:write'])] + #[ApiProperty( + description: 'El tipo de recurrencia de la programación', + example: 'daily' + )] public ?string $recurrenceType = null; #[Groups(['command-task-schedule:write'])] + #[ApiProperty( + description: 'La fecha de ejecución de la tarea', + example: '2024-01-15T00:00:00+00:00' + )] public ?\DateTimeInterface $executionDate = null; #[Groups(['command-task-schedule:write'])] + #[ApiProperty( + description: 'La hora de ejecución de la tarea', + example: '2024-01-15T09:00:00+00:00' + )] public ?\DateTimeInterface $executionTime = null; #[Groups(['command-task-schedule:write'])] + #[ApiProperty( + description: 'Los detalles de la recurrencia', + example: ['interval' => 1, 'days' => ['monday', 'wednesday', 'friday']] + )] public ?array $recurrenceDetails = null; #[Groups(['command-task-schedule:write'])] + #[ApiProperty( + description: 'Si la programación está habilitada', + example: true + )] public ?bool $enabled = null; public function __construct(?CommandTaskSchedule $commandTaskSchedule = null) diff --git a/src/Dto/Input/CommandTaskScriptInput.php b/src/Dto/Input/CommandTaskScriptInput.php index 8eb8583..d46f001 100644 --- a/src/Dto/Input/CommandTaskScriptInput.php +++ b/src/Dto/Input/CommandTaskScriptInput.php @@ -2,27 +2,46 @@ namespace App\Dto\Input; +use ApiPlatform\Metadata\ApiProperty; use App\Dto\Output\CommandTaskOutput; -use App\Dto\Output\CommandTaskScheduleOutput; -use App\Entity\CommandTaskSchedule; use App\Entity\CommandTaskScript; use Symfony\Component\Serializer\Annotation\Groups; final class CommandTaskScriptInput { #[Groups(['command-task-script:write'])] + #[ApiProperty( + description: 'El contenido del script', + example: '#!/bin/bash\necho "Hello World"' + )] public ?string $content = null; #[Groups(['command-task-script:write'])] + #[ApiProperty( + description: 'El tipo de script', + example: 'bash' + )] public ?string $type = null; #[Groups(['command-task-script:write'])] + #[ApiProperty( + description: 'Los parámetros del script', + example: ['param1' => 'value1', 'param2' => 'value2'] + )] public ?array $parameters = null; #[Groups(['command-task-script:write'])] + #[ApiProperty( + description: 'La tarea de comando asociada', + example: null + )] public ?CommandTaskOutput $commandTask = null; #[Groups(['command-task-script:write'])] + #[ApiProperty( + description: 'El orden de ejecución del script', + example: 1 + )] public ?int $order = null; public function __construct(?CommandTaskScript $commandTaskScript = null) diff --git a/src/Dto/Input/ConvertImageToVirtualInput.php b/src/Dto/Input/ConvertImageToVirtualInput.php index d1d0e84..c86f598 100644 --- a/src/Dto/Input/ConvertImageToVirtualInput.php +++ b/src/Dto/Input/ConvertImageToVirtualInput.php @@ -2,8 +2,7 @@ namespace App\Dto\Input; -use App\Dto\Output\ImageOutput; -use App\Dto\Output\ImageRepositoryOutput; +use ApiPlatform\Metadata\ApiProperty; use Symfony\Component\Serializer\Annotation\Groups; use Symfony\Component\Validator\Constraints as Assert; @@ -11,5 +10,9 @@ class ConvertImageToVirtualInput { #[Assert\NotNull] #[Groups(['image-image-repository:write'])] + #[ApiProperty( + description: 'La extensión del archivo virtual a generar', + example: 'qcow2' + )] public ?string $extension = ''; } \ No newline at end of file diff --git a/src/Dto/Input/ExportImportImageRepositoryInput.php b/src/Dto/Input/ExportImportImageRepositoryInput.php index 690500b..f115da4 100644 --- a/src/Dto/Input/ExportImportImageRepositoryInput.php +++ b/src/Dto/Input/ExportImportImageRepositoryInput.php @@ -2,8 +2,8 @@ namespace App\Dto\Input; +use ApiPlatform\Metadata\ApiProperty; use App\Dto\Output\ImageOutput; -use App\Dto\Output\ImageRepositoryOutput; use Symfony\Component\Serializer\Annotation\Groups; use Symfony\Component\Validator\Constraints as Assert; @@ -14,5 +14,9 @@ class ExportImportImageRepositoryInput */ #[Assert\NotNull] #[Groups(['repository:write'])] + #[ApiProperty( + description: 'Las imágenes a exportar o importar', + example: [] + )] public array $images = []; } \ No newline at end of file diff --git a/src/Dto/Input/GetPartitionScriptDataInput.php b/src/Dto/Input/GetPartitionScriptDataInput.php index 14347bc..456e85d 100644 --- a/src/Dto/Input/GetPartitionScriptDataInput.php +++ b/src/Dto/Input/GetPartitionScriptDataInput.php @@ -2,7 +2,8 @@ namespace App\Dto\Input; -use App\Dto\Output\ClientOutput; +use ApiPlatform\Metadata\ApiProperty; +use App\Dto\Input\PartitionInput; use Symfony\Component\Serializer\Annotation\Groups; final class GetPartitionScriptDataInput @@ -11,6 +12,10 @@ final class GetPartitionScriptDataInput * @var PartitionInput[] */ #[Groups(['client:write'])] + #[ApiProperty( + description: 'Las particiones para obtener datos del script', + example: [] + )] public array $partitions = []; } diff --git a/src/Dto/Input/MultipleClientsInput.php b/src/Dto/Input/MultipleClientsInput.php index f47e203..3eca31d 100644 --- a/src/Dto/Input/MultipleClientsInput.php +++ b/src/Dto/Input/MultipleClientsInput.php @@ -2,6 +2,7 @@ namespace App\Dto\Input; +use ApiPlatform\Metadata\ApiProperty; use App\Dto\Output\ClientOutput; use Symfony\Component\Serializer\Annotation\Groups; @@ -11,9 +12,17 @@ final class MultipleClientsInput * @var ClientOutput[] */ #[Groups(['client:write'])] + #[ApiProperty( + description: 'Los clientes para la operación múltiple', + example: [] + )] public array $clients = []; #[Groups(['client:write'])] + #[ApiProperty( + description: 'Si encolar la operación', + example: false + )] public bool $queue = false; } diff --git a/src/Dto/Input/NetworkSettingsInput.php b/src/Dto/Input/NetworkSettingsInput.php index add2df6..161aa2e 100644 --- a/src/Dto/Input/NetworkSettingsInput.php +++ b/src/Dto/Input/NetworkSettingsInput.php @@ -8,8 +8,6 @@ use App\Dto\Output\ImageRepositoryOutput; use App\Dto\Output\MenuOutput; use App\Dto\Output\OgLiveOutput; use App\Dto\Output\PxeTemplateOutput; -use App\Entity\HardwareProfile; -use App\Entity\Menu; use App\Entity\NetworkSettings; use App\Validator\Constraints\OrganizationalUnitMulticastMode; use App\Validator\Constraints\OrganizationalUnitMulticastPort; @@ -20,71 +18,146 @@ use Symfony\Component\Validator\Constraints as Assert; class NetworkSettingsInput { #[Groups(['organizational-unit:write'])] + #[ApiProperty( + description: 'El servidor siguiente (next server) para PXE', + example: '192.168.1.1' + )] public ?string $nextServer = null; #[Groups(['organizational-unit:write'])] + #[ApiProperty( + description: 'El nombre del archivo de arranque', + example: 'pxelinux.0' + )] public ?string $bootFileName = null; #[Groups(['organizational-unit:write'])] + #[ApiProperty( + description: 'El servidor proxy', + example: 'http://proxy.example.com:8080' + )] public ?string $proxy = null; #[Assert\Ip(message: 'validators.network_settings.ip_address.invalid')] #[Groups(['organizational-unit:write'])] + #[ApiProperty( + description: 'El servidor DNS', + example: '8.8.8.8' + )] public ?string $dns = null; #[Assert\Ip(message: 'validators.network_settings.ip_address.invalid')] #[Groups(['organizational-unit:write'])] + #[ApiProperty( + description: 'La máscara de red', + example: '255.255.255.0' + )] public ?string $netmask = null; #[Groups(['organizational-unit:write'])] + #[ApiProperty( + description: 'La puerta de enlace (router)', + example: '192.168.1.1' + )] public ?string $router = null; #[Groups(['organizational-unit:write'])] + #[ApiProperty( + description: 'El servidor NTP', + example: 'pool.ntp.org' + )] public ?string $ntp = null; #[Groups(['organizational-unit:write'])] + #[ApiProperty( + description: 'La interfaz de red', + example: 'eth0' + )] public ?string $netiface = null; #[OrganizationalUnitP2PMode] #[Groups(['organizational-unit:write'])] + #[ApiProperty( + description: 'El modo P2P para despliegues torrent', + example: 'seed' + )] public ?string $p2pMode = null; #[Assert\GreaterThan(0, message: 'validators.network_settings.p2p_time.invalid')] #[Groups(['organizational-unit:write'])] + #[ApiProperty( + description: 'El tiempo P2P en segundos', + example: 3600 + )] public ?int $p2pTime = null; #[Assert\Ip(message: 'validators.network_settings.ip_address.invalid')] #[Groups(['organizational-unit:write'])] + #[ApiProperty( + description: 'La dirección IP de multicast', + example: '239.255.255.250' + )] public ?string $mcastIp = null; #[Assert\GreaterThan(0, message: 'validators.network_settings.mcast_speed.invalid')] #[Groups(['organizational-write:write'])] + #[ApiProperty( + description: 'La velocidad de multicast en Mbps', + example: 100 + )] public ?int $mcastSpeed = null; #[OrganizationalUnitMulticastPort] #[Groups(['organizational-unit:write'])] + #[ApiProperty( + description: 'El puerto de multicast', + example: 8000 + )] public ?int $mcastPort = null; #[OrganizationalUnitMulticastMode] #[Groups(['organizational-unit:write'])] + #[ApiProperty( + description: 'El modo de multicast', + example: 'full' + )] public ?string $mcastMode = null; #[Groups(['organizational-unit:write'])] + #[ApiProperty( + description: 'El menú de la configuración de red' + )] public ?MenuOutput $menu = null; #[Groups(['organizational-unit:write'])] + #[ApiProperty( + description: 'El perfil de hardware de la configuración de red' + )] public ?HardwareProfileOutput $hardwareProfile = null; #[Groups(['organizational-unit:write'])] + #[ApiProperty( + description: 'La configuración OgLive de la configuración de red' + )] public ?OgLiveOutput $ogLive = null; #[Groups(['organizational-unit:write'])] + #[ApiProperty( + description: 'El repositorio de imágenes de la configuración de red' + )] public ?ImageRepositoryOutput $repository = null; #[Groups(['organizational-unit:write'])] + #[ApiProperty( + description: 'La plantilla PXE de la configuración de red' + )] public ?PxeTemplateOutput $pxeTemplate = null; #[Groups(['organizational-unit:write'])] + #[ApiProperty( + description: 'La ruta de ogshare', + example: '/var/ogshare' + )] public ?string $ogshare = null; public function __construct(?NetworkSettings $networkSettings = null) diff --git a/src/Dto/Input/OperativeSystemInput.php b/src/Dto/Input/OperativeSystemInput.php index 8ebac93..23e90a5 100644 --- a/src/Dto/Input/OperativeSystemInput.php +++ b/src/Dto/Input/OperativeSystemInput.php @@ -2,6 +2,7 @@ namespace App\Dto\Input; +use ApiPlatform\Metadata\ApiProperty; use App\Entity\OperativeSystem; use Symfony\Component\Serializer\Annotation\Groups; use Symfony\Component\Validator\Constraints as Assert; @@ -10,6 +11,10 @@ class OperativeSystemInput { #[Assert\NotBlank(message: 'validators.operative_system.name.not_blank')] #[Groups(['operative-system:write'])] + #[ApiProperty( + description: 'El nombre del sistema operativo', + example: 'Ubuntu 20.04 LTS' + )] public ?string $name = null; public function __construct(?OperativeSystem $operativeSystem = null) diff --git a/src/Dto/Input/OrganizationalUnitInput.php b/src/Dto/Input/OrganizationalUnitInput.php index 64b8930..d0d3bf6 100644 --- a/src/Dto/Input/OrganizationalUnitInput.php +++ b/src/Dto/Input/OrganizationalUnitInput.php @@ -6,9 +6,6 @@ use ApiPlatform\Metadata\ApiProperty; use App\Dto\Output\OrganizationalUnitOutput; use App\Dto\Output\RemoteCalendarOutput; use App\Entity\OrganizationalUnit; -use App\Validator\Constraints\OrganizationalUnitMulticastMode; -use App\Validator\Constraints\OrganizationalUnitMulticastPort; -use App\Validator\Constraints\OrganizationalUnitP2PMode; use App\Validator\Constraints\OrganizationalUnitParent; use App\Validator\Constraints\OrganizationalUnitType; use Symfony\Component\Serializer\Annotation\Groups; @@ -19,45 +16,95 @@ class OrganizationalUnitInput { #[Assert\NotBlank(message: 'validators.organizational_unit.name.not_blank')] #[Groups(['organizational-unit:write'])] + #[ApiProperty( + description: 'El nombre de la unidad organizativa', + example: 'Aula 1' + )] public ?string $name = null; #[Groups(['organizational-unit:write'])] + #[ApiProperty( + description: 'La unidad organizativa padre', + example: null + )] public ?OrganizationalUnitOutput $parent = null; #[Groups(['organizational-unit:write'])] + #[ApiProperty( + description: 'La descripción de la unidad organizativa', + example: 'Aula de informática principal' + )] public ?string $description = null; #[Groups(['organizational-unit:write'])] + #[ApiProperty( + description: 'La ubicación de la unidad organizativa', + example: 'Planta baja, edificio A' + )] public ?string $location = null; #[Groups(['organizational-unit:write'])] + #[ApiProperty( + description: 'Si tiene proyector', + example: true + )] public ?bool $projector = null; #[Groups(['organizational-unit:write'])] + #[ApiProperty( + description: 'Si tiene pizarra digital', + example: false + )] public ?bool $board = null; #[Assert\GreaterThan(0)] #[Groups(['organizational-unit:write'])] + #[ApiProperty( + description: 'La capacidad de la unidad organizativa', + example: 30 + )] public ?int $capacity = null; #[Groups(['organizational-unit:write'])] + #[ApiProperty( + description: 'Comentarios adicionales', + example: 'Aula equipada con ordenadores de última generación' + )] public ?string $comments = null; #[Groups(['organizational-unit:write'])] #[OrganizationalUnitType] + #[ApiProperty( + description: 'El tipo de unidad organizativa', + example: 'aula' + )] public ?string $type = null; #[Groups(['organizational-unit:write'])] #[Assert\Valid()] + #[ApiProperty( + description: 'La configuración de red de la unidad organizativa' + )] public ?NetworkSettingsInput $networkSettings = null; #[Groups(['organizational-unit:write'])] + #[ApiProperty( + description: 'El calendario remoto de la unidad organizativa' + )] public ?RemoteCalendarOutput $remoteCalendar = null; #[Groups(['organizational-unit:write'])] + #[ApiProperty( + description: 'Si es un PC remoto', + example: false + )] public ?bool $remotePc = false; #[Groups(['organizational-unit:write'])] + #[ApiProperty( + description: 'Si excluir cambios del padre', + example: false + )] public ?bool $excludeParentChanges = null; public function __construct(?OrganizationalUnit $organizationalUnit = null) diff --git a/src/Dto/Input/PartitionInput.php b/src/Dto/Input/PartitionInput.php index 5942a3b..8c5d5c2 100644 --- a/src/Dto/Input/PartitionInput.php +++ b/src/Dto/Input/PartitionInput.php @@ -3,12 +3,8 @@ namespace App\Dto\Input; use ApiPlatform\Metadata\ApiProperty; -use App\Dto\Output\ClientOutput; use App\Dto\Output\ImageOutput; use App\Dto\Output\OperativeSystemOutput; -use App\Dto\Output\OrganizationalUnitOutput; -use App\Entity\HardwareProfile; -use App\Entity\Menu; use App\Entity\Partition; use Ramsey\Uuid\UuidInterface; use Symfony\Component\Serializer\Annotation\Groups; diff --git a/src/Dto/Input/SubnetAddHostInput.php b/src/Dto/Input/SubnetAddHostInput.php index d903357..7cff517 100644 --- a/src/Dto/Input/SubnetAddHostInput.php +++ b/src/Dto/Input/SubnetAddHostInput.php @@ -4,9 +4,6 @@ namespace App\Dto\Input; use ApiPlatform\Metadata\ApiProperty; use App\Dto\Output\ClientOutput; -use App\Dto\Output\PxeTemplateOutput; -use App\Dto\Output\SubnetOutput; -use App\Entity\PxeBootFile; use Symfony\Component\Serializer\Annotation\Groups; use Symfony\Component\Validator\Constraints as Assert; @@ -17,5 +14,9 @@ final class SubnetAddHostInput */ #[Assert\NotNull] #[Groups(['subnet:write'])] + #[ApiProperty( + description: 'Los clientes a añadir a la subred', + example: [] + )] public ?array $clients = []; } \ No newline at end of file diff --git a/src/Dto/Input/TransferGlobalImageInput.php b/src/Dto/Input/TransferGlobalImageInput.php index 7193d13..7341644 100644 --- a/src/Dto/Input/TransferGlobalImageInput.php +++ b/src/Dto/Input/TransferGlobalImageInput.php @@ -3,7 +3,7 @@ namespace App\Dto\Input; use App\Dto\Output\ImageOutput; -use App\Dto\Output\ImageRepositoryOutput; +use ApiPlatform\Metadata\ApiProperty; use Symfony\Component\Serializer\Annotation\Groups; use Symfony\Component\Validator\Constraints as Assert; @@ -14,5 +14,9 @@ class TransferGlobalImageInput */ #[Assert\NotNull] #[Groups(['image-image-repository:write'])] + #[ApiProperty( + description: 'Los repositorios de destino para transferir la imagen global', + example: [] + )] public array $repositories = []; } \ No newline at end of file diff --git a/src/Dto/Input/UserGroupInput.php b/src/Dto/Input/UserGroupInput.php index 918e1ef..1dabc19 100644 --- a/src/Dto/Input/UserGroupInput.php +++ b/src/Dto/Input/UserGroupInput.php @@ -2,6 +2,7 @@ namespace App\Dto\Input; +use ApiPlatform\Metadata\ApiProperty; use App\Entity\UserGroup; use App\Validator\Constraints\UserGroupsValidPermission; use Symfony\Component\Serializer\Annotation\Groups; @@ -11,14 +12,26 @@ final class UserGroupInput { #[Assert\NotBlank] #[Groups(['user-group:write'])] + #[ApiProperty( + description: 'El nombre del grupo de usuario', + example: 'Administradores' + )] public ?string $name = null; #[Groups(['user-group:write'])] #[UserGroupsValidPermission] + #[ApiProperty( + description: 'Los permisos del grupo de usuario', + example: ['ROLE_ADMIN', 'ROLE_USER_MANAGEMENT'] + )] public ?array $permissions = []; #[Assert\NotNull] #[Groups(['user-group:write'])] + #[ApiProperty( + description: 'Si el grupo está habilitado', + example: true + )] public ?bool $enabled = false; public function __construct(?UserGroup $userGroupGroup = null) diff --git a/src/Dto/Input/UserInput.php b/src/Dto/Input/UserInput.php index aea6947..c524e2b 100644 --- a/src/Dto/Input/UserInput.php +++ b/src/Dto/Input/UserInput.php @@ -15,47 +15,85 @@ final class UserInput { #[Assert\NotBlank] #[Groups('user:write')] + #[ApiProperty( + description: 'El nombre de usuario', + example: 'admin' + )] public ?string $username = null; /** * @var OrganizationalUnitOutput[] */ #[Groups('user:write')] - #[ApiProperty(readableLink: false, writableLink: false)] + #[ApiProperty( + description: 'Las unidades organizativas permitidas para el usuario', + example: [], + readableLink: false, + writableLink: false + )] public array $allowedOrganizationalUnits = []; #[Assert\NotBlank(groups: ['user:post'])] #[Assert\Length(min: 8, groups: ['user:write', 'user:post'])] #[Groups('user:write')] + #[ApiProperty( + description: 'La contraseña del usuario (mínimo 8 caracteres)', + example: 'password123' + )] public ?string $password = null; #[Groups('user:write')] + #[ApiProperty( + description: 'La vista por defecto de grupos para el usuario', + example: 'grid' + )] public ?string $groupsView = null; #[Assert\NotNull] #[Groups('user:write')] + #[ApiProperty( + description: 'Si el usuario está habilitado', + example: true + )] public ?bool $enabled = true; /** * @var UserGroupOutput[] */ #[Groups('user:write')] - #[ApiProperty(readableLink: false, writableLink: false)] + #[ApiProperty( + description: 'Los grupos de usuario asignados', + example: [], + readableLink: false, + writableLink: false + )] public array $userGroups = []; #[Assert\NotBlank(groups: ['user:reset-password'])] #[Groups('user:reset-password')] + #[ApiProperty( + description: 'La contraseña actual del usuario', + example: 'currentpass123' + )] public ?string $currentPassword = null; #[Assert\NotBlank(groups: ['user:reset-password'])] #[Assert\Length(min: 8, groups: ['user:reset-password'])] #[Groups('user:reset-password')] + #[ApiProperty( + description: 'La nueva contraseña del usuario (mínimo 8 caracteres)', + example: 'newpass123' + )] public ?string $newPassword = null; #[Assert\NotBlank(groups: ['user:reset-password'])] #[Assert\Length(min: 8, groups: ['user:reset-password'])] #[Assert\Expression(expression: 'this.newPassword === this.repeatNewPassword', message: 'This value should be the same as the new password', groups: ['user:reset-password'])] #[Groups('user:reset-password')] + #[ApiProperty( + description: 'Repetir la nueva contraseña para confirmación', + example: 'newpass123' + )] public ?string $repeatNewPassword = null; public function __construct(?User $user = null) diff --git a/src/Dto/Input/WoLInput.php b/src/Dto/Input/WoLInput.php index 82d36ca..7ec82e6 100644 --- a/src/Dto/Input/WoLInput.php +++ b/src/Dto/Input/WoLInput.php @@ -12,6 +12,9 @@ class WoLInput * @var ClientOutput[]|null */ #[Groups(['repository:write'])] - #[ApiProperty(description: 'The client to wol')] + #[ApiProperty( + description: 'Los clientes para Wake on LAN', + example: [] + )] public ?array $clients = null; } \ No newline at end of file diff --git a/src/Dto/Output/ClientOutput.php b/src/Dto/Output/ClientOutput.php index bc7ca50..a9d1b9b 100644 --- a/src/Dto/Output/ClientOutput.php +++ b/src/Dto/Output/ClientOutput.php @@ -14,70 +14,150 @@ final class ClientOutput extends AbstractOutput CONST string TYPE = 'client'; #[Groups(['client:read', 'organizational-unit:read', 'pxe-template:read', 'trace:read', 'subnet:read', 'hardware-profile:read'])] + #[ApiProperty( + description: 'El nombre del cliente', + example: 'PC-Aula-01' + )] public string $name; #[Groups(['client:read', 'organizational-unit:read'])] + #[ApiProperty( + description: 'El tipo de entidad', + example: 'client' + )] public string $type = self::TYPE; #[Groups(['client:read', 'organizational-unit:read', 'pxe-template:read', 'trace:read', 'subnet:read', 'hardware-profile:read'])] + #[ApiProperty( + description: 'La dirección IP del cliente', + example: '192.168.1.100' + )] public ?string $ip = ''; #[Groups(['client:read', 'organizational-unit:read', 'pxe-template:read', 'trace:read', 'subnet:read', 'hardware-profile:read'])] + #[ApiProperty( + description: 'La dirección MAC del cliente', + example: '00:1A:2B:3C:4D:5E' + )] public ?string $mac = ''; #[Groups(['client:read'])] + #[ApiProperty( + description: 'El tipo de firmware (BIOS/UEFI)', + example: 'UEFI' + )] public ?string $firmwareType = ''; #[Groups(['client:read', 'organizational-unit:read', 'trace:read'])] + #[ApiProperty( + description: 'El número de serie del cliente', + example: 'SN123456789' + )] public ?string $serialNumber = ''; #[Groups(['client:read'])] + #[ApiProperty( + description: 'La interfaz de red', + example: 'eth0' + )] public ?string $netiface = ''; #[Groups(['client:read'])] + #[ApiProperty( + description: 'El controlador de red', + example: 'e1000' + )] public ?string $netDriver = ''; #[Groups(['client:read'])] - #[ApiProperty(readableLink: true)] + #[ApiProperty( + description: 'La unidad organizativa a la que pertenece el cliente', + readableLink: true + )] public ?OrganizationalUnitOutput $organizationalUnit = null; #[Groups(['client:read'])] + #[ApiProperty( + description: 'Las particiones del disco del cliente', + example: [] + )] public array $partitions = []; #[Groups(['client:read'])] + #[ApiProperty( + description: 'El menú de arranque asignado al cliente', + example: null + )] public ?MenuOutput $menu = null; #[Groups(['client:read'])] - #[ApiProperty(readableLink: true )] + #[ApiProperty( + description: 'El repositorio de imágenes asignado al cliente', + readableLink: true + )] public ?ImageRepositoryOutput $repository = null; #[Groups(['client:read', 'organizational-unit:read', 'pxe-template:read', 'trace:read', 'subnet:read'])] - #[ApiProperty(readableLink: true )] + #[ApiProperty( + description: 'La plantilla PXE asignada al cliente', + readableLink: true + )] public ?PxeTemplateOutput $pxeTemplate = null; #[Groups(['client:read', 'organizational-unit:read', 'pxe-template:read', 'trace:read', 'subnet:read'])] - #[ApiProperty(readableLink: true )] + #[ApiProperty( + description: 'La imagen OGLive asignada al cliente', + readableLink: true + )] public ?OgLiveOutput $ogLive = null; #[Groups(['client:read', 'organizational-unit:read', 'pxe-template:read', 'trace:read', 'subnet:read'])] + #[ApiProperty( + description: 'La subred del cliente en formato CIDR', + example: '192.168.1.0/24' + )] public ?string $subnet = null; #[Groups(['client:read', 'organizational-unit:read'])] + #[ApiProperty( + description: 'La posición del cliente en la interfaz gráfica', + example: ['x' => 100, 'y' => 200] + )] public ?array $position = ['x' => 0, 'y' => 0]; #[Groups(['client:read', 'organizational-unit:read', 'pxe-template:read', 'trace:read', 'subnet:read'])] + #[ApiProperty( + description: 'El estado actual del cliente', + example: 'online' + )] public ?string $status = ''; #[Groups(['client:read'])] + #[ApiProperty( + description: 'Fecha de creación del cliente', + example: '2024-01-15T10:30:00+00:00' + )] public \DateTime $createdAt; #[Groups(['client:read'])] + #[ApiProperty( + description: 'Usuario que creó este registro', + example: 'admin' + )] public ?string $createdBy = null; #[Groups(['client:read', 'organizational-unit:read', 'pxe-template:read', 'trace:read', 'subnet:read'])] + #[ApiProperty( + description: 'Indica si el cliente está en modo mantenimiento', + example: false + )] public ?bool $maintenance = false; #[Groups(['client:read'])] + #[ApiProperty( + description: 'Indica si la configuración PXE está sincronizada', + example: true + )] public ?bool $pxeSync = false; public function __construct(Client $client) diff --git a/src/Dto/Output/CommandGroupOutput.php b/src/Dto/Output/CommandGroupOutput.php index 617bf79..cf47375 100644 --- a/src/Dto/Output/CommandGroupOutput.php +++ b/src/Dto/Output/CommandGroupOutput.php @@ -2,6 +2,7 @@ namespace App\Dto\Output; +use ApiPlatform\Metadata\ApiProperty; use ApiPlatform\Metadata\Get; use App\Entity\Command; use App\Entity\CommandGroup; @@ -11,15 +12,31 @@ use Symfony\Component\Serializer\Annotation\Groups; final class CommandGroupOutput extends AbstractOutput { #[Groups(['command-group:read', 'command-task:read'])] + #[ApiProperty( + description: 'El nombre del grupo de comandos', + example: 'Comandos de sistema' + )] public string $name; #[Groups(['command-group:read', 'command-task:read'])] + #[ApiProperty( + description: 'Los comandos incluidos en el grupo', + example: [] + )] public array $commands = []; #[Groups(['command-group:read'])] + #[ApiProperty( + description: 'Fecha de creación del grupo de comandos', + example: '2024-01-15T10:30:00+00:00' + )] public \DateTime $createdAt; #[Groups(['command-group:read'])] + #[ApiProperty( + description: 'Usuario que creó este registro', + example: 'admin' + )] public ?string $createdBy = null; public function __construct(CommandGroup $commandGroup) diff --git a/src/Dto/Output/CommandOutput.php b/src/Dto/Output/CommandOutput.php index 0622b70..0832c78 100644 --- a/src/Dto/Output/CommandOutput.php +++ b/src/Dto/Output/CommandOutput.php @@ -2,6 +2,7 @@ namespace App\Dto\Output; +use ApiPlatform\Metadata\ApiProperty; use ApiPlatform\Metadata\Get; use App\Entity\Command; use Symfony\Component\Serializer\Annotation\Groups; @@ -10,27 +11,59 @@ use Symfony\Component\Serializer\Annotation\Groups; final class CommandOutput extends AbstractOutput { #[Groups(['command:read', 'command-group:read', 'command-task:read', 'trace:read'])] + #[ApiProperty( + description: 'El nombre del comando', + example: 'Reiniciar sistema' + )] public string $name; #[Groups(['command:read', 'command-group:read', 'command-task:read', 'trace:read'])] + #[ApiProperty( + description: 'El script del comando', + example: 'reboot' + )] public ?string $script = ''; #[Groups(['command:read'])] + #[ApiProperty( + description: 'Indica si el comando es de solo lectura', + example: false + )] public ?bool $readOnly = false; #[Groups(['command:read'])] + #[ApiProperty( + description: 'Indica si el comando está habilitado', + example: true + )] public ?bool $enabled = true; #[Groups(['command:read'])] + #[ApiProperty( + description: 'Indica si el comando acepta parámetros', + example: true + )] public ?bool $parameters = true; #[Groups(['command:read'])] + #[ApiProperty( + description: 'Comentarios sobre el comando', + example: 'Reinicia el equipo de forma controlada' + )] public ?string $comments = ''; #[Groups(['command:read'])] + #[ApiProperty( + description: 'Fecha de creación del comando', + example: '2024-01-15T10:30:00+00:00' + )] public \DateTime $createdAt; #[Groups(['command:read'])] + #[ApiProperty( + description: 'Usuario que creó este registro', + example: 'admin' + )] public ?string $createdBy = null; public function __construct(Command $command) diff --git a/src/Dto/Output/CommandTaskOutput.php b/src/Dto/Output/CommandTaskOutput.php index c6be84f..eb04d38 100644 --- a/src/Dto/Output/CommandTaskOutput.php +++ b/src/Dto/Output/CommandTaskOutput.php @@ -2,6 +2,7 @@ namespace App\Dto\Output; +use ApiPlatform\Metadata\ApiProperty; use ApiPlatform\Metadata\Get; use App\Entity\Client; use App\Entity\Command; @@ -13,30 +14,66 @@ use Symfony\Component\Serializer\Annotation\Groups; final class CommandTaskOutput extends AbstractOutput { #[Groups(['command-task:read'])] + #[ApiProperty( + description: 'El nombre de la tarea de comando', + example: 'Actualización nocturna' + )] public ?string $name = null; #[Groups(['command-task:read'])] + #[ApiProperty( + description: 'Los clientes asignados a la tarea', + example: [] + )] public array $clients = []; #[Groups(['command-task:read'])] + #[ApiProperty( + description: 'La unidad organizativa asociada a la tarea', + example: null + )] public ?OrganizationalUnitOutput $organizationalUnit = null; #[Groups(['command-task:read'])] + #[ApiProperty( + description: 'Fecha de la última ejecución', + example: '2024-01-15T02:00:00+00:00' + )] public ?\DateTimeInterface $lastExecution = null; #[Groups(['command-task:read'])] + #[ApiProperty( + description: 'Fecha de la próxima ejecución programada', + example: '2024-01-16T02:00:00+00:00' + )] public ?\DateTimeInterface $nextExecution = null; #[Groups(['command-task:read'])] + #[ApiProperty( + description: 'Notas adicionales sobre la tarea', + example: 'Ejecutar fuera del horario escolar' + )] public ?string $notes = null; #[Groups(['command-task:read'])] + #[ApiProperty( + description: 'El alcance de la tarea', + example: 'clients' + )] public ?string $scope = null; #[Groups(['command-task:read'])] + #[ApiProperty( + description: 'Fecha de creación de la tarea', + example: '2024-01-15T10:30:00+00:00' + )] public \DateTime $createdAt; #[Groups(['command-task:read'])] + #[ApiProperty( + description: 'Usuario que creó este registro', + example: 'admin' + )] public ?string $createdBy = null; diff --git a/src/Dto/Output/CommandTaskScheduleOutput.php b/src/Dto/Output/CommandTaskScheduleOutput.php index 45dcd02..6860aee 100644 --- a/src/Dto/Output/CommandTaskScheduleOutput.php +++ b/src/Dto/Output/CommandTaskScheduleOutput.php @@ -2,6 +2,7 @@ namespace App\Dto\Output; +use ApiPlatform\Metadata\ApiProperty; use ApiPlatform\Metadata\Get; use App\Entity\CommandTaskSchedule; use Symfony\Component\Serializer\Annotation\Groups; @@ -10,18 +11,38 @@ use Symfony\Component\Serializer\Annotation\Groups; class CommandTaskScheduleOutput extends AbstractOutput { #[Groups(['command-task-schedule:read'])] + #[ApiProperty( + description: 'El tipo de recurrencia de la programación', + example: 'weekly' + )] public ?string $recurrenceType = null; #[Groups(['command-task-schedule:read'])] + #[ApiProperty( + description: 'La fecha de ejecución programada', + example: '2024-01-20T00:00:00+00:00' + )] public ?\DateTimeInterface $executionDate = null; #[Groups(['command-task-schedule:read'])] + #[ApiProperty( + description: 'La hora de ejecución programada', + example: '2024-01-15T02:00:00+00:00' + )] public ?\DateTimeInterface $executionTime = null; #[Groups(['command-task-schedule:read'])] + #[ApiProperty( + description: 'Los detalles de la recurrencia', + example: ['days' => ['monday', 'wednesday', 'friday']] + )] public ?array $recurrenceDetails = null; #[Groups(['command-task-schedule:read'])] + #[ApiProperty( + description: 'Indica si la programación está habilitada', + example: true + )] public ?bool $enabled = null; public function __construct(?CommandTaskSchedule $commandTaskSchedule = null) diff --git a/src/Dto/Output/CommandTaskScriptOutput.php b/src/Dto/Output/CommandTaskScriptOutput.php index 1354ffc..ce6274d 100644 --- a/src/Dto/Output/CommandTaskScriptOutput.php +++ b/src/Dto/Output/CommandTaskScriptOutput.php @@ -2,6 +2,7 @@ namespace App\Dto\Output; +use ApiPlatform\Metadata\ApiProperty; use ApiPlatform\Metadata\Get; use App\Entity\CommandTaskSchedule; use App\Entity\CommandTaskScript; @@ -11,18 +12,38 @@ use Symfony\Component\Serializer\Annotation\Groups; class CommandTaskScriptOutput extends AbstractOutput { #[Groups(['command-task-script:read'])] + #[ApiProperty( + description: 'El contenido del script', + example: '#!/bin/bash\necho "Hello World"' + )] public ?string $content = null; #[Groups(['command-task-script:read'])] + #[ApiProperty( + description: 'El tipo de script', + example: 'bash' + )] public ?string $type = null; #[Groups(['command-task-script:read'])] + #[ApiProperty( + description: 'Los parámetros del script', + example: [] + )] public ?array $parameters = null; #[Groups(['command-task-script:read'])] + #[ApiProperty( + description: 'La tarea de comando asociada', + example: null + )] public ?CommandTaskOutput $commandTaskOutput = null; #[Groups(['command-task-script:read'])] + #[ApiProperty( + description: 'El orden de ejecución del script', + example: 1 + )] public ?int $order = null; public function __construct(?CommandTaskScript $commandTaskScript = null) diff --git a/src/Dto/Output/GitRepositoryOutput.php b/src/Dto/Output/GitRepositoryOutput.php index 9040e0f..3c65e96 100644 --- a/src/Dto/Output/GitRepositoryOutput.php +++ b/src/Dto/Output/GitRepositoryOutput.php @@ -2,6 +2,7 @@ namespace App\Dto\Output; +use ApiPlatform\Metadata\ApiProperty; use ApiPlatform\Metadata\Get; use App\Entity\GitRepository; use Symfony\Component\Serializer\Annotation\Groups; @@ -22,6 +23,10 @@ final class GitRepositoryOutput * ) */ #[Groups(['git-repository:read', 'git-image-repository:read'])] + #[ApiProperty( + description: 'El UUID del repositorio Git', + example: '123e4567-e89b-12d3-a456-426614174000' + )] public string $uuid = ''; /** @@ -31,6 +36,10 @@ final class GitRepositoryOutput * ) */ #[Groups(['git-repository:read', 'git-image-repository:read'])] + #[ApiProperty( + description: 'El ID del repositorio Git', + example: 1 + )] public int $id = 0; /** @@ -40,6 +49,10 @@ final class GitRepositoryOutput * ) */ #[Groups(['git-repository:read', 'git-image-repository:read'])] + #[ApiProperty( + description: 'El nombre del repositorio Git', + example: 'mi-repositorio' + )] public string $name = ''; /** @@ -49,6 +62,10 @@ final class GitRepositoryOutput * ) */ #[Groups(['git-repository:read', 'git-image-repository:read'])] + #[ApiProperty( + description: 'La descripción del repositorio', + example: 'Repositorio para el proyecto principal' + )] public ?string $description = ''; /** @@ -58,6 +75,10 @@ final class GitRepositoryOutput * ) */ #[Groups(['git-repository:read', 'git-image-repository:read'])] + #[ApiProperty( + description: 'El servidor donde se encuentra el repositorio', + example: null + )] public ?ImageRepositoryOutput $repository = null; /** @@ -67,6 +88,10 @@ final class GitRepositoryOutput * ) */ #[Groups(['git-repository:read', 'git-image-repository:read'])] + #[ApiProperty( + description: 'Fecha de creación del repositorio', + example: '2024-01-01T00:00:00+00:00' + )] public ?\DateTime $createdAt = null; /** @@ -76,6 +101,10 @@ final class GitRepositoryOutput * ) */ #[Groups(['git-repository:read', 'git-image-repository:read'])] + #[ApiProperty( + description: 'Usuario que creó este registro', + example: 'admin' + )] public ?string $createdBy = null; public function __construct(GitRepository $gitRepository, array $context = []) diff --git a/src/Dto/Output/HardwareOutput.php b/src/Dto/Output/HardwareOutput.php index 3823f33..39a1d80 100644 --- a/src/Dto/Output/HardwareOutput.php +++ b/src/Dto/Output/HardwareOutput.php @@ -11,19 +11,38 @@ use Symfony\Component\Serializer\Annotation\Groups; final class HardwareOutput extends AbstractOutput { #[Groups(['hardware:read', 'hardware-profile:read'])] + #[ApiProperty( + description: 'El nombre del componente de hardware', + example: 'Intel Core i7-9700K' + )] public string $name; #[Groups(['hardware:read'])] + #[ApiProperty( + description: 'La descripción del componente de hardware', + example: 'Procesador de 8 núcleos a 3.6GHz' + )] public ?string $description = ''; #[Groups(['hardware:read'])] - #[ApiProperty(readableLink: true)] + #[ApiProperty( + description: 'El tipo de hardware', + readableLink: true + )] public ?HardwareTypeOutput $type = null; #[Groups(['hardware:read'])] + #[ApiProperty( + description: 'Fecha de creación del componente de hardware', + example: '2024-01-15T10:30:00+00:00' + )] public \DateTime $createdAt; #[Groups(['hardware:read'])] + #[ApiProperty( + description: 'Usuario que creó este registro', + example: 'admin' + )] public ?string $createdBy = null; public function __construct(Hardware $hardware) diff --git a/src/Dto/Output/HardwareProfileOutput.php b/src/Dto/Output/HardwareProfileOutput.php index 22b73f3..93a3b55 100644 --- a/src/Dto/Output/HardwareProfileOutput.php +++ b/src/Dto/Output/HardwareProfileOutput.php @@ -12,21 +12,45 @@ use Symfony\Component\Serializer\Annotation\Groups; final class HardwareProfileOutput extends AbstractOutput { #[Groups(['hardware-profile:read', 'client:read'])] + #[ApiProperty( + description: 'La descripción del perfil de hardware', + example: 'Perfil de hardware estándar para aula de informática' + )] public ?string $description = ''; #[Groups(['hardware-profile:read'])] + #[ApiProperty( + description: 'Comentarios adicionales sobre el perfil', + example: 'Configuración actualizada en enero 2024' + )] public ?string $comments = ''; #[Groups(['hardware-profile:read'])] + #[ApiProperty( + description: 'El cliente asociado a este perfil de hardware', + example: null + )] public ?ClientOutput $client = null; #[Groups(['hardware-profile:read'])] + #[ApiProperty( + description: 'La colección de componentes de hardware', + example: [] + )] public ?array $hardwareCollection = []; #[Groups(['hardware-profile:read'])] + #[ApiProperty( + description: 'Fecha de creación del perfil de hardware', + example: '2024-01-15T10:30:00+00:00' + )] public \DateTime $createdAt; #[Groups(['hardware-profile:read'])] + #[ApiProperty( + description: 'Usuario que creó este registro', + example: 'admin' + )] public ?string $createdBy = null; public function __construct(HardwareProfile $hardwareProfile) diff --git a/src/Dto/Output/HardwareTypeOutput.php b/src/Dto/Output/HardwareTypeOutput.php index 9606d3a..023be56 100644 --- a/src/Dto/Output/HardwareTypeOutput.php +++ b/src/Dto/Output/HardwareTypeOutput.php @@ -2,6 +2,7 @@ namespace App\Dto\Output; +use ApiPlatform\Metadata\ApiProperty; use ApiPlatform\Metadata\Get; use App\Entity\HardwareType; use Symfony\Component\Serializer\Annotation\Groups; @@ -10,15 +11,31 @@ use Symfony\Component\Serializer\Annotation\Groups; final class HardwareTypeOutput extends AbstractOutput { #[Groups(['hardware-type:read', 'hardware:read'])] + #[ApiProperty( + description: 'El nombre del tipo de hardware', + example: 'Tarjeta de red' + )] public string $name; #[Groups(['hardware-type:read', 'hardware:read'])] + #[ApiProperty( + description: 'La descripción del tipo de hardware', + example: 'Dispositivo de red Ethernet' + )] public ?string $description = null; #[Groups(['hardware-type:read', 'hardware:read'])] + #[ApiProperty( + description: 'El código del tipo de hardware', + example: 'NET' + )] public ?string $code = null; #[Groups(['hardware-type:read', 'hardware:read'])] + #[ApiProperty( + description: 'Fecha de creación del tipo de hardware', + example: '2024-01-15T10:30:00+00:00' + )] public \DateTime $createdAt; public function __construct(HardwareType $hardwareType) diff --git a/src/Dto/Output/ImageImageRepositoryOutput.php b/src/Dto/Output/ImageImageRepositoryOutput.php index c23ce24..d4cf4e9 100644 --- a/src/Dto/Output/ImageImageRepositoryOutput.php +++ b/src/Dto/Output/ImageImageRepositoryOutput.php @@ -2,6 +2,7 @@ namespace App\Dto\Output; +use ApiPlatform\Metadata\ApiProperty; use ApiPlatform\Metadata\Get; use App\Entity\ImageImageRepository; use Symfony\Component\Serializer\Annotation\Groups; @@ -10,36 +11,80 @@ use Symfony\Component\Serializer\Annotation\Groups; class ImageImageRepositoryOutput extends AbstractOutput { #[Groups(['image-image-repository:read', 'image:read'])] + #[ApiProperty( + description: 'La imagen asociada', + example: null + )] public ?ImageOutput $image = null; #[Groups(['image-image-repository:read', 'image:read'])] + #[ApiProperty( + description: 'El repositorio donde está almacenada la imagen', + example: null + )] public ?ImageRepositoryOutput $imageRepository = null; #[Groups(['image-image-repository:read', 'image:read'])] + #[ApiProperty( + description: 'El estado de la imagen en el repositorio', + example: 'synchronized' + )] public string $status; #[Groups(['image-image-repository:read', 'image:read', 'partition:read', 'client:read'])] + #[ApiProperty( + description: 'El nombre de la imagen', + example: 'Windows10-v1' + )] public string $name; #[Groups(['image-image-repository:read', 'image:read'])] + #[ApiProperty( + description: 'La suma de verificación completa de la imagen', + example: 'a1b2c3d4e5f6...' + )] public ?string $imageFullsum = null; #[Groups(['image-image-repository:read', 'image:read'])] + #[ApiProperty( + description: 'Información sobre las particiones de la imagen', + example: [] + )] public ?array $partitionInfo = null; #[Groups(['image-image-repository:read', 'image:read'])] + #[ApiProperty( + description: 'El tamaño de los datos en bytes', + example: '10737418240' + )] public ?string $datasize = null; #[Groups(['image-image-repository:read', 'image:read'])] + #[ApiProperty( + description: 'La descripción de la imagen', + example: 'Imagen base de Windows 10 actualizado' + )] public ?string $description = null; #[Groups(['image:read', 'image-image-repository:read'])] + #[ApiProperty( + description: 'La versión de la imagen', + example: 1 + )] public ?int $version = null; #[Groups(['image-image-repository:read', 'image:read'])] + #[ApiProperty( + description: 'Fecha de creación de la relación imagen-repositorio', + example: '2024-01-15T10:30:00+00:00' + )] public \DateTime $createdAt; #[Groups(['image-image-repository:read', 'image:read'])] + #[ApiProperty( + description: 'Usuario que creó este registro', + example: 'admin' + )] public ?string $createdBy = null; public function __construct(ImageImageRepository $imageImageRepository, array $context = []) diff --git a/src/Dto/Output/ImageOutput.php b/src/Dto/Output/ImageOutput.php index a5cf26f..9e857fc 100644 --- a/src/Dto/Output/ImageOutput.php +++ b/src/Dto/Output/ImageOutput.php @@ -2,6 +2,7 @@ namespace App\Dto\Output; +use ApiPlatform\Metadata\ApiProperty; use ApiPlatform\Metadata\Get; use App\Entity\Image; use App\Entity\ImageImageRepository; @@ -13,35 +14,76 @@ use Symfony\Component\Serializer\Annotation\Groups; final class ImageOutput extends AbstractOutput { #[Groups(['image:read', 'image-image-repository:read', 'git-image-repository:read'])] + #[ApiProperty( + description: 'El nombre de la imagen', + example: 'Windows 10 Pro' + )] public ?string $name = ''; + #[Groups(['image:read', 'image-image-repository:read'])] + #[ApiProperty( + description: 'Indica si es una imagen de PC remoto', + example: false + )] public ?bool $remotePc = null; #[Groups(['image:read', 'image-image-repository:read'])] + #[ApiProperty( + description: 'Indica si la imagen es global', + example: true + )] public ?bool $isGlobal = null; #[Groups(['image:read', 'image-image-repository:read'])] + #[ApiProperty( + description: 'El tipo de imagen', + example: 'basic' + )] public ?string $type = ''; #[Groups(['image:read'])] + #[ApiProperty( + description: 'El perfil de software asociado a la imagen', + example: null + )] public ?SoftwareProfileOutput $softwareProfile = null; /** * @var ImageRepositoryOutput[]|null */ #[Groups(['image:read'])] + #[ApiProperty( + description: 'Los repositorios donde está almacenada la imagen', + example: [] + )] public ?array $imageRepositories = []; #[Groups(['image:read'])] + #[ApiProperty( + description: 'Información sobre las particiones de la imagen', + example: [] + )] public ?array $partitionInfo = null; #[Groups(['image:read', 'image-image-repository:read'])] + #[ApiProperty( + description: 'La versión de la imagen', + example: 1 + )] public ?int $version = null; #[Groups(['image:read'])] + #[ApiProperty( + description: 'Fecha de creación de la imagen', + example: '2024-01-15T10:30:00+00:00' + )] public \DateTime $createdAt; #[Groups(['image:read'])] + #[ApiProperty( + description: 'Usuario que creó este registro', + example: 'admin' + )] public ?string $createdBy = null; public function __construct(Image $image) diff --git a/src/Dto/Output/ImageRepositoryOutput.php b/src/Dto/Output/ImageRepositoryOutput.php index 44445b6..876919c 100644 --- a/src/Dto/Output/ImageRepositoryOutput.php +++ b/src/Dto/Output/ImageRepositoryOutput.php @@ -2,6 +2,7 @@ namespace App\Dto\Output; +use ApiPlatform\Metadata\ApiProperty; use ApiPlatform\Metadata\Get; use App\Entity\ImageRepository; use Symfony\Component\Serializer\Annotation\Groups; @@ -10,24 +11,52 @@ use Symfony\Component\Serializer\Annotation\Groups; class ImageRepositoryOutput extends AbstractOutput { #[Groups(['repository:read', 'image:read', 'client:read', "organizational-unit:read", "image-image-repository:read"])] + #[ApiProperty( + description: 'El nombre del repositorio de imágenes', + example: 'Repositorio Principal' + )] public ?string $name = ''; #[Groups(['repository:read'])] + #[ApiProperty( + description: 'La dirección IP del servidor del repositorio', + example: '192.168.1.50' + )] public ?string $ip = ''; #[Groups(['repository:read'])] + #[ApiProperty( + description: 'Comentarios sobre el repositorio', + example: 'Servidor principal de almacenamiento de imágenes' + )] public ?string $comments = ''; #[Groups(['repository:read'])] + #[ApiProperty( + description: 'El puerto SSH del servidor', + example: '22' + )] public ?string $sshPort = ''; #[Groups(['repository:read'])] + #[ApiProperty( + description: 'El usuario SSH para acceder al repositorio', + example: 'opengnsys' + )] public ?string $user = ''; #[Groups(['repository:read'])] + #[ApiProperty( + description: 'Fecha de creación del repositorio', + example: '2024-01-15T10:30:00+00:00' + )] public \DateTime $createdAt; #[Groups(['repository:read'])] + #[ApiProperty( + description: 'Usuario que creó este registro', + example: 'admin' + )] public ?string $createdBy = null; public function __construct(ImageRepository $imageRepository, bool $status = true) diff --git a/src/Dto/Output/MenuOutput.php b/src/Dto/Output/MenuOutput.php index 1a81def..661c766 100644 --- a/src/Dto/Output/MenuOutput.php +++ b/src/Dto/Output/MenuOutput.php @@ -2,6 +2,7 @@ namespace App\Dto\Output; +use ApiPlatform\Metadata\ApiProperty; use ApiPlatform\Metadata\Get; use App\Entity\HardwareProfile; use App\Entity\Menu; @@ -11,27 +12,59 @@ use Symfony\Component\Serializer\Annotation\Groups; final class MenuOutput extends AbstractOutput { #[Groups(['menu:read', 'organizational-unit:read'])] + #[ApiProperty( + description: 'El nombre del menú de arranque', + example: 'Menú Principal' + )] public string $name; #[Groups(['menu:read'])] + #[ApiProperty( + description: 'La resolución del menú', + example: '1024x768' + )] public string $resolution; #[Groups(['menu:read'])] + #[ApiProperty( + description: 'Comentarios sobre el menú', + example: 'Menú de arranque predeterminado para todas las aulas' + )] public ?string $comments = null; #[Groups(['menu:read'])] + #[ApiProperty( + description: 'URL pública del menú', + example: 'https://example.com/menu/public' + )] public ?string $publicUrl = null; #[Groups(['menu:read'])] + #[ApiProperty( + description: 'URL privada del menú', + example: 'https://example.com/menu/private' + )] public ?string $privateUrl = null; #[Groups(['menu:read'])] + #[ApiProperty( + description: 'Indica si es el menú predeterminado', + example: true + )] public ?bool $isDefault = false; #[Groups(['menu:read'])] + #[ApiProperty( + description: 'Fecha de creación del menú', + example: '2024-01-15T10:30:00+00:00' + )] public \DateTime $createdAt; #[Groups(['menu:read'])] + #[ApiProperty( + description: 'Usuario que creó este registro', + example: 'admin' + )] public ?string $createdBy = null; public function __construct(Menu $menu) diff --git a/src/Dto/Output/NetworkSettingsOutput.php b/src/Dto/Output/NetworkSettingsOutput.php index 329cede..d433c8f 100644 --- a/src/Dto/Output/NetworkSettingsOutput.php +++ b/src/Dto/Output/NetworkSettingsOutput.php @@ -2,6 +2,7 @@ namespace App\Dto\Output; +use ApiPlatform\Metadata\ApiProperty; use ApiPlatform\Metadata\Get; use App\Entity\NetworkSettings; use Symfony\Component\Serializer\Annotation\Groups; @@ -10,69 +11,157 @@ use Symfony\Component\Serializer\Annotation\Groups; final class NetworkSettingsOutput extends AbstractOutput { #[Groups(['network-settings:read', "organizational-unit:read", "client:read"])] + #[ApiProperty( + description: 'La dirección del servidor TFTP siguiente', + example: '192.168.1.10' + )] public ?string $nextServer = null; #[Groups(['network-settings:read', "organizational-unit:read", "client:read"])] + #[ApiProperty( + description: 'El nombre del archivo de arranque', + example: 'pxelinux.0' + )] public ?string $bootFileName = null; #[Groups(['network-settings:read', "organizational-unit:read", "client:read"])] + #[ApiProperty( + description: 'La dirección del servidor proxy', + example: 'http://proxy.example.com:8080' + )] public ?string $proxy = null; #[Groups(['network-settings:read', "organizational-unit:read", "client:read"])] + #[ApiProperty( + description: 'La dirección del servidor DNS', + example: '8.8.8.8' + )] public ?string $dns = null; #[Groups(['network-settings:read', "organizational-unit:read", "client:read"])] + #[ApiProperty( + description: 'La máscara de subred', + example: '255.255.255.0' + )] public ?string $netmask = null; #[Groups(['network-settings:read', "organizational-unit:read", "client:read"])] + #[ApiProperty( + description: 'La dirección del router/gateway', + example: '192.168.1.1' + )] public ?string $router = null; #[Groups(['network-settings:read', "organizational-unit:read", "client:read"])] + #[ApiProperty( + description: 'La dirección del servidor NTP', + example: 'time.google.com' + )] public ?string $ntp = null; #[Groups(['network-settings:read', "organizational-unit:read", "client:read"])] + #[ApiProperty( + description: 'La interfaz de red', + example: 'eth0' + )] public ?string $netiface = null; #[Groups(['network-settings:read', "organizational-unit:read", "client:read"])] + #[ApiProperty( + description: 'El modo de transferencia punto a punto', + example: 'full' + )] public ?string $p2pMode = null; #[Groups(['network-settings:read', "organizational-unit:read", "client:read"])] + #[ApiProperty( + description: 'Tiempo de transferencia P2P en segundos', + example: 300 + )] public ?int $p2pTime = null; #[Groups(['network-settings:read', "organizational-unit:read", "client:read"])] + #[ApiProperty( + description: 'La dirección IP multicast', + example: '239.194.2.11' + )] public ?string $mcastIp = null; #[Groups(['network-settings:read', "organizational-unit:read", "client:read"])] + #[ApiProperty( + description: 'La velocidad multicast en Mbps', + example: 100 + )] public ?int $mcastSpeed = null; #[Groups(['network-settings:read', "organizational-unit:read", "client:read"])] + #[ApiProperty( + description: 'El puerto multicast', + example: 9000 + )] public ?int $mcastPort = null; #[Groups(['network-settings:read', "organizational-unit:read", "client:read"])] + #[ApiProperty( + description: 'El modo multicast', + example: 'full-duplex' + )] public ?string $mcastMode = null; #[Groups(['network-settings:read', "organizational-unit:read", "client:read"])] + #[ApiProperty( + description: 'El menú de arranque configurado', + example: null + )] public ?MenuOutput $menu = null; #[Groups(['network-settings:read', "organizational-unit:read", "client:read"])] + #[ApiProperty( + description: 'El perfil de hardware configurado', + example: null + )] public ?HardwareProfileOutput $hardwareProfile = null; #[Groups(['network-settings:read', "organizational-unit:read", "client:read"])] + #[ApiProperty( + description: 'La imagen OGLive configurada', + example: null + )] public ?OgLiveOutput $ogLive = null; #[Groups(['network-settings:read', "organizational-unit:read", "client:read"])] + #[ApiProperty( + description: 'El repositorio de imágenes configurado', + example: null + )] public ?ImageRepositoryOutput $repository = null; #[Groups(['network-settings:read', "organizational-unit:read", "client:read"])] + #[ApiProperty( + description: 'La plantilla PXE configurada', + example: null + )] public ?PxeTemplateOutput $pxeTemplate = null; #[Groups(['network-settings:read', "organizational-unit:read", "client:read"])] + #[ApiProperty( + description: 'La ruta compartida de OGAgent', + example: '/opt/opengnsys/ogshare' + )] public ?string $ogshare = null; #[Groups(['organizational-unit:read'])] + #[ApiProperty( + description: 'Fecha de creación de la configuración de red', + example: '2024-01-15T10:30:00+00:00' + )] public \DateTime $createdAt; #[Groups(['organizational-unit:read'])] + #[ApiProperty( + description: 'Usuario que creó este registro', + example: 'admin' + )] public ?string $createdBy = null; public function __construct(NetworkSettings $networkSettings) diff --git a/src/Dto/Output/OgLiveOutput.php b/src/Dto/Output/OgLiveOutput.php index 44f0b53..04e846d 100644 --- a/src/Dto/Output/OgLiveOutput.php +++ b/src/Dto/Output/OgLiveOutput.php @@ -11,48 +11,108 @@ use Symfony\Component\Serializer\Annotation\Groups; final class OgLiveOutput extends AbstractOutput { #[Groups(['og-live:read', 'client:read', "organizational-unit:read"])] + #[ApiProperty( + description: 'El nombre de la imagen OGLive', + example: 'ogLive-5.2.0' + )] public ?string $name = ''; #[Groups(['og-live:read'])] + #[ApiProperty( + description: 'Indica si la imagen está sincronizada', + example: true + )] public ?bool $synchronized = false; #[Groups(['og-live:read'])] + #[ApiProperty( + description: 'Indica si la imagen está instalada', + example: true + )] public ?bool $installed = false; #[Groups(['og-live:read'])] + #[ApiProperty( + description: 'Indica si es la imagen OGLive predeterminada', + example: true + )] public ?bool $isDefault = false; #[Groups(['og-live:read'])] + #[ApiProperty( + description: 'URL de descarga de la imagen', + example: 'https://opengnsys.es/svn/branches/version1.1/installer/ogLive-5.2.0-r6374.iso' + )] public ?string $downloadUrl = ''; #[Groups(['og-live:read'])] + #[ApiProperty( + description: 'El estado de la imagen', + example: 'synchronized' + )] public ?string $status = ''; #[Groups(['og-live:read'])] + #[ApiProperty( + description: 'Suma de verificación de la imagen', + example: 'a1b2c3d4e5f6...' + )] public ?string $checksum = ''; #[Groups(['og-live:read'])] + #[ApiProperty( + description: 'La distribución de Linux', + example: 'Ubuntu' + )] public ?string $distribution = ''; #[Groups(['og-live:read'])] + #[ApiProperty( + description: 'La revisión de la imagen', + example: 'r6374' + )] public ?string $revision = ''; #[Groups(['og-live:read', 'client:read', "organizational-unit:read"])] + #[ApiProperty( + description: 'El nombre del archivo de la imagen', + example: 'ogLive-5.2.0-r6374.iso' + )] public ?string $filename = null; #[Groups(['og-live:read', 'client:read', "organizational-unit:read"])] + #[ApiProperty( + description: 'La versión del kernel', + example: '5.4.0-42-generic' + )] public ?string $kernel = ''; #[Groups(['og-live:read'])] + #[ApiProperty( + description: 'La arquitectura del sistema', + example: 'amd64' + )] public ?string $architecture = ''; #[Groups(['og-live:read'])] + #[ApiProperty( + description: 'Fecha de creación del registro', + example: '2024-01-15T10:30:00+00:00' + )] public \DateTime $createdAt; #[Groups(['og-live:read', 'client:read', "organizational-unit:read"])] + #[ApiProperty( + description: 'Fecha de la imagen', + example: '2024-01-10T00:00:00+00:00' + )] public ?\DateTimeInterface $date; #[Groups(['og-live:read'])] + #[ApiProperty( + description: 'Usuario que creó este registro', + example: 'admin' + )] public ?string $createdBy = null; public function __construct(OgLive $ogLive) diff --git a/src/Dto/Output/OperativeSystemOutput.php b/src/Dto/Output/OperativeSystemOutput.php index fac3ef1..7cd46bb 100644 --- a/src/Dto/Output/OperativeSystemOutput.php +++ b/src/Dto/Output/OperativeSystemOutput.php @@ -2,6 +2,7 @@ namespace App\Dto\Output; +use ApiPlatform\Metadata\ApiProperty; use ApiPlatform\Metadata\Get; use App\Entity\OperativeSystem; use Symfony\Component\Serializer\Annotation\Groups; @@ -10,12 +11,24 @@ use Symfony\Component\Serializer\Annotation\Groups; final class OperativeSystemOutput extends AbstractOutput { #[Groups(['operative-system:read', 'partition:read', 'software-profile:read', 'client:read'])] + #[ApiProperty( + description: 'El nombre del sistema operativo', + example: 'Windows 10 Pro' + )] public string $name; #[Groups(['operative-system:read'])] + #[ApiProperty( + description: 'Fecha de creación del sistema operativo', + example: '2024-01-15T10:30:00+00:00' + )] public \DateTime $createdAt; #[Groups(['operative-system:read'])] + #[ApiProperty( + description: 'Usuario que creó este registro', + example: 'admin' + )] public ?string $createdBy = null; public function __construct(OperativeSystem $operativeSystem) diff --git a/src/Dto/Output/OrganizationalUnitOutput.php b/src/Dto/Output/OrganizationalUnitOutput.php index d3705bd..290f0ad 100644 --- a/src/Dto/Output/OrganizationalUnitOutput.php +++ b/src/Dto/Output/OrganizationalUnitOutput.php @@ -12,59 +12,129 @@ use Symfony\Component\Serializer\Annotation\Groups; final class OrganizationalUnitOutput extends AbstractOutput { #[Groups(['organizational-unit:read', "client:read", "user:read", 'organizational-unit:read:collection:short', 'software-profile:read', 'command-task:read'])] + #[ApiProperty( + description: 'El nombre de la unidad organizativa', + example: 'Aula 1' + )] public string $name; #[Groups(['organizational-unit:read'])] + #[ApiProperty( + description: 'Comentarios adicionales', + example: 'Aula de informática equipada con 30 equipos' + )] public ?string $comments = null; #[Groups(['organizational-unit:read'])] + #[ApiProperty( + description: 'La descripción de la unidad organizativa', + example: 'Aula de informática principal' + )] public ?string $description = null; #[Groups(['organizational-unit:read'])] + #[ApiProperty( + description: 'La ubicación física', + example: 'Planta baja, edificio A' + )] public ?string $location = null; #[Groups(['organizational-unit:read'])] + #[ApiProperty( + description: 'Indica si tiene proyector', + example: true + )] public ?bool $projector = null; #[Groups(['organizational-unit:read'])] + #[ApiProperty( + description: 'Indica si tiene pizarra digital', + example: false + )] public ?bool $board = null; #[Groups(['organizational-unit:read'])] + #[ApiProperty( + description: 'La capacidad de la unidad organizativa', + example: 30 + )] public ?int $capacity = null; #[Groups(['organizational-unit:read', "client:read"])] + #[ApiProperty( + description: 'El tipo de unidad organizativa', + example: 'aula' + )] public string $type; #[Groups(['organizational-unit:read'])] + #[ApiProperty( + description: 'La unidad organizativa padre', + example: null + )] public ?self $parent = null; #[Groups(['organizational-unit:read', 'client:read', 'organizational-unit:read:collection:short'])] + #[ApiProperty( + description: 'La ruta completa de la unidad organizativa', + example: '/Edificio A/Planta Baja/Aula 1' + )] public string $path; #[Groups(['organizational-unit:read', "client:read"])] - #[ApiProperty(readableLink: true)] + #[ApiProperty( + description: 'La configuración de red de la unidad organizativa', + readableLink: true + )] public ?NetworkSettingsOutput $networkSettings = null; #[Groups(['organizational-unit:read'])] + #[ApiProperty( + description: 'Las unidades organizativas hijas', + example: [] + )] public array $children = []; #[Groups(['organizational-unit:read', "client:read"])] - #[ApiProperty(readableLink: true)] + #[ApiProperty( + description: 'El calendario remoto asociado', + readableLink: true + )] public ?RemoteCalendarOutput $remoteCalendar = null; #[Groups(['organizational-unit:read'])] + #[ApiProperty( + description: 'Indica si es un PC remoto', + example: false + )] public ?bool $remotePc = null; #[Groups(['organizational-unit:read'])] + #[ApiProperty( + description: 'Indica si está disponible según el calendario', + example: true + )] public ?bool $available = null; #[Groups(['organizational-unit:read'])] + #[ApiProperty( + description: 'Indica si excluye cambios del padre', + example: false + )] public ?bool $excludeParentChanges = null; #[Groups(['organizational-unit:read'])] + #[ApiProperty( + description: 'Fecha de creación de la unidad organizativa', + example: '2024-01-15T10:30:00+00:00' + )] public \DateTime $createdAt; #[Groups(['organizational-unit:read'])] + #[ApiProperty( + description: 'Usuario que creó este registro', + example: 'admin' + )] public ?string $createdBy = null; public function __construct(OrganizationalUnit $organizationalUnit, array $context = []) diff --git a/src/Dto/Output/PartitionOutput.php b/src/Dto/Output/PartitionOutput.php index 394abcb..76e55e2 100644 --- a/src/Dto/Output/PartitionOutput.php +++ b/src/Dto/Output/PartitionOutput.php @@ -2,6 +2,7 @@ namespace App\Dto\Output; +use ApiPlatform\Metadata\ApiProperty; use ApiPlatform\Metadata\Get; use App\Entity\ImageImageRepository; use App\Entity\Partition; @@ -11,30 +12,66 @@ use Symfony\Component\Serializer\Annotation\Groups; class PartitionOutput extends AbstractOutput { #[Groups(['partition:read', 'client:read'])] + #[ApiProperty( + description: 'El número del disco', + example: 1 + )] public ?int $diskNumber = null; #[Groups(['partition:read', 'client:read'])] + #[ApiProperty( + description: 'El número de la partición', + example: 1 + )] public ?int $partitionNumber = null; #[Groups(['partition:read', 'client:read'])] + #[ApiProperty( + description: 'El código del tipo de partición', + example: '83' + )] public ?string $partitionCode = null; #[Groups(['partition:read', 'client:read'])] + #[ApiProperty( + description: 'El tamaño de la partición en MB', + example: 51200 + )] public ?int $size = null; #[Groups(['partition:read', 'client:read'])] + #[ApiProperty( + description: 'El contenido de la caché', + example: 'system' + )] public ?string $cacheContent = null; #[Groups(['partition:read', 'client:read'])] + #[ApiProperty( + description: 'El sistema de archivos', + example: 'ext4' + )] public ?string $filesystem = null; #[Groups(['partition:read', 'client:read'])] + #[ApiProperty( + description: 'El sistema operativo instalado en la partición', + example: null + )] public ?OperativeSystemOutput $operativeSystem = null; #[Groups(['partition:read', 'client:read'])] + #[ApiProperty( + description: 'La imagen asociada a la partición', + example: null + )] public ?ImageImageRepositoryOutput $image = null; #[Groups(['partition:read', 'client:read'])] + #[ApiProperty( + description: 'El porcentaje de uso de memoria', + example: 45 + )] public ?int $memoryUsage = null; public function __construct(Partition $partition) diff --git a/src/Dto/Output/PxeTemplateOutput.php b/src/Dto/Output/PxeTemplateOutput.php index f625215..87c3578 100644 --- a/src/Dto/Output/PxeTemplateOutput.php +++ b/src/Dto/Output/PxeTemplateOutput.php @@ -12,24 +12,52 @@ use Symfony\Component\Serializer\Annotation\Groups; final class PxeTemplateOutput extends AbstractOutput { #[Groups(['pxe-template:read', 'client:read', 'organizational-unit:read'])] + #[ApiProperty( + description: 'El nombre de la plantilla PXE', + example: 'Plantilla BIOS' + )] public string $name; #[Groups(['pxe-template:read'])] + #[ApiProperty( + description: 'Indica si la plantilla está sincronizada', + example: true + )] public ?bool $synchronized = null; #[Groups(['pxe-template:read'])] + #[ApiProperty( + description: 'El contenido de la plantilla PXE', + example: 'DEFAULT ogLive\nPROMPT 0\nTIMEOUT 0...' + )] public ?string $templateContent = ''; #[Groups(['pxe-template:read'])] + #[ApiProperty( + description: 'Indica si es la plantilla predeterminada', + example: true + )] public ?bool $isDefault = null; #[Groups(['pxe-template:read'])] + #[ApiProperty( + description: 'El número de clientes que usan esta plantilla', + example: 15 + )] public ?int $clientsLength = 0; #[Groups(['pxe-template:read'])] + #[ApiProperty( + description: 'Fecha de creación de la plantilla', + example: '2024-01-15T10:30:00+00:00' + )] public \DateTime $createdAt; #[Groups(['pxe-template:read'])] + #[ApiProperty( + description: 'Usuario que creó este registro', + example: 'admin' + )] public ?string $createdBy = null; public function __construct(PxeTemplate $pxeTemplate) diff --git a/src/Dto/Output/RemoteCalendarOutput.php b/src/Dto/Output/RemoteCalendarOutput.php index b079f8a..52d80b7 100644 --- a/src/Dto/Output/RemoteCalendarOutput.php +++ b/src/Dto/Output/RemoteCalendarOutput.php @@ -2,6 +2,7 @@ namespace App\Dto\Output; +use ApiPlatform\Metadata\ApiProperty; use ApiPlatform\Metadata\Get; use App\Entity\RemoteCalendar; use App\Entity\RemoteCalendarRule; @@ -11,15 +12,27 @@ use Symfony\Component\Serializer\Annotation\Groups; final class RemoteCalendarOutput extends AbstractOutput { #[Groups(['remote-calendar:read', 'organizational-unit:read'])] + #[ApiProperty( + description: 'El nombre del calendario remoto', + example: 'Horario Escolar' + )] public ?string $name = null; /** * @var RemoteCalendarRuleOutput[] */ #[Groups(['remote-calendar:read'])] + #[ApiProperty( + description: 'Las reglas del calendario remoto', + example: [] + )] public array $remoteCalendarRules = []; #[Groups(['remote-calendar:read'])] + #[ApiProperty( + description: 'Fecha de creación del calendario', + example: '2024-01-15T10:30:00+00:00' + )] public ?\DateTimeInterface $createdAt = null; public function __construct(RemoteCalendar $remoteCalendar) diff --git a/src/Dto/Output/RemoteCalendarRuleOutput.php b/src/Dto/Output/RemoteCalendarRuleOutput.php index 9617599..894498e 100644 --- a/src/Dto/Output/RemoteCalendarRuleOutput.php +++ b/src/Dto/Output/RemoteCalendarRuleOutput.php @@ -2,6 +2,7 @@ namespace App\Dto\Output; +use ApiPlatform\Metadata\ApiProperty; use ApiPlatform\Metadata\Get; use App\Entity\RemoteCalendarRule; use Symfony\Component\Serializer\Annotation\Groups; @@ -10,24 +11,52 @@ use Symfony\Component\Serializer\Annotation\Groups; final class RemoteCalendarRuleOutput extends AbstractOutput { #[Groups(['remote-calendar-rule:read', 'remote-calendar:read'])] + #[ApiProperty( + description: 'Los días de la semana ocupados', + example: ['monday', 'wednesday', 'friday'] + )] public ?array $busyWeekDays = null; #[Groups(['remote-calendar-rule:read', 'remote-calendar:read'])] + #[ApiProperty( + description: 'Hora de inicio del periodo ocupado', + example: '08:00' + )] public ?string $busyFromHour = null; #[Groups(['remote-calendar-rule:read', 'remote-calendar:read'])] + #[ApiProperty( + description: 'Hora de fin del periodo ocupado', + example: '14:00' + )] public ?string $busyToHour = null; #[Groups(['remote-calendar-rule:read', 'remote-calendar:read'])] + #[ApiProperty( + description: 'Indica si está disponible para acceso remoto', + example: true + )] public ?bool $isRemoteAvailable = false; #[Groups(['remote-calendar-rule:read', 'remote-calendar:read'])] + #[ApiProperty( + description: 'Fecha desde la que está disponible', + example: '2024-01-15T00:00:00+00:00' + )] public ?\DateTimeInterface $availableFromDate = null; #[Groups(['remote-calendar-rule:read', 'remote-calendar:read'])] + #[ApiProperty( + description: 'Fecha hasta la que está disponible', + example: '2024-06-30T23:59:59+00:00' + )] public ?\DateTimeInterface $availableToDate = null; #[Groups(['remote-calendar-rule:read', 'remote-calendar:read'])] + #[ApiProperty( + description: 'El motivo de la disponibilidad', + example: 'Periodo lectivo' + )] public ?string $availableReason = null; public function __construct(RemoteCalendarRule $remoteCalendarRule) diff --git a/src/Dto/Output/SoftwareOutput.php b/src/Dto/Output/SoftwareOutput.php index 20da642..cf84134 100644 --- a/src/Dto/Output/SoftwareOutput.php +++ b/src/Dto/Output/SoftwareOutput.php @@ -11,18 +11,38 @@ use Symfony\Component\Serializer\Annotation\Groups; final class SoftwareOutput extends AbstractOutput { #[Groups(['software:read', 'software-profile:read'])] + #[ApiProperty( + description: 'El nombre del software', + example: 'Microsoft Office 2019' + )] public string $name; #[Groups(['software:read'])] + #[ApiProperty( + description: 'La descripción del software', + example: 'Suite de oficina completa' + )] public ?string $description = ''; #[Groups(['software:read', 'software-profile:read'])] + #[ApiProperty( + description: 'El tipo de software', + example: 'productivity' + )] public ?string $type = ''; #[Groups(['software:read'])] + #[ApiProperty( + description: 'Fecha de creación del software', + example: '2024-01-15T10:30:00+00:00' + )] public \DateTime $createdAt; #[Groups(['software:read'])] + #[ApiProperty( + description: 'Usuario que creó este registro', + example: 'admin' + )] public ?string $createdBy = null; public function __construct(Software $software) diff --git a/src/Dto/Output/SoftwareProfileOutput.php b/src/Dto/Output/SoftwareProfileOutput.php index 1b2f423..b3945bf 100644 --- a/src/Dto/Output/SoftwareProfileOutput.php +++ b/src/Dto/Output/SoftwareProfileOutput.php @@ -12,24 +12,52 @@ use Symfony\Component\Serializer\Annotation\Groups; final class SoftwareProfileOutput extends AbstractOutput { #[Groups(['software-profile:read', 'image:read'])] + #[ApiProperty( + description: 'La descripción del perfil de software', + example: 'Perfil estándar para aula de informática' + )] public ?string $description = ''; #[Groups(['software-profile:read'])] + #[ApiProperty( + description: 'Comentarios adicionales sobre el perfil', + example: 'Incluye software educativo básico' + )] public ?string $comments = ''; #[Groups(['software-profile:read'])] + #[ApiProperty( + description: 'La unidad organizativa asociada', + example: null + )] public ?OrganizationalUnitOutput $organizationalUnit = null; #[Groups(['software-profile:read'])] + #[ApiProperty( + description: 'El sistema operativo base del perfil', + example: null + )] public ?OperativeSystemOutput $operativeSystem = null; #[Groups(['software-profile:item:get'])] + #[ApiProperty( + description: 'La colección de software incluido en el perfil', + example: [] + )] public ?array $softwareCollection = []; #[Groups(['software-profile:read'])] + #[ApiProperty( + description: 'Fecha de creación del perfil de software', + example: '2024-01-15T10:30:00+00:00' + )] public \DateTime $createdAt; #[Groups(['software-profile:read'])] + #[ApiProperty( + description: 'Usuario que creó este registro', + example: 'admin' + )] public ?string $createdBy = null; public function __construct(SoftwareProfile $softwareProfile) diff --git a/src/Dto/Output/SubnetOutput.php b/src/Dto/Output/SubnetOutput.php index 672e6d1..7ac8868 100644 --- a/src/Dto/Output/SubnetOutput.php +++ b/src/Dto/Output/SubnetOutput.php @@ -13,36 +13,80 @@ use Symfony\Component\Serializer\Annotation\Groups; final class SubnetOutput extends AbstractOutput { #[Groups(['subnet:read'])] + #[ApiProperty( + description: 'El nombre de la subred', + example: 'Subred Principal' + )] public string $name; #[Groups(['subnet:read'])] + #[ApiProperty( + description: 'La máscara de subred', + example: '255.255.255.0' + )] public string $netmask; #[Groups(['subnet:read'])] + #[ApiProperty( + description: 'La dirección IP de la subred', + example: '192.168.1.0' + )] public string $ipAddress; #[Groups(['subnet:read'])] + #[ApiProperty( + description: 'La dirección del servidor TFTP siguiente', + example: '192.168.1.10' + )] public ?string $nextServer = null; #[Groups(['subnet:read'])] + #[ApiProperty( + description: 'El nombre del archivo de arranque', + example: 'pxelinux.0' + )] public ?string $bootFileName = null; #[Groups(['subnet:read'])] + #[ApiProperty( + description: 'La dirección del router/gateway', + example: '192.168.1.1' + )] public ?string $router = null; #[Groups(['subnet:read'])] + #[ApiProperty( + description: 'La dirección del servidor DNS', + example: '8.8.8.8' + )] public ?string $dns = null; #[Groups(['subnet:read'])] + #[ApiProperty( + description: 'Indica si la subred está sincronizada', + example: true + )] public ?bool $synchronized = false; #[Groups(['subnet:read'])] + #[ApiProperty( + description: 'El ID del servidor DHCP', + example: 1 + )] public ?int $serverId; #[Groups(['subnet:read'])] + #[ApiProperty( + description: 'Fecha de creación de la subred', + example: '2024-01-15T10:30:00+00:00' + )] public \DateTime $createdAt; #[Groups(['subnet:read'])] + #[ApiProperty( + description: 'Usuario que creó este registro', + example: 'admin' + )] public ?string $createdBy = null; public function __construct(Subnet $subnet) diff --git a/src/Dto/Output/TraceOutput.php b/src/Dto/Output/TraceOutput.php index 94bd188..21f3214 100644 --- a/src/Dto/Output/TraceOutput.php +++ b/src/Dto/Output/TraceOutput.php @@ -2,6 +2,7 @@ namespace App\Dto\Output; +use ApiPlatform\Metadata\ApiProperty; use ApiPlatform\Metadata\Get; use App\Entity\Menu; use App\Entity\Trace; @@ -11,36 +12,80 @@ use Symfony\Component\Serializer\Annotation\Groups; final class TraceOutput extends AbstractOutput { #[Groups(['trace:read'])] + #[ApiProperty( + description: 'El comando ejecutado', + example: 'Reiniciar sistema' + )] public ?string $command; #[Groups(['trace:read'])] + #[ApiProperty( + description: 'El cliente sobre el que se ejecutó el comando', + example: null + )] public ?ClientOutput $client = null; #[Groups(['trace:read'])] + #[ApiProperty( + description: 'El estado de la traza', + example: 'completed' + )] public string $status; #[Groups(['trace:read'])] + #[ApiProperty( + description: 'El ID del trabajo asociado', + example: 'job-12345' + )] public ?string $jobId = null; #[Groups(['trace:read'])] + #[ApiProperty( + description: 'Fecha de ejecución del comando', + example: '2024-01-15T10:30:00+00:00' + )] public ?\DateTimeInterface $executedAt = null; #[Groups(['trace:read'])] + #[ApiProperty( + description: 'La salida del comando ejecutado', + example: 'Sistema reiniciado correctamente' + )] public ?string $output = null; #[Groups(['trace:read'])] + #[ApiProperty( + description: 'Los parámetros de entrada del comando', + example: [] + )] public ?array $input = null; #[Groups(['trace:read'])] + #[ApiProperty( + description: 'Fecha de finalización del comando', + example: '2024-01-15T10:31:00+00:00' + )] public ?\DateTimeInterface $finishedAt = null; #[Groups(['trace:read'])] + #[ApiProperty( + description: 'El progreso de ejecución (0.0 a 1.0)', + example: 1.0 + )] public ?float $progress = null; #[Groups(['trace:read'])] + #[ApiProperty( + description: 'Fecha de creación de la traza', + example: '2024-01-15T10:30:00+00:00' + )] public \DateTime $createdAt; #[Groups(['trace:read'])] + #[ApiProperty( + description: 'Usuario que creó este registro', + example: 'admin' + )] public ?string $createdBy = null; public function __construct(Trace $trace) diff --git a/src/Dto/Output/UserGroupOutput.php b/src/Dto/Output/UserGroupOutput.php index 3892d4b..22e0a81 100644 --- a/src/Dto/Output/UserGroupOutput.php +++ b/src/Dto/Output/UserGroupOutput.php @@ -2,6 +2,7 @@ namespace App\Dto\Output; +use ApiPlatform\Metadata\ApiProperty; use ApiPlatform\Metadata\Get; use App\Entity\User; use App\Entity\UserGroup; @@ -11,18 +12,38 @@ use Symfony\Component\Serializer\Annotation\Groups; final class UserGroupOutput extends AbstractOutput { #[Groups(['user-group:read', 'user:read'])] + #[ApiProperty( + description: 'El nombre del grupo de usuarios', + example: 'Administradores' + )] public string $name; #[Groups(['user-group:read'])] + #[ApiProperty( + description: 'Los permisos asignados al grupo', + example: ['clients.read', 'clients.write', 'images.read'] + )] public array $permissions; #[Groups(['user-group:read'])] + #[ApiProperty( + description: 'Indica si el grupo está habilitado', + example: true + )] public bool $enabled; #[Groups(['user-group:read'])] + #[ApiProperty( + description: 'Fecha de creación del grupo de usuarios', + example: '2024-01-15T10:30:00+00:00' + )] public \DateTime $createdAt; #[Groups(['user-group:read'])] + #[ApiProperty( + description: 'Usuario que creó este registro', + example: 'admin' + )] public ?string $createdBy = null; public function __construct(UserGroup $userGroup) diff --git a/src/Dto/Output/UserOutput.php b/src/Dto/Output/UserOutput.php index afa038f..c67c8fc 100644 --- a/src/Dto/Output/UserOutput.php +++ b/src/Dto/Output/UserOutput.php @@ -2,6 +2,7 @@ namespace App\Dto\Output; +use ApiPlatform\Metadata\ApiProperty; use ApiPlatform\Metadata\Get; use App\Entity\OrganizationalUnit; use App\Entity\User; @@ -12,24 +13,59 @@ use Symfony\Component\Serializer\Annotation\Groups; final class UserOutput extends AbstractOutput { #[Groups(['user:read'])] + #[ApiProperty( + description: 'El nombre de usuario', + example: 'admin' + )] public string $username; #[Groups(['user:read'])] + #[ApiProperty( + description: 'Los roles asignados al usuario', + example: ['ROLE_USER', 'ROLE_ADMIN'] + )] public array $roles; #[Groups(['user:read'])] + #[ApiProperty( + description: 'Indica si el usuario está habilitado', + example: true + )] public bool $enabled; + #[Groups(['user:read'])] + #[ApiProperty( + description: 'Las unidades organizativas permitidas para el usuario', + example: [] + )] public array $allowedOrganizationalUnits; + #[Groups(['user:read'])] + #[ApiProperty( + description: 'Los grupos de usuario asignados', + example: [] + )] public array $userGroups; + #[Groups(['user:read'])] + #[ApiProperty( + description: 'La vista por defecto de grupos para el usuario', + example: 'card' + )] public ?string $groupsView = 'card'; #[Groups(['user:read'])] + #[ApiProperty( + description: 'Fecha de creación del usuario', + example: '2024-01-15T10:30:00+00:00' + )] public \DateTime $createdAt; #[Groups(['user:read'])] + #[ApiProperty( + description: 'Usuario que creó este registro', + example: 'admin' + )] public ?string $createdBy = null; public function __construct(User $user) diff --git a/src/Dto/Output/ViewOutput.php b/src/Dto/Output/ViewOutput.php index e2f17bb..d8a9837 100644 --- a/src/Dto/Output/ViewOutput.php +++ b/src/Dto/Output/ViewOutput.php @@ -2,6 +2,7 @@ namespace App\Dto\Output; +use ApiPlatform\Metadata\ApiProperty; use ApiPlatform\Metadata\Get; use App\Entity\View; use Symfony\Component\Serializer\Annotation\Groups; @@ -10,12 +11,24 @@ use Symfony\Component\Serializer\Annotation\Groups; final class ViewOutput extends AbstractOutput { #[Groups(['view:read'])] + #[ApiProperty( + description: 'El nombre de la vista', + example: 'Mi Vista Personalizada' + )] public string $name; #[Groups(['view:read'])] + #[ApiProperty( + description: 'Indica si es una vista favorita', + example: true + )] public bool $favorite; #[Groups(['view:read'])] + #[ApiProperty( + description: 'Los filtros aplicados en la vista', + example: [] + )] public ?array $filters = null; public function __construct(View $view) diff --git a/src/Factory/ClientFactory.php b/src/Factory/ClientFactory.php index b8f4b89..902955c 100644 --- a/src/Factory/ClientFactory.php +++ b/src/Factory/ClientFactory.php @@ -3,6 +3,7 @@ namespace App\Factory; use App\Entity\Client; +use App\Model\OrganizationalUnitTypes; use Zenstruck\Foundry\ModelFactory; use Zenstruck\Foundry\Persistence\PersistentProxyObjectFactory; @@ -33,6 +34,7 @@ final class ClientFactory extends ModelFactory 'name' => self::faker()->text(255), 'updatedAt' => self::faker()->dateTime(), 'maintenance' => self::faker()->boolean(), + 'organizationalUnit' => OrganizationalUnitFactory::createOne(['type' => OrganizationalUnitTypes::ORGANIZATIONAL_UNIT])->_save(), ]; } diff --git a/src/Factory/HardwareProfileFactory.php b/src/Factory/HardwareProfileFactory.php index fe3148b..13021dc 100644 --- a/src/Factory/HardwareProfileFactory.php +++ b/src/Factory/HardwareProfileFactory.php @@ -38,7 +38,7 @@ final class HardwareProfileFactory extends ModelFactory 'createdAt' => self::faker()->dateTime(), 'updatedAt' => self::faker()->dateTime(), 'description' => self::faker()->text(255), - 'organizationalUnit' => OrganizationalUnitFactory::createOne(['type' => OrganizationalUnitTypes::ORGANIZATIONAL_UNIT])->_save(), + 'client' => ClientFactory::new(), ]; } diff --git a/tests/Functional/ClientTest.php b/tests/Functional/ClientTest.php index c09b047..20efdda 100644 --- a/tests/Functional/ClientTest.php +++ b/tests/Functional/ClientTest.php @@ -3,17 +3,10 @@ namespace Functional; use App\Entity\Client; -use App\Entity\HardwareProfile; -use App\Entity\HardwareType; use App\Entity\OrganizationalUnit; -use App\Entity\User; -use App\Entity\UserGroup; use App\Factory\ClientFactory; -use App\Factory\HardwareProfileFactory; -use App\Factory\HardwareTypeFactory; use App\Factory\OrganizationalUnitFactory; use App\Factory\UserFactory; -use App\Factory\UserGroupFactory; use App\Model\OrganizationalUnitTypes; use App\Model\UserGroupPermissions; use Symfony\Component\HttpFoundation\Response; @@ -29,7 +22,6 @@ class ClientTest extends AbstractTest CONST string CLIENT_CREATE = 'test-client-create'; CONST string CLIENT_UPDATE = 'test-client-update'; CONST string CLIENT_DELETE = 'test-client-delete'; - const string HW_PROFILE = 'HW Test'; /** * @throws RedirectionExceptionInterface @@ -71,13 +63,9 @@ class ClientTest extends AbstractTest OrganizationalUnitFactory::createOne(['type' => OrganizationalUnitTypes::ORGANIZATIONAL_UNIT]); $ouIri = $this->findIriBy(OrganizationalUnit::class, ['type' => OrganizationalUnitTypes::ORGANIZATIONAL_UNIT]); - HardwareProfileFactory::createOne(['description' => self::HW_PROFILE]); - $hpIri = $this->findIriBy(HardwareProfile::class, ['description' => self::HW_PROFILE]); - $this->createClientWithCredentials()->request('POST', '/clients',['json' => [ 'name' => self::CLIENT_CREATE, 'organizationalUnit' => $ouIri, - 'hardwareProfile' => $hpIri, 'serialNumber' => '123abc', ]]); @@ -103,9 +91,8 @@ class ClientTest extends AbstractTest UserFactory::createOne(['username' => self::USER_ADMIN, 'roles'=> [UserGroupPermissions::ROLE_SUPER_ADMIN]]); $ou = OrganizationalUnitFactory::createOne(['type' => OrganizationalUnitTypes::ORGANIZATIONAL_UNIT]); - $hp = HardwareProfileFactory::createOne(['description' => self::HW_PROFILE]); - ClientFactory::createOne(['name' => self::CLIENT_UPDATE, 'serialNumber' => '123abc', 'organizationalUnit' => $ou, 'hardwareProfile' => $hp]); + ClientFactory::createOne(['name' => self::CLIENT_UPDATE, 'serialNumber' => '123abc', 'organizationalUnit' => $ou]); $iri = $this->findIriBy(Client::class, ['name' => self::CLIENT_UPDATE]); $this->createClientWithCredentials()->request('PUT', $iri, ['json' => [ @@ -133,9 +120,8 @@ class ClientTest extends AbstractTest UserFactory::createOne(['username' => self::USER_ADMIN, 'roles'=> [UserGroupPermissions::ROLE_SUPER_ADMIN]]); $ou = OrganizationalUnitFactory::createOne(['type' => OrganizationalUnitTypes::ORGANIZATIONAL_UNIT]); - $hp = HardwareProfileFactory::createOne(['description' => self::HW_PROFILE]); - ClientFactory::createOne(['name' => self::CLIENT_DELETE, 'serialNumber' => '123abc', 'organizationalUnit' => $ou, 'hardwareProfile' => $hp]); + ClientFactory::createOne(['name' => self::CLIENT_DELETE, 'serialNumber' => '123abc', 'organizationalUnit' => $ou]); $iri = $this->findIriBy(Client::class, ['name' => self::CLIENT_DELETE]); $this->createClientWithCredentials()->request('DELETE', $iri); diff --git a/tests/Functional/HardwareProfileTest.php b/tests/Functional/HardwareProfileTest.php index 6d710b8..c4833aa 100644 --- a/tests/Functional/HardwareProfileTest.php +++ b/tests/Functional/HardwareProfileTest.php @@ -3,12 +3,11 @@ namespace Functional; +use App\Entity\Client; use App\Entity\HardwareProfile; -use App\Entity\OrganizationalUnit; +use App\Factory\ClientFactory; use App\Factory\HardwareProfileFactory; -use App\Factory\OrganizationalUnitFactory; use App\Factory\UserFactory; -use App\Model\OrganizationalUnitTypes; use App\Model\UserGroupPermissions; use Symfony\Component\HttpFoundation\Response; use Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface; @@ -59,12 +58,12 @@ class HardwareProfileTest extends AbstractTest { UserFactory::createOne(['username' => self::USER_ADMIN, 'roles'=> [UserGroupPermissions::ROLE_SUPER_ADMIN]]); - OrganizationalUnitFactory::createOne(['type' => OrganizationalUnitTypes::ORGANIZATIONAL_UNIT]); - $ouIri = $this->findIriBy(OrganizationalUnit::class, ['type' => OrganizationalUnitTypes::ORGANIZATIONAL_UNIT]); + ClientFactory::createOne(['name' => 'test-client']); + $clientIri = $this->findIriBy(Client::class, ['name' => 'test-client']); $this->createClientWithCredentials()->request('POST', '/hardware-profiles',['json' => [ 'description' => self::HW_PROFILE_CREATE, - 'organizationalUnit' => $ouIri + 'client' => $clientIri ]]); $this->assertResponseStatusCodeSame(201); diff --git a/tests/Functional/ImageRepositoryTest.php b/tests/Functional/ImageRepositoryTest.php index da616c6..0bdce48 100644 --- a/tests/Functional/ImageRepositoryTest.php +++ b/tests/Functional/ImageRepositoryTest.php @@ -2,19 +2,9 @@ namespace Functional; -use App\Entity\Client; -use App\Entity\HardwareProfile; use App\Entity\ImageRepository; -use App\Entity\Menu; -use App\Entity\OrganizationalUnit; -use App\Entity\User; -use App\Factory\ClientFactory; -use App\Factory\HardwareProfileFactory; use App\Factory\ImageRepositoryFactory; -use App\Factory\MenuFactory; -use App\Factory\OrganizationalUnitFactory; use App\Factory\UserFactory; -use App\Model\OrganizationalUnitTypes; use App\Model\UserGroupPermissions; use Symfony\Component\HttpFoundation\Response; use Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface; diff --git a/tests/Functional/MenuTest.php b/tests/Functional/MenuTest.php index ffdd305..8154c56 100644 --- a/tests/Functional/MenuTest.php +++ b/tests/Functional/MenuTest.php @@ -2,17 +2,9 @@ namespace Functional; -use App\Entity\Client; -use App\Entity\HardwareProfile; use App\Entity\Menu; -use App\Entity\OrganizationalUnit; -use App\Entity\User; -use App\Factory\ClientFactory; -use App\Factory\HardwareProfileFactory; use App\Factory\MenuFactory; -use App\Factory\OrganizationalUnitFactory; use App\Factory\UserFactory; -use App\Model\OrganizationalUnitTypes; use App\Model\UserGroupPermissions; use Symfony\Component\HttpFoundation\Response; use Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface; diff --git a/tests/Functional/OgLiveTest.php b/tests/Functional/OgLiveTest.php index 883b9a1..01e9834 100644 --- a/tests/Functional/OgLiveTest.php +++ b/tests/Functional/OgLiveTest.php @@ -2,11 +2,7 @@ namespace Functional; -use App\Entity\Client; -use App\Entity\HardwareProfile; use App\Entity\OgLive; -use App\Entity\User; -use App\Factory\HardwareProfileFactory; use App\Factory\OgLiveFactory; use App\Factory\UserFactory; use App\Model\OgLiveStatus; diff --git a/tests/Functional/PartitionTest.php b/tests/Functional/PartitionTest.php index 859bba0..4168a8c 100644 --- a/tests/Functional/PartitionTest.php +++ b/tests/Functional/PartitionTest.php @@ -2,20 +2,9 @@ namespace Functional; -use App\Entity\Client; -use App\Entity\Image; -use App\Entity\Menu; -use App\Entity\OperativeSystem; use App\Entity\Partition; -use App\Factory\ClientFactory; -use App\Factory\HardwareProfileFactory; -use App\Factory\ImageFactory; -use App\Factory\MenuFactory; -use App\Factory\OperativeSystemFactory; -use App\Factory\OrganizationalUnitFactory; use App\Factory\PartitionFactory; use App\Factory\UserFactory; -use App\Model\OrganizationalUnitTypes; use App\Model\UserGroupPermissions; use Symfony\Component\HttpFoundation\Response; use Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface; @@ -27,9 +16,6 @@ use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface; class PartitionTest extends AbstractTest { CONST string USER_ADMIN = 'ogadmin'; - CONST string CLIENT_CREATE = 'test-client-create'; - - const string HW_PROFILE = 'HW Test'; /** * @throws RedirectionExceptionInterface diff --git a/tests/Functional/ViewTest.php b/tests/Functional/ViewTest.php index 5a0b016..ccdd769 100644 --- a/tests/Functional/ViewTest.php +++ b/tests/Functional/ViewTest.php @@ -3,14 +3,9 @@ namespace Functional; -use App\Entity\HardwareProfile; -use App\Entity\OrganizationalUnit; use App\Entity\View; -use App\Factory\HardwareProfileFactory; -use App\Factory\OrganizationalUnitFactory; use App\Factory\UserFactory; use App\Factory\ViewFactory; -use App\Model\OrganizationalUnitTypes; use App\Model\UserGroupPermissions; use Symfony\Component\HttpFoundation\Response; use Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface;