Orchestrate jobs by running Nextflow pipelines on Batch

---

Ce tutoriel explique comment exécuter un pipeline Nextflow sur Batch. Plus précisément, ce tutoriel exécute l'exemple de pipeline rnaseq-nf de sciences de la vie de Nextflow, qui quantifie les caractéristiques génomiques à partir de données de lecture courte à l'aide de l'ARN-Seq.

Ce tutoriel s'adresse aux utilisateurs de Batch qui souhaitent utiliser Nextflow avec Batch.

Nextflow est un logiciel Open Source permettant d'orchestrer des workflows de bioinformatique.

Remarque: Ce tutoriel fournit des instructions d'utilisation pour l'application suivante: Nextflow version 23.04.1. Ces instructions peuvent ne pas représenter les versions les plus récentes de l'application. Pour en savoir plus, consultez la documentation : Nextflow.

Objectifs

À la fin de ce tutoriel, vous saurez:

• Installez Nextflow dans Cloud Shell.
• Créer un bucket Cloud Storage
• Configurer un pipeline Nextflow
• Exécuter un exemple de pipeline à l'aide de Nextflow sur Batch
• Affichez les sorties du pipeline.
• Effectuez un nettoyage pour éviter que des frais supplémentaires ne vous soient facturés en procédant comme suit :
  • Supprimez un projet.
  • Supprimez des ressources individuelles.

Coûts

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

• Batch
• Cloud Storage

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 gratuit.

Les ressources créées dans ce tutoriel coûtent généralement moins d'un dollar, en supposant que vous effectuiez toutes les étapes, y compris le nettoyage, dans un délai raisonnable.

Avant de commencer

1. 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.
2. Install the Google Cloud CLI.

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

   gcloud init

4. Create or select a Google Cloud project.

   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.

5. Make sure that billing is enabled for your Google Cloud project.

6. Enable the Batch, Cloud Storage, Compute Engine, and Logging APIs:

   gcloud services enable batch.googleapis.com compute.googleapis.com logging.googleapis.com storage.googleapis.com

7. Install the Google Cloud CLI.

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

   gcloud init

9. Create or select a Google Cloud project.

   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.

10. Make sure that billing is enabled for your Google Cloud project.

11. Enable the Batch, Cloud Storage, Compute Engine, and Logging APIs:

    gcloud services enable batch.googleapis.com compute.googleapis.com logging.googleapis.com storage.googleapis.com

12. Assurez-vous que votre projet dispose d'un réseau de cloud privé virtuel (VPC) avec une configuration réseau valide pour ce tutoriel.

    Remarque:Aucune action n'est requise pour cette étape, sauf si votre organisation désactive la création de réseau default en activant la contrainte de règle compute.skipDefaultNetworkCreation ou si votre projet a modifié son réseau default.

    Ce tutoriel suppose que vous utilisez le réseau default. Par défaut,les ressources Google Cloud utilisent le réseau default, qui fournit l'accès réseau requis pour ce tutoriel.

    Objectif:Si vous souhaitez qu'une tâche par lot pour un pipeline Nextflow utilise un autre réseau, vous pouvez modifier le fichier nextflow.config de ce tutoriel pour définir également le réseau et le sous-réseau de la tâche à l'aide des champs Nextflow google.batch.network et google.batch.subnetwork, respectivement. Toutefois, vous devez également vous assurer que le réseau et le sous-réseau sont correctement configurés pour votre charge de travail. Pour en savoir plus, consultez la section Présentation de la mise en réseau par lot.

13. Assurez-vous que votre projet dispose d'au moins un compte de service disposant des autorisations requises pour exécuter la tâche de traitement par lot dans ce tutoriel.

    Par défaut, les jobs utilisent le compte de service Compute Engine par défaut, qui se voit automatiquement attribuer le rôle IAM Éditeur (roles/editor) et dispose déjà de toutes les autorisations requises pour ce tutoriel.

    Remarque:Aucune action n'est requise pour cette étape, sauf si votre organisation désactive les autorisations automatiques pour les comptes de service par défaut en activant la contrainte de règle iam.automaticIamGrantsForDefaultServiceAccounts, si votre projet a modifié son compte de service Compute Engine par défaut ou si vous souhaitez utiliser un autre compte de service.

    Pour vous assurer que le compte de service de la tâche dispose des autorisations nécessaires pour permettre à l'agent de service Batch de créer et d'accéder aux ressources pour les tâches Batch, demandez à votre administrateur d'accorder au compte de service de la tâche les rôles IAM suivants:

    • Responsable du signalement d'agent par lot (roles/batch.agentReporter) sur le projet
    • Administrateur de l'espace de stockage (roles/storage.admin) sur le projet
    • (Recommandé) Autorisez les tâches à générer des journaux dans Cloud Logging : Rédacteur de journaux (roles/logging.logWriter) sur le projet

    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.

    Votre administrateur peut également attribuer au compte de service de la tâche les autorisations requises via des rôles personnalisés ou d'autres rôles prédéfinis.

14. Assurez-vous de disposer des autorisations requises pour suivre ce tutoriel.

    Remarque:Si vous avez créé le projet que vous prévoyez d'utiliser pour ce tutoriel, aucune action n'est requise pour cette étape. En tant que créateur du projet, vous disposez automatiquement du rôle IAM Propriétaire (roles/owner), qui inclut déjà toutes les autorisations requises pour ce tutoriel.

    Pour obtenir les autorisations nécessaires pour suivre ce tutoriel, demandez à votre administrateur de vous accorder les rôles IAM suivants:

    • Éditeur de tâches par lot (roles/batch.jobsEditor) sur le projet
    • Utilisateur du compte de service (roles/iam.serviceAccountUser) sur le compte de service de la tâche
    • Administrateur des objets Storage (roles/storage.objectAdmin) pour le projet

15. Installez Nextflow:

    curl -s -L https://github.com/nextflow-io/nextflow/releases/download/v23.04.1/nextflow | bash
    

    La sortie devrait ressembler à ce qui suit :

    N E X T F L O W
    version 23.04.1 build 5866
    created 15-04-2023 06:51 UTC
    cite doi:10.1038/nbt.3820
    http://nextflow.io
    
    Nextflow installation completed. Please note:
    - the executable file `nextflow` has been created in the folder: ...
    - you may complete the installation by moving it to a directory in your $PATH
    

Créer un bucket Cloud Storage

Pour créer un bucket Cloud Storage afin de stocker des fichiers de travail et de sortie temporaires à partir du pipeline Nextflow, utilisez la console Google Cloud ou la ligne de commande.

Console

Pour créer un bucket Cloud Storage à l'aide de la console Google Cloud , procédez comme suit:

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

   Accéder à la page "Buckets"

2. Cliquez sur Créer.

3. Sur la page Créer un bucket, saisissez un nom unique pour votre bucket.

4. Cliquez sur Créer.

5. Dans la fenêtre L'accès public sera bloqué, cliquez sur Confirmer.

gcloud

Pour créer un bucket Cloud Storage à l'aide de Google Cloud CLI, exécutez la commande gcloud storage buckets create.

gcloud storage buckets create gs://BUCKET_NAME

Remplacez BUCKET_NAME par un nom unique au niveau mondial pour votre bucket.

Si la requête aboutit, la sortie doit ressembler à ceci:

Creating gs://BUCKET_NAME/...
   ```

Configurer Nextflow

Pour configurer le pipeline Nextflow pour qu'il s'exécute sur Batch, procédez comme suit dans la ligne de commande:

1. Clonez l'exemple de dépôt de pipeline:

   git clone https://github.com/nextflow-io/rnaseq-nf.git
   

2. Accédez au dossier rnaseq-nf :

   cd rnaseq-nf
   

3. Ouvrez le fichier nextflow.config :

   nano nextflow.config
   

   Le fichier doit contenir la section gcb suivante:

   gcb {
     params.transcriptome = 'gs://rnaseq-nf/data/ggal/transcript.fa'
     params.reads = 'gs://rnaseq-nf/data/ggal/gut_{1,2}.fq'
     params.multiqc = 'gs://rnaseq-nf/multiqc'
     process.executor = 'google-batch'
     process.container = 'quay.io/nextflow/rnaseq-nf:v1.1'
     workDir = 'gs://BUCKET_NAME/WORK_DIRECTORY'
     google.region  = 'REGION'
   }
   

4. Dans la section gcb, procédez comme suit:

   1. Remplacez BUCKET_NAME par le nom du bucket Cloud Storage que vous avez créé aux étapes précédentes.

   2. Remplacez WORK_DIRECTORY par le nom d'un nouveau dossier que le pipeline peut utiliser pour stocker les journaux et les sorties.

      Par exemple, saisissez workDir.

   3. Remplacez REGION par la région à utiliser.

      Par exemple, saisissez us-central1.

   4. Après le champ google.region, ajoutez les champs suivants:

      1. Ajoutez le champ google.project:

         google.project = 'PROJECT_ID'
         

         Remplacez PROJECT_ID par l'ID de projet du projet Google Cloud actuel.

      2. Si vous n'utilisez pas le compte de service Compute Engine par défaut comme compte de service du job, ajoutez le champ google.batch.serviceAccountEmail:

         google.batch.serviceAccountEmail = 'SERVICE_ACCOUNT_EMAIL'
         

         Remplacez SERVICE_ACCOUNT_EMAIL par l'adresse e-mail du compte de service de la tâche que vous avez préparée pour ce tutoriel.

      Objectif :Pour en savoir plus sur tous les champs que vous pouvez spécifier pour configurer la tâche par lot d'un pipeline Nextflow, consultez la documentation Nextflow sur le champ d'application de la configuration par lot.

5. Pour enregistrer vos modifications, procédez comme suit:

   1. Appuyez sur la touche Control+S.

   2. Saisissez Y.

   3. Appuyez sur la touche Enter.

Exécuter le pipeline

Exécutez l'exemple de pipeline Nextflow à l'aide de la ligne de commande:

../nextflow run nextflow-io/rnaseq-nf -profile gcb

Le pipeline exécute un petit ensemble de données à l'aide des paramètres que vous avez fournis aux étapes précédentes. Cette opération peut prendre jusqu'à 10 minutes.

Une fois l'exécution du pipeline terminée, le résultat doit ressembler à ce qui suit:

N E X T F L O W  ~  version 23.04.1
Launching `https://github.com/nextflow-io/rnaseq-nf` [crazy_curry] DSL2 - revision: 88b8ef803a [master]
 R N A S E Q - N F   P I P E L I N E
 ===================================
 transcriptome: gs://rnaseq-nf/data/ggal/transcript.fa
 reads        : gs://rnaseq-nf/data/ggal/gut_{1,2}.fq
 outdir       : results

Uploading local `bin` scripts folder to gs://example-bucket/workdir/tmp/53/2847f2b832456a88a8e4cd44eec00a/bin
executor >  google-batch (4)
[67/71b856] process > RNASEQ:INDEX (transcript)     [100%] 1 of 1 ✔
[0c/2c79c6] process > RNASEQ:FASTQC (FASTQC on gut) [100%] 1 of 1 ✔
[a9/571723] process > RNASEQ:QUANT (gut)            [100%] 1 of 1 ✔
[9a/1f0dd4] process > MULTIQC                       [100%] 1 of 1 ✔

Done! Open the following report in your browser --> results/multiqc_report.html

Completed at: 20-Apr-2023 15:44:55
Duration    : 10m 13s
CPU hours   : (a few seconds)
Succeeded   : 4

Afficher les sorties du pipeline

Une fois l'exécution du pipeline terminée, il stocke les fichiers de sortie, les journaux, les erreurs ou les fichiers temporaires dans le fichier results/qc_report.html du dossier WORK_DIRECTORY de votre bucket Cloud Storage.

Pour vérifier les fichiers de sortie du pipeline dans le dossier WORK_DIRECTORY de votre bucket Cloud Storage, vous pouvez utiliser la console Google Cloud ou la ligne de commande.

Console

Pour vérifier les fichiers de sortie du pipeline à l'aide de la console Google Cloud , procédez comme suit:

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

   Accéder à la page "Buckets"

2. Dans la colonne Nom, cliquez sur le nom du bucket que vous avez créé aux étapes précédentes.

3. Sur la page Informations sur le bucket, ouvrez le dossier WORK_DIRECTORY.

Il existe un dossier pour chaque tâche distincte exécutée par le workflow. Chaque dossier contient les commandes exécutées, les fichiers de sortie et les fichiers temporaires créés par le pipeline.

gcloud

Pour vérifier les fichiers de sortie du pipeline à l'aide de la gcloud CLI, utilisez la commande gcloud storage ls.

gcloud storage ls gs://BUCKET_NAME/WORK_DIRECTORY

Remplacez les éléments suivants :

• BUCKET_NAME: nom du bucket que vous avez créé aux étapes précédentes.

• WORK_DIRECTORY: répertoire que vous avez spécifié dans le fichier nextflow.config.

La sortie liste un dossier pour chaque tâche distincte exécutée par le pipeline. Chaque dossier contient les commandes exécutées, les fichiers de sortie et les fichiers temporaires créés par le pipeline.

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

Le moyen le plus simple d'éviter la facturation consiste à supprimer le projet en cours.

Pour supprimer le projet en cours, utilisez la console Google Cloud ou la gcloud CLI.

Console

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.

Si vous envisagez d'explorer plusieurs architectures, tutoriels et guides de démarrage rapide, réutiliser des projets peut vous aider à ne pas dépasser les limites de quotas des projets.

1. In the Google Cloud console, go to the Manage resources page.

   Go to Manage resources

2. In the project list, select the project that you want to delete, and then click Delete.
3. In the dialog, type the project ID, and then click Shut down to delete the project.

gcloud

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.

Si vous envisagez d'explorer plusieurs architectures, tutoriels et guides de démarrage rapide, réutiliser des projets peut vous aider à ne pas dépasser les limites de quotas des projets.

Delete a Google Cloud project:

gcloud projects delete PROJECT_ID

Supprimer des ressources individuelles

Si vous souhaitez continuer à utiliser le projet actuel, supprimez les ressources individuelles utilisées dans ce tutoriel.

Supprimer le bucket

Si vous n'avez plus besoin du bucket que vous avez utilisé dans ce tutoriel, supprimez-le.

Supprimer les fichiers de sortie du bucket

Une fois l'exécution du pipeline terminée, il crée et stocke des fichiers de sortie dans le dossier WORK_DIRECTORY de votre bucket Cloud Storage.

Pour réduire les frais Cloud Storage sur le compteGoogle Cloud actuel, vous pouvez supprimer le dossier contenant les fichiers de sortie du pipeline à l'aide de la console Google Cloud ou de la ligne de commande.

Console

Pour supprimer le dossier WORK_DIRECTORY et tous les fichiers de sortie de votre bucket Cloud Storage à l'aide de la consoleGoogle Cloud , procédez comme suit:

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

   Accéder à la page "Buckets"

2. Dans la colonne Nom, cliquez sur le nom du bucket que vous avez créé aux étapes précédentes.

3. Sur la page Informations sur le bucket, sélectionnez la ligne contenant le dossier WORK_DIRECTORY, puis procédez comme suit:

   1. Cliquez sur Supprimer.

   2. Pour confirmer, saisissez DELETE, puis cliquez sur Supprimer.

gcloud

Pour supprimer le dossier WORK_DIRECTORY et tous les fichiers de sortie de votre bucket Cloud Storage à l'aide de la gcloud CLI, exécutez la commande gcloud storage rm avec l'option --recursive.

gcloud storage rm gs://BUCKET_NAME/WORK_DIRECTORY \
      --recursive

Remplacez les éléments suivants :

• BUCKET_NAME: nom du bucket que vous avez spécifié aux étapes précédentes.

• WORK_DIRECTORY: répertoire dans lequel stocker les fichiers de sortie du pipeline que vous avez spécifiés aux étapes précédentes.

Étape suivante

• Pour en savoir plus sur le déploiement de workflows Nextflow, consultez le dépôt GitHub Nextflow.

• Pour en savoir plus sur les processus, les scripts et les options de configuration Nextflow, consultez la documentation Nextflow.