Desplegar en Docker

Si sólo desea ver el sistema corriendo vaya a la guía de Instalación Rápida.

Antes de comenzar

Los requisitos mínimos para desplegar Arai-Personas:

• Docker Engine, en la versión 18.06 o superior
• la versión de la imagen corresponde a la versión del proyecto. En este ejemplo mostramos la v1.0.0
• por defecto está altamente integrado con SIU-Araí: Usuarios. Si desea usar otro IdP deberá observar los cambios necesarios

Como desplegar

Los siguientes pasos componen una estrategia para desplegar la API:

1. configurar los parámetros de Arai-Personas
2. desplegar en Docker, de referencia para trasladarlo al orquestador de elección
3. registrar el endpoint de Arai-Personas en la configuración de SIU-Araí: Usuarios
4. iniciar el servicio de SSO (una instalación de SIU-Araí: Usuarios operativa)

A continuación a modo de ejemplo se detalla cada paso.

Definir parámetros

Las imágenes Docker son configurables a través de las variables de entorno especificadas en este documento. Muchas de ellas son opcionales, pero pueden ser configuradas según sea necesario.

• Las variables que son obligatorias para poder iniciar la API:

API_URL
API_BASIC_CLIENTES
API_XXX

• Las variables obligatorias que especifican la conexión con la base de datos y su encoding:

DB_HOST
DB_PORT
DB_DBNAME
DB_XXX

• Finalmente, aquellas variables que definen información de caracter funcional:

SELLOS_FORMATO_ESTAMPADO

Inicializar la base de datos

Una vez definidos los parámetros de conexión a la base de datos, podemos hacer uso de una de las imágenes para generar y/o actualizar la estructura de la misma.

Nota: Previo a la ejecución de esta job se debe crear la base de datos con el identificador expresado en la variable DB_DBNAME

1. Inicializar / Actualizar la DB

   sudo docker run --detach \
     --hostname personas.uunn.local \
     --name init-personas \
     --env-file personas.env \
     hub.siu.edu.ar:5005/siu/expedientes/arai-personas/db:v1.0.0
   

Desplegar

Se muestra un despliegue simple con Docker Engine de una de las imágenes que se ofrecen para el proyecto Araí-Personas.

La idea es que vean la flexibilidad y lo adapten al esquema que mejor crean conveniente.

1. Configurar Arai-Personas

   Generar el archivo personas.env con las variables de entorno previamente definidas. Opcionalmente puede proporcionarlas mediante el flag --env.

2. Configurar Arai-Usuarios

   Generar el archivo usuarios.env con las variables de entorno que indica la documentaciòn de Arai-Usuarios. Opcionalmente puede proporcionarlas mediante el flag --env.

3. Iniciar la API

   sudo docker run --detach \
     --hostname personas.uunn.local \
     --publish 9999:80 \
     --name arai-personas \
     --restart always \
     --env-file personas.env \
     hub.siu.edu.ar:5005/siu/expedientes/personas:v1.0.0
   

Registrar Arai-Personas en SIU-Araí: Usuarios

Los endpoints de este proyecto se encuentran publicados en una URL especifica y con los datos necesarios para la autenticación.

Dado que Arai-Usuarios consume este proyecto, es necesario indicar dicha información para que el módulo (IDM) pueda hacer uso de Arai-Personas.

Esto se configura mediante una variable dentro del archivo de entorno de Arai-Usuarios.

Para mayor información, dirigirse a su documentación

Luego de indicar los datos en el formato adecuado desplegar Arai-Usuarios.