Mettre à niveau des environnements

Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3

Cette page explique comment mettre à niveau votre environnement vers une nouvelle version de Cloud Composer ou d'Airflow.

À propos des opérations de mise à niveau

Vous pouvez mettre à niveau la version Cloud Composer, la version Airflow ou les deux en même temps.

Lorsque vous modifiez la version d'Airflow ou de Cloud Composer utilisée par votre environnement:

  • Cloud Composer redéploie les composants de votre environnement à l'aide de nouvelles versions des images Cloud Composer.

  • Cloud Composer applique les modifications de configuration Airflow, telles que les packages PyPI personnalisés ou les remplacements d'options de configuration Airflow, si votre environnement en proposait avant la mise à niveau.

  • Cloud Composer met à jour la connexion Airflow airflow_db pour qu'elle pointe vers la nouvelle base de données Cloud SQL.

La mise à niveau ne modifie pas la façon dont vous vous connectez aux ressources de votre environnement, comme l'URL du bucket de votre environnement ou le serveur Web Airflow.

Limites des opérations de mise à niveau

Les opérations de mise à niveau présentent les limites suivantes:

  • Vous ne pouvez pas revenir à une version antérieure de Cloud Composer ou d'Airflow.
  • Dans la console Google Cloud, vous ne pouvez effectuer une mise à niveau que vers les dernières versions compatibles de Cloud Composer.

  • Dans la Google Cloud CLI, l'API ou Terraform, vous pouvez mettre à niveau un environnement vers les dernières versions compatibles, les trois précédentes versions de Cloud Composer et vers des versions avec un calendrier de mise à niveau étendu. Il n'est pas possible de mettre à niveau vers d'autres versions de Cloud Composer, même si elles sont toujours compatibles et peuvent être utilisées pour créer un environnement.

  • La version que vous mettez à niveau doit être compatible avec la version Python actuelle de votre environnement.

  • Les limites de quota de l'API Compute Engine peuvent empêcher les mises à niveau. Dans la console Google Cloud, accédez à la page IAM et administration > Quotas et limites du système et vérifiez si le quota de processeurs de l'API Compute Engine n'est pas dépassé. Si le seuil de quota est atteint, demandez une extension de quota avant de poursuivre l'opération de mise à niveau.

  • Vous ne pouvez pas mettre à niveau votre environnement si la base de données Airflow contient plus de 16 Go de données. Lors d'une mise à niveau, un avertissement s'affiche si la taille de la base de données Airflow dépasse 16 Go. Dans ce cas, effectuez la maintenance de la base de données afin de réduire sa taille.

Avant de commencer

  • Nous vous recommandons de créer un nouvel instantané de l'environnement afin de pouvoir le recréer si nécessaire.

  • Votre compte doit disposer d'un rôle pouvant déclencher des opérations de mise à niveau de l'environnement. En outre, le compte de service de l'environnement doit disposer d'un rôle disposant d'autorisations suffisantes pour effectuer des opérations de mise à niveau. Pour en savoir plus, consultez la page Contrôle des accès.

Vérifier que votre environnement est à jour

Cloud Composer affiche des avertissements lorsque la date de fin de compatibilité totale de l'image de votre environnement approche. Vous pouvez utiliser ces avertissements pour que votre environnement reste compatible.

Un message d'abandon s'affiche sur la page "Détails de l'environnement".
Figure 1. Un message d'abandon s'affiche sur la page "Détails de l'environnement".

Cloud Composer assure le suivi de la version de l'image Cloud Composer sur laquelle votre environnement est basé. À l'approche de la date de fin de compatibilité, un avertissement s'affiche dans la liste des environnements et sur la page Détails de l'environnement.

Pour vérifier si votre environnement est à jour:

Console

  1. Dans la console Google Cloud, accédez à la page Environnements.

    Accéder à la page Environnements

  2. Dans la liste des environnements, cliquez sur le nom de votre environnement. La page Détails de l'environnement s'ouvre.

  3. Accédez à l'onglet Configuration de l'environnement.

  4. Dans le champ Version de l'image, l'un des messages suivants s'affiche :

    • Dernière version disponible Votre image d'environnement est entièrement compatible.

    • Nouvelle version disponible Votre image d'environnement est entièrement compatible et vous pouvez la mettre à niveau vers une version ultérieure.

    • La prise en charge de cette version de l'image prendra fin dans… Votre image d'environnement approche de la fin de la période de prise en charge pcomplète.

    • Cette version n'est plus compatible depuis le… Votre environnement a dépassé la période de prise en charge complète.

gcloud

Cette fonctionnalité n'est pas disponible via la Google Cloud CLI. À la place, vous pouvez afficher les mises à niveau disponibles pour afficher les nouvelles versions disponibles.

API

Cette fonctionnalité n'est pas disponible via l'API. À la place, vous pouvez afficher les mises à niveau disponibles pour afficher les nouvelles versions disponibles.

Afficher les mises à niveau disponibles

Pour afficher les versions Cloud Composer que vous pouvez mettre à niveau, procédez comme suit :

Console

  1. Dans la console Google Cloud, accédez à la page Environnements.

    Accéder à la page Environnements

  2. Dans la liste des environnements, cliquez sur le nom de votre environnement. La page Détails de l'environnement s'ouvre.

  3. Accédez à l'onglet Configuration de l'environnement, puis cliquez sur Mettre à niveau la version de l'image.

  4. Pour obtenir la liste des versions disponibles, cliquez sur le menu déroulant Version de l'image de Cloud Composer.

gcloud

gcloud composer environments list-upgrades \
  ENVIRONMENT_NAME \
  --location LOCATION

Remplacez :

  • ENVIRONMENT_NAME par le nom de l'environnement.
  • LOCATION par la région dans laquelle se trouve l'environnement.

Exemple :

gcloud composer environments list-upgrades example-environment \
  --location us-central1

API

Vous pouvez afficher les versions disponibles pour un établissement. Pour ce faire, créez une requête API imageVersions.list.

Exemple :

// GET https://composer.googleapis.com/v1/projects/example-project/
// locations/us-central1/imageVersions

Recherchez les conflits de packages PyPI avant la mise à niveau

Vous pouvez vérifier si les packages PyPI installés dans votre environnement sont en conflit avec les packages préinstallés dans la nouvelle image Cloud Composer.

Une vérification réussie signifie qu'il n'y a pas de conflits dans les dépendances des packages PyPI entre la version actuelle et la version spécifiée. Cependant, une opération de mise à niveau peut toujours échouer pour d'autres raisons.

Console

Pour exécuter une vérification des mises à niveau de votre environnement, procédez comme suit :

  1. Dans la console Google Cloud, accédez à la page Environnements.

    Accéder à la page Environnements

  2. Dans la liste des environnements, cliquez sur le nom de votre environnement. La page Détails de l'environnement s'ouvre.

  3. Accédez à l'onglet Configuration de l'environnement, recherchez l'entrée Version de l'image, puis cliquez sur Mettre à niveau.

  4. Dans la boîte de dialogue Mise à niveau de la version de l'environnement, dans la liste déroulante Nouvelle version, sélectionnez une version de Cloud Composer vers laquelle vous souhaitez effectuer la mise à niveau.

  5. Dans la section Compatibilité des packages PyPI, cliquez sur Rechercher des conflits.

  6. Attendez la fin de la vérification. En cas de conflits de dépendance du package PyPI, les messages d'erreur affichés contiennent des détails sur les packages en conflit et les versions de package.

gcloud

Pour lancer une vérification de mise à niveau pour votre environnement, exécutez la commande environments check-upgrade avec la version de l'image Cloud Composer vers laquelle vous souhaitez effectuer la mise à niveau.

gcloud composer environments check-upgrade \
  ENVIRONMENT_NAME \
  --location LOCATION \
  --image-version VERSION

Remplacez :

  • ENVIRONMENT_NAME par le nom de l'environnement.
  • LOCATION par la région dans laquelle se trouve l'environnement.
  • VERSION par la nouvelle version d'image Cloud Composer vers laquelle vous souhaitez effectuer la mise à niveau, au format composer-a.b.c-airflow-x.y.z. Vous pouvez également utiliser tous les alias de version.

Exemple :

gcloud composer environments check-upgrade example-environment \
  --location us-central1 \
  --image-version composer-2.8.3-airflow-2.7.3

Exemple de résultat :

Waiting for [projects/example-project/locations/us-central1/environments/
example-environment] to be checked for PyPI package conflicts when upgrading
to composer-2.8.3-airflow-2.7.3. Operation [projects/example-project/locations/
us-central1/operations/04d0e8b2-...]...done.
...

Response:
'@type': type.googleapis.com/
google.cloud.orchestration.airflow.service.v1.CheckUpgradeResponse
buildLogUri: https://console.cloud.google.com/cloud-build/builds/79738aa7-...
containsPypiModulesConflict: CONFLICT
pypiConflictBuildLogExtract: |-
The Cloud Build image build failed: Build failed; check build logs for
details. Full log can be found at https://console.cloud.google.com/
cloud-build/builds/79738aa7-...
Error details: tensorboard 2.2.2 has requirement
setuptools>=41.0.0, but you have setuptools 40.3.0.

Vous pouvez également exécuter une vérification de mise à niveau de manière asynchrone. Utilisez l'argument --async pour effectuer un appel asynchrone, puis vérifiez le résultat à l'aide de la commande gcloud composer operations describe.

API

Rédigez une requête d'API environments.checkUpgrade.

Spécifiez la version de l'image dans le champ imageVersion :

{
  "imageVersion": "VERSION"
}

Remplacez VERSION par la nouvelle version vers laquelle vous souhaitez effectuer la mise à niveau, au format composer-a.b.c-airflow-x.y.z.

Mettre à niveau votre environnement

Pour mettre à niveau votre environnement vers une version ultérieure de Cloud Composer ou Airflow, procédez comme suit:

Console

  1. Dans la console Google Cloud, accédez à la page Environnements.

    Accéder à la page Environnements

  2. Dans la liste des environnements, cliquez sur le nom de votre environnement. La page Détails de l'environnement s'ouvre.

  3. Accédez à l'onglet Configuration de l'environnement.

  4. Recherchez l'élément Version de l'image, puis cliquez sur Mettre à niveau.

  5. Dans le menu déroulant Version de l'image, sélectionnez une version de Cloud Composer vers laquelle vous souhaitez effectuer la mise à niveau.

  6. Cliquez sur Mettre à jour.

gcloud

gcloud composer environments update \
  ENVIRONMENT_NAME \
  --location LOCATION \
  --image-version VERSION

Remplacez :

  • ENVIRONMENT_NAME par le nom de l'environnement.
  • LOCATION par la région dans laquelle se trouve l'environnement.
  • VERSION par la nouvelle version d'image Cloud Composer vers laquelle vous souhaitez effectuer la mise à niveau, au format composer-a.b.c-airflow-x.y.z. Vous pouvez également utiliser tous les alias de version.

Exemple :

gcloud composer environments update
  example-environment \
  --location us-central1 \
  --image-version composer-2.8.3-airflow-2.7.3

API

  1. Rédigez une requête API environments.patch.

  2. Dans cette requête :

    1. Dans le paramètre updateMask, spécifiez le masque config.softwareConfig.imageVersion.

    2. Dans le corps de la requête, dans le champ imageVersion, spécifiez la nouvelle version vers laquelle vous souhaitez effectuer la mise à niveau.

Exemple :

// PATCH https://composer.googleapis.com/v1/projects/example-project/
// locations/us-central1/environments/example-environment?updateMask=
// config.softwareConfig.imageVersion

  {
    "config": {
      "softwareConfig": {
        "imageVersion": "composer-2.8.3-airflow-2.7.3"
      }
    }
  }

Terraform

Le champ image_version du bloc config.software_config contrôle l'image Cloud Composer de votre environnement. Dans ce champ, spécifiez une nouvelle image Cloud Composer.

  resource "google_composer_environment" "example" {
  provider = google-beta
  name = "ENVIRONMENT_NAME"
  region = "LOCATION"

  config {
    software_config {
      image_version = "VERSION"
    }
  }
}

Remplacez :

  • ENVIRONMENT_NAME par le nom de l'environnement.
  • LOCATION par la région dans laquelle se trouve l'environnement. la nouvelle version d'image Cloud Composer vers laquelle vous souhaitez effectuer la mise à niveau, au format composer-a.b.c-airflow-x.y.z ; Vous pouvez également utiliser tous les alias de version.

Exemple :

resource "google_composer_environment" "example" {
  provider = google-beta
  name = "example-environment"
  region = "us-central1"

  config {
    software_config {
      image_version = "composer-2.8.3-airflow-2.7.3"
    }
  }
}

Étapes suivantes