¿Cómo desplegar código personalizado en una instancia dedicada? – Athento

Athento permite desplegar código personalizado en una instancia dedicada.

Entre el código que permite desplegar están:

Operaciones: automatismos propios del caso de uso del cliente que se pueden ejecutar a demanda, desde la Ui del producto o desde la API.
Comandos: procesos programáticos que usualmente se ejecutan de forma masiva.
Plantillas HTML: para customizar la interfaz de Athento.
Hooks de API
Máscaras de bandejas: para hacer consultas específicas o complejas.

Para trabajar con código personalizado, se deben realizar los siguientes pasos:

Disponer de un repositorio GIT
Subir el código con la misma estructura que puede verse en el directorio /var/www/athentose
Enviar un correo a soporte@athento.com facilitando la URL del repositorio GIT y facilitando credenciales de lectura, indicando sobre qué instancia se solicita realizar el despliegue del código personalizado. Puntualmente, puede indicarse la rama que se quiere usar para los despliegues y la frecuencia de despliegue automático.

Estructura del código

Dado que Athento está implementado sobre Django, se puede seguir una estructura de aplicación de Django normal, aunque con mejoras aportadas por Athento, como es la carpeta de operaciones (operations)

A continuación puede encontrar una plantilla de app https://bitbucket.org/athento/template_athento/src/main/

Como desplegar el código personalizado por primera vez

Para desplegar el código personalizado se debe configurar un nuevo config git desde la administración avanzada (puedes acceder directamente con este enlace https://<DOMINIO>/aseadm/config/configgit/).

Una vez dentro de los config git, se debe añadir una nueva configuración:

Allí se abrirá una pantalla donde el usuario podrá añadir la información necesaria para configurar el nuevo repositorio en la instancia:

Se debe completar el nombre del repositorio, la url que será https://bitbucket.org/athento/<nombre_del_repositorio>.git, el nombre de usuario de quien realiza la configuración, la contraseña de la aplicación (puedes ver como obtenerla aquí) y una breve descripción del elemento.

Una vez realizada la configuración, se debe lanzar el comando "clone_git_repositories" (aquí se explica como hacerlo). Este comando marcará el check "Cloned", cuando se haya clonado correctamente el repositorio.
Finalmente, para que las actualizaciones del repositorio se vean reflejadas en la instancia, es necesario lanzar también el comando "update_custom" que actualizara el código personalizado con la frecuencia que se haya establecido al configurarlo.

Actualizaciones

Las actualizaciones del código se realizarán de forma automática, normalmente cada hora o menos.

Por lo tanto, debe tenerse en cuenta que cualquier código subido a la rama principal de dicho repositorio, será actualizado automáticamente. Es recomendable entonces usar ramas diferentes para el desarrollo y trabajar con Pull Requests para hacer merge del codigo en la rama principal.

Los desarrolladores son responsables de subir el código definitivo al repositorio. La subida de código al repositorio no forma parte del soporte.

Puntualmente, puede solicitarse a Athento la actualización manual del código en casos especiales. En estos casos, el soporte de Athento se limitará a realizar los siguientes comandos:

"git pull", para desplegar el nuevo código
"./scripts/soft_reload.sh" para que se apliquen los cambios

Los tickets de soporte deben llevar por título "Actualización código custom en instancia", indicando claramente la instancia para la que se solicita la actualización.

Cómo desplegar el código como aplicación Django

Crear enlace simbólico del proyecto en /var/www/athentose/athentose
Configurar el fichero /var/www/athentose/athentose/settings_config/custom/settings_custom_apps.py

Ejemplo de comando para crear el enlace simbólico

ln -s /var/www/athentose/athentose/custom/MyApp /var/www/athentose/athentose

Ejemplo de código para settings_custom_apps.py

CUSTOM_INSTALLED_APPS = ('MyApp.apps.MyAppConfig', )
INSTALLED_APPS += CUSTOM_INSTALLED_APPS

Comandos útiles para subir código al repositorio

Si se trabaja desde un entorno de UAT sobre código personalizado, estos comando son útiles para subir el código al repositorio:

git add: para añadir nuevos archivos al control de versiones
git commit: para confirmar cambios en el repositorio
git push: para subir los cambios al repositorio

Algunos recursos sobre GIT

Relacionada con