Convention des noms

Terraform Best Practices

Terraform AWS modules, training and consulting Twitter @antonbabenko Terraform Weekly

Search…

Français (French)

Bienvenue

Concepts clés

Structure du code

Exemples de structure de code

Ecrire des configurations Terraform

Atélier

Convention des noms

Conventions générales
Il ne devrait y avoir aucune raison de ne pas suivre au moins ces conventions :)
Prenez notes que les ressources réelles dans le cloud ont souvent des restrictions dans les noms autorisés. Certaines ressources, par exemple, ne peuvent pas contenir de tirets, certaines doivent être en camel-case. Les conventions de ce livre font référence aux noms Terraform eux-mêmes.
1.Utilisez _ (surligné) au lieu de - (tiret) partout (noms des ressources, noms des sources de données, noms des variables, sorties, etc.).
2.Préférez les lettres minuscules et les chiffres (même si UTF-8 est pris en charge).
Arguments de ressource et de source de données
1.Ne répétez pas le type de ressource dans le nom de la ressource (ni partiellement, ni complètement) :
resource "aws_route_table" "public" {}
resource "aws_route_table" "public_route_table" {}
resource "aws_route_table" "public_aws_route_table" {}
2.Le nom de la ressource doit être ainsi donné s'il n'y a plus de nom descriptif et général disponible, ou si le module de ressources crée une seule ressource de ce type (par exemple, dans AWS VPC module il y a une seule ressource de type aws_nat_gateway et plusieurs ressources de typeaws_route_table, donc aws_nat_gateway pourrait être nommé this etaws_route_table devrait avoir des noms plus descriptifs - comme private, public, database).
3.Toujours utilisez des noms au singulier.
4.Utiliser - à l'intérieur des valeurs des arguments et aux endroits où la valeur sera exposée à un humain (par exemple, à l'intérieur du nom DNS de l'instance RDS).
5.Inclure l'argument count / for_each à l'intérieur du bloc de ressource ou de source de données comme premier argument en haut et séparé par une nouvelle ligne après celui-ci.
6.Inclure l'argument tags,si pris en charge par ressource, comme dernier argument réel, suivi de depends_on etlifecycle, si necessaire. Tous ces éléments doivent être séparés par une seule ligne vide.
7.Lorsque vous utilisez des conditions dans un argumentcount / for_each, il est préférable d'employer les valeurs booléennes au lieu delength ou d'autres expressions.
Exemples de  code de ressource
Utilisation de count / for_each
main.tf
1
resource "aws_route_table" "public" {
2
  count = 2
3
​
4
  vpc_id = "vpc-12345678"
5
  # ... remaining arguments omitted
6
}
7
​
8
resource "aws_route_table" "private" {
9
  for_each = toset(["one", "two"])
10
​
11
  vpc_id = "vpc-12345678"
12
  # ... remaining arguments omitted
13
}
Copied!
main.tf
1
resource "aws_route_table" "public" {
2
  vpc_id = "vpc-12345678"
3
  count  = 2
4
​
5
  # ... remaining arguments omitted
6
}
Copied!
Emplacement de tags
main.tf
1
resource "aws_nat_gateway" "this" {
2
  count = 2
3
​
4
  allocation_id = "..."
5
  subnet_id     = "..."
6
​
7
  tags = {
8
    Name = "..."
9
  }
10
​
11
  depends_on = [aws_internet_gateway.this]
12
​
13
  lifecycle {
14
    create_before_destroy = true
15
  }
16
}   
Copied!
main.tf
1
resource "aws_nat_gateway" "this" {
2
  count = 2
3
​
4
  tags = "..."
5
​
6
  depends_on = [aws_internet_gateway.this]
7
​
8
  lifecycle {
9
    create_before_destroy = true
10
  }
11
​
12
  allocation_id = "..."
13
  subnet_id     = "..."
14
}
Copied!
Conditions dans count
outputs.tf
1
resource "aws_nat_gateway" "that" {    # Best
2
  count = var.create_public_subnets ? 1 : 0
3
}
4
​
5
resource "aws_nat_gateway" "this" {    # Good
6
  count = length(var.public_subnets) > 0 ? 1 : 0
7
}
Copied!
Variables
1.Ne réinventez pas la roue dans les modules de ressources : utilisez le nom, la description et la valeur par défaut des variables telles que définies dans la section "Référence des arguments" pour la ressource avec laquelle vous travaillez.
2.La prise en charge de la validation dans les variables est plutôt limitée (par exemple, impossible d'accéder à d'autres variables ou de faire des recherches). Planifiez en conséquence car dans de nombreux cas, cette fonctionnalité est inutile.
3.Utilisez la forme plurielle dans un nom de variable lorsque type est list(...) ou map(...).
4.Ordonner les clés dans un bloc variable comme ceci: description , type, default, validation.
5.Toujours inclure description sur toutes les variables même si vous pensez que c'est évident (vous en aurez besoin à l'avenir).
6.Préférez l'utilisation de types simples (number, string, list(...), map(...), any) plutôt qu'un type spécifique comme object() sauf si vous avez besoin d'avoir des contraintes strictes sur chaque clé.
7.Utilisez des types spécifiques comme map(map(string))si tous les éléments de la carte ont le même type (par exemple, string) ou peuvent être convertis en celui-ci (par exemple, le type de nombre peut être converti en string).
8.Utilisez type any pour désactiver la validation de type à partir d'une certaine profondeur ou lorsque plusieurs types doivent être pris en charge.
9.La Valeur {} est parfois un map mais quelques fois object. Utiliser tomap(...) pour créer une carte car il n'y a aucun moyen de créer un objet.
Sorties
Faire les sorties cohérentes et compréhensibles en dehors de son champ d'application (lorsqu'un utilisateur utilise un module, le type et l'attribut de la valeur renvoyée doivent être évidents).
1.Le nom de la sortie doit décrire la propriété qu'il contient et être moins libre que vous ne le souhaiteriez normalement.
2.Une bonne structure pour le nom de la sortie ressemble à {name}_{type}_{attribute} , où:
1.{name} est le nom de la ressource ou de la source de données sans le préfixe du fournisseur. {name} pour aws_subnet est sous-réseau, pouraws_vpc ce sera vpc.
2.{type} est le type de ressource 
3.{attribute} est l'attribut retourné par la sortie
4.​Voir exemples.
3.Si la sortie renvoie une valeur avec des fonctions d'interpolation et plusieurs ressources, {name} et {type} il devrait être aussi générique que possible (this comme préfixe être omis). Voir exemple.
4.Si la valeur renvoyée est une liste, elle doit avoir un nom au pluriel. Voir exemple.
5.Incluez toujours une description pour toutes les sorties, même si vous pensez que c'est évident.
6.Évitez de définir un argument sensible à moins que vous ne contrôliez entièrement l'utilisation de cette sortie à tous les endroits de tous les modules
7.Préférez try() (disponible depuis Terraform 0.13) à element(concat(...)) (approche héritée pour la version antérieure à 0.13)
Exemples de Code de sortie (output)
Renvoie au plus un ID de groupe de sécurité :
outputs.tf
1
output "security_group_id" {
2
  description = "The ID of the security group"
3
  value       = try(aws_security_group.this[0].id, aws_security_group.name_prefix[0].id, "")
4
}
Copied!
Lorsque vous avez plusieurs ressources du même type, cela doit être omis dans le nom de la sortie:
outputs.tf
1
output "this_security_group_id" {
2
  description = "The ID of the security group"
3
  value       = element(concat(coalescelist(aws_security_group.this.*.id, aws_security_group.web.*.id), [""]), 0)
4
}
Copied!
Utilisez un nom pluriel si la valeur retournée est une liste
outputs.tf
1
output "rds_cluster_instance_endpoints" {
2
  description = "A list of all cluster instance endpoints"
3
  value       = aws_rds_cluster_instance.this.*.endpoint
4
}
Copied!
​