Terraform Best Practices
Terraform consultingTwitter @antonbabenkoTerraform Weekly
Deutsch (German)
Deutsch (German)
  • Willkommen
  • Grundlegende Konzepte
  • Aufbau des Codes
  • Beispiele für Code-Strukturen
    • Terragrunt
    • Terraform
      • Kleinere Infrastruktur mit Terraform
      • Mittlere Infrastruktur mit Terraform
      • Größere Infrastruktur mit Terraform
  • Namenskonventionen
  • Code-Styling
  • FAQ - Häufig gestellte Fragen
  • Referenzen
  • Schreiben von Terraform-Konfigurationen
  • Workshop
Powered by GitBook
On this page
  • Dokumentation
  • Automatisch erstellte Dokumentation
  • terraform-docs
  • Ressourcen
Export as PDF

Code-Styling

PreviousNamenskonventionenNextFAQ - Häufig gestellte Fragen

Last updated 2 years ago

  • Beispiele und Terraform-Module sollten eine Dokumentation enthalten, in der die Funktionen und deren Verwendung erklärt werden.

  • Alle Links in README.md-Dateien sollten absolut sein, damit die Terraform Registry Website sie korrekt anzeigt.

  • Die Dokumentation kann mit erstellte Diagramme und mit erstellte Blueprints enthalten.

  • Verwenden Sie , um sicherzustellen, dass der Code gültig, richtig formatiert und automatisch dokumentiert ist, bevor er nach Git gepusht und von Menschen überprüft wird.

Dokumentation

Automatisch erstellte Dokumentation

ist ein Framework für die Verwaltung und Pflege von Pre-Commit-Hooks für mehrere Programmiersprachen. Es ist in Python geschrieben und ist ein leistungsfähiges Werkzeug, um auf dem Rechner eines Entwicklers automatisch etwas zu tun, bevor der Code in ein Git-Repository übertragen wird. Normalerweise wird es verwendet, um Linter auszuführen und Code zu formatieren (siehe ).

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

Schauen Sie sich das an, um sich damit vertraut zu machen, sowie bestehende Repositories (z.B. ), in denen dies bereits verwendet wird.

terraform-docs

ist ein Werkzeug, das die Dokumentation von Terraform-Modulen in verschiedenen Ausgabeformaten erzeugt. Sie können es manuell ausführen (ohne pre-commit hooks), oder verwenden, um die Dokumentation automatisch zu aktualisieren.

@todo: Document module versions, release, GH actions

Ressourcen

  1. Blog post von :

mermaid
cloudcraft.co
Terraform Pre-Commit Hooks
pre-commit
unterstützte Hooks
pre-commit-terraform Repository
terraform-aws-vpc
terraform-docs
pre-commit-terraform hooks
pre-commit framework homepage
Collection of git hooks for Terraform to be used with pre-commit framework
Dean Wilson
pre-commit hooks and terraform - a safety net for your repositories