AWS ElasticBeanstalk + EC2 + Github Action setup

Este documento describe brevemente los pasos necesarios para ejecutar tu aplicación (ya sea web, api o servicio) en la nube de AWS.

En un enfoque tradicional y simple AWS provee, entre sus muchos servicios, la posibilidad de ejecutar máquinas virtuales denominadas instancias EC2 que no son más que computadoras 💻 como las nuestras pero en otro lugar. Para hacer uso de las mismas, deberemos seleccionar las características del hardware, configurar su acceso y finalmente conectarnos para instalar las aplicaciones correspondientes. Luego, manejaremos nuestras aplicaciones conectándonos a la misma para realizar modificaciones.

Sin embargo, AWS también provee un servicio Elastic Beanstalk, un servicio para el deployment y administración de aplicaciones que complementa estas instancias EC2 con configuraciones adicionales para la provicion de escalabilidad, seteo de variables de ambiente, configuración de la red, balanceo de carga, monitoreo, entre otros.

Para que el proceso de deployment sea aún más sencillo, proponemos incluir un Github Action para el release de las nuevas versiones de nuestra aplicación, de forma tal que cada nuevo push a un determinado branch realizará la actualización correspondiente en Elastic Beanstalk y al mismo tiempo en la instancia EC2 que existe detrás.

Se detallan a continuación los pasos necesarios para dejar nuestra app lista en la nube de AWS: 🗒️

1. Acceder a la cuenta de AWS de Zircon acá. Solicitar usuario de AWS en caso de no tenerlo.
2. Dirigirse a Elastic Beanstalk a la sección de aplicaciones
3. Crear una nueva aplicación para el proyecto y darle un nombre

4. Crear un nuevo environment dentro de la nueva aplicación, cada environment deberá representar un stage de nuestro pipeline (ej: dev, uat, qa, prod). En la mayoría de los casos desearemos crear un environment del tipo Web Server.

5. Ingresar la información correspondiente en los diferentes campos:

   1. Nombre del ambiente. Ej: MyApp-Dev
   2. Plataforma, que indica el setup inicial para correr cierto tipo de aplicaciones. Ej: NodeJS (se recomienda siempre seleccionar la última versión disponible.
   3. Seleccionar "Sample application" para asegurarnos que todo funciona correctamente

6. Por defecto se asignará una instancia EC2 de la free tier para nuestra aplicación. Una vez creado el ambiente, visitar la sección de configuración donde se encontrará mayor detalle de esta y otras configuraciones. Por ejemplo la sección de "Software" nos permitirá añadir variables de entorno que estarán disponibles para nuestra aplicación.

7. Al guardar modificaciones en las variables de entorno, realizar actualizaciones del código de nuestra aplicación u otros cambios, EB automáticamente se encargará de aplicar las configuraciones correspondientes sin necesidad de conectarnos directamente a las instancias. De hecho, esto no deberá ser necesario, salvo excepciones, ya que Beanstalk también se encarga del autoscaling de nuestra aplicación haciendo provisioning de sub-instancias para mantener un determinado nivel de performance. Esto quiere decir que las instancias que funcionan debajo seran constantemente reemplazadas por lo que no debemos depender de una configuracion especifica dentro de las mismas.

8. Ahora que tenemos Beanstalk iniciado y con las variables de entorno necesarias ya añadidas, el siguiente paso es hacer deployment de nuestra propia aplicación. Para lograrlo vamos a usar Github Actions que mediante archivos de configuración dentro del propio repositorio del proyecto nos va a permitir controlar el workflow de desarrollo. Si bien es posible automatizar muchos procesos utilizando las Actions, nos enfocaremos en la que nos permitirá hacer deployment de nuestra aplicación particularmente en Elastic Beanstalk.

   1. Crear las carpetas .github/workflows en la raíz del proyecto
   2. Crear un archivo .yml con un nombre descriptivo como eb_deploy_action.yml
   3. Incluir en su contenido el ejemplo de este reposorio. Notar que ésta Github Action realiza la ejecución sí y solo sí lo que estamos realizando es un push al branch develop por lo que deberemos adaptarlo en caso de que nuestro branch de deployment sea diferente. De la misma forma, pueden añadirse sentencias adicionales en caso que deseemos hacer deployment bajo otras condiciones.

9. Modificar el archivo incluído en el paso anterior con las características del proyecto como el App Name, Environment Name y principalmente los comandos de requerimientos y compilación que varían según la base de nuestro projecto. En ese caso la base es una aplicación NodeJS pero será diferente en otros casos claramente. Aqui pueden encontrarse configuraciones para Python a modo de ejemplo.

10. Para que esta nueva Action pueda efectivamente realizar el deployment es necesario proveer keys de AWS con permisos de CLI. Como queremos mantener esta información de forma oculta, las actions permiten referenciar secrets utilizando la sintáxis de ${{ secrets.AWS_ACCESS_KEY_ID }} como muestra el ejemplo. Por lo tanto, deberemos agregar estos parámetros en la sección de settings correspondiente en el propio repo. En caso de no contar con claves de AWS para un projecto en Zircon, solicitar acceso.

11. Bajo las circunstancias descritas, al realizar un nuevo push o merge sobre el branch develop el Github Action hará deployment de una nueva versión de la aplicación en Elastic Beanstalk. Se podrá ver el estado de ejecución en la tab de Actions del repo.

Eso es todo! Mucha suerte con tu setup! 🚀

--

PD: Se agradecen PRs para contribuir con la descripción de estos pasos en caso de que te hayas encontrado con otros obstáculos. Los próximos devs van a estar agradecidos 😉