Terraform desde las Trincheras (Buena práctica ‘Definición de nomenclatura’)
Continuando con las buenas prácticas de IaC con Terraform (que hemos podido utilizar en nuestros proyectos de Azure esperando que faciliten una curva de aprendizaje para aquellos que aún no las aplican y que también están referenciadas en Internet donde existe bastante información de calidad sobre ello) revisaremos la segunda parte de esta serie de artículos:
Definición de nomenclatura
No siempre una sola persona se encarga de implementar el código Terraform o darle mantenimiento, pues existe la posibilidad que más de uno participe en ambas tareas, e incluso que después de un tiempo se tenga que hacer cambios debido a nuevos requerimientos en la Arquitectura Cloud.
Todo lo anterior se complica hacerlo, si no se tiene un documento que indique sobre cómo se debe nombrar a los recursos, variables locales, variables globales y variables de salida. Dicho documento (aunque podría ser más de uno o uno solo con varias secciones o apartados) detallamos a continuación.
Con respecto a nombrar los recursos cubre 2 aspectos:
Aspecto sobre nombrar cada recurso cloud que existirá en Azure
Este primer aspecto es el nombre de cada recurso cloud que existirá en Azure y que cuando se accede al Portal se puede visualizar ello como se ve en la siguiente imagen:
Por lo general el cliente (que es dueño del Tenant y Suscripción en Azure) o la compañía donde uno trabaja, cuenta cuando con un documento que detalla cómo se debe nombrar a cada recurso cloud; sin embargo, si no se tuviera se puede elaborar uno donde por cada tipo de recurso cloud que tiene o tendrá la Arquitectura, indique como se debe de nombrar los recursos cloud, y un ejemplo de ello es que el nombre tenga letras que identifique características importantes (Nombre de aplicación o Entorno) como se muestra en la siguiente imagen:
Aspecto sobre nombrar cada recurso cloud en Terraform
El segundo aspecto es definir la forma que se nombra a cada recurso en Terraform, donde también puede darse el caso que ya exista ello en la compañía donde uno trabaja y en el caso que no, tenemos que definirlo y un ejemplo es cada nombre inicie con las siglas del tipo de recurso seguido por palabras o prefijos que describen con más detalle al recurso y todo en minúsculas y separados por guión bajo como se muestra en la siguiente imagen:
Sobre el nombre de las variables es otro punto importante que se debe tener definido para diferenciar que tipo de variable (local, global o de salida) se tienen que modificar o cuales se verán impactadas por los cambios que se tengan que hacer al código Terraform.
Se puede tener un estándar similar para los 3 tipos de variables o uno específico para cada uno. Por ejemplo las variables locales se podrían definir en minúsculas y con guion bajo en la separación de las palabras que las conformen, las variables globales podrían tener la primera letra en mayúscula de cada palabra que forma parte del nombre y las demás letras en minúsculas sin usar ningún separador entre cada palabra, las variables de salida podrían iniciar con el prefijo out y luego seguir el estándar de las variables locales. Lo anterior se puede observar en la siguiente imagen:
Si bien es cierto que existen prefijos en Terraform que también ayudan a saber qué tipo de variable se usa en el código, la propuesta de tener un estándar para los nombres de variables es para que cuando uno tenga que hacer cambios no cree nuevas variables con una forma distinta a la que la ya existe.
Las recomendaciones de nomenclatura revisadas en este artículo se recomiendan que este en un documento o varios con fácil acceso al equipo que realiza los cambios en el código Terraform y además se debe informar que dichos documentos se actualizarán con el tiempo y que deben consultarse siempre en su última versión.
En el siguiente artículo explicaremos la buena práctica de IaC con Terraform llamada «Uso de service principal».