Un endpoint di deployment webhook chiede all'istanza di Looker di eseguire il deployment delle modifiche da un ramo Git, da un commit SHA o dal nome di un tag, per poi spingerle nella versione di produzione del progetto. (Consulta la sezione Deployment con webhook per i formati di deployment webhook di Looker). Per la maggior parte dei progetti, Looker gestisce le integrazioni Git ed esegue il deployment degli aggiornamenti in produzione, quindi non è necessario configurare un webhook di deployment.
Tuttavia, devi utilizzare un webhook di deployment per inviare le modifiche in produzione se si applica una delle seguenti circostanze:
- Esegui il push degli aggiornamenti al ramo della produzione remota al di fuori dell'IDE di Looker, il che è 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 consente di specificare il ramo, l'SHA di commit o il nome del tag utilizzato per la versione di produzione del progetto Looker.
- Hai configurato il tuo progetto Looker con 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 al tuo ambiente di produzione Looker. La maggior parte dei servizi di hosting Git ha modi 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 Configurazione progetto, ma non possono modificare le opzioni da lì.
Aggiunta di un secret di deployment
Looker supporta i secret web per i seguenti provider Git: GitHub, Bitbucket Server e GitLab.
Per impostare un secret di deployment webhook per il tuo progetto:
- In modalità di sviluppo, apri il progetto e seleziona l'icona delle impostazioni nella barra di navigazione dell'IDE per aprire il riquadro delle impostazioni del progetto.
- Seleziona Configurazione nel riquadro delle impostazioni del progetto.
- Scorri fino alla sezione Secret di deployment webhook e fai clic su Imposta secret webhook. Looker genererà automaticamente un token secret. Puoi utilizzare questo secret generato automaticamente oppure digitare il tuo token segreto.
- Sia che tu stia utilizzando il secret generato automaticamente o che stia creando il tuo secret, copia il secret di deployment del webhook e incollalo in un file di testo in modo da averne di più se devi aggiungere il secret al webhook per il tuo repository. Assicurati di copiarlo a questo punto. Se esci dalla pagina Configurazione progetto o la aggiorni, perdi l'accesso al segreto di deployment del webhook e dovrai modificare o rimuovere il segreto di deployment del webhook per riottenere 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 di staging di Looker, devi includere il segreto di deployment dell'webhook nell'intestazione HTTP per eseguire il deployment in produzione. Per i progetti con integrazione delle richieste di pull di 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 pull di Git, se hai aggiunto un secret webhook di deployment al tuo progetto LookML, devi accedere all'interfaccia del tuo provider Git per aggiungere il secret all'webhook per il tuo repository. Ad esempio, ecco come eseguire questa operazione utilizzando GitHub:
Vai alle impostazioni del repository del progetto sul sito web del tuo provider Git.
SUGGERIMENTO: se hai configurato il progetto per l'integrazione di 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 Secret di deployment del webhook in Looker.
Fai clic su Aggiorna webhook.
Il secret webhook è ora necessario per eseguire il deployment delle modifiche alla versione di produzione del progetto. Se necessario, puoi modificare il secret o rimuoverlo dal progetto.
Modifica di un secret di deployment
Dopo aver aggiunto un secret di deployment del webhook al progetto, se sei un amministratore di Looker, puoi modificare il secret seguendo questa procedura:
- Nel progetto, seleziona l'icona Impostazioni nella barra di navigazione.
- Scorri fino alla sezione Secret di deployment webhook e fai clic su Ripristina secret. Looker genererà automaticamente un nuovo token segreto. Puoi utilizzare questo secret generato automaticamente oppure digitare il tuo nuovo token segreto.
- Sia che tu stia utilizzando il secret generato automaticamente o che stia creando il tuo secret, copia il secret di deployment del webhook e incollalo in un file di testo in modo da averne di più se devi aggiungere il secret al webhook per il tuo repository. Assicurati di copiarlo dagli appunti. Dopo aver abbandonato o aggiornato la pagina Configurazione 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 accedere all'interfaccia del tuo provider Git per aggiornare il secret webhook per il repository.
Rimozione di un secret di deployment
Una volta aggiunto un segreto di deployment di webhook al progetto, se sei un amministratore di Looker puoi rimuoverlo nel seguente modo:
- Dal progetto, seleziona l'icona Impostazioni dalla barra di navigazione.
- Scorri fino alla sezione Secret di deployment del webhook e fai clic su Rimuovi secret. A questo punto, puoi annullare l'operazione e mantenere il secret del deployment facendo clic su Don't remove (Non rimuovere).
- Per rimuovere definitivamente il segreto di deployment dell'webhook dal progetto, fai clic su Salva la configurazione del 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 webhook dal repository. Looker non controllerà più la presenza di un secret dal lato del provider Git, quindi non è male se per il webhook del repository Git è ancora configurato un secret. Se vuoi rimuovere il segreto dal tuo repository Git, consulta Configurare il segreto per l'webhook del tuo repository Git per informazioni su come modificare il segreto nell'interfaccia di un provider Git.