Servidor de instancias Odoo 

Fecha de elaboración: 7 de junio de 2024 

Versión de la documentación: 1.0 

Tabla de contenidos 

1. Introducción 
2. Resumen de funcionalidades 
3. Funcionalidades detalladas 
4. 1. Acceso al sistema 
   2. Visualización de bases de datos e instancia 
   3. Gestión de contenedores 
   4. Visualización de detalles y métricas de bases de datos 
   5. Acciones disponibles sobre bases de datos 
   6. 1. Backup de base de datos 
      2. Actualización (Update) de base de datos 
      3. Borrado de base de datos 
   7. Gestión de backups 
   8. 1. Visualización de backups 
      2. Descarga de backups
      3. Restauración de backups 
      4. Borrado de backups 
   9. Remote Backups 
5. Glosario 
6. Preguntas frecuentes (FAQ) 
7. Anexos y enlaces 

1. Introducción 

El sistema Servidor de instancias de Odoo es una plataforma que permite la gestión unificada y visual de bases de datos y backups asociados, así como el control de distintas instancias de contenedores de Odoo y Bases de datos. El acceso y las funcionalidades están orientados a facilitar la administración de bases de datos y la gestión de copias de seguridad desde una interfaz amigable. 

2. Resumen de funcionalidades 

• Acceso seguro mediante usuario y contraseña. 
• Visualización de todas las bases de datos disponibles en la instancia actual. 
• Supervisión de los recursos utilizados por la instancia y sus copias de seguridad. 
• Gestión de contenedores Teodoo y Bolares: estado, control y supervisión en tiempo real. 
• Visualización del tamaño de bases de datos, archivos y backups. 
• Acceso a acciones clave sobre bases de datos: backup, actualización, borrado. 
• Gestión específica e independiente de backups: descarga, restauración y eliminación. 
• Opción para importar backups desde entornos remotos configurados. 

3. Funcionalidades detalladas 

3.a Acceso al sistema 

• Descripción general: 
  El acceso al sistema se realiza mediante introducción de un usuario y contraseña válidos. Al iniciar sesión, el usuario accede a la interfaz principal. 

• Datos requeridos:  Usuario y contraseña asignados. 
• Resultados esperados:  Acceso a la pantalla principal con el menú lateral de navegación y listado de bases de datos. 
• Restricciones o límites: ​El acceso está restringido a usuarios autenticados. No se permite la autogestión de usuarios ni recuperación automática de contraseña desde la interfaz. 

3.b Visualización de bases de datos e instancia 

• Descripción general: 
  Al acceder, se muestra en la parte izquierda de la interfaz un menú con un enlace a los «Backups» y un listado de las bases de datos disponibles en la instancia de Odoo actual. 

• Resultados esperados: 
  Visualización del menú lateral y listado actualizado de las bases de datos. 
• Restricciones o límites: 
  Solo se muestran bases de datos disponibles en la instancia conectada. 

3.c Gestión de contenedores 

• Descripción general: 
  Al seleccionar una base de datos, la parte derecha de la pantalla muestra dos tarjetas (una para Odoo y otra para la base de datos) con el estado y opciones de control de cada contenedor asociado. 

• Opciones y configuraciones: 
  Para cada contenedor, se presentan: 
• • Estado actual (corriendo/parado) 
  • Botón para detener el contenedor 
  • Botón para reiniciar el contenedor 
  • Botón para ejecutar «pull» de la imagen y actualizarla 
  • Botón para visualizar logs en tiempo real 
  • Botón para abrir terminal interactiva 
• Datos requeridos: 
  Base de datos seleccionada. 
• Resultados esperados: 
  Visualización del estado y control de los contenedores asociados. 
• Restricciones o límites: 
• • El pull de imagen puede estar inoperativo o pendiente de implementación. 
  • La visualización de logs solo muestra datos en tiempo real (no históricos). 
  • La terminal puede presentar errores de formato o codificación en ciertos casos. 

3.d Visualización de detalles y métricas de bases de datos 

• Descripción general: 
  Para la base de datos seleccionada, se muestran los siguientes detalles y métricas: 
• • Tamaño de la base de datos 
  • Tamaño de los archivos (File Store) 
  • Tamaño de los backups almacenados 
  • Tamaño total (suma de valores anteriores) 

• Datos requeridos: 
  Selección de una base de datos. 
• Resultados esperados: 
  Visualización clara de los recursos consumidos por la base de datos seleccionada. 
• Restricciones o límites: 
  Los tamaños se calculan en base a la información disponible en la instancia; posibles retrasos en actualización según procesos de backup/restore activos. 

3.e Acciones disponibles sobre bases de datos 

3.e.i Backup de base de datos 

• Descripción general: 
  Permite realizar una copia de seguridad (backup) de la base de datos seleccionada. El backup se almacena en el servidor. 

• Opciones y configuraciones: 
  Backup manual desde la interfaz. 
• Datos requeridos: 
  Selección de base de datos. 
• Resultados esperados: 
  Generación y almacenamiento local del backup; el backup aparece disponible en el listado de copias. 
• Restricciones o límites: 
  El backup no se descarga automáticamente al usuario; sólo se almacena en el servidor. 

3.e.ii Actualización (Update) de base de datos 

• Descripción general: 
  Permite actualizar los módulos de la base de datos que hayan sido modificados o tengan una versión distinta a la instalada. 

• Opciones y configuraciones: 
  Acción de actualizar basada en diferencias de módulos. 
• Datos requeridos: 
  Selección de base de datos y módulos actualizables. 
• Resultados esperados: 
  La base de datos se actualiza solo con los módulos que requieren actualización. 
• Restricciones o límites: 
  Solo se afectan los módulos con diferencia de versión respecto al estado actual. 

3.e.iii Borrado de base de datos 

• Descripción general: 
  Permite eliminar una base de datos seleccionada. 

Se requiere confirmar escribiendo el nombre completo de la base de datos antes de proceder. 

• Opciones y configuraciones: 
  Solicitud de confirmación por escrito del nombre de la base de datos. 
• Datos requeridos: 
  Selección de base de datos y confirmación escrita. 
• Resultados esperados: 
  Eliminación permanente de la base de datos seleccionada y su información asociada. 
• Restricciones o límites: 
  El borrado requiere confirmación exacta para evitar eliminaciones accidentales. Acción irreversible. 

3.f Gestión de backups 

3.f.i Visualización de backups 

• Descripción general: 
  Visualización de todos los backups disponibles para una base de datos mediante la sección de «Backups» o desde la parte inferior de los detalles de la base de datos. 

• Opciones y configuraciones: 
  Listado de backups asociados a cada base de datos. 
• Datos requeridos: 
  Base de datos y backups existentes. 
• Resultados esperados: 
  Visualización ordenada de todas las copias de seguridad disponibles. 
• Restricciones o límites: 
  Solo se muestran los backups asociados a la base de datos seleccionada. 

3.f.ii Descarga de backups 

• Descripción general: 
  Posibilidad de descargar desde la interfaz una copia de seguridad almacenada en el servidor. 

• Opciones y configuraciones: 
  Acción de descarga para cada backup individual listado. 
• Datos requeridos: 
  Backup existente. 
• Resultados esperados: 
  Descarga del archivo de backup al dispositivo local del usuario. 
• Restricciones o límites: 
  Sólo se pueden descargar backups que existan en el servidor. 

3.f.iii Restauración de backups 

• Descripción general: 
  Permite restaurar una copia de seguridad a una nueva base de datos o en la misma base existente. 

• Opciones y configuraciones: 
• • Especificar nuevo nombre si es una restauración como copia. 
  • Opción de neutralización si procede. 
• Datos requeridos: 
  Backup elegido y, opcionalmente, nuevo nombre para la base de datos restaurada. 
• Resultados esperados: 
  Base de datos restaurada según configuración seleccionada. 
• Restricciones o límites: 
  La restauración requiere especificar un nuevo nombre en caso de copia. La acción muestra un aviso para confirmar. 

3.f.iv Borrado de backups 

• Descripción general: 
  Permite eliminar una copia de seguridad seleccionada. Se presenta un aviso de confirmación antes de proceder. 

• Opciones y configuraciones: 
  Solicitud de confirmación mediante ventana de aviso. 
• Datos requeridos: 
  Selección del backup a eliminar. 
• Resultados esperados: 
  Eliminación de la copia de seguridad seleccionada. 
• Restricciones o límites: 
  Acción irreversible; requiere confirmación expresa del usuario. 

3.g Remote Backups 

• Descripción general: 
  Si el sistema está configurado, permite consultar backups almacenados en un entorno remoto (por ejemplo, producción) y descargar una copia a la instancia local. 

• Opciones y configuraciones: 
• • Listado de backups remotos disponibles. 
  • Botón para descargar backup remoto al servidor local. 
• Datos requeridos: 
  Configuración previa de acceso remoto. Backup existente en el entorno remoto. 
• Resultados esperados: 
  El backup remoto seleccionado se transfiere al servidor local y queda disponible en el listado de backups locales. 
• Restricciones o límites: 
  La descarga solo traslada el backup al servidor, no directamente al dispositivo local del usuario. Se requiere configuración previa de entornos remotos. 

4. Glosario 

• File Store: Término referido al conjunto de archivos auxiliares adjuntos en Odoo. 
• Contenedor: Entorno de ejecución aislado, usado para instancias específicas (Teodoo y Bolares) dentro del sistema. 

5. Preguntas frecuentes (FAQ) 

P: ¿Puedo recuperar una base de datos eliminada? 

R: No. La eliminación es irreversible y requiere confirmación expresa. 

P: ¿El backup se descarga automáticamente tras crearlo? 

R: No. El backup se almacena en el servidor y debe descargarse manualmente desde la interfaz. 

P: ¿Qué ocurre si el «pull» de imagen no funciona? 

R: El resto de acciones (logs, terminal, detener y reiniciar) sigue disponible, pero la actualización de la imagen podría estar pendiente de implementación o corrección. 

6. Anexos y enlaces

Enlace al proyecto: https://gitlab.sdi.es/sidoo/sidooker-server-manager