Cómo desplegar Azure Logic Apps con Terraform

Durante la Semana Santa he estado intentando deshacerme de todas las PoCs que tengo en mi suscripción, incluidas aquellas en las que hago uso de Logic Apps, pero con la intención de levantar el entorno en otro momento que lo necesite. Cuando trabajas con este tipo de recursos y Terraform te darás cuenta de que no es muy intuitivo su despliegue. En este artículo te cuento cómo lo hago yo a día de hoy.

Logic App de ejemplo

Para poder contarte todos los puntos a los que debes prestar atención, voy a utilizar como ejemplo este flujo, que es una variante del artículo donde te hablaba de cómo indexar vídeos con Azure Media Services.

Este hace lo siguiente: cada vez que un nuevo vídeo se almacena en la cuenta de almacenamiento asociada se ejecuta una Azure Function, que a su vez se comunica con Azure Media Services, que analiza el contenido con Video Indexer y devuelve a la Logic App los metadatos obtenidos. Estos son almacenados dentro de una CosmosDB, teniendo como resultado final lo siguiente:

Como ves, bastantes piezas a automatizar, enlazadas entre sí y que nos hace tener que seguir un orden a la hora de desplegar.

Terraform y las Logic Apps

Si has revisado la documentación de Terraform , verás que la forma que está documentada para el despliegue de Logic Apps es definiendo cada una de las acciones que tenemos dentro del flujo.

A mí personalmente me parece demasiado complejo definirlas de esta forma, por lo que he optado por hacerlo de esta otra:

Descargarse las plantillas ARM.
Desplegar Azure Storage, CosmosDB y las API Connections.
Desplegar Azure Function y Azure Media Services.
Desplegar workflow de Logic App enlazando todo lo anterior.

Veamos pues punto por punto.

1. Descargarse las plantillas ARM

Lo habitual cuando quieres automatizar una Logic App es que esta ya la tengas generada a través del diseñador durante la fase de desarrollo. Una vez que tienes definidos todos los pasos, las conexiones necesarias y todo funcionando simplemente debes ir al apartado Automation > Export template y hacer clic en el botón Download para descargarte la plantilla ARM de tu flujo.

Descargar la plantilla ARM de un recurso

Una vez descargada, si abres el archivo, verás en la parte inferior cuántas conexiones estás utilizando para el flujo en cuestión:

También será necesario que te descargues todas las plantillas de las conexiones a las que hace referencia. Por lo que en este ejemplo deberías de acceder a cada una de las API connections dentro del grupo de recursos y descargarte también su plantilla ARM:

Ahora que ya tienes todas las plantillas ARM que necesitas, lo ideal es que hagas algunos cambios en ellas, para que sean lo más reutilizables posibles. Hay algunos parámetros que se quedan hardcodeados, como la ubicación de los recursos, el id de tu suscripción, etcétera, que quizás conviene que los parametrices para que puedas utilizarlo donde quieras. Además, el nombre de los parámetros quizás tampoco sean lo más descriptivos del mundo, por lo que puede ser interesante que modifiques sus nombres. En mi flujo ha quedado de la siguiente manera, después de refactorizar la plantilla descargada:

Si comparas con la plantilla ARM que te descargas de tu Logic App, en mi ejemplo he procurado en todo momento generalizar la suscripción (usando subscription().id), y los nombres de los recursos, para que pueda reutilizarla en diferentes entornos y con diferentes nombres. También he movido la creación de los id de los diferentes recursos al apartado variables, para que como parámetro solo recoja el nombre del recurso, sin tener que proveer la ruta completa al mismo.

Las conexiónes quedarían de la siguiente manera: En el caso de la conexión de tipo Azure Storage es posible añadir el nombre de la cuenta y la access key durante la creación, lo cual nos evita tener que añadirlo después, ya que ya le estamos dando la información que necesita para poder conectarse al recurso.

‍

A día de hoy no existe documentación como tal de los parámetros que necesita cada conexión, pero puedes seguir los pasos del artículo de mi compañero Derek, que te explica cómo obtenerlos. Existen otras conexiones, como veremos después, que no permiten añadir estos parámetros y necesitarán ser autorizadas en un segundo paso.

Aquí puedes echar un vistazo a todas las plantillas ARM descargadas y modificadas para este ejemplo.

2. Desplegar Azure Storage, CosmosDB y las API Connections.

Ahora que ya tienes las plantillas ARM de tu flujo con Logic Apps y las conexiones que utiliza, el siguiente paso es desplegar los recursos y las conexiones que hacen alusión a estos:

‍

El despliegue de la cuenta de almacenamiento y el CosmosDB sería de la forma habitual con Terraform. Sin embargo, para las conexiones a las APIs utilizo el recurso azurerm_template_deployment el cual te permite desplegar plantillas ARM desde Terraform, y a estas le paso como parámetros aquellas propiedades necesarias de los recursos creados fuera de estas.

Es importante que tengas en cuenta que este debe ser el primer paso cuando tu flujo depende de ciertas conexiones, ya que de lo contrario el mismo no funcionará correctamente. Para lanzar esta primera parte, puedes hacerlo con los siguientes comandos:

Como ves, estoy haciendo uso de Azure Storage para almacenar los .tfstates , por lo que debes asignar una cuenta de almacenamiento durante terraform init. La variable azuread_domain, durante el terraform plan, se utiliza para generar los enlaces que dan acceso a través del portal de Azure a los recursos API Connections que vamos a crear. Cuando el proceso finalice, deberías de tener un output parecido al siguiente:

En el caso de la conexión de la cuenta de almacenamiento, o del CosmosDB, al haber añadido las credenciales como parte de la plantilla ARM no requerirán de ninguna acción más por nuestra parte, y aparecerán con el estado Connected.

Sin embargo, hay otros conectores como el de Office 365, Twitter, Event Grid, etcétera que requieren que te autentiques mediante un flujo OAuth que hace que no sea posible automatizar este paso. En el caso de la conexión con Event Grid deberás acceder al enlace devuelto en el output y autorizar la conexión:

Te darás cuenta rápido de aquellas conexiones que necesitan de autorización manual ya que estas tienen directamente en el apartado Edit API connection un botón llamado Authorize, en lugar de cajas de texto con la información que se espera, como ocurre en Azure Storage o CosmosDB.

3. Desplegar Azure Function y Azure Media Services.

Ahora que ya tenemos las conexiones, y los recursos asociados a ellas, lo siguiente que debemos desplegar es la Azure Function y Azure Media Services para obtener metadatos de los vídeos que subamos. Esta debe ser desplegada antes que el workflow de la Logic App, ya que este hace referencia a una función que todavía no existe y al intentar crear el flujo fallaría si no se desplega antes.

‍

Una de las cosas interesantes que he utilizado para esta parte es la capacidad de consultar otros Terraform State para recuperar los outputs definidos.

Para ello está terraform_remote_state que en este caso lo utilizo para poder recuperar el grupo de recursos donde están alojadas las API Connections, la cuenta de almacenamiento, etcétera.

Por lo tanto, a la hora de ejecutar esta segunda parte, el comando tendrá que ser como el que sigue:

Como ves, en terraform plan añado la variable remote_states_access_key para poder conectarme al tfstate de Terraform que necesito para recuperar los valores.

Como último punto, en este escenario concreto, es importante tener en cuenta que es necesaria la información del service principal asociado a la cuenta de Azure Media Services. Por normal general, esta información se puede recuperar a través del siguiente comando:

az ams account sp create --account-name YOUR_AMS_NAME --resource-group YOUR_RESOURCE_GROUP

En este ejemplo esta parte se ha automatizado a través de lo que se conoce en Terraform como provisioner, utilizando un comando dentro de la definición de la Azure Function que actualizará los app settings con la información del service principal del AMS. Lo que hace es coger estas credenciales, transforma el objeto JSON, gracias a jq, en el formato que entiende la Azure Function y lo inserta dentro del apartado App Settings. Me parece importante que tengas en cuenta este punto ya que el comando se lanza en la máquina local que ejecuta el Terraform, por lo que si no estás usando Mac, que es donde se ha montado este ejemplo, puede ser que esta parte tengas que adaptarla.

IMPORTANTE: Una vez que tenemos la infraestructura para la Azure Function desplegada necesitamos publicar la lógica, que está en el proyecto AMSv3Indexer que forma parte del repositorio, antes de continuar. Puedes hacerlo desde Visual Studio Code, aunque lo realmente interesante sería que todo este proceso se lanzara desde otra herramienta más como GitHub Actions o Azure DevOps.

4. Desplegar workflow de Logic App enlazando todo lo anterior.

Por último, ya podemos desplegar la Logic App con la información de los dos despliegues anteriores: