Gestire le pipeline utilizzando Gestione del controllo del codice sorgente

Questa pagina descrive come gestire le pipeline utilizzando il controllo del codice sorgente in Cloud Data Fusion tramite repository Git.

Informazioni sulla gestione del controllo del codice sorgente

Cloud Data Fusion offre la possibilità di progettare visivamente le pipeline per le integrazioni ETL ed ELT. Per una migliore gestione delle pipeline tra sviluppo e produzione, Cloud Data Fusion consente la gestione del controllo del codice sorgente delle pipeline utilizzando GitHub e altri sistemi di controllo delle versioni.

La gestione del controllo del codice sorgente in Cloud Data Fusion ti consente di:

• Integrare ogni spazio dei nomi di Cloud Data Fusion con un sistema di controllo della versione.
• Gestisci le tue pipeline in un repository Git centrale.
• Esaminare e controllare le modifiche apportate alla pipeline.
• Ripristina le modifiche alla pipeline.
• Collaborare efficacemente con il team garantendo al contempo un controllo centralizzato.

Importante: la funzionalità di sincronizzazione di una singola pipeline è supportata in Cloud Data Fusion 6.9.0 e versioni successive. La funzionalità di sincronizzazione di più pipeline è supportata in Cloud Data Fusion 6.10.0 e versioni successive.

Prima di iniziare

• La gestione del controllo del codice sorgente supporta l'integrazione con i repository GitHub, Bitbucket Server, Bitbucket Cloud e Gitlab.
• Il protocollo OAuth di GitHub non è supportato.
• Gestione del controllo del codice sorgente supporta solo pipeline batch.
• Source Control Management supporta solo JSON di progettazione delle pipeline per le operazioni push e pull. Le configurazioni di esecuzione non sono supportate.
• Il limite per le dimensioni del repository collegato è 5 GB.

Avviso: assicurati che le pipeline di cui viene eseguito il push nei repository Git non includano secret, ad esempio il codice JSON dell'account di servizio in testo normale. Per archiviare i secret, consigliamo vivamente di utilizzare chiavi sicure.

Importante: per connetterti a un server di sistema con controllo della versione da un'istanza Cloud Data Fusion privata, devi configurare le impostazioni di rete per l'accesso all'origine pubblica. Per saperne di più, consulta Creare un'istanza privata e Connettersi a un'origine pubblica da un'istanza privata.

Ruoli e autorizzazioni richiesti

Nota: i ruoli predefiniti e le autorizzazioni attuali di Cloud Data Fusion non coprono necessariamente le autorizzazioni read, write e update_repo_metadata nei repository Git di gestione del controllo del codice sorgente.

La gestione del controllo del codice sorgente in Cloud Data Fusion prevede due operazioni chiave:

• Configurazione dei repository di controllo del codice sorgente
• Sincronizzazione delle pipeline con i repository Git mediante le operazioni di push e pull

Per ottenere le autorizzazioni necessarie per utilizzare la funzionalità di gestione del controllo del codice sorgente, chiedi all'amministratore di concederti uno dei seguenti ruoli predefiniti nel progetto:

• Configura il repository di controllo del codice sorgente:

  • Operatore Cloud Data Fusion (roles/datafusion.operator)
  • Editor di Cloud Data Fusion (roles/datafusion.editor)
  • Amministratore Cloud Data Fusion (roles/datafusion.admin)

• Sincronizza le pipeline utilizzando un'operazione push o pull da uno spazio dei nomi:

  • Operatore Cloud Data Fusion (roles/datafusion.operator)
  • Sviluppatore Cloud Data Fusion (roles/datafusion.developer)
  • Editor di Cloud Data Fusion (roles/datafusion.editor)
  • Amministratore Cloud Data Fusion (roles/datafusion.admin)

Per maggiori informazioni sulla concessione dei ruoli, consulta Gestire l'accesso.

Potresti anche riuscire a ottenere le autorizzazioni richieste tramite altri ruoli predefiniti.

configura un repository Git

Per creare un repository Git in GitHub, segui le istruzioni descritte in Creare un repository.

Nota: se utilizzi un'istanza abilitata per Private Service Connect, assicurati che il server Git non sia ospitato nell'intervallo IP 240.0.0.0/16 o 240.1.0.0/16 per evitare problemi di connessione tra l'istanza Cloud Data Fusion e il server Git.

Per maggiori informazioni sui token di accesso personale in GitHub e in altri sistemi di controllo delle versioni, consulta le pagine seguenti:

• Documentazione relativa al token di accesso Cloud di Bitbucket

• Documentazione relativa al token di accesso di Bitbucket Server

• GitHub: Creazione di un token di accesso personale e Creazione di un token di accesso personale granulare

• Documentazione relativa ai token di accesso GitLab

Nota: ti consigliamo di utilizzare il token di accesso personale granulare GitHub, poiché ruoli come Operatore Cloud Data Fusion e Editor Cloud Data Fusion possono accedere ai token salvati.

Connetti un repository Git con Cloud Data Fusion

Cloud Data Fusion consente di configurare e connettere il repository Git nella scheda Gestione del controllo del codice sorgente per ogni spazio dei nomi. Per collegare uno spazio dei nomi con il tuo repository Git, segui questi passaggi:

Console

1. In Cloud Data Fusion Studio, fai clic su Menu.
2. Fai clic su Amministratore spazio dei nomi.
3. Nella pagina Amministratore spazio dei nomi, fai clic sulla scheda Gestione del controllo del codice sorgente.
4. Fai clic su Collega repository.

5. Inserisci i seguenti dettagli:

   • Provider: scegli un fornitore di servizi Git, come GitHub o GitLab.
   • URL repository: inserisci l'URL da cui è possibile accedere al repository. Per GitHub, l'URL del repository è https://github.com/HOST/REPO.
   • (Facoltativo) Ramo predefinito: inserisci il ramo iniziale del Git. Questo ramo può essere diverso dal ramo predefinito configurato su GitHub. Questo ramo viene utilizzato per sincronizzare le pipeline, indipendentemente da quello predefinito su GitHub.
   • (Facoltativo) Prefisso del percorso: inserisci un prefisso per il nome della pipeline che viene salvato nel repository Git. Ad esempio, se il nome della pipeline è DataFusionQuickStart e se specifichi il prefisso namespaceName, la pipeline viene salvata come namespaceName/DataFusionQuickStart nel repository Git.
   • Tipo di autenticazione: Cloud Data Fusion consente di utilizzare il token di accesso personalizzato come tipo di autenticazione. Questa selezione viene selezionata automaticamente.
   • Nome token: inserisci un nome che può essere associato al token.
   • Token: inserisci il token fornito dal repository GitHub.
   • (Facoltativo) Nome utente: inserisci un nome utente o un proprietario per il token.

6. Fai clic su Validate (Convalida). Attendi che la connessione venga verificata.

7. Al termine della configurazione, fai clic su Salva e chiudi per confermare.

API REST

1. Crea una chiave segreta in Cloud Data Fusion contenente il token di accesso personale.

2. Esegui questo comando:

   curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" 
   ${CDAP_ENDPOINT}/v3/namespaces/NAMESPACE_ID/securekeys/PASSWORD_SECRET_KEY -X PUT -d '{ "description": "Example Secure Key","data": "PERSONAL_ACCESS_TOKEN"}'
   

   Sostituisci quanto segue:

   • NAMESPACE_ID: l'ID dello spazio dei nomi.
   • PASSWORD_SECRET_KEY: il nome della chiave segreta contenente il token di accesso personale.
   • PERSONAL_ACCESS_TOKEN: token di accesso personale di GitHub.

3. Esegui questo comando:

   curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" 
   ${CDAP_ENDPOINT}/v3/namespaces/NAMESPACE_ID/repository -X PUT -d '{"test": "TEST_ONLY", "config": {"provider": "PROVIDER_TYPE", "link": "REPO_URL", "defaultBranch": "DEFAULT_BRANCH", "pathPrefix": "PATH_TO_DIRECTORY", "auth": {"type": "AUTH_TYPE", "patConfig": {"passwordName": "PASSWORD_SECRET_KEY", "username": "USER_NAME"}}}}'
   

   Sostituisci quanto segue:

   • NAMESPACE_ID: l'ID dello spazio dei nomi.
   • TEST_ONLY: imposta su true se vuoi convalidare solo la configurazione e non aggiungerne altre.
   • PROVIDER_TYPE: il nome del provider Git, ossia GITHUB.
   • REPO_URL: URL del repository da collegare. Utilizza un URL https, ad esempio https://github.com/user/repo.git.
   • DEFAULT_BRANCH: ramo utilizzato per le operazioni push e pull. Se omesso, viene utilizzato il ramo configurato predefinito nel repository, ad esempio il ramo principale.
   • PATH_TO_DIRECTORY: percorso della directory nel repository in cui sono archiviati i file di configurazione.
   • AUTH_TYPE: il tipo di autenticazione. È supportato solo PAT. Vedi Token di accesso personale granulare in GitHub.
   • PASSWORD_SECRET_KEY: il nome della chiave segreta contenente il token di accesso personale per il tipo di autenticazione PAT.
   • USER_NAME: puoi omettere questo valore per il tipo di autenticazione PAT.

Sincronizza le pipeline di Cloud Data Fusion con un repository remoto

Dopo aver configurato un repository Git con uno spazio dei nomi, puoi eseguire il push e il pull delle pipeline e sincronizzarle con il repository Git.

Esegui il push delle pipeline da Cloud Data Fusion al repository Git

Per sincronizzare più pipeline di cui è stato eseguito il deployment da uno spazio dei nomi a un repository Git, segui questi passaggi:

Console

1. In Cloud Data Fusion Studio, fai clic su Menu.
2. Fai clic su Amministratore spazio dei nomi.
3. Nella pagina Amministratore spazio dei nomi, fai clic sulla scheda Gestione del controllo del codice sorgente.
4. Trova il repository Git con cui vuoi eseguire la sincronizzazione e fai clic su Sincronizza pipeline.
5. Fai clic sulla scheda Pipeline dello spazio dei nomi.

6. Cerca e seleziona le pipeline di cui vuoi eseguire il push al repository Git.

   Se viene eseguito il push o il pull della pipeline dal repository Git, lo stato Connesso a Git mostra Connected. Se non è mai stato eseguito il push della pipeline su GitHub, lo stato Connesso a Git sarà vuoto (-).

   Se esegui il deployment di una versione più recente di una pipeline già sincronizzata con il repository Git, lo stato Connesso a Git passa da Connected a vuoto (-).

7. Fai clic su Esegui il push al repository.

8. Inserisci un Messaggio di commit e fai clic su OK.

   L'operazione di push viene avviata e viene visualizzato un messaggio che indica che viene eseguito il push delle pipeline selezionate nel repository remoto.

Quando l'operazione di push è stata completata correttamente, viene visualizzato un messaggio di operazione riuscita che indica il numero di pipeline di cui è stato eseguito il push al repository remoto.

Se l'operazione di push non va a buon fine, controlla la pipeline in GitHub per verificare che si tratti della versione più recente. Per ogni operazione push non riuscita, viene visualizzato un messaggio di errore. Per visualizzare i dettagli dell'errore, espandi il messaggio.

Nota: se un'operazione push per più pipeline è in esecuzione, non puoi avviare contemporaneamente un'altra operazione di push o pull nello spazio dei nomi fino al completamento dell'operazione attuale. L'elenco delle pipeline nelle schede Pipeline dello spazio dei nomi e Pipeline del repository rimane disabilitato fino al completamento dell'operazione di push attuale.

Puoi anche eseguire il push di singole pipeline in un repository Git da Pipeline Design Studio:

1. In Cloud Data Fusion Studio, fai clic su Menu.
2. Fai clic su Elenco.
3. Fai clic sulla pipeline di cui vuoi eseguire il push nel repository Git.
4. Nella pagina della pipeline, fai clic su Azioni > Esegui il push al repository.
5. Inserisci un Messaggio di commit e fai clic su OK.

API REST

1. Esegui il push di un set di pipeline da Cloud Data Fusion al repository Git:

   curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"
   ${CDAP_ENDPOINT}/v3/namespaces/NAMESPACE_ID/repository/apps/push -X POST
   -d '{"apps": ["PIPELINE_NAME_1", "PIPELINE_NAME_2"]}, "commitMessage": "COMMIT_MESSAGE"'
   

   Sostituisci quanto segue:

   • NAMESPACE_ID: l'ID dello spazio dei nomi.
   • PIPELINE_NAME_1, PIPELINE_NAME_2: nomi delle pipeline di cui eseguire il push.
   • COMMIT_MESSAGE: messaggio di commit per il commit Git.

   La risposta contiene l'ID dell'operazione di push. Ad esempio:

   RESPONSE
   {
   "id": OPERATION_ID
   }
   

2. Per eseguire il polling dello stato dell'operazione di push, esegui questo comando:

   curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" 
   ${CDAP_ENDPOINT}/v3/namespaces/NAMESPACE_ID/operations/OPERATION_ID
   

   Sostituisci quanto segue:

   • NAMESPACE_ID: l'ID dello spazio dei nomi.
   • OPERATION_ID: l'ID operazione ricevuto dall'operazione di push.

   La risposta contiene lo stato dell'operazione di push. Ad esempio:

   RESPONSE
   {
   "id": OPERATION_ID
   "done": True/False
   "status": STARTING/RUNNING/SUCCEEDED/FAILED
   "error": {"message": ERROR_MESSAGE, "details":[{"resourceUri": RESOURCE, "message": ERROR_MESSAGE}]}
   }
   

   Per verificare se l'operazione di push è stata completata, controlla la proprietà done nella risposta. Se l'operazione non è riuscita, controlla la proprietà error per ulteriori dettagli.

Esegui il pull delle pipeline dal repository Git a Cloud Data Fusion

Per sincronizzare più pipeline da un repository Git allo spazio dei nomi, segui questi passaggi:

Console

1. In Cloud Data Fusion Studio, fai clic su Menu.
2. Fai clic su Amministratore spazio dei nomi.
3. Nella pagina Amministratore spazio dei nomi, fai clic sulla scheda Gestione del controllo del codice sorgente.
4. Trova il repository Git che vuoi sincronizzare e fai clic su Sincronizza pipeline.
5. Fai clic sulla scheda Pipeline del repository. Vengono visualizzate tutte le pipeline archiviate nel repository Git.
6. Cerca e seleziona le pipeline di cui vuoi eseguire il pull dal repository Git nello spazio dei nomi di Cloud Data Fusion.

7. Fai clic su Pull dal repository.

   L'operazione di pull viene avviata e viene visualizzato un messaggio che indica che è in corso il pull delle pipeline selezionate dal repository remoto. Cloud Data Fusion cerca i file JSON nel percorso configurato, li esegue il pull e il deployment come pipeline in Cloud Data Fusion.

Una volta completata l'operazione di pull, viene visualizzato un messaggio di operazione riuscita che indica il numero di pipeline di cui è stato eseguito il pull dal repository remoto.

Se l'operazione di pull non riesce, viene visualizzato un messaggio di errore. Per visualizzare i dettagli dell'errore, espandi il messaggio di errore.

Nota: se un'operazione pull per più pipeline è in esecuzione, non puoi avviare contemporaneamente un'altra operazione di push o pull nello spazio dei nomi fino al completamento dell'operazione attuale. L'elenco delle pipeline nelle schede Pipeline dello spazio dei nomi e Pipeline del repository rimane disabilitato fino al completamento dell'operazione di pull attuale.

Puoi anche eseguire il pull di singole pipeline da un repository Git a uno spazio dei nomi da pipeline Design Studio:

1. In Cloud Data Fusion Studio, fai clic su Menu.
2. Fai clic su Elenco.
3. Fai clic sulla pipeline di cui vuoi eseguire il pull dal repository Git.
4. Nella pagina della pipeline, fai clic su Azioni > Pull dal repository.

API REST

1. Esegui il pull di un set di pipeline dal repository Git a Cloud Data Fusion:

   curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" 
   ${CDAP_ENDPOINT}/v3/namespaces/NAMESPACE_ID/repository/apps/pull -X POST -d '{"apps": ["PIPELINE_NAME_1", "PIPELINE_NAME_2"]}'
   

   Sostituisci quanto segue:

   • NAMESPACE_ID: l'ID dello spazio dei nomi.
   • PIPELINE_NAME_1, PIPELINE_NAME_2: nomi delle pipeline di cui eseguire il pull.

   La risposta contiene l'ID dell'operazione di pull. Ad esempio:

   RESPONSE
   {
   "id": OPERATION_ID
   }
   

2. Per eseguire il polling dello stato dell'operazione di pull, esegui questo comando:

   curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" 
   ${CDAP_ENDPOINT}/v3/namespaces/NAMESPACE_ID/operations/OPERATION_ID
   

   Sostituisci quanto segue:

   • NAMESPACE_ID: l'ID dello spazio dei nomi.
   • OPERATION_ID: l'ID operazione ricevuto dall'operazione di pull.

   La risposta contiene lo stato dell'operazione di pull. Ad esempio:

   RESPONSE
   {
   "id": OPERATION_ID
   "done": True/False
   "status": STARTING/RUNNING/SUCCEEDED/FAILED
   "error": {"message": ERROR_MESSAGE, "details":[{"resourceUri": RESOURCE, "message": ERROR_MESSAGE}]}
   }
   

   Per verificare se l'operazione di pull è stata completata, controlla la proprietà done nella risposta. Se l'operazione non è riuscita, controlla la proprietà error per ulteriori dettagli.

Elimina la configurazione del repository Git

Per eliminare la configurazione del repository Git da uno spazio dei nomi:

Console

1. In Cloud Data Fusion Studio, fai clic su Menu.
2. Fai clic su Amministratore spazio dei nomi.
3. Nella pagina Amministratore spazio dei nomi, fai clic sulla scheda Gestione del controllo del codice sorgente.
4. Per la configurazione del repository Git che vuoi eliminare, fai clic su > Elimina.

API REST

Elimina la configurazione del repository Git:

curl -H "Authorization: Bearer $(gcloud auth print-access-token)"
${CDAP_ENDPOINT}/v3/namespaces/NAMESPACE_ID/repository -X DELETE

Sostituisci NAMESPACE_ID con l'ID dello spazio dei nomi.

Passaggi successivi

• Scopri di più sull'utilizzo di un repository GitHub per gestire le pipeline.