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 consiste en 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 tels que 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 devez 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 s'accumule au fil du temps sous forme de 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 sur les 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

                       \ : /
                    '-: __ :-'
                    -:  )(_ :--
                    -' |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>…

checkForUpdates

Pour que cela s'exécute là où les modules utilisent des référentiels GitHub privés, le fichier de configuration .samwise.yaml doit être transmis en argument ou doit être présent dans le répertoire personnel de l'utilisateur.

.samwise.yamlformat :

github_key:
github_username:

Actuellement, seule l'authentification HTTPS GitHub est prise en charge, mais l'authentification SSH le sera bientôt.

Résultat

Format CSV

Format JSON

Limitations (ou mieux décrites comme fonctionnalités à ajouter)

• Authentification SSH pour récupérer les sources du module
• Suivi du module du registre de Hashicorp (ils ont une API pour lister les versions ici

Contexte du nom

J'adore le Seigneur des Anneaux :)