0Pricing
DevOps Bootcamp · Lektion

Code-Struktur und Namenskonventionen

Übernehmen Sie Best Practices zur Organisation Ihrer Terraform-Dateien und -Module sowie einheitliche Namenskonventionen für Ressourcen und Variablen.

Code-Struktur und Namenskonventionen ist eine kostenlose DevOps Bootcamp-Lektion auf CoddyKit. Dies ist Lektion 1 von 4. Du kannst die komplette Lektion unten kostenlos lesen – dann übst du sie direkt im Browser mit einem integrierten Code-Editor und einem KI-Tutor rund um die Uhr. Sie ist Teil des DevOps Bootcamp-Lernpfads, und dein Fortschritt wird über Web und CoddyKit-App synchronisiert. Der DevOps Bootcamp-Kurs umfasst insgesamt 4 Lektionen.

Warum Terraform-Code strukturieren?

Genau wie die Organisation Ihres Arbeitsplatzes erleichtert eine gute Strukturierung Ihres Terraform-Codes das Verständnis, die Verwaltung und die Zusammenarbeit.

Eine gute Struktur verbessert die Lesbarkeit, verringert Fehler und hilft neuen Teammitgliedern, sich schnell einzuarbeiten.

Wichtige Terraform-Dateien

Terraform-Projekte beginnen normalerweise mit einigen wichtigen Dateien. Es ist eine gängige bewährte Vorgehensweise, Ihre Konfiguration auf diese Dateien aufzuteilen:

  • main.tf: Definiert Ressourcen und Module.
  • variables.tf: Deklariert alle Eingabevariablen.
  • outputs.tf: Definiert Ausgabewerte Ihrer Infrastruktur.
  • versions.tf: Gibt Terraform- und Provider-Versionen an.

Ressourcen benennen

Durch einheitliche Benennungen lassen sich Ressourcen leicht identifizieren. Befolgen Sie für den lokalen Namen (z. B. my_instance in resource "aws_instance" "my_instance") diese allgemeinen Richtlinien:

  • Aussagekräftige Namen verwenden: Was macht die Ressource?
  • Bindestriche oder Unterstriche verwenden: Für bessere Lesbarkeit (z. B. web-server-sg oder web_server_sg).
  • Allgemeine Namen vermeiden: server ist weniger aussagekräftig als app-frontend-server.

Lokale Ressourcennamen in Terraform müssen innerhalb eines Moduls eindeutig sein.

Konventionen für Variablen

Variablen machen Ihre Konfigurationen flexibel. Eine gute Benennung ist entscheidend:

  • Kleinbuchstaben mit Unterstrichen: Dies ist die gängigste Konvention (z. B. instance_type, vpc_id).
  • Spezifisch sein: Was steuert diese Variable?
  • Beschreibungen hinzufügen: Erklären Sie den Zweck der Variable, um Klarheit zu schaffen.

Gute Variablennamen helfen anderen zu verstehen, welche Eingaben Ihr Modul erwartet.

Ausgabewerte benennen

Ausgaben stellen wichtige Informationen über Ihre bereitgestellte Infrastruktur bereit. Eine einheitliche Benennung hilft den Nutzern dieser Ausgaben:

  • Kleinbuchstaben mit Unterstrichen: Ähnlich wie bei Variablen, z. B. web_server_ip.
  • Den Wert beschreiben: Welche Informationen werden bereitgestellt?
  • Beschreibungen hinzufügen: Bei Modulausgaben unerlässlich, um zu erklären, was sie zurückgeben.

Beispiel: Einfache Konfiguration

Diese vollständige main.tf-Datei demonstriert gute Benennungskonventionen für eine Ressource, eine Variable und eine Ausgabe. Sie können damit terraform init und terraform plan ausführen.

terraform {
  required_providers {
    null = {
      source = "hashicorp/null"
      version = "~> 3.0"
    }
  }
}

resource "null_resource" "example_web_server" {
  # Descriptive resource name
  triggers = {
    always_run = timestamp()
  }
}

variable "app_environment" {
  description = "The application's deployment environment (e.g., dev, prod)."
  type        = string
  default     = "development"
}

output "resource_unique_id" {
  description = "The unique ID of the example null resource."
  value       = null_resource.example_web_server.id
}

Terraform-Module strukturieren

Wiederverwendbare Komponenten, also Module, haben eine eigene klare Struktur:

  • Root-Modul: Das Verzeichnis der obersten Ebene, das Ihre Hauptkonfiguration enthält.
  • Child-Module: Unterverzeichnisse, die jeweils eine eigene main.tf, variables.tf, outputs.tf usw. enthalten.
  • README.md: Unerlässlich, um Zweck, Eingaben und Ausgaben des Moduls zu erklären.

So bleiben Module in sich geschlossen und leicht wiederverwendbar.

Projektordner organisieren

Neben den Dateien ist auch die Organisation Ihrer Projektordner entscheidend, insbesondere bei größeren Umgebungen:

  • Umgebungen trennen: Verwenden Sie eigene Ordner für dev, staging und prod, jeweils mit einer eigenen Konfiguration.
  • Gemeinsamer Modulordner: Ein modules-Verzeichnis für Ihre benutzerdefinierten wiederverwendbaren Module.
  • Root-Ordner für Provider: Im Ordner der obersten Ebene werden normalerweise Provider und das State-Backend definiert.

Dies verhindert Konfigurationsabweichungen und verbessert die Verwaltbarkeit über mehrere Umgebungen hinweg.

Beispiel für eine Projektordnerstruktur

Ein typisches Terraform-Projekt mit mehreren Umgebungen könnte wie folgt aussehen und eine klare Trennung sowie Wiederverwendbarkeit ermöglichen:

. ├── modules/ │ ├── vpc/ │ │ ├── main.tf │ │ ├── variables.tf │ │ └── outputs.tf │ └── ec2-instance/ │ ├── main.tf │ └── variables.tf ├── environments/ │ ├── dev/ │ │ └── main.tf │ ├── staging/ │ │ └── main.tf │ └── prod/ │ └── main.tf └── README.md

Überprüfen Sie Ihr Verständnis

Welche der folgenden Optionen ist die beste Vorgehensweise für die Benennung einer Terraform-Eingabevariablen, die die Anzahl der Instanzen angibt?

Zusammenfassung: Struktur und Benennung

Wir haben gelernt, dass gut strukturierter und einheitlich benannter Terraform-Code entscheidend für Lesbarkeit, Wartbarkeit und die Zusammenarbeit im Team ist.

  • Organisieren Sie Dateien in main.tf, variables.tf und outputs.tf.
  • Verwenden Sie aussagekräftige Namen in Kleinbuchstaben mit Unterstrichen für Ressourcen, Variablen und Ausgaben.
  • Strukturieren Sie Module und Projektordner für Wiederverwendbarkeit und die Trennung von Umgebungen.

Diese Vorgehensweisen bilden die Grundlage für eine effektive Verwaltung von IaC!

Häufig gestellte Fragen

Ist die Lektion „Code-Struktur und Namenskonventionen“ kostenlos?

Ja — der vollständige Text von „Code-Struktur und Namenskonventionen“ ist hier im Web kostenlos zu lesen. Um sie interaktiv zu üben (integrierter Code-Editor und 24/7 KI-Tutor) und den Rest des DevOps Bootcamp-Kurses freizuschalten, upgrade auf CoddyKit PRO. Der DevOps Bootcamp-Kurs umfasst insgesamt 4 Lektionen.

Was lerne ich in „Code-Struktur und Namenskonventionen“?

Übernehmen Sie Best Practices zur Organisation Ihrer Terraform-Dateien und -Module sowie einheitliche Namenskonventionen für Ressourcen und Variablen. Du übst DevOps Bootcamp mit praktischem Code, den du direkt im Browser ausführst, und ein 24/7 KI-Tutor beantwortet deine Fragen während du die Lektion bearbeitest.

Brauche ich Erfahrung, um DevOps Bootcamp zu starten?

Keine Vorkenntnisse erforderlich. DevOps Bootcamp auf CoddyKit ist für Anfänger bis fortgeschrittene Lernende strukturiert, sodass du hier starten oder von Anfang an beginnen und in deinem eigenen Tempo voranschreiten kannst. Dies ist Lektion 1 von 4.

Wie lange dauert die Lektion „Code-Struktur und Namenskonventionen“?

Die meisten CoddyKit-Lektionen dauern etwa 5–10 Minuten. Jede ist kompakt und interaktiv, sodass du stetig Fortschritte machst und genau dort weitermachst, wo du aufgehört hast – im Web und in der App.

Kann ich in dieser DevOps Bootcamp-Lektion Code schreiben und ausführen?

Ja. Jede DevOps Bootcamp-Lektion enthält einen integrierten Code-Editor, sodass du echten Code direkt in deinem Browser schreibst und ausführst und sofort KI-Feedback erhältst — ohne lokale Einrichtung erforderlich.

Alle Lektionen in diesem Kurs

  1. Code-Struktur und Namenskonventionen
  2. Versionsverwaltung mit Git
  3. Teamzusammenarbeit und Workflows
  4. Dokumentation und Self-Service-Workflows
← Zurück zu DevOps Bootcamp