Terraform Infrastructure as Code · Lekcja

Struktura kodu i konwencje nazewnicze

Stosuj dobre praktyki organizowania plików i modułów Terraform oraz spójne konwencje nazewnicze zasobów i zmiennych.

Struktura kodu i konwencje nazewnicze to bezpłatna lekcja Terraform Infrastructure as Code na CoddyKit. To lekcja 1 z 4. Możesz przeczytać całą lekcję poniżej za darmo — a potem ćwiczyć ją interaktywnie w przeglądarce z wbudowanym edytorem kodu i tutorem AI dostępnym 24/7. To część ścieżki edukacyjnej Terraform Infrastructure as Code, a Twój postęp synchronizuje się między webem a aplikacją CoddyKit. Kurs Terraform Infrastructure as Code zawiera 4 lekcji w sumie.

Po co strukturyzować kod Terraform?

Podobnie jak uporządkowanie fizycznego miejsca pracy, odpowiednia struktura kodu Terraform ułatwia jego zrozumienie, zarządzanie nim i współpracę nad nim.

Dobra struktura zwiększa czytelność, ogranicza liczbę błędów i pomaga nowym członkom zespołu szybko wdrożyć się w projekt.

Najważniejsze pliki Terraform

Projekty Terraform zwykle zaczynają się od kilku kluczowych plików. Organizowanie konfiguracji w tych plikach jest powszechną dobrą praktyką:

main.tf: Definiuje zasoby i moduły.
variables.tf: Deklaruje wszystkie zmienne wejściowe.
outputs.tf: Definiuje wartości wyjściowe infrastruktury.
versions.tf: Określa wersje Terraform i providerów.

Nazywanie zasobów

Spójne nazewnictwo ułatwia identyfikowanie zasobów. Należy przestrzegać następujących ogólnych wytycznych dotyczących nazwy lokalnej (np. my_instance w resource "aws_instance" "my_instance"):

Używaj opisowych nazw: Co robi dany zasób?
Używaj łączników lub podkreśleń: Zwiększają czytelność (np. web-server-sg lub web_server_sg).
Unikaj ogólnych nazw: server jest mniej pomocne niż app-frontend-server.

Lokalne nazwy zasobów Terraform powinny być unikatowe w obrębie modułu.

Konwencje nazewnictwa zmiennych

Zmienne zwiększają elastyczność konfiguracji. Odpowiednie ich nazwanie ma kluczowe znaczenie:

Małe litery i podkreślenia: To najczęściej stosowana konwencja (np. instance_type, vpc_id).
Precyzyjne nazwy: Co kontroluje dana zmienna?
Dodawaj opisy: Wyjaśniaj przeznaczenie zmiennej, aby zwiększyć przejrzystość.

Dobre nazwy zmiennych pomagają innym zrozumieć, jakich danych wejściowych oczekuje moduł.

Nazywanie wartości wyjściowych

Wartości wyjściowe udostępniają ważne informacje o wdrożonej infrastrukturze. Spójne nazewnictwo ułatwia korzystanie z nich:

Małe litery i podkreślenia: Podobnie jak w przypadku zmiennych, np. web_server_ip.
Opisuj wartość: Jakie informacje udostępnia?
Dodawaj opisy: Są niezbędne w przypadku wartości wyjściowych modułu, aby wyjaśnić, co zwracają.

Przykład: prosta konfiguracja

Ten kompletny plik main.tf pokazuje dobre praktyki nazewnictwa zasobu, zmiennej i wartości wyjściowej. Można za jego pomocą uruchomić terraform init i terraform plan.

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
}

Strukturyzowanie modułów Terraform

W przypadku wielokrotnego użytku moduły mają własną przejrzystą strukturę:

Moduł główny: Katalog najwyższego poziomu zawierający główną konfigurację.
Moduły podrzędne: Podkatalogi, z których każdy zawiera własne pliki main.tf, variables.tf, outputs.tf itd.
README.md: Niezbędny do wyjaśnienia przeznaczenia modułu oraz jego danych wejściowych i wyjściowych.

Dzięki temu moduły są samodzielne i łatwe do ponownego wykorzystania.

Organizowanie folderów projektu

Oprócz samych plików kluczowe znaczenie ma sposób organizacji folderów projektu, szczególnie w przypadku większych konfiguracji:

Rozdziel środowiska: Utwórz osobne foldery dla dev, staging i prod, z których każdy będzie zawierał własną konfigurację.
Wspólny folder modułów: Katalog modules na własne moduły wielokrotnego użytku.
Folder główny dla providerów: Folder najwyższego poziomu zwykle definiuje providery i backend stanu.

Zapobiega to rozbieżnościom między konfiguracjami i ułatwia zarządzanie środowiskami.

Przykład struktury folderów projektu

Typowy wielośrodowiskowy projekt Terraform może wyglądać następująco, zapewniając przejrzysty podział i możliwość ponownego użycia:

.
├── 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

Sprawdź swoje zrozumienie

Która z poniższych praktyk jest najlepsza podczas nazywania zmiennej wejściowej Terraform określającej liczbę instancji?

Podsumowanie: struktura i nazewnictwo

Dowiedzieliśmy się, że dobrze ustrukturyzowany i spójnie nazwany kod Terraform ma kluczowe znaczenie dla czytelności, łatwości utrzymania i współpracy w zespole.

Organizuj pliki w main.tf, variables.tf i outputs.tf.
Używaj opisowych nazw pisanych małymi literami i połączonych podkreśleniami dla zasobów, zmiennych i wartości wyjściowych.
Organizuj moduły i foldery projektu tak, aby umożliwić ponowne wykorzystanie oraz rozdzielenie środowisk.

Praktyki te stanowią podstawę skutecznego zarządzania IaC!

Często zadawane pytania

Czy lekcja „Struktura kodu i konwencje nazewnicze” jest bezpłatna?

Tak — pełny tekst „Struktura kodu i konwencje nazewnicze” jest dostępny za darmo tutaj w sieci. Aby ćwiczyć ją interaktywnie (wbudowany edytor kodu i tutor AI dostępny 24/7) i odblokować resztę kursu Terraform Infrastructure as Code, przejdź na CoddyKit PRO. Kurs Terraform Infrastructure as Code zawiera 4 lekcji w sumie.

Co nauczysz się w „Struktura kodu i konwencje nazewnicze”?

Stosuj dobre praktyki organizowania plików i modułów Terraform oraz spójne konwencje nazewnicze zasobów i zmiennych. Ćwiczysz Terraform Infrastructure as Code z praktycznym kodem, który uruchamiasz bezpośrednio w przeglądarce, a tutor AI dostępny 24/7 odpowiada na Twoje pytania podczas pracy nad lekcją.

Czy potrzebuję doświadczenia, aby zacząć Terraform Infrastructure as Code?

Nie wymagamy żadnego doświadczenia. Terraform Infrastructure as Code w CoddyKit jest strukturyzowany dla początkujących i zaawansowanych użytkowników, więc możesz zacząć tutaj lub od początku i uczyć się w swoim tempie. To lekcja 1 z 4.

Ile czasu zajmuje lekcja „Struktura kodu i konwencje nazewnicze”?

Większość lekcji CoddyKit trwa około 5–10 minut. Każda lekcja to mały, interaktywny krok, dzięki czemu robisz systematyczne postępy i zawsze wracasz dokładnie do tego samego miejsca — na webie i w aplikacji.

Czy mogę pisać i uruchamiać kod w tej lekcji Terraform Infrastructure as Code?

Tak. Każda lekcja Terraform Infrastructure as Code zawiera wbudowany edytor kodu, więc piszesz i uruchamiasz prawdziwy kod bezpośrednio w przeglądarce i od razu otrzymujesz sprzężenie zwrotne od AI — bez konfiguracji na komputerze.

Wszystkie lekcje w tym kursie

← Powrót do Terraform Infrastructure as Code