Orchestrare i job eseguendo le pipeline dsub su Batch

---

Questo tutorial spiega come eseguire una pipeline dsub su Batch. Nello specifico, la pipeline di esempio dsub elabora i dati di sequenzi del DNA in un file BAM (Binary Alignment Map) per creare un file indice BAM (BAI).

Questo tutorial è rivolto agli utenti di Batch che vogliono utilizzare dsub con Batch. dsub è un programma di pianificazione dei job open source per l'orchestrazione di flussi di lavoro di elaborazione batch su Google Cloud. Per scoprire di più su come utilizzare Batch con dsub, consulta la documentazione di dsub per Batch.

Obiettivi

• Esegui una pipeline dsub in Batch che legga e scriva file nei bucket Cloud Storage.
• Visualizza i file di output in un bucket Cloud Storage.

Costi

In questo documento utilizzi i seguenti componenti fatturabili di Google Cloud:

• Batch
• Cloud Storage

Per generare una stima dei costi in base all'utilizzo previsto, utilizza il Calcolatore prezzi. I nuovi Google Cloud utenti potrebbero avere diritto a una prova gratuita.

Le risorse create in questo tutorial in genere costano meno di un dollaro, se completi tutti i passaggi, inclusa la pulizia, in modo puntuale.

Prima di iniziare

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. Assicurati che il tuo progetto abbia almeno un account di servizio con le autorizzazioni richieste per questo tutorial.

    Nota: se utilizzi un nuovo progetto, questo passaggio non è obbligatorio a meno che la tua organizzazione non impedisca le concessioni automatiche dei ruoli per gli account servizio predefiniti. Per impostazione predefinita, all'account di servizio predefinito di Compute Engine viene assegnato automaticamente il ruolo IAM Editor (roles/editor), che dispone già di tutte le autorizzazioni richieste per questo tutorial.

    Ogni job richiede un account di servizio che consenta all'agente di servizio Batch di creare e accedere alle risorse necessarie per l'esecuzione del job. Per questo tutorial, l'account di servizio del job è l'account di servizio predefinito di Compute Engine.

    Per assicurarti che l'account di servizio predefinito di Compute Engine disponga delle autorizzazioni necessarie per consentire all'agente di servizio Batch di creare e accedere alle risorse per i job Batch, chiedi all'amministratore di concedere all'account di servizio predefinito di Compute Engine i seguenti ruoli IAM:

    • Batch Agent Reporter (roles/batch.agentReporter) nel progetto
    • Amministratore archiviazione (roles/storage.admin) del progetto
    • (Consigliato) Consenti ai job di generare log in Cloud Logging: Logs Writer (roles/logging.logWriter) nel progetto

    Per saperne di più sulla concessione dei ruoli, consulta Gestire l'accesso a progetti, cartelle e organizzazioni.

    L'amministratore potrebbe anche essere in grado di assegnare all'account di servizio predefinito di Compute Engine le autorizzazioni richieste tramite ruoli personalizzati o altri ruoli predefiniti.

13. Assicurati di disporre delle autorizzazioni richieste per questo tutorial.

    Nota: se hai creato questo progetto, questo passaggio non è necessario. In qualità di autore del progetto, ti viene assegnato automaticamente il ruolo IAM Proprietario (roles/owner), che dispone già di tutte le autorizzazioni richieste per questo tutorial.

    Per ottenere le autorizzazioni necessarie per completare questo tutorial, chiedi all'amministratore di concederti i seguenti ruoli IAM:

    • Batch Job Editor (roles/batch.jobsEditor) nel progetto
    • Utente account di servizio (roles/iam.serviceAccountUser) nell'account di servizio del job, che per questo tutorial è l'account di servizio predefinito di Compute Engine
    • Amministratore oggetti Storage (roles/storage.objectAdmin) del progetto

14. Installa dsub e le relative dipendenze. Per ulteriori informazioni, consulta la documentazione di installazione di dsub.

    1. Assicurati di aver installato le versioni di Python e pip supportate dall'ultima versione di dsub. Per visualizzare le versioni attualmente installate, esegui il seguente comando:

       pip --version
       

       Se devi installare o aggiornare pip o Python, segui i passaggi per l'installazione di Python.

    2. Consigliato: per evitare errori di conflitto di dipendenza durante l'installazione di dsub, crea e attiva un ambiente virtuale Python:

       python -m venv dsub_libs && source dsub_libs/bin/activate
       

    3. Clona il repository GitHub di dsub utilizzando git e aprilo:

       git clone https://github.com/databiosphere/dsub.git && cd dsub
       

    4. Installa dsub e le relative dipendenze:

       python -m pip install .
       

       L'output è simile al seguente:

       ...
       Successfully installed cachetools-5.3.1 certifi-2023.7.22 charset-normalizer-3.3.1 dsub-0.4.9 funcsigs-1.0.2 google-api-core-2.11.0 google-api-python-client-2.85.0 google-auth-2.17.3 google-auth-httplib2-0.1.0 google-cloud-batch-0.10.0 googleapis-common-protos-1.61.0 grpcio-1.59.0 grpcio-status-1.59.0 httplib2-0.22.0 idna-3.4 mock-4.0.3 parameterized-0.8.1 proto-plus-1.22.3 protobuf-4.24.4 pyasn1-0.4.8 pyasn1-modules-0.2.8 pyparsing-3.1.1 python-dateutil-2.8.2 pytz-2023.3 pyyaml-6.0 requests-2.31.0 rsa-4.9 six-1.16.0 tabulate-0.9.0 tenacity-8.2.2 uritemplate-4.1.1 urllib3-2.0.7
       

Crea un bucket Cloud Storage

Per creare un bucket Cloud Storage per archiviare i file di output della pipeline di esempio dsub utilizzando gcloud CLI, esegui il comando gcloud storage buckets create:

gcloud storage buckets create gs://BUCKET_NAME \
    --project PROJECT_ID

Sostituisci quanto segue:

• BUCKET_NAME: un nome univoco a livello globale per il bucket.

• PROJECT_ID: il ID progetto del tuo Google Cloud progetto.

L'output è simile al seguente:

Creating gs://BUCKET_NAME/...

Esegui la pipeline dsub

La pipeline di esempio dsub indicizza un file BAM del Progetto 1000 genomi e restituisce i risultati in un bucket Cloud Storage.

Per eseguire la pipeline dsub di esempio, esegui il seguente comando dsub:

dsub \
    --provider google-batch \
    --project PROJECT_ID \
    --logging gs://BUCKET_NAME/WORK_DIRECTORY/logs \
    --input BAM=gs://genomics-public-data/1000-genomes/bam/HG00114.mapped.ILLUMINA.bwa.GBR.low_coverage.20120522.bam \
    --output BAI=gs://BUCKET_NAME/WORK_DIRECTORY/HG00114.mapped.ILLUMINA.bwa.GBR.low_coverage.20120522.bam.bai \
    --image quay.io/cancercollaboratory/dockstore-tool-samtools-index \
    --command 'samtools index ${BAM} ${BAI}' \
    --wait

Sostituisci quanto segue:

• PROJECT_ID: il ID progetto del tuo Google Cloud progetto.

• BUCKET_NAME: il nome del bucket Cloud Storage che hai creato.

• WORK_DIRECTORY: il nome di una nuova directory che la pipeline può utilizzare per archiviare log e output. Ad esempio, inserisci workDir.

La pipeline dsub esegue un job batch che scrive il file BAI e i log nella directory specificata nel bucket Cloud Storage. Nello specifico, il repository dsub contiene un'immagine Docker precompilata che utilizza samtools per indicizzare il file BAM specificato nel flag --input.

Il comando non termina finché la pipeline dsub non termina di essere eseguita, il che può variare in base a quando è pianificato il job batch. In genere, sono necessari circa 10 minuti: Batch avvia solitamente l'esecuzione del job entro pochi minuti e il tempo di esecuzione del job è di circa 8 minuti.

All'inizio, il comando è ancora in esecuzione e l'output è simile al seguente:

Job properties:
  job-id: JOB_NAME
  job-name: samtools
  user-id: USERNAME
Provider internal-id (operation): projects/PROJECT_ID/locations/us-central1/jobs/JOB_NAME
Launched job-id: JOB_NAME
To check the status, run:
  dstat --provider google-batch --project PROJECT_ID --location us-central1 --jobs 'JOB_NAME' --users 'USERNAME' --status '*'
To cancel the job, run:
  ddel --provider google-batch --project PROJECT_ID --location us-central1 --jobs 'JOB_NAME' --users 'USERNAME'
Waiting for job to complete...
Waiting for: JOB_NAME.

Al termine del job, il comando termina e l'output è simile al seguente:

  JOB_NAME: SUCCESS
JOB_NAME

Questo output include i seguenti valori:

• JOB_NAME: il nome del job.

• USERNAME: il tuo Google Cloud nome utente.

• PROJECT_ID: il ID progetto del tuo Google Cloud progetto.

Visualizza i file di output

Per visualizzare i file di output creati dalla pipeline dsub di esempio utilizzando gcloud CLI, esegui il comando gcloud storage ls:

gcloud storage ls gs://BUCKET_NAME/WORK_DIRECTORY \
    --project PROJECT_ID

Sostituisci quanto segue:

• BUCKET_NAME: il nome del bucket Cloud Storage che hai creato.

• WORK_DIRECTORY: la directory specificata nel comando dsub.

• PROJECT_ID: il ID progetto del tuo Google Cloud progetto.

L'output è simile al seguente:

gs://BUCKET_NAME/WORK_DIRECTORY/HG00114.mapped.ILLUMINA.bwa.GBR.low_coverage.20120522.bam.bai
gs://BUCKET_NAME/WORK_DIRECTORY/logs/

Questa uscita include il file BAI e una directory contenente i log del job.

Esegui la pulizia

Per evitare che al tuo account Google Cloud vengano addebitati costi relativi alle risorse utilizzate in questo tutorial, elimina il progetto che contiene le risorse oppure mantieni il progetto ed elimina le singole risorse.

Elimina il progetto

Il modo più semplice per eliminare la fatturazione è eliminare il progetto corrente.

Attenzione: l'eliminazione di un progetto ha i seguenti effetti:

• L'intero contenuto del progetto viene eliminato. Se hai utilizzato un progetto esistente per le attività descritte in questo documento, quando lo elimini elimini anche tutto il lavoro svolto nel progetto.
• Gli ID progetto personalizzati non sono più disponibili. Quando hai creato questo progetto, potresti aver creato un ID progetto personalizzato che vuoi utilizzare in futuro. Per conservare gli URL che utilizzano l'ID progetto, ad esempio un URL appspot.com, elimina le risorse selezionate all'interno del progetto anziché eliminare l'intero progetto.

Se intendi esplorare più architetture, tutorial o guide rapide, il riuso dei progetti può aiutarti a non superare i limiti di quota.

Delete a Google Cloud project:

gcloud projects delete PROJECT_ID

Elimina singole risorse

Se vuoi continuare a utilizzare il progetto corrente, elimina le singole risorse utilizzate in questo tutorial.

Elimina il bucket

Al termine dell'esecuzione, la pipeline crea e archivia i file di output nella directory WORK_DIRECTORY del bucket Cloud Storage.

Per ridurre gli addebiti di Cloud Storage all'accountGoogle Cloud attuale, esegui una delle seguenti operazioni:

• Se non hai più bisogno del bucket utilizzato in questo tutorial, utilizza il comando gcloud storage rm con il flag --recursive per eliminare il bucket e tutti i relativi contenuti:

  gcloud storage rm gs://BUCKET_NAME \
      --recursive \
      --project PROJECT_ID
  

  Sostituisci quanto segue:

  • BUCKET_NAME: il nome del bucket Cloud Storage che hai creato.

  • PROJECT_ID: il ID progetto del tuo Google Cloud progetto.

• In caso contrario, se hai ancora bisogno del bucket, utilizza il comando gcloud storage rm con il flag --recursive per eliminare solo la directory WORK_DIRECTORY e tutti i relativi contenuti:

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

  Sostituisci quanto segue:

  • BUCKET_NAME: il nome del bucket Cloud Storage che hai creato.

  • WORK_DIRECTORY: la directory specificata nel comando dsub.

  • PROJECT_ID: il ID progetto del tuo Google Cloud progetto.

Elimina il job

Per eliminare un job utilizzando gcloud CLI, esegui il comando gcloud batch jobs delete.

gcloud batch jobs delete JOB_NAME \
    --location us-central1 \
    --project PROJECT_ID

Sostituisci quanto segue:

• JOB_NAME: il nome del job.
• PROJECT_ID: il ID progetto del tuo Google Cloud progetto.

Passaggi successivi

• Scopri di più su dsub e dsub per Batch.
• Scopri di più sull'utilizzo dei volumi di archiviazione con Batch.