Armar el ambiente para desarrollar el portal
Esta guía tiene como objetivo mostrar como realizar una instalación del portal SIU-Huarpe que nos permita:
- probar cambios y/o ajustes sobre el portal
- desarrollar nuevos bundles
- personalizar bundles existentes
Requisitos
- Docker Engine en su versión más reciente: https://docs.docker.com/install
- Docker Compose en su versión más reciente: https://docs.docker.com/compose/install
Descargar el código fuente
Clonar el repositorio del portal SIU-Huarpe:
git clone https://hub.siu.edu.ar/siu-arai/huarpe-core huarpe
Si tenemos un fork propio del portal, debemos clonar dicho repositorio en lugar del original.
Recomendamos el uso de la herramienta git-flow para gestionar mejor el desarrollo de múltiples features concurrentemente. Si se desea utilizar esta herramienta, luego de instalarlo, se deberá proceder a inicializar el repositorio mediante el comando de consola
git flow init
.
Definir la configuración
La configuración se realiza mediante variables de entorno, por favor copie el archivo templates/.env.dist
--> ./desarrollo/huarpe.env
y realice los ajustes pertinentes.
Desplegar el ambiente
Se muestra un despliegue simple con Docker Engine del proyecto Huarpe en modo de desarrollo conjuntamente con una instalación rápida de Arai-Usuarios. La idea es que se vea la flexibilidad y que lo adapten al esquema que mejor crean conveniente.
Se parte del directorio donde tenemos el código del proyecto Huarpe.
- Primeramente realizar el deploy del stack de trabajo ejecutando:
cd desarrollo
CURRENT_USER=$(id -u) docker-compose up -d
Ello desplegará las imagenes necesarias para los contenedores en runtime.
- Seguidamente ejecutar el script de inicialización que se encuentra en la carpeta
desarrollo
:
chmod 755 init.sh
./init.sh
Esto inicializará Arai-Usuarios, realizará el download de las dependencias, ajustará los permisos y limpiará la cache de desarrollo.
- Finalmente, debemos registrar la aplicación Huarpe como SP (service provider) en el IDM de arai-usuarios para contar con SSO:
Trabajando en el dia a dia
Los ciclos de trabajo se pueden llevar adelante mediante los comandos docker-compose stop/start
En caso de necesitar modificar un parámetro no configurable vía variables de entorno, se puede crear/editar un archivo yaml (config/services_dev.yaml
) donde incluir su valor.
Sin embargo, le sugerimos que la configuración de parámetros existentes y/o nuevos se lleve adelante mediante variables de entorno, siendo esto último mas adecuado para el trabajo con contenedores.
parameters:
uni.miproyecto.api: { auth: ['%env(MI_USUARIO_API)%', '%env(file:MI_SECRET_API)%', basic], base_uri: '%env(MI_API_URL)%' }