samwise-CLI : le suivi des dépendances du module Open Source Terraform

Terraforme

Terraform est un outil Infrastructure-as-Code (IaC) écrit en Hashicorp Configuration Language (HCL). Cet article suppose que le lecteur a travaillé avec Terraform et comprend le fonctionnement des modules.

Tous ceux qui codent dans Terraform ont soit créé leurs propres modules, soit au moins utilisé ceux de quelqu'un d'autre.

Modules Terraform

Les modules sont des conteneurs pour plusieurs ressources utilisées ensemble. Un module est constitué d'une collection de fichiers .tf et/ou .tf.json conservés ensemble dans un répertoire.

Les modules constituent le principal moyen de regrouper et de réutiliser des configurations de ressources avec Terraform.

Les modules peuvent être publiés dans des registres comme le registre Terraform ou GitLab. Les modules peuvent également être servis à partir des référentiels Git en fournissant les URL HTTPS ou SSH. Ceux-ci peuvent également être versionnés. Par exemple,

module "consul" {
  source = "github.com/hashicorp/example"
}

Versionné :

module "consul" {
  source = "github.com/hashicorp/example?ref=1.2.6"
}

Défi

Au fur et à mesure que vos référentiels se développent et que vous référencez vos modules dans d'autres référentiels, vous devrez raisonnablement versionner vos modules pour vous assurer que les modifications en amont dans la source ne brisent pas votre infrastructure. Cependant, il est difficile de suivre toutes les nouvelles versions des modules utilisés et encore plus difficile de le faire régulièrement. Non résolu, cela crée au fil du temps une dette technologique lorsqu'un jour vous découvrez qu'un module de base a désormais 3 versions majeures en avance.

Solution

Présentation de samwise-cli, un outil pour vous aider à suivre les dépendances Terraform/OpenTofu de votre référentiel en amont. Recherche dans votre référentiel les utilisations des modules et génère un rapport des modules pour lesquels des mises à jour sont disponibles ainsi que toutes les versions plus avancées que la version utilisée actuellement.

Pour le moment, il n'y a qu'une seule commande, mais j'espère qu'il y en aura d'autres bientôt au fur et à mesure du développement de l'outil.

Repo aléatoire pour le moment

Dark-Tech / samwise-cli

Une application CLI pour vous accompagner dans votre parcours de module Terraform et partager votre fardeau de mises à jour des dépendances de modules, tout comme un courageux Hobbit a aidé Frodon à porter le sien :)

samwise

Une application CLI pour vous accompagner dans votre parcours de module Terraform et partager votre fardeau de mises à jour des dépendances de modules, tout comme un courageux Hobbit a aidé Frodon à porter le sien :)

%,( "' /%% / Cccc' (cause I couldn't find good enough Samwise Gamgee ASCII art) Frodo by Shanaka Dias">

                       \ : /
                    '-: __ :-'
                    -:  )(_ :--
                    -' |r-_i'-
            ,sSSSSs,   (2-,7
            sS';:'`Ss   )-j
           ;K e (e s7  /  (
            S, ''  SJ (  ;/
            sL_~~_;(S_)  _7
|,          'J)_.-' />'-' `Z
j J         /-;-A'-'|'--'-j\
 L L        )  |/   :    /  \
  \ \       | | |    '._.'|  L
   \ \      | | |       | \  J
    \ \    _/ | |       |  ',|
     \ L.,' | | |       |   |/
    _;-r-<_.| \=\    __.;  _/
      {_}"  L-'  '--'   / /|
            |   ,      |  \|
            |   |      |   ")
            L   ;|     |   /|
           /|    ;     |  / |
          | |    ;     |  ) |
         |  |    ;|    | /  |
         | ;|    ||    | |  |
         L-'|____||    )/   |
             % %/ '-,-

…

Voir sur GitHub

checkForUpdates

For this to run where modules are using private GitHub repositories, .samwise.yaml config file needs to passed as an argument or needs to be present at the user's home directory.

.samwise.yaml format:

github_key:
github_username:

Currently only GitHub HTTPS authentication is supported but SSH authentication will be supported soon.

Result

CSV Format

JSON Format

Limitations(or better described as features to be added)

• SSH authentication for retrieving module sources
• Tracking Hashicorp's registry's module(they have an API to list versions here

Context for the name

I love Lord of the Rings :)