Planifier des opérations de station de travail à l'aide de Cloud Scheduler et de Cloud Run

Ce tutoriel explique comment utiliser Cloud Scheduler et Cloud Run pour effectuer automatiquement des opérations telles que

• Planifier l'augmentation et la diminution automatiques de la taille du pool de démarrage rapide.
• Démarrer automatiquement les stations de travail selon une programmation régulière.

Ce tutoriel vous aide à augmenter et à réduire la taille du pool de démarrage rapide pour qu'elle corresponde aux horaires d'ouverture habituels.

Objectifs

1. Écrire et déployer un service Cloud Run qui met à jour la taille du pool de démarrage rapide pour une configuration de station de travail.
2. Configurez un job Cloud Scheduler qui planifie l'exécution du service créé à l'étape 1 de 9h à 17h, du lundi au vendredi, pour correspondre aux horaires d'ouverture de l'heure du Pacifique.

Coûts

Dans ce document, vous utilisez les composants facturables suivants de Google Cloud :

• Cloud Scheduler
• Cloud Run

Obtenez une estimation des coûts en fonction de votre utilisation prévue à l'aide du simulateur de coût.

Les nouveaux utilisateurs de Google Cloud peuvent bénéficier d'un essai sans frais.

Une fois que vous avez terminé les tâches décrites dans ce document, supprimez les ressources que vous avez créées pour éviter que des frais vous soient facturés. Pour en savoir plus, consultez la section Effectuer un nettoyage.

Avant de commencer

1. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Roles required to select or create a project

   • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
   • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.
   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

2. Verify that billing is enabled for your Google Cloud project.

3. Enable the Cloud Run, Cloud Scheduler, Cloud Workstations APIs, if any are not already enabled.

   Roles required to enable APIs

   To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

   Enable the APIs

4. Install the Google Cloud CLI.

5. Configure the gcloud CLI to use your federated identity.

   For more information, see Sign in to the gcloud CLI with your federated identity.

6. To initialize the gcloud CLI, run the following command:

   gcloud init

Préparer l'environnement

Définissez les variables d'environnement suivantes, qui sont utilisées par les scripts automatisés que vous créerez ultérieurement.

1. Définissez les variables PROJECT_ID et REGION que vous prévoyez d'utiliser :

   PROJECT_ID=$PROJECT_ID
   REGION=$REGION
   

   Remplacez $REGION par le nom de la région que vous prévoyez d'utiliser (par exemple, us-central1).

   Pour en savoir plus sur les régions disponibles, consultez Emplacements Cloud Workstations.

Architecture de l'application

Cette solution comprend les composants Google Cloud suivants :

• Cloud Run pour mettre à jour la taille du pool de démarrage rapide de WorkstationConfig.
• Jobs Cloud Scheduler pour effectuer des appels selon un calendrier défini afin de mettre à jour le WorkstationConfig.

créer un service Cloud Run ;

La première étape consiste à configurer un serveur Web simple pour écouter les requêtes HTTP que vous recevez sur le port 8080. Comme l'application est conteneurisée, vous pouvez écrire votre serveur dans n'importe quel langage.

Pour écrire l'application d'écouteur du serveur Web en Python, procédez comme suit :

1. Créez un répertoire nommé workstation-config-updater et modifiez les sous-répertoires comme suit :

   mkdir workstation-config-updater
   cd workstation-config-updater
   

2. Créez un fichier nommé app.py et collez-y le code suivant :

   import os, subprocess
   from flask import Flask, request, abort
   
   app = Flask(__name__)
   
   @app.route("/", methods=["POST"])
   def update():
       app.logger.info("Update request received.")
       data = request.json
       cluster = data["cluster"]
       region = data["region"]
       pool_size = data["pool-size"]
   
       path = os.path.join(app.root_path, "update_config.sh")
       o = subprocess.run(
           [path, cluster, region, pool_size],
           stdout=subprocess.PIPE, stderr=subprocess.STDOUT, text=True
       )
       app.logger.info("Sending response:", o.stdout)
       return o.stdout
   
   if __name__ == "__main__":
       app.run(host="0.0.0.0", port=8080, debug=True)
   

   Ce code crée un serveur Web de base qui écoute le port défini par la variable d'environnement PORT et exécute le script update_config.sh.

3. Créez un fichier nommé update_config.sh et collez-y le code suivant :

   #!/bin/bash
   
   set -e
   
   if [ $# -ne 3 ]
   then
      echo "Usage: update_config.sh CLUSTER REGION POOL_SIZE"
      exit 1
   fi
   
   CLUSTER=$1
   REGION=$2
   POOL_SIZE=$3
   
   # list workstation configs
   echo "Attempting to list workstation configs in cluster $CLUSTER and region $REGION ..."
   for CONFIG in $(gcloud  workstations configs list --cluster $CLUSTER --region $REGION --format="value(NAME)"); do
       echo "Attempting to update Quick Pool Size to $POOL_SIZE for config $CONFIG ..."
       # update the workstation config pool-size
       RET=$(gcloud workstations configs update $CONFIG --cluster $CLUSTER  --region $REGION --pool-size=$POOL_SIZE)
       if [[ $RET -eq 0 ]]; then
           echo "Workstation config $CONFIG updated."
       else
           echo "Workstation config $CONFIG update failed."
       fi
   done
   
   

   Ce script utilise des commandes gcloud pour lister tous les WorkstationConfig d'un cluster donné et définir la taille du pool de démarrage rapide sur POOL_SIZE.

4. Créez un fichier nommé Dockerfile et collez-y le code suivant :

   FROM google/cloud-sdk
   
   RUN apt-get update && apt-get install -y python3-pip python3
   
   # Copy local code to the container image.
   ENV APP_HOME /app
   WORKDIR $APP_HOME
   COPY . ./
   
   RUN /bin/bash -c 'ls -la; chmod +x ./update_config.sh'
   
   # Install production dependencies.
   RUN pip3 install Flask gunicorn
   
   # Run the web service on container startup
   CMD exec gunicorn --bind :8080 --workers 1 --threads 8 app:app
   

   Ce code conteneurise l'application pour qu'elle soit prête à être déployée sur Cloud Run.

Déployer dans Cloud Run

Pour déployer sur Cloud Run, exécutez la commande suivante :

gcloud run deploy --source . --project $PROJECT_ID --region $REGION

1. Lorsque vous êtes invité à saisir le nom du service, appuyez sur Entrée pour accepter le nom par défaut workstation-config-updater.

2. Si vous êtes invité à activer l'API Artifact Registry ou à autoriser la création du dépôt Artifact Registry, appuyez sur y.

3. Lorsque vous êtes invité à autoriser les appels non authentifiés, appuyez sur n.

4. Patientez jusqu'à la fin du déploiement.

5. Lorsque l'URL du service s'affiche au format suivant, copiez-la :

SERVICE_URL=$SERVICE_URL

Configurer un compte de service pour appeler Cloud Run

Le service workstation-config-updater que vous avez déployé n'autorise pas les appels non authentifiés.

Cloud Scheduler nécessite un compte de service disposant des identifiants appropriés pour appeler le service workstation-config-updater.

Configurer le compte de service

1. Si vous ne disposez pas déjà d'un compte de service que vous souhaitez utiliser pour les jobs Cloud Scheduler, créez un compte de service.

   gcloud iam service-accounts create $SERVICE_ACCOUNT_NAME \
       --description="$DESCRIPTION" \
       --display-name="$DISPLAY_NAME"

2. Ajoutez la liaison de rôle IAM requise pour permettre à votre compte de service d'appeler Cloud Run.

   gcloud run services add-iam-policy-binding workstation-config-updater \
       --member=serviceAccount:$SERVICE_ACCOUNT_NAME@$PROJECT_ID. \
       --region $REGION \
       --role=roles/run.invoker

Créer une configuration Cloud Scheduler avec authentification

1. Créez un job et spécifiez le URL que vous avez copié à partir de Déployer sur Cloud Run :

   gcloud scheduler jobs create http workstation-pool-increaser-cron \
       --http-method=POST \
       --location=us-central1 \
       --schedule="0 9 * * 1-5" \
       --time-zone="America/Los_Angeles" \
       --headers "Content-Type=application/json" \
       --message-body='{"cluster":"$CLUSTER", "region":"$REGION", "pool-size": "2"}' \
       --uri=$SERVICE_URL \
       --oidc-service-account-email=$SERVICE_ACCOUNT_NAME@$PROJECT_ID.

   Cette commande planifie un job pour augmenter la taille du pool de démarrage rapide pour tous les WorkstationConfigs dans WorkstationCluster $CLUSTER à 2 à 9h PST du lundi au vendredi.

   Pour plus d'informations, reportez-vous à la rubrique Configurer la planification de tâches.

2. De même, pour réduire à 0 la taille du pool de votre configuration de station de travail à la fin d'une journée de travail, exécutez la commande suivante :

   gcloud scheduler jobs create http workstation-pool-decreaser-cron \
       --http-method=POST \
       --location=$REGION \
       --schedule="0 17 * * 1-5" \
       --time-zone="America/Los_Angeles" \
       --headers "Content-Type=application/json" \
       --message-body='{"cluster":"$CLUSTER", "region":"$REGION", "pool-size": "0"}' \
       --uri=$SERVICE_URL \
       --oidc-service-account-email=$SERVICE-ACCOUNT@$PROJECT_ID.

Facultatif : Vérifier les jobs

Pour vous assurer que vos jobs fonctionnent comme prévu, vous pouvez les vérifier.

1. Accédez à la page Cloud Scheduler dans la console Google Cloud .

   Accéder à Cloud Scheduler

   workstation-pool-increaser-cron devrait apparaître dans la liste des jobs.

2. Sur la ligne correspondant au job workstation-pool-increaser-cron, cliquez sur Actions > Forcer l'exécution d'un job.

   L'exécution du premier job créé dans un projet peut prendre quelques minutes.

3. Dans la colonne État de la dernière exécution, l'état Success indique que le job a bien été exécuté.

Pour vérifier que les configurations de stations de travail sont mises à jour, procédez comme suit :

1. Accédez à la page Configurations de stations de travail de la console Google Cloud .

   Accéder aux configurations de stations de travail

2. Vérifiez que la taille du pool de démarrage rapide est de 2.

3. Affichez les journaux de votre service Cloud Run.

Effectuer un nettoyage

Pour éviter que les ressources utilisées lors de ce tutoriel soient facturées sur votre compte Google Cloud, supprimez le projet contenant les ressources, ou conservez le projet et supprimez les ressources individuelles.

Supprimer le projet de test

Pour éviter que des frais supplémentaires ne soient facturés sur votre compte Google Cloud , supprimez toutes les ressources que vous avez déployées avec ce guide de démarrage rapide.

Supprimer votre dépôt

Cloud Run ne vous facture pas lorsque votre service déployé n'est pas utilisé. Toutefois, il se peut que des frais vous soient facturés pour le stockage de l'image de conteneur dans Artifact Registry. Pour supprimer des dépôts Artifact Registry, suivez les étapes de la section Supprimer des dépôts de la documentation Artifact Registry.

Supprimer votre service

Les services Cloud Run n'entraînent aucuns frais tant qu'ils ne reçoivent pas de requêtes. Pour supprimer votre service Cloud Run, suivez l'une de ces étapes :

Console

Pour supprimer un service, procédez comme suit :

1. Dans la console Google Cloud , accédez à la page Services Cloud Run :

   Accédez à Cloud Run

2. Recherchez le service que vous souhaitez supprimer dans la liste des services, puis cliquez la case correspondante pour le sélectionner.

3. Cliquez sur Supprimer pour supprimer toutes les révisions du service.

gcloud

Pour supprimer un service, exécutez la commande suivante :

gcloud run services delete SERVICE --region REGION

Remplacez les éléments suivants :

• SERVICE : nom de votre service.
• REGION : région Google Cloud du service.

Supprimer votre projet de test

La suppression de votre projet Google Cloud arrête la facturation de toutes les ressources de ce projet. Pour libérer toutes les ressources Google Cloud de votre projet, procédez comme suit :

Attention : La suppression d'un projet entraîne les effets décrits ci-dessous :
• Tout le contenu du projet est supprimé. Si vous avez utilisé un projet existant pour les tâches décrites dans ce document et que vous le supprimez, vous supprimerez également tout autre travail effectué dans le projet.
• Les ID de projets personnalisés sont perdus. Lorsque vous avez créé ce projet, vous avez peut-être créé un ID de projet personnalisé que vous souhaitez utiliser à l'avenir. Pour conserver les URL qui utilisent l'ID de projet, telle qu'une URL appspot.com, supprimez les ressources sélectionnées dans le projet au lieu de supprimer l'ensemble du projet.
1. Dans la console Google Cloud , accédez à la page Gérer les ressources.

   Accéder à la page "Gérer les ressources"

2. Dans la liste des projets, sélectionnez le projet que vous souhaitez supprimer, puis cliquez sur Supprimer.
3. Dans la boîte de dialogue, saisissez l'ID du projet, puis cliquez sur Arrêter pour supprimer le projet.

Supprimer des jobs Cloud Scheduler

Pour supprimer des ressources Cloud Scheduler individuelles,

1. Accédez à la page Cloud Scheduler dans la console Google Cloud .

   Accéder à Cloud Scheduler

2. Cochez les cases situées en regard de vos tâches.

3. Cliquez sur le bouton Supprimer en haut de la page et confirmez la suppression.

Étapes suivantes

• Découvrez des architectures de référence, des schémas et des bonnes pratiques concernant Google Cloud. Consultez notre Cloud Architecture Center.