Saltar al contenido principal
Version: Next

Desplegar Sudocu

Los siguientes pasos son para realizar una nueva instalación de Sudocu. En el caso de una actualización vaya al correspondiente apartado.

Desde la raíz del repositorio navegue a la carpeta donde se encuentra la configuración de Sudocu:

cd prod/sudocu

Sobre esta carpeta se procederá a adaptar los archivos de configuración a las necesidades de su instalación y luego a desplegar el stack .

Configuración​

La especificación del stack de este módulo se encuentra en sudocu.yml.

Modificar dominio​

En los archivos de configuración se asume el dominio uunn.local, para reemplazarlo por el dominio definitivo puede utilizar el siguiente comando:

sed -i 's/uunn.local/universidad.edu.ar/g' \
    config/config-api-server.json \
    config/config-sudocu-login.json \
    config/config-sudocu-mpd.json \
    config/config-sudocu-mpc.json \
    config/config-sudocu-gestion.json \
    sudocu.yml

Crear secretos​

  1. Copiar el template de los secrets:
cp sudocu-api-server-secret.json.dist sudocu-api-server-secret.json
  1. Editar el archivo sudocu-api-server-secret.json con los datos que correspondan:
{
  "auth_providers_basic_password": "integracion",
  "repositorios_arai_password": "docs123",
  "firma_password": "docs123",
  "db_password": "postgres",
  "redis_options_password": "redis"
}
  • auth_providers_basic_password: Password de autenticación básica del servicio de integración de Sudocu.
  • repositorios_arai_password: Password de servicio Araí Documentos.
  • firma_password: Password de servicio firma de Araí Documentos.
  • db_password: Password de Postgres de Sudocu.
  • redis_options_password: Password de Redis de Sudocu.
docker secret create sudocu-api-server ./sudocu-api-server-secret.json

Acceso a Postgres​

Editar la configuracion de conexión a la base de datos en el archivo config/config-api-server.json:

  "ungsxt": {
    "host": "db-sudocu",
    "port": "5432",
    "database": "sudocu",
    "user": "postgres"
  }

Creación de Base de Datos​

Antes de crear la estructura de la base hay que crear el schema sudocu:

createdb -h DB_HOST -U DB_USER -p DB_PORT sudocu
psql -h DB_HOST -U DB_USER -p DB_PORT -c "CREATE SCHEMA sudocu; ALTER SCHEMA sudocu OWNER TO postgres;" sudocu
  1. Inicializar la base de datos. Cambiar los valores de conexión. 
    docker run --rm \
      --env SUDOCU_DB_HOST=db-sudocu \
      --env SUDOCU_DB_NAME=sudocu \
      --env SUDOCU_DB_PORT=5432 \
      --env SUDOCU_DB_USER=postgres \
      --env SUDOCU_DB_PASSWORD=postgres \
      ungs/sudocu-db-instalador:1.6.1

Herramientas auxiliares y persistencia de redis​

A partir de la versión 1.4.15 de SUDOCU se incorporan en el deploy dos herramientas auxiliares opcionales, que permiten monitorear y tener control sobre las distintas colas de trabajo que se incorporaron en las últimas versiones. Estas herramientas son bull-dashboard y redis-commander. Ambas apuntan a ser solo accesibles por los administradores del sistema. También a partir de la versión 1.4.17 se incorpora un archivo de configuración del servicio de cache (Redis) con el fin de hacerlo persistente Más info. En este sentido también se incorpora en el servicio de cache un nuevo volumen para persistir el archivo de restauración de Redis.

Bull-dashboard:​

Para desplegar bull-dashboard se deben seguir los siguientes pasos:

  • Descomentar el bloque de bull-dashboard en sudocu.yml
  • Modficar las variables <USER>:<PASSWORD> con un usuario y password para el acceso. El user se escribe sin codificar, en cambio el password debe ser un hash que se puede generar con el comando openssl passwd -apr1 password escapando los $ Más info.
  • Modificar uunn.local por el dominio donde se está desplegando.

Una vez desplegado se podra acceder desde https://uunn.local/bull-dashboard

Redis-commander:​

Para desplegar redis-commander se deben seguir los siguientes pasos:

  • Descomentar el bloque de redis-commander en sudocu.yml
  • Modficar las variables de entorno HTTP_USER y HTTP_PASSWORD con un usuario y password para el acceso.
  • Modificar uunn.local por el dominio donde se está desplegando.

Una vez desplegado se podra acceder desde https://uunn.local/redis-commander

Deploy​

docker stack deploy --with-registry-auth --compose-file sudocu.yml sudocu

Registrar Sudocu como Service Provider en Araí Usuarios​

Debe registrarse de manera manual desde Araí-Usuarios. Para hacerlo siga los siguientes pasos:

  1. Ingrese a Araí-Usuarios (user admin y password seteado anteriormente)
  2. Dirigirse al item Aplicaciones
  3. Presionar el botón Agregar +
  4. Completar de la siguiente manera el tab Datos Generales
  5. Completar de la siguiente manera el tab SAML
  6. Presionar el botón Guardar

Crear usuario Admin de Sudocu en Araí Usuarios​

  1. Ingrese a Araí-Usuarios (user admin y password seteado anteriormente)
  2. Dirigirse al item Usuarios
  3. Presionar el botón Agregar +
  4. Completar de la siguiente manera el tab Perfil:
    • Identificador: adminsudocu
    • Nombre: Admin
    • Apellido: Sudocu
    • Nombre: Admin
    • E-mail: admin@sudocu.edu.ar
    • Password: ******
  5. Presionar el botón Guardar
  6. Completar de la siguiente manera el tab Cuentas
    • Aplicación: Sudocu
    • Cuenta: adminsudocu
  7. Presionar el botón Agregar
  8. Presionar el botón Guardar

Una vez realizados estos pasos, debería poder acceder en https://uunn.local/sudocu (o el dominio que haya definido)

Para mayor información y documentación funcional recurrir a la página oficial de SUDOCU.

Actualización de versión​

IMPORTANTE: En las actualizaciones es posible que se incluyan nuevos parámetros en los archivos de configuración del api-server y los distintos modulos de SUDOCU. Por lo tanto, es necesario en cada actualización comparar los archivos de configuración desplegados localmente con el archivo config-default.json ubicado en la raíz de cada módulo, y agregar los parámetros que no se encuentren en el archivo local.

  1. Borrar el stack actual:
docker stack rm sudocu

Antes de actualizar es necesario realizar un backup de la base de datos.

pg_dump -h DB_HOST -U DB_USER -p DB_PORT sudocu > sudocu.$(date -I).sql
  1. Realizar nuevo deploy:
docker stack deploy --with-registry-auth --compose-file sudocu.yml sudocu
  1. Actualizar la base de datos:
docker run --rm \
  --env SUDOCU_DB_HOST=db-sudocu \
  --env SUDOCU_DB_NAME=sudocu \
  --env SUDOCU_DB_PORT=5432 \
  --env SUDOCU_DB_USER=postgres \
  --env SUDOCU_DB_PASSWORD=postgres \
  ungs/sudocu-db-instalador:1.6.1