Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
Validez le code Account Factory pour Terraform (AFT) localement
Créée par Alexandru Pop (AWS) et Michal Gorniak (AWS)
Environnement : Production | Technologies : infrastructure DevOps ; modernisation ; DevelopmentAndTesting | Charge de travail : Open source |
Services AWS : AWS Control Tower |
Récapitulatif
Ce modèle montre comment tester localement le code HashiCorp Terraform géré par AWS Control Tower Account Factory for Terraform (AFT). Terraform est un outil open source d'infrastructure sous forme de code (IaC) qui vous aide à utiliser le code pour provisionner et gérer l'infrastructure et les ressources cloud. AFT met en place un pipeline Terraform qui vous aide à provisionner et à personnaliser plusieurs comptes AWS dans AWS Control Tower.
Lors du développement du code, il peut être utile de tester votre infrastructure Terraform en tant que code (IaC) localement, en dehors du pipeline AFT. Ce modèle montre comment effectuer les opérations suivantes :
Récupérez une copie locale du code Terraform stocké dans les CodeCommit référentiels AWS de votre compte de gestion AFT.
Simulez le pipeline AFT localement en utilisant le code récupéré.
Cette procédure peut également être utilisée pour exécuter des commandes Terraform qui ne font pas partie du pipeline AFT normal. Par exemple, vous pouvez utiliser cette méthode pour exécuter des commandes telles que terraform validate
terraform plan
,terraform destroy
, etterraform import
.
Conditions préalables et limitations
Prérequis
Un environnement AWS multi-comptes actif qui utilise AWS Control Tower
Un environnement AFT entièrement déployé
Interface de ligne de commande AWS (AWS CLI), installée et configurée
Assistant d'identification de la CLI AWS pour Code Commit, installé et configuré
Python 3.x
Git
, installé et configuré sur votre machine locale git-remote-commit utilitaire, installé et configuré
Terraform
, installé et configuré (la version du package Terraform local doit correspondre à la version utilisée dans le déploiement AFT)
Limites
Ce modèle ne couvre pas les étapes de déploiement requises pour AWS Control Tower, AFT ou tout autre module Terraform spécifique.
La sortie générée localement au cours de cette procédure n'est pas enregistrée dans les journaux d'exécution du pipeline AFT.
Architecture
Pile technologique cible
Infrastructure AFT déployée dans le cadre d'un déploiement d'AWS Control Tower
Terraform
Git
Version 2 de l'interface de ligne de commande AWS
Automatisation et mise à l'échelle
Ce modèle montre comment invoquer localement le code Terraform pour les personnalisations de comptes globaux AFT dans un seul compte AWS géré par AFT. Une fois votre code Terraform validé, vous pouvez l'appliquer aux comptes restants de votre environnement multi-comptes. Pour plus d'informations, consultez la section Personnalisations de Re-invoke dans la documentation d'AWS Control Tower.
Vous pouvez également utiliser un processus similaire pour exécuter des personnalisations de compte AFT dans un terminal local. Pour invoquer localement le code Terraform à partir des personnalisations de compte AFT, clonez le aft-account-customizations référentiel plutôt que le aft-global-account-customizationsréférentiel depuis votre compte de CodeCommit gestion AFT.
Outils
Services AWS
AWS Control Tower vous aide à configurer et à gérer un environnement AWS multi-comptes, conformément aux meilleures pratiques prescriptives.
L'interface de ligne de commande AWS (AWS CLI) est un outil open source qui vous permet d'interagir avec les services AWS par le biais de commandes dans votre shell de ligne de commande.
Autres services
HashiCorp Terraform
est un outil open source d'infrastructure sous forme de code (IaC) qui vous aide à utiliser le code pour provisionner et gérer l'infrastructure et les ressources cloud. Git
est un système de contrôle de version distribué et open source.
Code
Voici un exemple de script bash qui peut être utilisé pour exécuter localement du code Terraform géré par AFT. Pour utiliser le script, suivez les instructions de la section Epics de ce modèle.
#! /bin/bash # Version: 1.1 2022-06-24 Unsetting AWS_PROFILE since, when set, it interferes with script operation # 1.0 2022-02-02 Initial Version # # Purpose: For use with AFT: This script runs the local copy of TF code as if it were running within AFT pipeline. # * Facilitates testing of what the AFT pipline will do # * Provides the ability to run terraform with custom arguments (like 'plan' or 'move') which are currently not supported within the pipeline. # # © 2021 Amazon Web Services, Inc. or its affiliates. All Rights Reserved. # This AWS Content is provided subject to the terms of the AWS Customer Agreement # available at http://aws.amazon.com/agreement or other written agreement between # Customer and either Amazon Web Services, Inc. or Amazon Web Services EMEA SARL or both. # # Note: Arguments to this script are passed directly to 'terraform' without parsing nor validation by this script. # # Prerequisites: # 1. local copy of ct GIT repositories # 2. local backend.tf and aft-providers.tf filled with data for the target account on which terraform is to be run # Hint: The contents of above files can be obtain from the logs of a previous execution of the AFT pipeline for the target account. # 3. 'terraform' binary is available in local PATH # 4. Recommended: .gitignore file containing 'backend.tf', 'aft_providers.tf' so the local copy of these files are not pushed back to git readonly credentials=$(aws sts assume-role \ --role-arn arn:aws:iam::$(aws sts get-caller-identity --query "Account" --output text ):role/AWSAFTAdmin \ --role-session-name AWSAFT-Session \ --query Credentials ) unset AWS_PROFILE export AWS_ACCESS_KEY_ID=$(echo $credentials | jq -r '.AccessKeyId') export AWS_SECRET_ACCESS_KEY=$(echo $credentials | jq -r '.SecretAccessKey') export AWS_SESSION_TOKEN=$(echo $credentials | jq -r '.SessionToken') terraform "$@"
Épopées
Tâche | Description | Compétences requises |
---|---|---|
Enregistrez l'exemple de code dans un fichier local. |
| Administrateur AWS |
Rendez l'exemple de code exécutable. | Ouvrez une fenêtre de terminal et authentifiez-vous sur votre compte de gestion AWS AFT en effectuant l'une des opérations suivantes :
Remarque : votre organisation dispose peut-être également d'un outil personnalisé pour fournir des informations d'authentification à votre environnement AWS. | Administrateur AWS |
Vérifiez l'accès au compte de gestion AFT dans la bonne région AWS. | Important : Assurez-vous d'utiliser la même session de terminal que celle avec laquelle vous vous êtes authentifié sur votre compte de gestion AFT.
| Administrateur AWS |
Créez un nouveau répertoire local pour stocker le code du référentiel AFT. | Au cours de la même session de terminal, exécutez les commandes suivantes :
| Administrateur AWS |
Clonez le code du référentiel AFT distant. |
| Administrateur AWS |
Tâche | Description | Compétences requises |
---|---|---|
Ouvrez un pipeline AFT déjà exécuté et copiez les fichiers de configuration Terraform dans un dossier local. | Remarque : Les fichiers de configuration backend.tf et aft-providers.tf créés dans cette épopée sont nécessaires au fonctionnement local du pipeline AFT. Ces fichiers sont créés automatiquement dans le pipeline AFT basé sur le cloud, mais doivent être créés manuellement pour que le pipeline s'exécute localement. L'exécution locale du pipeline AFT nécessite un ensemble de fichiers représentant l'exécution du pipeline au sein d'un seul compte AWS.
Exemple d'instruction backend.tf générée automatiquement
Remarque : Les | Administrateur AWS |
Tâche | Description | Compétences requises |
---|---|---|
Implémentez les modifications de configuration Terraform que vous souhaitez valider. |
| Administrateur AWS |
Exécutez le script ct_terraform.sh et examinez le résultat. |
Important :
| Administrateur AWS |
Tâche | Description | Compétences requises |
---|---|---|
Ajoutez des références aux fichiers backend.tf et aft-providers.tf à un fichier .gitignore. | Ajoutez les
Remarque : le déplacement des fichiers vers le | Administrateur AWS |
Validez et transférez vos modifications de code dans le référentiel AFT distant. |
Important : les modifications de code que vous introduisez en suivant cette procédure jusqu'à présent ne sont appliquées qu'à un seul compte AWS. | Administrateur AWS |
Tâche | Description | Compétences requises |
---|---|---|
Appliquez les modifications à tous vos comptes gérés par AFT. | Pour appliquer les modifications à plusieurs comptes AWS gérés par AFT, suivez les instructions de la section Personnalisations Réinvoquée dans la documentation d'AWS Control Tower. | Administrateur AWS |