Cette page explique comment utiliser Infrastructure Manager pour prévisualiser le déploiement des ressources définies dans une configuration Terraform.
Un aperçu décrit les actions permettant d'activer une configuration Terraform spécifique. Avant de créer ou de mettre à jour un déploiement, vous pouvez le prévisualiser pour vérifier les ressources dont le provisionnement est prévu.
Un aperçu exécute la commande Terraform plan. Cette page suppose que vous connaissez déjà Terraform. Pour en savoir plus, consultez Terraform et Infrastructure Manager.
Pour créer un aperçu, la configuration Terraform doit être compatible avec l'une des versions de Terraform compatibles.
Avant de commencer
- Activez Infra Manager.
- Assurez-vous de disposer des autorisations IAM (Identity and Access Management) nécessaires pour créer des aperçus :
roles/config.admin. - Assurez-vous de disposer d'un compte de service avec les autorisations nécessaires. Pour en savoir plus, consultez Configurer le compte de service.
- Identifiez la configuration Terraform à prévisualiser. Assurez-vous que cette configuration Terraform respecte les contraintes, y compris qu'elle ne contient pas de données sensibles.
Si vous souhaitez stocker la configuration Terraform dans un bucket de stockage, assurez-vous qu'elle est importée dans un bucket Cloud Storage. Pour en savoir plus, consultez Importer une configuration dans un bucket de stockage.
Un bucket de stockage vous permet de contrôler l'accès à la configuration. Vous pouvez également déployer une configuration Terraform stockée dans un dépôt Git ou sur votre ordinateur local.
Prévisualiser un nouveau déploiement
La configuration Terraform que vous prévisualisez peut se trouver dans un bucket de stockage ou dans un dépôt Git.
Prévisualiser à l'aide d'une configuration Terraform stockée dans un bucket Cloud Storage
Assurez-vous que la configuration Terraform est importée dans un bucket Cloud Storage. Pour en savoir plus, consultez Importer une configuration dans un bucket de stockage.
Un bucket de stockage vous permet de contrôler l'accès à la configuration. Vous pouvez également déployer une configuration Terraform stockée dans un dépôt Git ou sur votre ordinateur local.
Pour prévisualiser la mise à jour :
gcloud infra-manager previews create projects/PROJECT_ID/locations/LOCATION/previews/PREVIEW_ID \ --service-account projects/SERVICE_ACCOUNT_PROJECT_ID/serviceAccounts/SERVICE_ACCOUNT \ --gcs-source gs://BUCKET_NAME/OBJECT_NAME \ --input-values=INPUT_1_NAME=VALUE,INPUT_2_NAME=VALUE \ --tf-version-constraint=TERRAFORM_VERSION \ --annotations="ANNOTATION_KEY=ANNOTATION_VALUE" \ --provider-source=SERVICE_MAINTAINED
Remplacez :
- PROJECT_ID est l'ID du projet dans lequel Infrastructure Manager s'exécute.
- LOCATION est l'emplacement où Infra Manager s'exécute. Pour obtenir la liste des emplacements valides, consultez Emplacements Infrastructure Manager.
- PREVIEW_ID est l'identifiant d'aperçu que vous spécifiez. Pour en savoir plus sur les contraintes liées à l'identifiant de l'aperçu, consultez Nom de l'aperçu.
- SERVICE_ACCOUNT est le nom du compte de service que vous utilisez pour appeler Infra Manager.
- SERVICE_ACCOUNT_PROJECT_ID est l'ID du projet du compte de service. Il s'agit généralement du même projet que celui dans lequel Infra Manager s'exécute.
- BUCKET_NAME est le nom du bucket de stockage où la configuration est stockée.
OBJECT_NAME est le nom d'objet du fichier de configuration. Cet objet peut être un répertoire ou un fichier ZIP, mais pas un fichier Terraform. Si vous utilisez la gestion des versions des objets, vous pouvez également spécifier le numéro de génération de l'objet. Pour en savoir plus, consultez Utiliser des objets avec des versions gérées.
Si le bucket de stockage est le chemin d'accès racine de la configuration Terraform, OBJECT_NAME est facultatif.
INPUT_1_NAME=VALUE et INPUT_2_NAME=VALUE : toutes les valeurs d'entrée de la configuration Terraform, y compris celles qui ne sont pas définies par défaut. Par exemple, vous pouvez spécifier le projet dans lequel vous déployez les ressources comme suit :
project_id=my-project.Si toutes les valeurs d'entrée sont définies par défaut dans la configuration, cette option est facultative.
Facultatif : TERRAFORM_VERSION : version de Terraform qu'Infra Manager doit utiliser pour créer l'aperçu. Consultez la section Version de Terraform compatible pour obtenir la liste des versions compatibles. Si vous supprimez cette option facultative, la dernière version de Terraform compatible avec le niveau sans frais (
1.5.7) est utilisée par défaut. Pour prévisualiser une version payante (telle que1.16.5), vous devez spécifier explicitement la version. Les aperçus n'entraînent pas de frais pour les versions payantes de Terraform.Facultatif : ANNOTATION_KEY et ANNOTATION_VALUE représentent une paire clé-valeur de texte libre qui peut être associée à vos déploiements Infra Manager. Pour en savoir plus sur l'utilisation et les contraintes des annotations et des libellés, consultez Annotations et libellés.
- Facultatif : PROVIDER_SOURCE : détermine le fournisseur Terraform pour Google Cloud que le déploiement utilise. Définissez cette option sur
SERVICE_MAINTAINEDpour utiliser le fournisseur Terraform géré par Infra Manager. Omettez ce champ pour utiliser le fournisseur Terraform géré par HashiCorp. Pour en savoir plus, consultez Utiliser le fournisseur Terraform pour Google Cloud.
Les champs du déploiement, tels que la configuration Terraform, les variables et le compte de service, sont automatiquement fusionnés dans l'aperçu, sauf si vous spécifiez de nouvelles valeurs dans la commande d'aperçu.
Maintenant que vous avez créé un aperçu, vous pouvez exporter et afficher les résultats pour examiner le plan de déploiement.
Prévisualiser à l'aide d'une configuration Terraform stockée dans un dépôt Git
Lorsque vous mettez à jour un déploiement, certaines des ressources existantes peuvent ne pas changer. La prévisualisation d'une mise à jour vous indique les ressources dont le provisionnement ou la suppression sont prévus, ainsi que celles qui ne seront pas modifiées.
Pour mettre à jour un déploiement stocké dans un dépôt Git :
Si vous utilisez un dépôt Git privé, assurez-vous de vous être connecté à votre hôte GitHub et à votre dépôt GitHub à l'aide de Cloud Build pour fournir à Infra Manager l'accès à votre dépôt.
Pour prévisualiser le déploiement :
gcloud infra-manager previews create projects/PROJECT_ID/locations/LOCATION/previews/PREVIEW_ID \ --service-account projects/SERVICE_ACCOUNT_PROJECT_ID/serviceAccounts/SERVICE_ACCOUNT \ --git-source-repo="GIT_REPO" \ --git-source-directory="DIRECTORY" \ --git-source-ref="REF" \ --input-values=INPUT_1_NAME=VALUE,INPUT_2_NAME=VALUE \ --tf-version-constraint=TERRAFORM_VERSION \ --annotations="ANNOTATION_KEY=ANNOTATION_VALUE" \ --provider-source=SERVICE_MAINTAINED
Remplacez :
- PROJECT_ID est l'ID du projet dans lequel Infrastructure Manager s'exécute.
- LOCATION est l'emplacement où Infra Manager s'exécute. Pour obtenir la liste des emplacements valides, consultez Emplacements Infrastructure Manager.
- PREVIEW_ID est l'identifiant d'aperçu que vous spécifiez. Pour en savoir plus sur les contraintes liées à l'identifiant de l'aperçu, consultez Nom de l'aperçu.
- SERVICE_ACCOUNT est le nom du compte de service que vous utilisez pour appeler Infra Manager.
- SERVICE_ACCOUNT_PROJECT_ID est l'ID du projet du compte de service. Il s'agit généralement du même projet que celui dans lequel Infra Manager s'exécute.
- GIT_REPO : dépôt Git.
- DIRECTORY : répertoire contenant la configuration Terraform.
- REF : référence Git de la configuration. La référence est facultative. Si vous ne spécifiez pas de référence, la branche configurée par défaut pour le dépôt Git est utilisée.
INPUT_1_NAME=VALUE et INPUT_2_NAME=VALUE : toutes les valeurs d'entrée de la configuration Terraform, y compris celles qui ne sont pas définies par défaut. Par exemple, vous pouvez spécifier le projet dans lequel vous déployez les ressources comme suit :
project_id=my-project.Si toutes les valeurs d'entrée sont définies par défaut dans la configuration, cette option est facultative.
Facultatif : TERRAFORM_VERSION : version de Terraform qu'Infra Manager doit utiliser pour créer l'aperçu. Consultez la section Version de Terraform compatible pour obtenir la liste des versions compatibles. Si vous supprimez cette option facultative, la dernière version de Terraform compatible avec le niveau sans frais (
1.5.7) est utilisée par défaut. Pour prévisualiser une version payante (telle que1.16.5), vous devez spécifier explicitement la version. Les versions Preview n'entraînent pas de frais pour les versions payantes de Terraform.Facultatif : ANNOTATION_KEY et ANNOTATION_VALUE représentent une paire clé-valeur de texte libre qui peut être associée à vos déploiements Infra Manager. Pour en savoir plus sur l'utilisation et les contraintes des annotations et des libellés, consultez Annotations et libellés.
- Facultatif : PROVIDER_SOURCE : détermine le fournisseur Terraform pour Google Cloud que le déploiement utilise. Définissez cette option sur
SERVICE_MAINTAINEDpour utiliser le fournisseur Terraform géré par Infra Manager. Omettez ce champ pour utiliser le fournisseur Terraform géré par HashiCorp. Pour en savoir plus, consultez Utiliser le fournisseur Terraform pour Google Cloud.
Les champs du déploiement, tels que la configuration Terraform, les variables et le compte de service, sont automatiquement fusionnés dans l'aperçu, sauf si vous spécifiez de nouvelles valeurs dans la commande d'aperçu.
Maintenant que vous avez créé un aperçu, vous pouvez exporter et afficher les résultats pour examiner le plan de déploiement.
Après avoir prévisualisé un déploiement, vous pouvez le créer pour provisionner les ressources. Pour en savoir plus, consultez Déployer des ressources.
Étapes suivantes
- Exporter et afficher les résultats de l'aperçu
- Utilisez Infra Manager pour déployer des ressources.
- Automatiser les déploiements.
- En savoir plus sur Terraform avec Infra Manager