Tutorial : Full RESTfull API con AWS, Terraform, y Serverless Framework

Hace ya algunos años que he querido hacer un tutorial como este, en dónde de manera sencilla pueda explicar los distintos pasos de la creación de un API REST, o al menos como lo he aprendido a hacer basado en experiencia y errores.

Una de las razones del por qué nunca comencé con este proyecto es debido a que crear un API puede ser tan complejo como uno quiera, y nunca encontré el tiempo para realizarlo, por lo que decidí lanzar este tutorial por partes e iré publicando las distintas partes a medida que las vaya realizando.

En este tutorial crearemos un Full RESTfull API con seguridad basada en tokens utilizando AWS, Swagger, Terraform, DynamoDB, SSM, y Serverless Framework quién generará los recursos del API Gateway y Lambdas.

 

Estado Proyecto En Progreso
Fecha Inicio 17/05/2020
Fecha Actualización 17/05/2020
Fecha de Término
Capítulos listos 2/10
Link Youtube Playlist https://www.youtube.com/playlist?list=PLCjIDwuXOgwR64ScpUf6WLnW6j2jdkREX

 

Indice

  1. Entendiedo la necesidad. API de manejo de datos de usuarios y los datos requeridos.
  2. Conociendo las herramientas que se utilizarán y el por qué las usaremos.
  3. Diseñando la API utilizando Swagger. Antes de crear el API debemos saber que información recibirá y que información retornará.
  4. Generando la base de datos DynamoDB, y el recurso relacionado de SSM utilizando Terraform.
  5. Generando los endpoints utilizando Serverless Framework.
  6. Generando el CRUD de la aplicación. – Create, Read, Update, Delete –
  7. Asegurando nuestra API.

Extra

  1. Bloqueo de recursos en Terraform para impedir eliminaciones accidentales.
  2. Endpoint que lista los usuarios con paginación.
  3. Sincronizando DynamoDB con Redshift para realizar operaciones analiticas.

Contenido

Puedes encontrar el playlist con los vídeos en el siguiente link : https://www.youtube.com/playlist?list=PLCjIDwuXOgwR64ScpUf6WLnW6j2jdkREX

1.- Entendiendo la necesidad.

A pesar de la creencia popular nadie desarrolla por desarrollar, a menos que esté aprendiendo. Es muy importante entender la necesidad que existe por detrás de lo que se está creando para no tener duplicidad en el trabajo realizado ni atrasos inesperados. La solución siempre se debe de diseñar antes del proceso de desarrollo.

 

2.- Conociendo las herramientas

En este capítulo conversamos un poco de las herramientas que estaremos utilizando para este proyecto.

  1. Serverless Framework
  2. Terraform
  3. Swagger
  4. API Gateway
  5. Amazon Lambda
  6. Amazon DynamoDB
  7. SSM – Parameter Store.

3.- Diseñando la API (Work in Progress)

4.- Generando los recursos / DynamoDB (Work in Progress)

5.- Generando los endpoints usando Serverless. (Work in Progress)

6.- Generando el CRUD de la aplicación (Work in Progress)

7.- Asegurando el API (Work in Progress)

 

 

¡Mantengamos el contacto!

Me encantaría que te mantuvieras al día con el contenido que estoy generando. Recuerda que no es solo el blog, son las redes sociales, libros, y distintos pódcast 😎.

Hago todo lo posible para no hacer Spam,

Usando TravisCI y Github Package Repository (GPR)

TRAVIS CI

Travis-CI es un sistema de Integración Continua, y es una herramienta muy importante en el mundo de la automatización de pasos a producción, mientras que GitHub Package Repository corresponde a un sistema de manejo de paquetes y dependencias relativamente nuevo proporcionado por GitHub.

Estamos modificando el flujo de automatización que tenemos de paso a producción, y un amigo me recomendó enormemente ( y reiteradamente ) que comenzara a usar TravisCI.

Hace bastante no escribía un blogpost, sin embargo pasé un par de horas que no tenía planeadas en invertir en esta conexión así que creo que amerita escribir algo al respecto.

Antes de iniciar :

  1. Debes de tener una cuenta en GitHub
  2. Debes de tener una cuenta en TravisCI
  3. Asumiré que la conexión entre ambos ya está realizada y tienes un proyecto que incluya un paquete alojado en GITHub Package Repository.

 

Creando variables de entorno encriptadas.

Creando variables de entorno a través de la línea de comandos.

Hay distintas formas de generar las variables de entorno encriptadas, en mi caso el que se acomodó a lo que necesitaba era teniendo la herramienta de línea de comandos de TravisCI instalada.

El siguiente comando será ejecutado desde la línea de comandos en el root folder del proyecto que tengamos con travis.

travis env set GITHUB_TOKEN MIGITHUBTOKEN --private

Esto generará una variable de entorno global en el proyecto en Travis, pero no generará ningún cambio en el archivo de proyecto que tenemos.

Creando variables de entorno desde la página web.

Si seleccionamos nuestro proyecto en TravisCI y vamos a Settings, podemos encontrar una sección en dónde alojan las variables de entorno. En este caso podemos ver la variable que creamos en la sección anterior, además de poder crear una variable nueva asociada a un branch.

TRAVISCI y GPR

Generando automáticamente el archivo .npmrc

Ahora que ya tenemos nuestro token de GitHub como variable de entorno en nuestro proyecto de Travis, es necesario ocuparla para generar el archivo de configuración para descargar el paquete desde el repositorio de GitHub (GPR).

En el archivo de configuración de travis (.travis.yml) agregamos los siguiente.

language: node_js
node_js:
- 10

cache:
  directories:
  - node_modules

before_install:

- echo "BEFORE INSTALL - ADD PRIVATE REPO"
- npm config set registry https://npm.pkg.github.com/OWNER
- echo "GENERATING AUTH"
- echo //npm.pkg.github.com/:_authToken=$GITHUB_TOKEN > .npmrc

install:
- echo "INSTALL"
- npm install

En el ejemplo anterior, antes de instalar los paquetes, se está agregando el repositorio de github y el usuario al que pertenece el paquete. Este en el caso de nosotros es el repositorio de la empresa. No olviden cambiar OWNER con el nombre de la cuenta de GITHUB.

Una vez agregado el repositorio, generamos el archivo de configuración .npmrc con el token de github que será necesario para descargar el paquete sin tener errores de permisos.

Conclusión

La verdad es un proceso bastante sencillo y que agrega un montón de valor al paso productivo de proyectos privados. No se justificaban las horas requeridas para hacerlo haberlo logrado, pero que bueno que finalmente funcionó.

Espero que les sirva para que no pasen por el mismo tiempo de aprendizaje.

¡Mantengamos el contacto!

Me encantaría que te mantuvieras al día con el contenido que estoy generando. Recuerda que no es solo el blog, son las redes sociales, libros, y distintos pódcast 😎.

Hago todo lo posible para no hacer Spam,

Mejorando el performance de SQS para millones de escrituras

Solución Procesar SQS Fargate Aurora

Hace ya casi un año que Amazon publicó que estaban desarrollando el soporte de Amazon SQS como «Event Source» para una función Lambda, y desde que la solución estuvo disponible buscaba una escusa para poder encontrar un mini proyecto para probarla.

Para el desarrollo interno de la empresa tengo un «Bot» que obtiene de manera diaria un CSV con alrededor de 1.000.000 de filas. Para todos los que estamos acostumbrados a trabajar con archivos grandes, 1M de datos no suena tan complejo, por lo que a pesar de tener mejores opciones decidí que era el momento de hacer una prueba de fuego parseando este archivo y enviando el resultado directamente a la cola fila por fila para luego ser procesado a través de una función lambda.

Este post es para comentar sobre la estructura final del proyecto, y como se fue modificando para poder funcionar de manera correcta.

Suposiciones

  • El archivo ya existe. Este POST no es sobre como crear un BOT para obtener un archivo.
  • Existe algo de conocimiento previo de lo que significa SQS, Lambda, un Trigger y Aurora.

Los problemas encontrados

A continuación una lista de problemas encontrados en el orden que fueron sucediendo.

  • El parseo inicial fue realizado a través de una función creada en NodeJS. Al parecer hasta el día de hoy el SDK de NodeJS de AWS tiene un bug en el cual el garbage collector no alcanza a borrar suficiente memoria cuando se usan sockets. Esto implica que el enviar cientos de llamados desde NodeJS hacia SQS implicaba que a pesar de tener el máximo de memoria soportado para la ejecusión, el resultado era falla de la ejecución del código. La recomendación de Amazon fue usar otro lenguaje para esta solución.
  • Luego los mensajes a SQS fueron enviados desde el parseador desarrollado en PHP sin problemas de manera secuencial, esperando que cada uno de los mensajes se enviara antes de seguir con el siguiente. Si bien esto funcionó sin problemas, el tiempo necesario para que la solución terminara fue de un poco más de 24 horas. ( Cero opción de que esto sea una solución definitiva ).

La Solución

Solución Procesar SQS Fargate Aurora
Solución Procesar SQS Fargate Aurora

Una de las características que más me gusta del desarrollo en la nube y los microservicios, es la versatilidad de como puedo manejar distintos lenguajes de programación para distintas soluciones y que todos puedan convivir sin problemas entre ellos. El BOT funciona en un contenedor de docker con PHP, y el consumidor de la cola en una función lambda utilizando NodeJS conectado a una base de datos Aurora Serverless.

Envío del mensaje a la cola

Para reducir el tiempo en que el parser del archivo CSV se utilizó una librería que trae promesas y asincronía a los desarrollos en PHP. La verdad hasta hace un par de días no sabía que esto era posible, pero la librería Guzzle Promises funciona de maravilla. Gracias a esto en vez de procesar los mensajes de la cola de manera individual los comencé a procesar por lotes de 500. Solo este cambio hizo que la solución en vez de demorarse un poco más de 24 horas, solo se demorara 86 minutos.

SQS from CSV + PHP

Si bien para la necesidad que tenía ya era un tiempo razonable, en especial por la hora a la que se ejecuta la solución, comencé a ver un par de alternativas que me permitieran reducir el tiempo de ingreso a la cola.

Encontré que en vez de mandar una fila del CSV por mensaje se aprovechaba de mejor manera la inserción en la cola si el mensaje incluía arreglos de 10 filas por mensaje. Solo este cambio significó una mejora desde los 86 minutos a 25 minutos.

PHP + SQS + CSV 25 Min

A esta altura por el momento ya quedo contento con la solución de inserción a la cola. La verdad es que se puede seguir mejorando la inserción, incluso incluyendo más filas por mensaje y comprimir el texto usando alguna librería. Es muy posible que en un futuro lo haga por curiosidad, pero por el momento me quedo contento con el tiempo de ejecución.

Procesando el mensaje.

Ya pasando por el proceso de inserción a la cola, el resto fue bastante sencillo. En la misma función lambda se ingreso como trigger directamente la cola en dónde se estaban ingresando los mensajes, con un máximo de mensajes por función de 10 ( Esto lo podemos hacer mucho más grande ! ).

Por lo que queda como lo siguiente :

  1. Cada mensaje contiene 10 filas con datos.
  2. Cada lambda maneja de manera «simultanea» 10 mensajes de la cola.
  3. Cada función lambda fue configurada con una concurrencia máxima de 100 para no tener que hacer mayores cambios en las conexiones a la BdD Aurora.  Para re-usar las conexiones a la base de datos se usa la librería Aurora Mysql Cluster de NodeJS.

Esto resulta en que en cada unidad de tiempo de procesamiento se pueden estar ingresando a la BdD alrededor de 10000 de lo que en su momento fueron filas con información desde un CSV, por lo tanto,  la velocidad de procesamiento e inserción a la base de datos es mucho mayor que la velocidad de inserción en la cola (Lo que podría traducirse en que quizás la mejor solución era ingresar a la base de datos de manera directa y no pasar por SQS).

Conclusión

Puede que la solución no sea la mejor para el problema dado por lo que deberé cambiarla en un futuro cercano. Sin embargo, estoy contento con el resultado del desempeño de Lambda con SQS como event source, que era lo que se quería probar desde un comienzo.

Espero poder probar el trigger desde SQS a Lambda en un proyecto en producción pronto.

 

¡Mantengamos el contacto!

Me encantaría que te mantuvieras al día con el contenido que estoy generando. Recuerda que no es solo el blog, son las redes sociales, libros, y distintos pódcast 😎.

Hago todo lo posible para no hacer Spam,

Creando un servidor de MySQL local con Docker

Docker es un software de manejo de contenedores que permite exportar tu código junto con la configuración del entorno en donde se encuentra de manera sencilla y liviana sin preocuparse por los cambios que puedan haber en el sistema operativo, mientras que MySQL es la base de datos relacional Open Source más popular.

El objetivo de este POST es explicar el paso a paso de la creación de un contenedor de MySQL de manera local que se pueda acceder desde otras aplicaciones instaladas en la misma máquina. Se usa un computador con Ubuntu 18.04 LTS para el tutorial.

Requerimientos

  • Docker Instalado

Leer más

¿Latino América sin efectivo?

Pagos en efectivo en Chile y Latino America

En un mundo en vías de ser Cashless ( sin efectivo ) aún nos queda un largo camino que recorrer.

Hace ya un par de meses que asistí a MoneyConf en Dublín, uno de los congresos Fintech más grandes del mundo, y además de los tópicos obvios; cryptocurrencies, los estándares PSD2, el flujo del dinero, y distintas innovaciones, también se habló mucho sobre una sociedad Cashless – sin efectivo -.

Desde ese entonces quería escribir algo al respecto, pero no sin antes haber realizado algo con que ejemplificarlo. Actualmente en Pago Fácil aceptamos efectivo para pagos online a través de dos Fintech; Multicaja y Pago46, y les trataré de explicar el por qué es muy importante que aún aceptemos pagos en efectivo a pesar de vender online.

Leer más