Créer des environnements avec Terraform

Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3

Cette page accompagne la page principale sur créer des environnements. Il explique comment configurer un environnement Cloud Composer et un compte de service géré par l'utilisateur pour cet environnement dans un projet Google Cloud existant avec Terraform. Vous pouvez utiliser cette page comme point de départ, puis en ajouter d'autres paramètres de configuration propres à votre environnement, selon vos besoins.

Avant de commencer

• Ce guide suppose que vous disposez d'un projet Google Cloud avec une facturation configurée :

  • Vous pouvez utiliser un projet existant.
  • Vous pouvez créer un projet. à l'aide de la console Google Cloud, de la Google Cloud CLI, de l'API ou d'une bibliothèque cliente Python.
  • Vous pouvez créer et gérer votre projet à l'aide de Terraform. Pour plus consultez la documentation Terraform pour découvrir Ressource google_project.

• Installez gcloud CLI.

Authentification avec Google Cloud

Pour vous authentifier auprès de Google Cloud, exécutez la commande suivante:

gcloud auth application-default login

Pour en savoir plus sur cette commande, consultez la page sur gcloud auth application-default.

Configurer le fournisseur Google dans Terraform

Spécifiez votre ID de projet existant et une région par défaut pour les ressources. Votre environnement Cloud Composer utilise cette région.

Remarque : Le fournisseur google-beta est compatible avec les fonctionnalités Cloud Composer en version Preview. Si vous souhaitez n'utiliser que les fonctionnalités GA de Cloud Composer, utilisez le fournisseur google au lieu de google-beta.

provider "google-beta" {
  project = "example-project"
  region  = "us-central1"
}

Activer l'API Cloud Composer

Activez l'API Cloud Composer dans votre projet:

resource "google_project_service" "composer_api" {
  provider = google-beta
  project = "example-project"
  service = "composer.googleapis.com"
  // Disabling Cloud Composer API might irreversibly break all other
  // environments in your project.
  // This parameter prevents automatic disabling
  // of the API when the resource is destroyed.
  // We recommend to disable the API only after all environments are deleted.
  disable_on_destroy = false
  // this flag is introduced in 5.39.0 version of Terraform. If set to true it will
  //prevent you from disabling composer_api through Terraform if any environment was
  //there in the last 30 days
  check_if_service_has_usage_on_destroy = true
}

Créer un compte de service personnalisé dans votre projet

Par défaut, les environnements Cloud Composer utilisent compte Compute Engine. Ce guide présente une autre approche, en créant un compte de service disposant de toutes les autorisations requises pour exécuter un environnement Cloud Composer.

Remarque : Ce compte de service peut nécessiter des autorisations supplémentaires pour accéder aux autres ressources de votre projet. Par exemple, si vos DAG transfèrent des données BigQuery, ce compte peut nécessiter des autorisations ou des rôles spécifiques à BigQuery.

Définissez un compte de service personnalisé avec les rôles et autorisations suivants. Pour plus d'informations sur les autorisations pour les comptes de service de l'environnement, consultez Contrôle des accès avec IAM

resource "google_service_account" "custom_service_account" {
  provider = google-beta
  account_id   = "custom-service-account"
  display_name = "Example Custom Service Account"
}

resource "google_project_iam_member" "custom_service_account" {
  provider = google-beta
  project  = "example-project"
  member   = format("serviceAccount:%s", google_service_account.custom_service_account.email)
  // Role for Public IP environments
  role     = "roles/composer.worker"
}

Créez un environnement

Créez votre environnement à l'aide de Terraform.

Cet exemple montre comment créer un environnement qui utilise un de service géré. Vous pouvez ajouter d'autres paramètres qui définissent d'autres configurations paramètres de votre environnement, tels que l'évolutivité et les performances personnalisées des paramètres ou des packages PyPI supplémentaires.

Pour en savoir plus sur les autres paramètres, consultez la page Créer des environnements.

Attention :Si vous utilisez des alias de version dans le paramètre image_version, il se peut que votre environnement soit mis à niveau vers lorsque vous exécutez terraform apply. Pour éviter cela, utilisez une version spécifique dans ce paramètre.

resource "google_composer_environment" "example_environment" {
  provider = google-beta
  name = "example-environment"

  config {

    software_config {
      image_version = "composer-1.20.12-airflow-1.10.15"
    }

    node_config {
      service_account = google_service_account.custom_service_account.email
    }

  }
}

Script Terraform complet (paramètres par défaut)

provider "google-beta" {
  project = "example-project"
  region  = "us-central1"
}

resource "google_project_service" "composer_api" {
  provider = google-beta
  project = "example-project"
  service = "composer.googleapis.com"
  // Disabling Cloud Composer API might irreversibly break all other
  // environments in your project.
  disable_on_destroy = false
  // this flag is introduced in 5.39.0 version of Terraform. If set to true it will
  //prevent you from disabling composer_api through Terraform if any environment was
  //there in the last 30 days
  check_if_service_has_usage_on_destroy = true
}

resource "google_composer_environment" "example_environment" {
  provider = google-beta
  name = "example-environment"

  config {

    // Add your environment configuration here

    software_config {
      image_version = "composer-1.20.12-airflow-1.10.15"
    }

  }
}

Script Terraform complet (compte de service personnalisé)

provider "google-beta" {
  project = "example-project"
  region  = "us-central1"
}

resource "google_project_service" "composer_api" {
  provider = google-beta
  project = "example-project"
  service = "composer.googleapis.com"
  // Disabling Cloud Composer API might irreversibly break all other
  // environments in your project.
  disable_on_destroy = false
  // this flag is introduced in 5.39.0 version of Terraform. If set to true it will
  //prevent you from disabling composer_api through Terraform if any environment was
  //there in the last 30 days
  check_if_service_has_usage_on_destroy = true
}

resource "google_service_account" "custom_service_account" {
  provider = google-beta
  account_id   = "custom-service-account"
  display_name = "Example Custom Service Account"
}

resource "google_project_iam_member" "custom_service_account" {
  provider = google-beta
  project  = "example-project"
  member   = format("serviceAccount:%s", google_service_account.custom_service_account.email)
  // Role for Public IP environments
  role     = "roles/composer.worker"
}

resource "google_composer_environment" "example_environment" {
  provider = google-beta
  name = "example-environment"

  config {

    software_config {
      image_version = "composer-1.20.12-airflow-1.10.15"
    }

    node_config {
      service_account = google_service_account.custom_service_account.email
    }

  }
}

Étape suivante

Consultez les autres pages de documentation pour en savoir plus sur la configuration de votre environnement avec Terraform. Exemple :

• Créer des environnements
• Remplacer les options de configuration Airflow
• Définir des variables d'environnement
• Installer des dépendances Python
• Faire évoluer des environnements