Aller au contenu
DevSecOps Logo DevSecOps Logo DevSecOps
Docs
Blog
Blog

Création de Modules Terraform

Mise à jour :

logo terraform

Dans le domaine de la gestion de l’infrastructure en tant que code, la factorisation et l’optimisation du code sont essentielles pour maintenir des systèmes efficaces et évolutifs. Comparable à des fonctions dans les langages de programmation, les modules Terraform offrent un moyen élégant et puissant de regrouper et de réutiliser des configurations d’infrastructure.

Les modules Terraform permettent de regrouper des configurations répétitives et de les réutiliser facilement dans différents projets. Ils apportent une modularité et une organisation améliorée à votre code, ce qui simplifie la maintenance et améliore la collaboration entre les équipes. Ce guide est conçu pour vous accompagner dans l’exploration des modules Terraform avancés, en partant de leur création jusqu’à leur utilisation dans des contextes complexes.

Fonctionnement des Modules Terraform

Les modules Terraform sont un élément clé pour organiser et réutiliser votre code d’infrastructure. Un module est simplement un ensemble de fichiers de configuration dans un répertoire. Utiliser des modules permet de regrouper des configurations communes, facilitant ainsi la gestion de projets complexes et la réduction de la duplication de code.

Les modules permettent de modéliser des composants d’infrastructure réutilisables. Par exemple, vous pouvez créer un module pour déployer un réseau virtuel, un autre pour un cluster Kubernetes et les combiner selon vos besoins spécifiques.

En isolant les différents composants de votre infrastructure dans des modules distincts, vous pouvez plus facilement gérer et maintenir chaque partie de votre infrastructure. Cela simplifie également le dépannage, car chaque module peut être testé indépendamment.

Les modules acceptent des variables, ce qui permet de personnaliser les instances du module lors de leur utilisation. Cela signifie que vous pouvez créer un module générique et le réutiliser avec des configurations spécifiques à chaque projet ou environnement.

Les modules peuvent également définir des sorties pour exposer des valeurs spécifiques aux configurations parent. Cela permet aux modules parents d’utiliser les résultats des configurations enfants.

Pour utiliser un module dans votre projet, vous devez le référencer et passer les variables nécessaires.

Structure de Base d’un Module Terraform

Pour créer un module Terraform efficace, il est essentiel de comprendre sa structure de base. Un module Terraform typique se compose de plusieurs fichiers, chacun ayant un rôle spécifique.

Terminal window
├── main.tf
├── variables.tf
├── versions.tf
├── outputs.tf
├── LICENSE
├── README.md

Explorons les composants clés :

main.tf

C’est le cœur d’un module Terraform. Le fichier main.tf contient la majorité de la logique du module, y compris la définition des ressources que le module va gérer. Par exemple, si vous créez un module pour déployer une instance de serveur virtuel dans le cloud, main.tf contiendra la configuration de cette instance. Il est possible de scinder ce fichier en plusieurs fichiers pour des raisons de clarté, mais tous seront chargés par Terraform comme s’ils étaient un seul fichier.

variables.tf

Ce fichier définit les variables utilisées dans le module. Les variables permettent de personnaliser le module à chaque utilisation, rendant le module flexible et réutilisable. Chaque variable peut avoir une valeur par défaut et les utilisateurs du module peuvent fournir leurs propres valeurs lors de l’utilisation du module. Par exemple, pour un module de serveur, vous pourriez avoir des variables pour la taille de l’instance, la région du datacenter etc.

outputs.tf

Après l’exécution d’un module, il peut être utile d’obtenir certaines informations sur les ressources créées, comme une adresse IP ou un identifiant de ressource. outputs.tf définit ces valeurs de sortie. Ces informations peuvent être utilisées par d’autres parties de votre configuration Terraform ou affichées à l’utilisateur.

Autres fichiers et dossiers

  • README.md : Bien que non requis par Terraform, un fichier README est important pour la documentation de votre module. Il doit expliquer ce que fait le module, comment l’utiliser et lister les variables et les sorties.
  • Le fichier providers.tf est utilisé pour spécifier les providers dont le module dépend. Cela permet d’isoler les configurations des providers spécifiques à chaque module et d’assurer qu’ils utilisent les bonnes versions et configurations.
  • Dossiers pour les sous-modules : Pour des modules complexes, vous pouvez organiser votre code en sous-modules, chacun dans son propre dossier, pour une meilleure organisation.

En comprenant et en utilisant efficacement cette structure, vous pouvez construire des modules Terraform clairs, maintenables et réutilisables, facilitant la gestion de votre infrastructure en tant que code.

Exemple de Module Terraform

Pour illustrer concrètement les concepts abordés, prenons l’exemple d’un module Terraform simple, mais courant : un module pour déployer une machine virtuelle dans le cloud Outscale.

Structure du Module

  • main.tf : Ce fichier contiendra la configuration nécessaire pour déployer une instance de serveur et installer un serveur web. Il utilisera des ressources Terraform comme outscale_vm et des scripts d’initialisation pour configurer le serveur.
  • variables.tf : Ici, nous définirons les variables nécessaires pour personnaliser notre serveur. Cela peut inclure :
    • vm_type : La taille de l’instance de serveur (par exemple, tinav7.c2r4p2).
    • keypair_name : La clé nécessaire à une connexion SSH.
    • imag_id : L’image du système d’exploitation à utiliser.
    • …
  • outputs.tf : Ce fichier fournira des informations utiles après le déploiement du serveur, telles que :
    • private_ip : L’adresse IP privé de l’instance de serveur.
    • id : L’identifiant unique de l’instance de serveur.
  • providers.tf

Exemple de Code

main.tf :

resource "outscale_vm" "example" {
  image_id      = var.image_id
  vm_type       = var.vm_type
  keypair_name  = var.keypair_name


  ...
}

variables.tf :

variable "image_id" {
  type = string
  description = "OS image id"
}


variable "vm_type" {
  type = string
  description = "OS image id"
}


variable "keypair_name" {
  type = string
  description = "The name of a keypair"
}

outputs.tf :

output "id" {
  value = outscale_vm.vm.id
}


output "private_ip" {
  value = outscale_vm.vm.private_ip
}

providers.tf :

terraform {
  required_providers {
    outscale = {
      source  = "outscale/outscale"
      version = "0.12.0"
    }
  }
}

Utilisation du Module

Pour utiliser ce module, un utilisateur Terraform n’a qu’à spécifier les variables requises et appeler le module dans sa configuration principale. Cela permet de déployer rapidement un serveur web dans n’importe quel projet, avec la flexibilité de personnaliser la taille de l’instance, la région et l’image du système d’exploitation.

module "outscale-vm" {
  source       = "../modules/outscale-vm"
  vm_type      = "tinav6.c2r4p1"
  keypair_name = "bastion"
  subnet_id    = data.outscale_subnet.backend_subnet-a.subnet_id
  image_id     = data.outscale_image.image.image_id
  name         = "grafana"
  group        = "grafana"
  env          = "test"
  security_group_ids = [
    data.outscale_security_group.sg-ssh-all-a.security_group_id,
    outscale_security_group.grafana.security_group_id
  ]
}

Ce module simple démontre comment la modularité dans Terraform peut simplifier et accélérer le déploiement de l’infrastructure, tout en offrant une flexibilité et une réutilisabilité significatives.

Le source du module peut aussi être placé dans un projet git :

  source       = "git@gitlab.xxxxx.internal:XXXX/terraform-outscale-vm.git"

Création de Modules Réutilisables

Un module réutilisable est conçu de manière à pouvoir être facilement adapté et intégré dans différents projets ou environnements. Voici comment procéder :

Conception Modulaire

La première étape vers la réutilisabilité est une conception modulaire efficace. Cela signifie structurer votre module de manière à ce qu’il puisse être utilisé dans différents contextes sans modification. Pensez à votre module comme à un produit : il doit être adaptable et répondre aux besoins de divers utilisateurs. Pour cela, il est essentiel de comprendre et d’anticiper les différents scénarios d’utilisation.

Utilisation de Variables

Les variables sont au cœur de la réutilisabilité dans Terraform. Elles permettent aux utilisateurs de votre module de spécifier des paramètres personnalisés comme la taille d’une instance ou l’emplacement d’une ressource. Assurez-vous que vos variables soient bien documentées et aient des valeurs par défaut. Cela rendra votre module accessible même aux utilisateurs moins expérimentés.

Sorties Flexibles

Tout comme les variables, les sorties de votre module doivent être conçues pour être utiles dans divers contextes. Elles permettent aux autres parties de votre configuration Terraform d’accéder aux informations sur les ressources créées par le module. Par exemple, l’adresse IP d’une instance de serveur pourrait être une sortie utile pour un module qui déploie des serveurs.

Documentation Claire

Un module réutilisable doit être accompagné d’une documentation complète. Cela inclut une description de ce que fait le module, comment l’utiliser et une liste de toutes les variables et sorties avec des explications. Une bonne documentation est essentielle pour que d’autres puissent utiliser votre module sans avoir à plonger dans le code source pour comprendre son fonctionnement. Vous pouvez générer la documentation avec terraform-docs ↗.

Fournir des exemples d’utilisation de votre module dans la documentation peut grandement aider les utilisateurs. Cela leur donne un point de départ pour intégrer le module dans leurs propres projets et montre concrètement comment le module peut être utilisé.

Tests et Validation

Enfin, assurez-vous que votre module soit bien testé dans différents environnements et configurations. Cela garantit non seulement sa fiabilité mais aussi sa réutilisabilité. Les tests peuvent inclure des validations de syntaxe, des plans d’exécution Terraform et des déploiements de test pour vérifier le comportement du module dans des conditions réelles.

Convention de nommage

Adoptez des conventions de nommage cohérentes pour les variables, les ressources et les sorties. Cela rend le code plus lisible et facilite la compréhension pour les nouveaux utilisateurs. Par exemple, utilisez des noms descriptifs comme instance_type plutôt que des abréviations obscures.

Gestion des Versions

Utilisez la gestion des versions pour vos modules. Cela permet aux utilisateurs de spécifier une version particulière du module pour éviter des changements inattendus si le module est mis à jour. Utilisez des tags dans votre système de contrôle de version pour marquer les versions des modules.

Sécurité et Conformité

Assurez-vous que vos modules respectent les meilleures pratiques de sécurité. Cela inclut l’utilisation de politiques de sécurité appropriées, la gestion sécurisée des secrets et la conformité aux normes réglementaires, si nécessaire.

Gestion des Dépendances

Soyez attentif aux dépendances entre modules. Gérez-les soigneusement pour éviter les conflits et les problèmes de version. Utilisez des techniques comme le versionnage ou la gestion des états pour gérer les dépendances entre ressources.

Retours et Mises à Jour Continues

Soyez réceptif aux retours des utilisateurs de vos modules. Améliorez et mettez à jour vos modules en fonction des feedbacks et des évolutions des pratiques et des technologies.

Conclusion

Les modules Terraform représentent un outil essentiel pour les utilisateurs cherchant à gérer des infrastructures complexes de manière efficace et réutilisable. Grâce aux modules, vous pouvez standardiser vos configurations, réduire la duplication de code et améliorer la maintenabilité de vos projets.

En résumé, les modules Terraform offrent une manière puissante et flexible de gérer l’infrastructure as code. En adoptant une approche modulaire, vous simplifiez la gestion de vos ressources et vous vous assurez que vos configurations sont robustes, réutilisables et faciles à maintenir.

Pour approfondir vos connaissances et obtenir plus d’exemples, je vous recommande de consulter les ressources suivantes :