Orchestra i job eseguendo pipeline dsub su Batch

---

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

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

Obiettivi

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

Costi

In questo documento vengono utilizzati 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 utenti di Google Cloud possono essere idonei a una prova senza costi aggiuntivi.

Le risorse create in questo tutorial in genere costano meno di un dollaro, supponendo che tutti i passaggi, inclusa la pulizia, vengano completati in modo tempestivo.

Prima di iniziare

1. Accedi al tuo account Google Cloud. Se non conosci Google Cloud, crea un account per valutare le prestazioni dei nostri prodotti in scenari reali. I nuovi clienti ricevono anche 300 $di crediti gratuiti per l'esecuzione, il test e il deployment dei carichi di lavoro.
2. Installa Google Cloud CLI.

3. Per inizializzare l'interfaccia a riga di comando gcloud, esegui il comando seguente:

   gcloud init

4. Crea o seleziona un progetto Google Cloud.

   Nota: se non prevedi di conservare le risorse che crei in questa procedura, crea un progetto invece di selezionarne uno esistente. Dopo aver completato questi passaggi, puoi eliminare il progetto e rimuovere tutte le risorse associate.

   • Crea un progetto Google Cloud:

     gcloud projects create PROJECT_ID

   • Seleziona il progetto Google Cloud che hai creato:

     gcloud config set project PROJECT_ID

5. Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.

6. Abilita le API Batch, Cloud Storage, Compute Engine, and Logging.

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

7. Installa Google Cloud CLI.

8. Per inizializzare l'interfaccia a riga di comando gcloud, esegui il comando seguente:

   gcloud init

9. Crea o seleziona un progetto Google Cloud.

   Nota: se non prevedi di conservare le risorse che crei in questa procedura, crea un progetto invece di selezionarne uno esistente. Dopo aver completato questi passaggi, puoi eliminare il progetto e rimuovere tutte le risorse associate.

   • Crea un progetto Google Cloud:

     gcloud projects create PROJECT_ID

   • Seleziona il progetto Google Cloud che hai creato:

     gcloud config set project PROJECT_ID

10. Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.

11. Abilita le API Batch, Cloud Storage, Compute Engine, and Logging.

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

12. Assicurati che il 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 la concessione automatica dei ruoli per gli account di servizio predefiniti. Per impostazione predefinita, all'account di servizio predefinito di Compute Engine viene concesso automaticamente il ruolo IAM Editor (roles/editor), che dispone già di tutte le autorizzazioni necessarie 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 eseguire il 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 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: Writer log (roles/logging.logWriter) nel progetto

    Per saperne di più sulla concessione dei ruoli, vedi Gestire l'accesso.

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

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

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

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

    • Editor job batch (roles/batch.jobsEditor) sul progetto
    • Utente account di servizio (roles/iam.serviceAccountUser) sull'account di servizio del job, che per questo tutorial è l'account di servizio predefinito di Compute Engine
    • Storage Object Admin (roles/storage.objectAdmin) nel progetto

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

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

       pip --version
       

       Se devi installare o aggiornare pip o Python, segui la procedura per l'installazione di Python.

    2. Consigliato: per evitare errori di conflitto di dipendenze 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 sue 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 l'archiviazione dei file di output dalla pipeline dsub di esempio 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: l'ID progetto del tuo progetto Google Cloud.

L'output è simile al seguente:

Creating gs://BUCKET_NAME/...

Esegui la pipeline dsub

La pipeline dsub di esempio indicizza un file BAM dal progetto 1000 Genomes e restituisce i risultati a un bucket Cloud Storage.

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

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: l'ID progetto del tuo progetto Google Cloud.

• 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 registra i log nella directory specificata nel bucket Cloud Storage. In particolare, il repository dsub contiene un'immagine Docker predefinita che utilizza samtools per indicizzare il file BAM specificato nel flag --input.

Il comando non viene completato fino al termine dell'esecuzione della pipeline dsub, il che potrebbe variare in base alla pianificazione del job batch. In genere questa operazione richiede circa 10 minuti: in genere Batch avvia l'esecuzione del job entro pochi minuti e il runtime 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.

Quindi, 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 nome utente Google Cloud.

• PROJECT_ID: l'ID progetto del tuo progetto Google Cloud.

Visualizza i file di output

Per visualizzare i file di output creati dalla pipeline di esempio dsub 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: l'ID progetto del tuo progetto Google Cloud.

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/

Questo output 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à in questo documento, quando lo elimini elimini anche qualsiasi altro 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, puoi riutilizzare i progetti ed evitare così di superare i limiti di quota.

Elimina un progetto Google Cloud:

gcloud projects delete PROJECT_ID

Elimina singole risorse

Se vuoi continuare a utilizzare il progetto attuale, 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'account Google Cloud attuale, esegui una delle seguenti operazioni:

• Se non hai più bisogno del bucket che hai 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: l'ID progetto del tuo progetto Google Cloud.

• Altrimenti, 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 suoi 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: l'ID progetto del tuo progetto Google Cloud.

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: l'ID progetto del tuo progetto Google Cloud.

Passaggi successivi

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