Terraform Best Practices
Search…
Kluczowe koncepty
Oficjalna dokumentacja Terraforma szczegółowo opisuje wszystkie aspekty konfiguracji. Przeczytaj ją uważnie, aby zrozumieć resztę tej sekcji.
Ta sekcja opisuje kluczowe pojęcia, które są używane w książce.
Zasób (resource)
Przykładowe zasoby to
aws_vpc, aws_db_instance, itd. Zasób należy do dostawcy (provider), może przyjmować argumenty (parameters) oraz zwracać różne atrybuty (outputs) i ma swój cykl życia (lifecycle). Może on być tworzony, pobierany, aktualizowany i usuwany.Moduł zasobu (resource module)
Moduł zasobu to zbiór połączonych zasobów, które razem wykonują wspólną akcję (np. moduł AWS VPC Terraform tworzy VPC, podsieci, bramę NAT itp.). Jest on zależny od konfiguracji dostawcy, którą można zdefiniować w nim lub w strukturach na wyższym poziomie (np. w module infrastruktury).
Moduł infrastruktury (infrastructure module)
Moduł infrastruktury to zbiór modułów zasobów, które nie muszą być ze sobą logicznie połączone, ale mogą, współpracując ze sobą służyć temu samemu celowi. Definiuje konfigurację dla dostawców, która jest następnie przekazywana do modułów zasobów podrzędnych i do samodzielnych zasobów. Zwykle ogranicza się on do pracy w pojedynczej encji na każdy logiczny separator (np. region AWS, projekt Google).
Na przykład moduł terraform-aws-atlantis wykorzystuje moduły zasobów, takie jak terraform-aws-vpc i terraform-aws-security-group, do zarządzania infrastrukturą wymaganą do uruchomienia Atlantis na AWS Fargate.
Innym przykładem jest moduł terraform-aws-cloudquery, w którym wiele modułów terraform-aws-modules jest używanych razem do zarządzania infrastrukturą, a także do tworzenia, wypychania i wdrażania obrazów platformy Docker. Wszystko w jednym miejscu.
Kompozycja (composition)
Kompozycja to zbiór modułów infrastruktury, które mogą obejmować kilka logicznie oddzielonych obszarów (np. regiony AWS, kilka kont AWS). Kompozycja służy do opisania kompletnej infrastruktury wymaganej dla całej organizacji lub projektu.
Kompozycja składa się z modułów infrastruktury, na które składają się moduły zasobów, które realizują poszczególne zasoby
Prosta kompozycja infrastruktury
Źródło danych (data source)
Źródło danych wykonuje operacje tylko do odczytu (read-only) i jest zależne od konfiguracji dostawcy. Jest ono używane w module zasobów i module infrastruktury.
Źródło danych
terraform_remote_state działa jako spoiwo dla modułów i kompozycji wyższego poziomu.Zewnętrzne źródło danych umożliwia, aby zewnętrzny program działał jako źródło danych, udostępniając dowolne dane do użycia w innym miejscu w konfiguracji Terraform. Oto przykład z modułu terraform-aws-lambda, w którym nazwa pliku jest uzyskiwana poprzez wywołanie zewnętrznego skryptu Python.
Źródło danych http wysyła żądanie HTTP GET do podanego adresu URL i zwraca informacje o odpowiedzi. Jest to często przydatne w uzyskiwaniu informacji z punktów końcowych (endpoints), dla których nie istnieje natywny dostawca Terraform.
Zdalny zapis stanu infrastruktury (remote state)
Moduły infrastruktury i kompozycje powinny zachowywać swój stan Terraform w zdalnej lokalizacji, gdzie mogą być pobierane przez inne osoby w kontrolowany sposób (np. z ACL, wersjonowaniem, rejestrowaniem).
Dostawca (provider, provisioner)
Dostawca jest bardzo dobrze opisany w oficjalnej dokumentacji. Nie ma więc sensu tego tutaj powtarzać. Moim zdaniem ma on niewiele wspólnego z pisaniem dobrych modułów w Terraform.
Skąd te trudności?
Podczas gdy poszczególne zasoby są jak atomy w infrastrukturze, moduły zasobów są molekułami. Moduł jest najmniejszą jednostką, którą wersjonujemy i możemy udostępniać innym. Ma dokładną listę argumentów i implementuje podstawową logikę. Na przykład moduł terraform-aws-security-group tworzy zasoby
aws_security_group oraz aws_security_group_rule na podstawie danych wejściowych. Może on być użyty razem z innymi modułami do stworzenia modułu infrastruktury.Dostęp do danych oraz wymiana między nimi (moduły zasobów i moduły infrastruktury) jest realizowany z wykorzystaniem wyjść modułów (module output) i źródeł danych.
Dostęp między kompozycjami jest często realizowany przy użyciu zdalnych źródeł danych stanu. Istnieje wiele sposobów na udostępnianie danych między konfiguracjami.
Starając się przedstawić opisane powyżej pojęcia przy pomocy pseudorelacji uzyskamy następującą strukturę:
1
composition-1 {
2
infrastructure-module-1 {
3
data-source-1 => d1
4
5
resource-module-1 {
6
data-source-2 => d2
7
resource-1 (d1, d2)
8
resource-2 (d2)
9
}
10
11
resource-module-2 {
12
data-source-3 => d3
13
resource-3 (d1, d3)
14
resource-4 (d3)
15
}
16
}
17
18
}
Copied!
Last modified 3mo ago