samwise-CLI: Der Abhängigkeits-Tracker des Open-Source-Terraform-Moduls

Terraform

Terraform ist ein Infrastructure-as-Code(IaC)-Tool, das in der Hashicorp Configuration Language (HCL) geschrieben ist. In diesem Artikel wird davon ausgegangen, dass der Leser mit Terraform gearbeitet hat und versteht, wie Module funktionieren.

Jeder, der in Terraform programmiert, hat entweder seine eigenen Module erstellt oder zumindest die von jemand anderem verwendet.

Terraform-Module

Module sind Container für mehrere Ressourcen, die zusammen verwendet werden. Ein Modul besteht aus einer Sammlung von .tf- und/oder .tf.json-Dateien, die in einem Verzeichnis zusammengehalten werden.

Module sind die wichtigste Möglichkeit, Ressourcenkonfigurationen mit Terraform zu verpacken und wiederzuverwenden.

Module können in Registern wie Terraform Registry oder GitLab veröffentlicht werden. Module können auch aus Git-Repositorys bereitgestellt werden, indem die HTTPS- oder SSH-URLs bereitgestellt werden. Diese können auch versioniert werden. Zum Beispiel

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

Versioniert:

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

Herausforderung

Wenn Ihre Repositorys wachsen und Sie auf Ihre Module in anderen Repositorys verweisen, sollten Sie Ihre Module vernünftigerweise versionieren, um sicherzustellen, dass Upstream-Änderungen in der Quelle Ihre Infrastruktur nicht beschädigen. Allerdings ist es schwierig, den Überblick über alle Neuerscheinungen der eingesetzten Module zu behalten und noch schwieriger, dies regelmäßig zu tun. Wenn man es nicht angeht, baut sich dies mit der Zeit als technische Schulden auf, wenn man eines Tages feststellt, dass ein Kernmodul jetzt drei Hauptversionen voraus ist.

Lösung

Wir präsentieren samwise-cli, ein Tool, mit dem Sie die Terraform/OpenTofu-Abhängigkeiten Ihres Repositorys im Upstream verfolgen können. Durchsucht Ihr Repository nach Modulverwendungen und erstellt einen Bericht über die Module, für die Aktualisierungen verfügbar sind, sowie über alle Versionen, die fortgeschrittener sind als die derzeit verwendete Version.

Im Moment gibt es nur einen Befehl, aber hoffentlich werden es bald weitere sein, wenn das Tool weiterentwickelt wird.

Zufälliges Repo vorerst

Darth-Tech / samwise-cli

Eine CLI-Anwendung, die Sie auf Ihrer Reise mit dem Terraform-Modul begleitet und die Last der Modulabhängigkeitsaktualisierungen teilt, so wie ein mutiger Hobbit Frodo dabei geholfen hat, seine zu tragen :)

samwise

Eine CLI-Anwendung, die Sie auf Ihrer Reise mit dem Terraform-Modul begleiten und mit der Sie Ihre Last der Modulabhängigkeitsaktualisierungen teilen können, so wie ein mutiger Hobbit Frodo dabei geholfen hat, seine zu tragen :)

%,( "' /%% / 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-'|____||    )/   |
             % %/ '-,-

…

Auf GitHub ansehen

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 :)