Un endpoint di deployment del webhook richiede all'istanza di Looker di eseguire il deployment delle modifiche da un ramo Git, da una SHA di commit o dal nome di un tag e quindi di eseguire il push delle modifiche alla versione di produzione del progetto. Consulta la sezione Deployment con i webhook per informazioni sui formati dei webhook di deployment di Looker. Per la maggior parte dei progetti, Looker gestisce le integrazioni di Git ed esegue il deployment degli aggiornamenti in produzione, senza dover configurare un webhook di deployment.
Tuttavia, devi utilizzare un webhook di deployment per eseguire il push delle modifiche in produzione se si applica una delle seguenti circostanze:
- Esegui il push degli aggiornamenti al ramo di produzione remoto al di fuori dell'IDE Looker, un'operazione comune nei flussi di lavoro di sviluppo con ambienti di gestione temporanea.
- Vuoi utilizzare un webhook per eseguire il deployment con la modalità di deployment avanzata, che ti consente di specificare il ramo, la SHA del commit o il nome del tag utilizzato per la versione di produzione del progetto Looker.
- Hai configurato il progetto Looker con le richieste di pull Git, il che significa che devi attivare un webhook di deployment dopo aver unito una richiesta di pull per eseguire il push di queste modifiche nell'ambiente di produzione di Looker. La maggior parte dei servizi di hosting Git offre un modo per automatizzare questa operazione se aggiungi il webhook all'interfaccia del tuo provider Git.
Se sei un amministratore di Looker, puoi configurare il webhook di deployment in modo che richieda un secret in modo che solo le parti autorizzate possano attivarlo. Gli sviluppatori di Looker che non sono amministratori possono visualizzare la pagina Impostazioni progetto, ma non possono modificare le opzioni lì.
Aggiunta di un secret di deployment
Looker supporta i web secret per i seguenti provider Git: GitHub, Bitbucket Server e GitLab.
Per impostare un secret di deployment del webhook nel tuo progetto:
- In modalità di sviluppo, apri il tuo progetto e seleziona l'icona delle impostazioni nella barra di navigazione di IDE per aprire il relativo riquadro.
- Seleziona Configurazione nel riquadro delle impostazioni del progetto.
- Scorri fino alla sezione Secret di deployment del webhook, quindi fai clic su Imposta secret del webhook. Looker genererà automaticamente un token del secret. Puoi utilizzare questo secret generato automaticamente oppure digitare il tuo token segreto.
- Che tu stia utilizzando il secret generato automaticamente o creando un tuo secret, copia il secret di deployment del webhook e incollalo in un file di testo per averlo a disposizione nel caso in cui tu debba aggiungere il secret al webhook per il tuo repository. Assicurati di copiarlo a questo punto. Dopo aver lasciato o aggiornato la pagina Impostazioni progetto, perderai l'accesso al secret di deployment del webhook e dovrai modificare o rimuovere il secret di deployment del webhook per recuperare l'accesso al progetto.
- Fai clic su Salva configurazione progetto.
Il webhook di deployment per il tuo progetto ora richiede questo secret. Per i progetti che utilizzano un'istanza temporanea di Looker, devi includere il secret di deployment del webhook nell'intestazione HTTP per eseguire il deployment in produzione. Per i progetti con integrazione delle richieste di pull Git, devi accedere all'interfaccia del tuo provider Git per aggiungere il secret al webhook per il tuo repository.
Configurazione del secret per il webhook del repository Git
Per i progetti con integrazione delle richieste di pull Git, se hai aggiunto un secret del webhook di deployment al progetto LookML, devi accedere all'interfaccia del provider Git per aggiungere il secret al webhook per il tuo repository. Ad esempio, ecco come farlo utilizzando GitHub:
Vai alle impostazioni del repository del tuo progetto sul sito web del tuo provider Git.
SUGGERIMENTO: se hai configurato il progetto per l'integrazione Git, puoi utilizzare l'opzione Visualizza progetto su Git dal menu Git del tuo progetto in Looker.
Nelle impostazioni del repository, fai clic su Webhook.
Trova il webhook per il tuo progetto LookML, poi fai clic sul relativo pulsante Modifica.
Nel campo Secret, incolla il secret di deployment del webhook che hai copiato dalla sezione Deployment secret del webhook in Looker.
Fai clic su Aggiorna webhook.
Il secret del webhook è ora necessario per eseguire il deployment delle modifiche alla versione di produzione del progetto. Se necessario, puoi modificare il secret o rimuovere il secret dal tuo progetto.
Modifica di un secret di deployment
Dopo aver aggiunto al progetto un secret di deployment del webhook, se sei un amministratore di Looker, puoi modificarlo nel seguente modo:
- Dal tuo progetto, seleziona l'icona Impostazioni dalla barra di navigazione.
- Scorri fino alla sezione Secret Deploy webhook e fai clic su Reset Secret (Reimposta secret). Looker genererà automaticamente un nuovo token del secret. Puoi utilizzare questo secret generato automaticamente oppure digitare il tuo nuovo token segreto.
- Che tu stia utilizzando il secret generato automaticamente o creando un tuo secret, copia il secret di deployment del webhook e incollalo in un file di testo per averlo a disposizione nel caso in cui tu debba aggiungere il secret al webhook per il tuo repository. A questo punto, accertati di copiarlo dagli appunti. Dopo aver lasciato o aggiornato la pagina Impostazioni progetto, perderai l'accesso al secret di deployment del webhook e dovrai tornare indietro e modificarlo o rimuoverlo completamente.
- Fai clic su Salva configurazione progetto.
Se il progetto è configurato con l'integrazione delle richieste di pull Git, devi anche andare all'interfaccia del tuo provider Git per aggiornare il secret del webhook per il repository.
Rimozione di un secret di deployment
Dopo aver aggiunto al progetto un secret di deployment del webhook, se sei un amministratore di Looker, puoi rimuoverlo procedendo nel seguente modo:
- Dal tuo progetto, seleziona l'icona Impostazioni dalla barra di navigazione.
- Scorri fino alla sezione Deployment secret del webhook e fai clic su Rimuovi secret. A questo punto, puoi annullare l'operazione e mantenere il secret di deployment facendo clic su Non rimuovere.
- Per rimuovere definitivamente il secret di deployment del webhook dal progetto, fai clic su Salva configurazione progetto.
Il tuo progetto non richiede più un secret per il webhook di deployment. Se il progetto è configurato con l'integrazione delle richieste di pull Git, ora puoi andare all'interfaccia del tuo provider Git per rimuovere il secret del webhook dal repository. Looker stesso non verificherà più la presenza di un secret sul lato del provider Git, pertanto non è male se per il webhook del repository Git è ancora configurato un secret. Se vuoi rimuovere il secret dal repository Git, consulta Configurazione del secret per il webhook del repository Git per informazioni sulla modifica del secret nell'interfaccia di un provider Git.