Créer un workflow à l'aide de la gcloud CLI

Créer un workflow à l'aide de la gcloud CLI

Dans ce guide de démarrage rapide, vous allez découvrir comment créer, déployer et exécuter votre premier workflow à l'aide de Google Cloud CLI. L'exemple de workflow envoie une requête à une API publique, puis renvoie la réponse de l'API.

Pour obtenir la liste de toutes les commandes gcloud CLI Workflows, consultez la page de référence de gcloud CLI Workflows.

Avant de commencer

Les contraintes de sécurité définies par votre organisation peuvent vous empêcher d'effectuer les étapes suivantes. Pour en savoir plus sur la résolution de ce problème, consultez Développer des applications dans un environnement Google Cloud limité.

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

Install the Google Cloud CLI.

Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

Pour initialiser la gcloud CLI, exécutez la commande suivante :

gcloud init

Create or select 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.

• Create a Google Cloud project:

  gcloud projects create PROJECT_ID

  Replace PROJECT_ID with a name for the Google Cloud project you are creating.

• Select the Google Cloud project that you created:

  gcloud config set project PROJECT_ID

  Replace PROJECT_ID with your Google Cloud project name.

Si vous utilisez un projet existant pour ce guide, vérifiez que vous disposez des autorisations nécessaires pour suivre les instructions. Si vous avez créé un projet, vous disposez déjà des autorisations requises.

Verify that billing is enabled for your Google Cloud project.

Enable the Workflows API:

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

gcloud services enable workflows.googleapis.com

Install the Google Cloud CLI.

Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

Pour initialiser la gcloud CLI, exécutez la commande suivante :

gcloud init

Create or select 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.

• Create a Google Cloud project:

  gcloud projects create PROJECT_ID

  Replace PROJECT_ID with a name for the Google Cloud project you are creating.

• Select the Google Cloud project that you created:

  gcloud config set project PROJECT_ID

  Replace PROJECT_ID with your Google Cloud project name.

Si vous utilisez un projet existant pour ce guide, vérifiez que vous disposez des autorisations nécessaires pour suivre les instructions. Si vous avez créé un projet, vous disposez déjà des autorisations requises.

Verify that billing is enabled for your Google Cloud project.

Enable the Workflows API:

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

gcloud services enable workflows.googleapis.com

1. Set up authentication:

   1. Ensure that you have the Create Service Accounts IAM role (roles/iam.serviceAccountCreator) and the Project IAM Admin role (roles/resourcemanager.projectIamAdmin). Learn how to grant roles.

   2. Create the service account:

      gcloud iam service-accounts create SERVICE_ACCOUNT_NAME

      Replace SERVICE_ACCOUNT_NAME with a name for the service account.

   3. Grant the roles/logging.logWriter IAM role to the service account:

      gcloud projects add-iam-policy-binding PROJECT_ID --member="serviceAccount:SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com" --role=roles/logging.logWriter

      Replace the following:

      • SERVICE_ACCOUNT_NAME: the name of the service account
      • PROJECT_ID: the project ID where you created the service account
      Note: The --role flag affects which resources the service account can access in your project. You can revoke these roles or grant additional roles later.

Pour en savoir plus sur les rôles et les autorisations des comptes de service, consultez Accorder à un workflow l'autorisation d'accéder aux ressourcesGoogle Cloud .

Rôles requis

Pour obtenir les autorisations nécessaires pour suivre ce guide de démarrage rapide, demandez à votre administrateur de vous accorder les rôles IAM suivants sur votre projet :

• Utilisateur du compte de service (roles/iam.serviceAccountUser)
• Administrateur de workflows (roles/workflows.admin)

Pour en savoir plus sur l'attribution de rôles, consultez la page Gérer l'accès aux projets, aux dossiers et aux organisations.

Vous pouvez également obtenir les autorisations requises avec des rôles personnalisés ou d'autres rôles prédéfinis.

Créer, déployer et exécuter un workflow

1. Dans votre répertoire d'accueil, créez un fichier appelé myFirstWorkflow.yaml ou myFirstWorkflow.json.

2. Copiez le workflow suivant et collez-le dans le nouveau fichier, puis enregistrez-le :

   YAML

   main:
     params: [input]
     steps:
       - checkSearchTermInInput:
           switch:
             - condition: '${"searchTerm" in input}'
               assign:
                 - searchTerm: '${input.searchTerm}'
               next: readWikipedia
       - getLocation:
           call: sys.get_env
           args:
             name: GOOGLE_CLOUD_LOCATION
           result: location
       - setFromCallResult:
           assign:
             - searchTerm: '${text.split(location, "-")[0]}'
       - readWikipedia:
           call: http.get
           args:
             url: 'https://en.wikipedia.org/w/api.php'
             query:
               action: opensearch
               search: '${searchTerm}'
           result: wikiResult
       - returnOutput:
           return: '${wikiResult.body[1]}'

   JSON

   {
     "main": {
       "params": [
         "input"
       ],
       "steps": [
         {
           "checkSearchTermInInput": {
             "switch": [
               {
                 "condition": "${\"searchTerm\" in input}",
                 "assign": [
                   {
                     "searchTerm": "${input.searchTerm}"
                   }
                 ],
                 "next": "readWikipedia"
               }
             ]
           }
         },
         {
           "getLocation": {
             "call": "sys.get_env",
             "args": {
               "name": "GOOGLE_CLOUD_LOCATION"
             },
             "result": "location"
           }
         },
         {
           "setFromCallResult": {
             "assign": [
               {
                 "searchTerm": "${text.split(location, \"-\")[0]}"
               }
             ]
           }
         },
         {
           "readWikipedia": {
             "call": "http.get",
             "args": {
               "url": "https://en.wikipedia.org/w/api.php",
               "query": {
                 "action": "opensearch",
                 "search": "${searchTerm}"
               }
             },
             "result": "wikiResult"
           }
         },
         {
           "returnOutput": {
             "return": "${wikiResult.body[1]}"
           }
         }
       ]
     }
   }
   

   À moins que vous ne saisissiez votre propre terme de recherche, ce workflow utilise votre emplacementGoogle Cloud pour construire un terme de recherche qu'il transmet à l'API Wikipédia. Une liste d'articles Wikipédia associés est renvoyée.

3. Déployez le workflow et associez-le au compte de service spécifié:

   gcloud workflows deploy myFirstWorkflow --source=myFirstWorkflow.EXTENSION \
       --service-account=SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
   

   Remplacez les éléments suivants :

   • EXTENSION : extension de fichier de votre workflow ; utilisez yaml pour la version YAML ou json pour la version JSON.
   • PROJECT_ID : ID de votre projet
   Remarque : Dans les environnements de production, nous vous recommandons vivement de créer un compte de service, puis de lui attribuer les rôles les moins permissifs qui permettent au compte de service d'accéder aux ressources requises. Pour en savoir plus, consultez la page Comptes de service. Pour obtenir la liste des rôles Workflows, consultez Rôles et autorisations Workflows.

4. Exécutez le workflow :

   gcloud workflows run myFirstWorkflow \
       --data='SEARCH_TERM'
   

   Remplacez SEARCH_TERM par votre terme de recherche, par exemple {"searchTerm":"North"}. Si vous saisissez {}, votre Google Cloud position est utilisée pour créer un terme de recherche.

   Cette méthode renvoie les résultats de la tentative d'exécution. Le résultat ressemble à ce qui suit :

   argument: '{"searchTerm":"North"}'
   duration: 0.210616856s
   endTime: '2023-05-10T21:56:39.465899376Z'
   name: projects/734581694262/locations/us-central1/workflows/workflow-1/executions/eae31f11-a5c3-47e2-8014-05b400820a79
   result: '["North","North America","Northern Ireland","North Korea","North Macedonia","North
     Carolina","Northrop Grumman B-2 Spirit","Northrop F-5","Northern Cyprus","North
     Dakota"]'
   startTime: '2023-05-10T21:56:39.255282520Z'
   state: SUCCEEDED
   status:
     currentSteps:
     - routine: main
       step: returnOutput
   workflowRevisionId: 000001-ac2
   

Vous avez déployé et exécuté votre premier workflow !

Effectuer un nettoyage

Pour éviter que les ressources utilisées dans cette démonstration soient facturées sur votre compte Google Cloud , supprimez le projet Google Cloud qui les contient.

1. Supprimez le workflow que vous avez créé :

   gcloud workflows delete myFirstWorkflow
   

2. Lorsque vous êtes invité à poursuivre l'opération, saisissez y.

Le workflow est supprimé.

Étape suivante

• Mettre à jour un workflow existant

• Contrôler l'ordre d'exécution des étapes d'un workflow

• Exemples de workflows

• Documentation de référence sur la syntaxe des workflows