Creazione di una suite di integrazione continua

Una suite di integrazione continua (CI) è un insieme di istruzioni di convalida associate al tuo progetto LookML. Un utente di Looker con l'autorizzazione manage_ci può configurare quanto segue in una suite di CI:

Prima di iniziare

Prima di poter creare una suite di CI, devi disporre di quanto segue:

Creazione di una suite di CI

Puoi configurare ed eseguire i validator nella pagina Suite nell'IDE di Looker:

Pagina delle suite di CI

Per creare una suite di CI, segui questi passaggi:

  1. Nell'IDE di Looker, fai clic sull'icona Integrazione continua nella barra di navigazione dell'IDE.
  2. Fai clic sulla scheda Suite per aprire la pagina Suite.
  3. Nella pagina Suite, puoi creare una nuova suite o modificarne una esistente:
    • Per creare una nuova suite, fai clic sul pulsante Crea suite.
    • Per modificare una suite esistente, fai clic sul pulsante Modifica suite corrispondente.
  4. Inserisci un nome per la Suite. Se stai modificando una suite esistente, puoi fare clic sull'icona a forma di matita per modificare il nome della suite.
  5. (Facoltativo) Attiva l'opzione Attiva in base a una pianificazione se vuoi configurare test di convalida automatici in base a una pianificazione ricorrente. Per saperne di più, consulta la sezione Attivazione in base a una pianificazione di questa pagina.

  6. (Facoltativo) Attiva l'opzione Attiva su richieste di pull da Looker se vuoi configurare test di convalida automatici ogni volta che uno sviluppatore Looker invia una richiesta di pull al tuo repository. Per saperne di più, consulta la sezione Attivazione sulle richieste di pull da Looker di questa pagina.

    Se attivi l'attivazione delle richieste di pull per una suite di CI, puoi utilizzare facoltativamente il campo Solo per il branch target per specificare che solo le richieste di pull a branch specifici nel repository devono attivare un'esecuzione della suite di CI. Per saperne di più, consulta la sezione Attivazione sulle richieste di pull da Looker di questa pagina.

  7. (Facoltativo) Attiva l'opzione Attiva le richieste di pull da dbt Cloud se vuoi configurare test di convalida automatici ogni volta che viene eseguito un job dbt Cloud CI. Per saperne di più, consulta la sezione Attiva le richieste di pull da dbt Cloud di questa pagina.

  8. (Facoltativo) Se vuoi configurare test di convalida automatici ogni volta che viene inviata una richiesta di pull a un progetto upstream (hub) importato, segui questi passaggi:

    1. Attiva l'opzione Attiva le richieste di pull dai progetti importati.
    2. In Seleziona i progetti upstream a cui iscriverti, seleziona la casella di controllo per ogni progetto hub importato che deve attivare un'esecuzione di questa suite di CI. Devi selezionare almeno un progetto upstream.

    Per saperne di più, consulta la sezione Attiva le richieste di pull dai progetti importati di questa pagina.

  9. (Facoltativo) Attiva l'opzione Abilita avvisi via email se vuoi ricevere avvisi via email in base allo stato di un'esecuzione di CI. Per saperne di più, consulta la sezione Configura gli avvisi di questa pagina.

  10. Facoltativamente, attiva i pulsanti di attivazione/disattivazione del validator per attivare un validator e configurare le relative opzioni. Per informazioni dettagliate, consulta le seguenti pagine della documentazione per ciascuno dei validator:

  11. Salva le modifiche utilizzando uno dei seguenti metodi:

    • Se stai creando una nuova suite, fai clic sul pulsante Crea suite.
    • Se stai modificando una suite esistente, fai clic sul pulsante Aggiorna suite.

Trigger

Le esecuzioni di CI possono essere attivate in diversi modi:

Trigger in base a una pianificazione

Puoi configurare una suite di CI in modo che venga attivata automaticamente in base a una pianificazione attivando l'opzione Attiva in base a una pianificazione.

Quando questo pulsante di attivazione/disattivazione è attivo, puoi selezionare la frequenza e le specifiche per l'esecuzione automatica della suite di CI:

  • Mensile, in un giorno e un'ora specifici
  • Settimanale, in un giorno e un'ora specifici
  • Ogni giorno, a un'ora specifica
  • Ogni ora o ogni 2, 3, 4, 6, 8 o 12 ore, con inizio e fine in orari specifici della giornata
  • Minuti: ogni 5, 10, 15, 20 o 30 minuti, con inizio e fine in orari specifici della giornata
  • Mesi specifici dell'anno, in un giorno e un'ora specifici
  • Giorni specifici della settimana a un'ora specifica

Attiva su richieste di pull da Looker

Per configurare una suite di CI per l'attivazione automatica su una richiesta di pull, attiva l'opzione Attiva su richieste di pull da Looker. Per utilizzare l'attivazione delle richieste di pull, il repository Git deve essere configurato dall'amministratore di Looker nella pagina Integrazione continua Admin di Looker.

Se attivi i trigger delle richieste di pull per una suite di CI, puoi facoltativamente specificare che solo le richieste di pull a rami specifici nel repository devono attivare un'esecuzione della suite di CI. Per limitare i trigger automatici delle richieste di pull delle esecuzioni di CI a branch specifici nel repository, inserisci un elenco separato da virgole dei branch nel campo Solo per il branch di destinazione.

Ad esempio, se un repository ha tre rami denominati main, release_1 e dev, puoi inserire main, release_1 nel campo Solo per il ramo di destinazione. Ciò significa che le esecuzioni di CI verranno attivate quando uno sviluppatore Looker invia una richiesta di pull al branch main o release_1. Se uno sviluppatore Looker invia una richiesta di pull al branch dev, non verrà attivata un'esecuzione automatica della suite CI.

Attiva le richieste di pull da dbt Cloud

Se hai configurato l'integrazione di dbt Cloud nella tua istanza, puoi configurare una suite di CI in modo che venga attivata automaticamente al termine di un job di CI di dbt Cloud. La suite CI verifica se le modifiche ai modelli dbt causeranno errori SQL nelle esplorazioni di Looker prima del deployment delle modifiche dbt.

Per configurare questo trigger, attiva l'opzione Attiva le richieste di pull da dbt Cloud durante la creazione o la modifica di una suite di CI.

Dopo aver attivato questo trigger, configura le seguenti opzioni:

  • Job dbt Cloud: seleziona dal campo a discesa il job dbt Cloud CI che deve attivare questa suite.

  • Attributo utente schema: seleziona l'attributo utente di Looker che contiene il nome dello schema per la connessione al database. In questo elenco vengono visualizzati solo gli attributi utente che sono stati abilitati per CI'integrazione dei clienti nel pannello Amministrazione.

Quando salvi la suite con questo trigger abilitato, Looker registra automaticamente un webhook nel tuo account dbt Cloud per monitorare il completamento dei job.

Per le esecuzioni attivate da dbt Cloud, Looker identifica dinamicamente lo schema temporaneo creato dall'esecuzione di dbt Cloud e sostituisce l'attributo utente selezionato con il nome di questo schema temporaneo per la durata dell'esecuzione di CI.

Attiva le richieste di pull dai progetti importati

Se il tuo progetto Looker utilizza le importazioni di progetti locali per importare altri progetti dalla stessa istanza di Looker, puoi configurare una suite di CI per testare i progetti downstream (noti come progetti spoke) ogni volta che viene aperta o aggiornata una richiesta di pull su un progetto upstream importato (noto come progetto hub).

Ad esempio, supponiamo di avere un progetto hub company_bi importato nei progetti spoke marketing e finance. Puoi configurare un trigger nei progetti marketing e finance per convalidare i progetti spoke ogni volta che viene inviata una richiesta di pull al repository company_bi.

Prima di configurare questo trigger, tieni presente i seguenti prerequisiti e comportamenti:

  • Solo importazioni di progetti locali: tutti i progetti hub sottoscritti devono essere importati localmente nel progetto spoke utilizzando il parametro local_dependency in manifest.lkml nella stessa istanza di Looker. I progetti remoti (importazioni che utilizzano il parametro remote_dependency nel file manifest del progetto) non sono supportati.
  • Git e modalità di produzione: sia il progetto spoke sia i progetti hub importati devono essere distribuiti in modalità di produzione e avere l'app GitHub CI configurata per i relativi repository Git.
  • Autorizzazioni: il ruolo Looker CI Users deve disporre dell'autorizzazione develop per i modelli sia nel progetto spoke sia nei progetti hub importati.
  • Comportamento del validator: poiché il progetto spoke viene convalidato rispetto alla sua versione di produzione e non ha uno stato Git del branch di sviluppo con cui eseguire il confronto, la convalida incrementale viene disattivata automaticamente per le esecuzioni attivate dalle richieste di pull del progetto importato, indipendentemente dall'impostazione della suite. Inoltre, ti consigliamo di disattivare CI LookML Validator e CI Style Validator nelle suite attivate solo dalle richieste di pull dei progetti importati, perché questi validator controllano solo i file del progetto spoke e non sono interessati dalle modifiche upstream.

Per configurare un progetto spoke in modo che esegua la convalida CI quando vengono inviate richieste di pull a uno o più progetti hub importati, segui questi passaggi durante la creazione o la modifica di una suite CI nel progetto spoke:

  1. Attiva l'opzione Attiva le richieste di pull dai progetti importati.
  2. In Seleziona i progetti upstream a cui iscriverti, seleziona la casella di controllo per ogni progetto hub importato che deve attivare un'esecuzione di questa suite di CI. Devi selezionare almeno un progetto upstream.

Se vuoi che le modifiche a un progetto hub attivino esecuzioni di convalida in più progetti spoke, devi configurare una suite di CI in ogni progetto spoke.

Quando salvi la suite di CI, Looker crea automaticamente una sottoscrizione webhook nel repository di ogni progetto hub selezionato per gli eventi di richiesta di pull. Quando viene inviata una richiesta di pull al repository di un progetto hub sottoscritto, Looker attiva un'esecuzione di CI nel progetto spoke. L'esecuzione convalida la versione di produzione del progetto spoke, mentre blocca temporaneamente il progetto hub importato sul commit della richiesta di pull. Looker segnala il risultato dell'CI dell'integrazione continua del progetto spoke come stato del commit nella richiesta di pull del progetto hub. Puoi anche visualizzare i dettagli dell'esecuzione nella pagina Esecuzioni del progetto spoke nell'IDE di Looker, dove la colonna Trigger mostra Importazione progetto e la pagina dei risultati dell'esecuzione include una sezione Importazioni progetto. Per saperne di più su come vengono eseguite queste esecuzioni e su come ispezionarne i risultati, consulta Esecuzione di suite di CI e Visualizzazione dei risultati di un'esecuzione di CI.

Configura avvisi

Per ricevere avvisi via email in base allo stato delle esecuzioni di CI continua, puoi configurare gli avvisi per una suite di CI. In questo modo puoi monitorare le esecuzioni di integrazione continua senza dover consultare la pagina Esecuzioni nell'IDE di Looker.

Per configurare gli avvisi via email per una suite di CI, segui questi passaggi durante la creazione o la modifica di una suite di CI:

  1. Attiva l'opzione Attiva avvisi via email.
  2. Nel campo Indirizzi email, inserisci un elenco separato da virgole degli indirizzi email che devono ricevere gli avvisi.
  3. Utilizza le caselle di controllo per selezionare gli stati dei job che devono attivare un avviso:
    • Non riuscita: attiva un'email quando un'esecuzione di CI non supera i test di convalida.
    • Errore: attiva un'email quando un'esecuzione di CI rileva un errore di sistema o di configurazione.
    • Superato: attiva un'email quando un'esecuzione CI viene completata correttamente.
    • Annullata: attiva un'email quando un'esecuzione CI viene annullata.

Eliminazione di una suite

Per eliminare una suite di CI, segui questi passaggi:

  1. Nell'IDE di Looker, fai clic sull'icona Integrazione continua nella barra di navigazione dell'IDE.
  2. Fai clic sulla scheda Suite per aprire la pagina Suite.
  3. Nella pagina Suite, fai clic sul pulsante Modifica suite per la suite.
  4. Nella pagina della suite, fai clic sul pulsante Elimina suite.
  5. Nella finestra di dialogo di conferma, fai clic sul pulsante Elimina suite.