Un endpoint di deployment webhook richiede all'istanza di Looker di eseguire il deployment delle modifiche da un ramo Git, da un commit SHA o dal nome di un tag, quindi di eseguire il push delle modifiche alla versione di produzione del progetto. (consulta la sezione Eseguire il deployment con gli webhook per i formati degli webhook di deployment di Looker). Per la maggior parte dei progetti, Looker gestisce le integrazioni di Git e 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 di produzione remoto al di fuori dell'IDE di Looker, che è una pratica comune nei flussi di lavoro di sviluppo con ambienti di staging.
- Vuoi utilizzare un webhook per eseguire il deployment con la modalità di deployment avanzata, che ti consente di specificare il ramo, l'SHA del commit o il nome del tag utilizzato per la versione di produzione del progetto Looker.
- Hai configurato il tuo progetto Looker con le richieste di pull di Git, il che significa che devi attivare un webhook di deployment dopo aver unito una richiesta di pull per eseguire il push delle modifiche nell'ambiente di produzione di Looker. La maggior parte dei servizi di hosting Git ha modi per automatizzare questa operazione se aggiungi l'webhook all'interfaccia del tuo provider Git.
Se sei un amministratore di Looker, puoi configurare l'webhook di deployment in modo che richieda un segreto, 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 al suo interno.
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 nel 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 segreto. Puoi utilizzare questo secret generato automaticamente oppure digitare il tuo token secret.
- Indipendentemente dal fatto che tu stia utilizzando il secret generato automaticamente o ne stia creando uno tuo, copia il secret di deployment dell'webhook e incollalo in un file di testo in modo da averlo a disposizione se devi aggiungere il secret all'webhook per il tuo repository. Assicurati di copiarlo a questo punto. Una volta lasciata o aggiornata la pagina Configurazione progetto, 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.
Ora l'webhook di deployment per il progetto 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.
Configurare il secret per l'webhook del tuo 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 progetto in Looker.
Nelle impostazioni del repository, fai clic su Webhook.
Individua l'webhook per il tuo progetto LookML, quindi fai clic sul pulsante Modifica.
Nel campo Secret (Secret), incolla il secret di deployment del webhook che hai copiato dalla sezione Webhook Deploy Secret (Secret di deployment del webhook) in Looker.
Fai clic su Aggiorna webhook.
Il secret webhook è ora obbligatorio per eseguire il deployment delle modifiche nella versione di produzione del progetto. Se necessario, puoi modificare il segreto o rimuoverlo dal progetto.
Modifica di un secret di deployment
Una volta aggiunto un segreto di deployment webhook al progetto, se sei un amministratore di Looker puoi modificarlo nel seguente modo:
- 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 secret.
- Indipendentemente dal fatto che tu stia utilizzando il secret generato automaticamente o ne stia creando uno tuo, copia il secret di deployment dell'webhook e incollalo in un file di testo in modo da averlo a disposizione se devi aggiungere il secret all'webhook per il tuo repository. Assicurati di copiarlo dagli appunti. Se esci o aggiorni la pagina Configurazione progetto, perderai l'accesso al segreto di deployment dell'webhook e dovrai tornare indietro e modificarlo o rimuoverlo del tutto.
- Fai clic su Salva configurazione progetto.
Se il progetto è configurato con l'integrazione delle richieste pull di Git, devi anche accedere all'interfaccia del tuo provider Git per aggiornare il secret webhook per il tuo repository.
Rimuovere 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:
- Nel progetto, seleziona l'icona Impostazioni nella barra di navigazione.
- Scorri fino alla sezione Secret di deployment webhook e fai clic su Rimuovi secret. A questo punto, puoi annullare l'operazione e mantenere il segreto di deployment facendo clic su Non rimuovere.
- Per rimuovere definitivamente il segreto di deployment dell'webhook dal progetto, fai clic su Salva la configurazione del progetto.
Il progetto non richiede più un secret per l'webhook di deployment. Se il tuo progetto è configurato con l'integrazione delle richieste pull di Git, ora puoi accedere all'interfaccia del tuo provider Git per rimuovere il secret webhook dal tuo repository. Looker stesso non controllerà più la presenza di un secret sul lato del provider Git, quindi non è un problema se l'webhook del repository Git ha ancora un secret configurato. Se vuoi rimuovere il segreto dal tuo repository Git, consulta Configurare il segreto per l'webhook del repository Git per informazioni su come modificare il segreto nell'interfaccia di un provider Git.