Gestión de servidores y docker compose
Gestor de Instancias de Docker Compose
Fecha de elaboración: 2024-06-15
Versión de la documentación: 1.1
Tabla de contenidos
- Introducción
- Resumen de funcionalidades
- Gestión y visualización de instancias de Docker Compose
- Filtrado de instancias
- Visualización de tarjetas de instancia
- Visualización de nombre
- Visualización de URLs asociadas
- Visualización de estado de contenedores
- Opciones de control de instancia
- Creación de nueva instancia
- Campos para la creación de instancia
- Glosario
- Mejoras, tareas pendientes y roadmap
- Anexos
Introducción
El Gestor de Instancias de Docker Compose es una herramienta diseñada para facilitar la administración y supervisión de múltiples entornos Docker Compose instalados en servidores dedicados. A través de una interfaz gráfica, el usuario puede identificar, visualizar y gestionar información básica de cada instancia configurada.
Resumen de funcionalidades
- Filtrado de instancias de Docker Compose por nombre.
- Visualización de cada instancia como una tarjeta individual.
- Visualización del nombre y las URLs asociadas a cada instancia.
- Visualización del estado de los contenedores de cada instancia (actualmente no funcional).
- Acceso rápido a acciones de control de cada instancia (actualizar, arrancar, parar, reiniciar; actualmente no funcionales).
- Creación de nuevas instancias mediante un formulario interactivo con campos específicos.
Gestión y visualización de instancias de Docker Compose
Filtrado de instancias
Descripción general:
Permite localizar rápidamente instancias de Docker Compose mediante un filtro de búsqueda por nombre.
Opciones y configuraciones: No existen variantes. El filtro acepta cadenas de texto para buscar coincidencias en los nombres de las instancias.
Datos requeridos: Texto de búsqueda (nombre total o parcial de la instancia).
Resultados esperados: Se muestran únicamente las tarjetas correspondientes a instancias cuyos nombres coincidan con el filtro introducido.
Restricciones o límites: El filtrado se realiza únicamente por el campo de nombre. No es sensible a filtros por otros atributos.
Visualización de tarjetas de instancia
Descripción general:
Cada instancia se muestra como una tarjeta individual en la interfaz principal.
Resultados esperados: El usuario observa una tarjeta para cada instancia de Docker Compose identificada en el servidor.
Restricciones o límites: Solo se muestran las instancias detectadas por el sistema. La cantidad de tarjetas puede variar según las instancias configuradas en el servidor.
Visualización de nombre
Descripción general:
Cada tarjeta muestra el nombre asociado a la instancia de Docker Compose correspondiente.
Resultados esperados:
El usuario ve claramente el nombre identificador de cada instancia en su tarjeta respectiva.
Restricciones o límites:
El nombre mostrado corresponde exactamente al configurado para cada instancia.
Visualización de URLs asociadas
Descripción general:
Para cada instancia, se listan dos URLs principales en la tarjeta: una correspondiente a “Odoo” y otra al “Manager de Odoo”.
Opciones y configuraciones: No existen variantes directas.
Datos requeridos:
- URL de Probiodu para la instancia.
- URL del Manager de Odoo de la instancia.
Resultados esperados: Ambas URLs son visibles y accesibles para el usuario desde la tarjeta de la instancia.
Restricciones o límites: Las URLs presentadas son aquellas asociadas a la configuración de la instancia y no pueden ser editadas desde la visualización estándar.
Visualización de estado de contenedores
Descripción general:
Se incluye información sobre el estado de los contenedores de cada instancia de Docker Compose.
Resultados esperados: Actualmente, la funcionalidad de mostrar el estado de los contenedores no se encuentra habilitada.
Restricciones o límites: No se presenta información relativa al estado actualizado de los contenedores. Esta sección está sin funcionamiento.
Opciones de control de instancia
Descripción general:
Cada tarjeta incluye botones para actualizar, arrancar, parar y reiniciar la instancia Docker Compose asociada.
Opciones y configuraciones:
- Actualizar
- Arrancar
- Parar
- Reiniciar
Resultados esperados:
Actualmente, las acciones de los botones mencionados no tienen efecto.
Restricciones o límites:
Estos botones no ejecutan ninguna acción sobre las instancias.
Creación de nueva instancia
Descripción general:
Dispone de un botón de creación que habilita una ventana o formulario para el ingreso de los datos requeridos para una nueva instancia de Docker Compose. Tras completar todos los campos y utilizar el botón correspondiente, se creará una nueva instancia, generando automáticamente su entorno en docker-compose.
Campos para la creación de instancia
Al crear una nueva instancia, se solicitarán los siguientes datos en la ventana de creación:
- Nombre: Identificador de la nueva instancia.
- URL: Dirección web principal asociada a la instancia.
- Tipo de instancia: Selección entre "Test", "Producción" o "Pruebas".
- Versión: Selección de versión entre las disponibles (actualmente de la 13 a la 18).
- Contraseña para el gestor: Contraseña específica que se utilizará para la administración del gestor asociado a la instancia.
- Codificación de la base de datos: Selección del idioma principal en el que estará la base de datos.
- Uso de kiwi.op: Opción para indicar si la instancia utilizará o no la funcionalidad de kiwi.op (marcar o desmarcar).
Tras completar los campos y pulsar el botón de creación, se generará automáticamente la nueva instancia en docker-compose y será visible en el sistema como una nueva tarjeta.
Opciones y configuraciones:
- Selección de tipo de instancia: Test, Producción, Pruebas.
- Selección de versión: 13, 14, 15, 16, 17, 18.
- Configuración del idioma/codificación.
- Activación/desactivación de kiwi.op.
Datos requeridos: Todos los campos mencionados anteriormente.
Resultados esperados: Se crea una nueva instancia de Docker Compose acorde a los datos introducidos por el usuario, y aparece reflejada en la interfaz del sistema.
Restricciones o límites: Los campos requeridos deben estar correctamente completados. La creación queda supeditada a la integridad y validez de los datos proporcionados.
Glosario
- Docker Compose: Herramienta para definir y ejecutar aplicaciones Docker con múltiples contenedores.
- Instancia: Conjunto particular de servicios y contenedores definidos y ejecutados por Docker Compose.
- Manager de Odoo: Interfaz de gestión específica de la instancia de Odoo.
- Codificación de la base de datos: Idioma principal de la base de datos utilizada por la instancia.
- queue job: Componente opcional cuya activación se define en el proceso de creación de la instancia.
Mejoras, tareas pendientes y roadmap
Este apartado recoge las funcionalidades identificadas actualmente como no operativas, así como los próximos desarrollos previstos para el sistema.
Funcionalidades pendientes de activación
- Visualización del estado de los contenedores:
Actualmente no es posible consultar el estado actualizado de los contenedores de cada instancia desde la interfaz del gestor.
- Botones de control de instancia (Actualizar, Arrancar, Parar, Reiniciar):
Los botones destinados a realizar acciones sobre las instancias (actualizar, arrancar, parar y reiniciar) no están habilitados y no producen ningún efecto.
Mejoras planificadas
- Integración de autenticación con cuentas de Office 365:
El sistema utiliza actualmente un método de autenticación basado únicamente en usuario y contraseña. Está previsto implantar un mecanismo de inicio de sesión que permita al usuario autenticarse utilizando credenciales de Office 365.
- Edición del fichero de Docker Compose desde la interfaz:
Se plantea la futura incorporación de una funcionalidad que permita editar directamente el archivo de Docker Compose de cada instancia desde la interfaz del gestor. Esto permitirá modificar la configuración y actualizar el funcionamiento de las instancias de manera centralizada.
Anexos y enlaces
- Enlace al proyecto principal: https://gitlab.sdi.es/sidoo/sidooker-compose-web-client
- Enlace al proyecto de creación de instancias: https://gitlab.sdi.es/sidoo/sidooker-copier-jail-template
Gestor de Instancias de Docker Compose
El Gestor de Instancias de Docker Compose es una herramienta orientada a la administración y supervisión centralizada de múltiples entornos Docker Compose en servidores dedicados. Ofrece una interfaz gráfica donde las instancias se presentan como tarjetas individuales, mostrando el nombre, URLs principales, y botones de acciones rápidas.
Principales funcionalidades:
- Filtrado de instancias por nombre.
- Visualización en tarjetas con nombre, URLs y datos asociados.
- (Pendiente) Visualización del estado de contenedores de cada instancia.
- Botones para actualizar, arrancar, parar y reiniciar instancias (actualmente no disponibles).
- Creación de nuevas instancias a través de un formulario que solicita: nombre, URL, tipo (test/producción/pruebas), versión (de la 13 a la 18), contraseña, idioma de la base de datos y activación de queue job.
- Listado de mejoras planificadas: integración con autenticación de Office 365 y edición directa del archivo de Docker Compose.
No hay comentarios por ahora.
para ser el primero en comentar.