Dieses Beispiel enthält Code als Beispiel für die Strukturierung von Terraform-Konfigurationen für eine kleine Infrastruktur, in der keine externen Abhängigkeiten verwendet werden.

Terraform ist leistungsfähig (wenn nicht sogar das leistungsfähigste, das es derzeit gibt) und eines der am häufigsten verwendeten Tools, das die Verwaltung der Infrastruktur als Code ermöglicht. Es erlaubt Entwicklern eine Menge Dinge zu tun und schränkt sie nicht ein, Dinge zu tun, die schwer zu unterstützen oder zu integrieren sind.

Einige der in diesem Buch beschriebenen Informationen mögen nicht als die besten Praktiken erscheinen. Ich weiß das, und um den Lesern zu helfen, zu unterscheiden, was bewährte Praktiken sind und was nur eine andere Art ist, Dinge zu tun, verwende ich manchmal Hinweise, um etwas Kontext zu liefern, und Symbole, um den Reifegrad jedes Unterabschnitts in Bezug auf bewährte Praktiken anzugeben.

Ein paar Jahre später wurde es mit mehr aktuellen Best Practices aktualisiert, die mit Terraform 1.0 verfügbar waren. Letztendlich sollte dieses Buch die meisten der unbestrittenen besten Praktiken und Empfehlungen für Terraform-Nutzer enthalten.

Sponsoren

Übersetzungen

Kontaktieren Sie mich, wenn Sie bei der Übersetzung dieses Buches in andere Sprachen helfen wollen.

Beiträge

Ich möchte immer Rückmeldungen erhalten und dieses Buch aktualisieren, wenn die Gemeinschaft reift und neue Ideen umgesetzt und überprüft werden.

Autoren

Lizenzen

Dieses Projekt steht unter der Apache-2-Lizenz. Siehe LICENSE für weitere Details.

Die Autoren und Mitwirkenden an diesem Inhalt können die Gültigkeit der hier gefundenen Informationen nicht garantieren. Bitte vergewissern Sie sich, dass Sie verstehen, dass die hier zur Verfügung gestellten Informationen frei zur Verfügung gestellt werden und dass keine Art von Vereinbarung oder Vertrag zwischen Ihnen und Personen, die mit diesem Inhalt oder Projekt in Verbindung stehen, entsteht. Die Autoren und Mitwirkenden übernehmen keine Haftung für Verluste, Schäden oder Störungen, die durch Fehler oder Auslassungen in den Informationen verursacht werden, die in diesem Inhalt enthalten sind, mit ihm in Verbindung stehen oder mit ihm verlinkt sind, unabhängig davon, ob solche Fehler oder Auslassungen auf Fahrlässigkeit, Unfälle oder andere Ursachen zurückzuführen sind.

Copyright © 2018-2023 Anton Babenko.

In diesem Abschnitt werden die wichtigsten Konzepte beschrieben, die in diesem Buch verwendet werden.

Ressource

aws_vpc, aws_db_instance und andere sind Beispiele für Ressourcen. Eine Ressource gehört zu einem Provider, akzeptiert Argumente, gibt Attribute aus und hat Lebenszyklen. Eine Ressource kann erstellt, abgerufen, aktualisiert und gelöscht werden.

Ressourcenmodule

Infrastrukturmodule

Ein Infrastrukturmodul ist eine Sammlung von Ressourcenmodulen, die nicht zwingend logisch miteinander verbunden sein müssen, aber in der aktuellen Situation/im aktuellen Projekt/im aktuellen Setup demselben Zweck dienen. Es definiert die Konfiguration für Provider, die an die nachgelagerten Ressourcenmodule und an Ressourcen weitergegeben wird. Normalerweise ist die Arbeit auf eine Einheit pro logischer Begrenzung beschränkt (z. B. AWS Region, Google Project).

Komposition

Eine Komposition ist eine Sammlung von Infrastrukturmodulen, die sich über mehrere logisch getrennte Bereiche erstrecken kann (z. B. AWS-Regionen, mehrere AWS-Konten). Eine Komposition wird verwendet, um die komplette Infrastruktur zu beschreiben, die für das gesamte Unternehmen oder Projekt erforderlich ist.

Eine Komposition besteht aus Infrastrukturmodulen, die aus Ressourcenmodulen bestehen, die einzelne Ressourcen implementieren.

Datenquellen

Eine Datenquelle führt einen Lese-Vorgang durch und ist abhängig von der Konfiguration des Providers; sie wird in einem Ressourcenmodul und einem Infrastrukturmodul verwendet.

Die Datenquelle terraform_remote_state dient als Bindeglied für übergeordnete Module und Kompositionen.

Remote-Status

Provider, Provisioner, ...

Provider, Provisioner und einige andere Begriffe sind in der offiziellen Dokumentation sehr gut beschrieben und es macht keinen Sinn, sie hier zu wiederholen. Meiner Meinung nach haben sie wenig mit dem Schreiben guter Terraform-Module zu tun.

Warum so kompliziert?

Der übergreifende Zugriff auf die Daten einzelner Moleküle (Ressourcenmodule und Infrastrukturmodule) erfolgt über die Ausgaben und Datenquellen der Module.

Wenn man die oben beschriebenen Konzepte in Pseudo-Beziehungen zueinander setzt, kann das so aussehen:

composition-1 {
  infrastructure-module-1 {
    data-source-1 => d1

    resource-module-1 {
      data-source-2 => d2
      resource-1 (d1, d2)
      resource-2 (d2)
    }

    resource-module-2 {
      data-source-3 => d3
      resource-3 (d1, d3)
      resource-4 (d3)
    }
  }

}

Dieses Beispiel enthält Code als Beispiel für die Strukturierung von Terraform-Konfigurationen für eine mittelgroße Infrastruktur, dazu werden verwendet:

• 2 AWS-Konten

• 2 separate Umgebungen (prod und stage, die sich nichts teilen). Jede Umgebung befindet sich in einem separaten AWS-Konto.

• Jede Umgebung verwendet die gleiche Version eines internen Moduls modules/network, da es aus einem lokalen Verzeichnis stammt.

Fragen, die sich auf die Terraform-Code-Struktur beziehen, sind mit Abstand die häufigsten in der Community. Jeder hat sich irgendwann einmal Gedanken über die beste Codestruktur für das Projekt gemacht.

Wie sollte ich meine Terraform-Konfigurationen strukturieren?

Dies ist eine der Fragen, für die es viele Lösungen gibt, und es ist sehr schwer, allgemeingültige Ratschläge zu erteilen, also sollten wir zunächst einmal verstehen, womit wir es zu tun haben.

• Wie komplex ist Ihr Projekt?

  • Anzahl der zugehörigen Ressourcen

  • Anzahl der Terraform-Provider (siehe Hinweis unten über "logische Provider")

• Wie oft ändert sich Ihre Infrastruktur?

  • Von einmal pro Monat/Woche/Tag

  • Bis kontinuierlich (jedes Mal, wenn es einen neuen Commit gibt)

• Initiatoren von Codeänderungen? Lassen Sie den CI-Server das Repository aktualisieren, wenn ein neues Artefakt erstellt wird?

  • Nur Entwickler können Änderungen am Infrastruktur-Repository vornehmen.

  • Jeder kann eine Änderung vorschlagen, indem er einen PR öffnet (einschließlich automatisierter Aufgaben, die auf dem CI-Server laufen)

• Welche Einsatzplattform oder welchen Einsatzdienst verwenden Sie?

  • AWS CodeDeploy, Kubernetes oder OpenShift erfordern einen etwas anderen Ansatz

• Wie sind die Umgebungen gruppiert?

  • Nach Umgebung, Region, Projekt

Erste Schritte bei der Strukturierung von Terraform-Konfigurationen

Es ist eine gute Idee, den gesamten Code in die Datei main.tf zu packen, wenn Sie gerade erst anfangen oder einen Beispielcode schreiben. In allen anderen Fällen ist es besser, mehrere Dateien zu haben, die logisch aufgeteilt sind, wie hier:

• main.tf - ruft Module, lokale Variablen und Datenquellen auf, um alle Ressourcen zu erstellen

• variables.tf - enthält die Deklarationen der in main.tf verwendeten Variablen

• outputs.tf - enthält die Ausgaben der in main.tf erstellten Ressourcen

• versions.tf - enthält die Versionsanforderungen für Terraform und Provider

Wie sollte man über die Struktur von Terraform-Konfigurationen nachdenken?

Allgemeine Empfehlungen für die Strukturierung von Code

• Es ist einfacher und schneller, mit einer kleineren Anzahl von Ressourcen zu arbeiten

  • terraform plan und terraform apply machen beide Cloud-API-Aufrufe, um den Status der Ressourcen zu überprüfen

  • Wenn Sie Ihre gesamte Infrastruktur in einer einzigen Komposition haben, kann dies einige Zeit dauern

• Der Blast-Radius ("Explosionsradius") ist kleiner mit weniger Ressourcen

  • Die Isolierung nicht zusammenhängender Ressourcen voneinander, indem sie in getrennten Kompositionen untergebracht werden, verringert das Risiko, wenn etwas schief geht.

• Beginnen Sie Ihr Projekt mit einem Remote-Status, denn:

  • Ihr Laptop ist kein Ort für Ihre Infrastruktur als "Quelle der Wahrheit"

  • Die Verwaltung einer tfstate-Datei in Git ist ein Alptraum

  • Später, wenn die Infrastrukturebenen in verschiedene Richtungen wachsen (Anzahl der Abhängigkeiten oder Ressourcen), wird es einfacher sein, die Dinge unter Kontrolle zu halten

• • Wie prozeduraler Code sollte auch Terraform-Code so geschrieben werden, dass ihn Entwickler gut lesen können; Konsistenz ist hilfreich, wenn sechs Monaten später Änderungen vorgenommen werden müssen

  • Es ist möglich, Ressourcen innerhalb der Terraform-Statusdatei zu verschieben, aber es kann schwieriger sein, wenn Sie eine inkonsistente Struktur und Namenskonvention haben

• Halten Sie die Ressourcenmodule so einfach wie möglich

• Geben Sie keine Werte fest ein, die als Variablen übergeben oder über Datenquellen ermittelt werden können

• Verwenden Sie Datenquellen und terraform_remote_state speziell als Verbindung zwischen Infrastrukturmodulen innerhalb der Komposition

In diesem Buch sind die Beispielprojekte nach Komplexität gruppiert - von kleinen bis zu sehr großen Infrastrukturen. Diese Trennung ist nicht strikt, probieren Sie daher auch Strukturen.

Orchestrierung von Infrastrukturmodulen und Kompositionen

Eine kleine Infrastruktur bedeutet, dass es nur eine geringe Anzahl von Abhängigkeiten und wenige Ressourcen gibt. Wenn das Projekt wächst, wird die Notwendigkeit deutlich, die Ausführung von Terraform-Konfigurationen zu verketten, verschiedene Infrastrukturmodule zu verbinden und Werte innerhalb einer Komposition zu übergeben.

Es gibt mindestens 5 verschiedene Gruppen von Orchestrierungslösungen, die Entwickler verwenden:

1. Nur Terraform. Sehr einfach, Entwickler müssen nur Terraform kennen, um die Arbeit zu erledigen.

2. Terragrunt. Ein reines Orchestrierungstool, mit dem die gesamte Infrastruktur orchestriert und Abhängigkeiten gehandhabt werden können. Terragrunt arbeitet nativ mit Infrastrukturmodulen und Kompositionen und reduziert so die Duplizierung von Code.

3. Interne Skripte. Dies geschieht oft als Ausgangspunkt für die Orchestrierung und bevor Terragrunt entdeckt wird.

4. Ansible oder ein ähnliches Allzweck-Automatisierungswerkzeug. Wird normalerweise verwendet, wenn Terraform nach Ansible eingeführt wird oder wenn die Ansible UI aktiv genutzt wird.

Vor diesem Hintergrund werden in diesem Buch die ersten beiden dieser Projektstrukturen, Terraform only und Terragrunt, vorgestellt.

Dieses Beispiel enthält Code als Beispiel für die Strukturierung von Terraform-Konfigurationen für eine groß angelegte Infrastruktur, dazu werden verwendet:

• 2 AWS-Konten

• 2 Regionen

• 2 separate Umgebungen (prod und stage, die sich nichts teilen). Jede Umgebung befindet sich in einem separaten AWS-Konto und verteilt die Ressourcen auf 2 Regionen.

• Jede Umgebung verwendet die gleiche Version eines internen Moduls modules/network, da es aus einem lokalen Verzeichnis stammt.

Allgemeine Konventionen

1. Verwenden Sie überall _ (Unterstrich) anstelle von - (Bindestrich) (Ressourcennamen, Datenquellennamen, Variablennamen, Ausgaben usw.).

2. Verwenden Sie vorzugsweise Kleinbuchstaben und Zahlen (auch wenn UTF-8 unterstützt wird).

Argumente für Ressourcen und Datenquellen

1. Wiederholen Sie den Ressourcentyp nicht im Ressourcennamen (weder teilweise noch vollständig):

   resource "aws_route_table" "public" {}

   resource "aws_route_table" "public_route_table" {}

   resource "aws_route_table" "public_aws_route_table" {}

3. Verwenden Sie bei Namen immer die Einzahl.

4. Verwenden Sie - innerhalb von Argumenten und an Stellen, an denen der Wert für einen Menschen sichtbar ist (z. B. innerhalb des DNS-Namens der RDS-Instanz).

5. Fügen Sie das Argument count / for_each innerhalb des Ressourcen- oder Datenquellenblocks als erstes Argument oben ein und trennen Sie es danach durch einen Zeilenumbruch.

6. Fügen Sie das Argument tags, falls von der Ressource unterstützt, als letztes echtes Argument ein, gefolgt von depends_on und lifecycle, falls erforderlich. Alle diese Argumente sollten durch eine einzelne Leerzeile getrennt werden.

7. Bei der Verwendung von Bedingungen in einem count / for_each Argument sind boolesche Werte zu bevorzugen, anstatt length oder andere Ausdrücke zu verwenden.

Code-Beispiele für resource

Verwendung von count / for_each

Platzierung von tags

Bedingungen in count

Variablen

1. Erfinden Sie das Rad in Ressourcenmodulen nicht neu: Verwenden Sie den Namen, die Beschreibung und den Standardwert für Variablen, wie sie im Abschnitt "Argumentreferenz" für die Ressource, mit der Sie arbeiten, definiert sind.

2. Die Unterstützung für die Validierung von Variablen ist ziemlich begrenzt (z.B. kann nicht auf andere Variablen zugegriffen werden oder Lookups durchgeführt werden). Planen Sie entsprechend, denn in vielen Fällen ist diese Funktion nutzlos.

3. Verwenden Sie die Pluralform in einem Variablennamen, wenn der Typ list(...) oder map(...) ist.

4. Ordnen Sie die Schlüssel in einem Variablenblock wie folgt an: description , type, default, validation

5. Fügen Sie immer eine description allen Variablen hinzu, auch wenn Sie denken, dass es offensichtlich ist (Sie werden es in Zukunft brauchen).

6. Verwenden Sie lieber einfache Typen (number, string, list(...), map(...), any) als spezifische Typen wie object(), es sei denn, Sie müssen strenge Einschränkungen für jeden Schlüssel haben.

7. Verwenden Sie spezifische Typen wie map(map(string)), wenn alle Elemente der Map denselben Typ haben (z. B. string) oder in diesen umgewandelt werden können (z. B. kann der Typ number in string umgewandelt werden).

8. Verwenden Sie type any, um die Typüberprüfung ab einer bestimmten Tiefe zu deaktivieren oder wenn mehrere Typen unterstützt werden sollen.

9. Der Wert {} ist manchmal eine map() und manchmal ein object(). Verwenden Sie tomap(...), um eine map() zu erstellen, da es keine Möglichkeit gibt, ein object() zu erstellen.

Ausgaben

Machen Sie Ausgaben konsistent und verständlich außerhalb des Moduls (wenn ein Benutzer ein Modul verwendet, sollte es offensichtlich sein, welchen Typ und welches Attribut der Wert hat, den es zurückgibt).

1. Der Name der Ausgabe sollte die darin enthaltene Eigenschaft beschreiben und weniger frei formuliert sein, als Sie es normalerweise wünschen würden.

2. Eine gute Struktur für den Namen der Ausgabe sieht aus wie {name}_{type}_{attribute} , wobei:

   1. {name} ein Ressourcen- oder Datenquellenname ohne Provider-Präfix ist. {name} für aws_subnet ist subnet, für aws_vpc ist es vpc.

   2. {type} ist ein Typ einer Ressourcenquelle

   3. {attribute} ist ein Attribut, das von der Ausgabe zurückgegeben wird.
5. Geben Sie immer eine description für alle Ausgaben an, auch wenn Sie denken, dass es offensichtlich ist.

6. Vermeiden Sie es, sensitive Argumente zu setzen, es sei denn, Sie kontrollieren die Verwendung dieser Ausgabe an allen Stellen in allen Modulen vollständig.

7. Bevorzugen Sie try() (verfügbar seit Terraform 0.13) gegenüber element(concat(...)) (Legacy-Ansatz für die Version vor 0.13)

Code-Beispiele für output

Höchstens eine ID einer Security-Gruppe ausgeben:

Wenn mehrere Ressourcen desselben Typs vorhanden sind, sollte this im Namen der Ausgabe weggelassen werden:

Pluralname verwenden, wenn der Rückgabewert eine Liste ist:

Terraform-Code Strukturen

Terragrunt-Code Strukturen

Dokumentation

Automatisch erstellte Dokumentation

Mit Terraform-Konfigurationen kann pre-commit verwendet werden, um Code zu formatieren und zu validieren, sowie um die Dokumentation zu aktualisieren.

terraform-docs

@todo: Document module versions, release, GH actions

Ressourcen

Welche Werkzeuge sollte ich kennen und nutzen?

Die Versionen der Ressourcen- und Infrastrukturmodule sollten angegeben werden. Provider sollten außerhalb von Modulen konfiguriert werden, aber nur in der Komposition. Die Versionen von Providern und Terraform können auch fixiert werden.

Es gibt auch einen Workshop für alle, die einige der in diesem Leitfaden beschriebenen Dinge üben wollen.

Verwenden Sie locals, um explizite Abhängigkeiten zwischen Ressourcen zu spezifizieren

Hilfreiche Möglichkeit, Terraform einen Hinweis zu geben, dass einige Ressourcen vorher gelöscht werden sollten, auch wenn es keine direkte Abhängigkeit in Terraform-Konfigurationen gibt.

Terraform 0.12 - Erforderliche und optionale Argumente

1. Das erforderliche Argument index_document muss gesetzt werden, wenn var.website keine leere map() ist.

2. Das optionale Argument error_document kann weggelassen werden.