Un endpoint di deployment webhook chiede alla tua istanza di Looker di eseguire il deployment delle modifiche da un ramo Git, da una SHA di commit o da un nome tag, quindi di eseguire il push delle modifiche alla versione di produzione del tuo progetto. Per i formati del webhook di implementazione di Looker, consulta la sezione Implementazione con webhook. Per la maggior parte dei progetti, Looker gestisce le integrazioni Git e implementa gli aggiornamenti in produzione, quindi non è necessario configurare un webhook di deployment.
Tuttavia, devi utilizzare un webhook di deployment per eseguire il push delle modifiche in produzione se si verifica una delle seguenti circostanze:
- Esegui il push degli aggiornamenti al ramo di produzione remoto al di fuori dell'IDE Looker, il che è comune nei flussi di lavoro di sviluppo con ambienti di staging.
- Vuoi utilizzare un webhook per 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 una volta unita una richiesta di pull per eseguire il push delle modifiche nell'ambiente di produzione Looker. La maggior parte dei servizi di hosting Git offre 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 modificarne le opzioni.
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 pannello delle impostazioni del progetto.
- Seleziona Configurazione nel riquadro delle impostazioni del progetto.
- Scorri fino alla sezione Webhook Deploy Secret, quindi fai clic su Set Webhook Secret. Looker genererà automaticamente un token segreto. Puoi utilizzare questo secret generato automaticamente o digitare il tuo token secret.
- Che tu stia utilizzando il secret generato automaticamente o ne stia creando uno tuo, copia il secret di deployment del webhook e incollalo in un file di testo in modo da averlo a portata di mano se devi aggiungerlo al webhook per il tuo repository. Assicurati di copiarlo a questo punto. Una volta uscito dalla pagina Configurazione progetto o dopo averla aggiornata, perdi l'accesso al segreto di deployment del webhook e dovrai modificarlo o rimuoverlo per riaccedere 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 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 webhook di deployment al tuo progetto LookML, devi accedere all'interfaccia del tuo 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 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 progetto in Looker.
Nelle impostazioni del repository, fai clic su Webhook.
Trova il webhook per il tuo progetto LookML, quindi fai clic sul 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.
Ora il secret webhook è obbligatorio 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
Una volta aggiunto un segreto di deployment del webhook al tuo progetto, se sei un amministratore di Looker, puoi modificarlo nel seguente modo:
- Dal progetto, seleziona l'icona Impostazioni nella barra di navigazione.
- Scorri fino alla sezione Webhook Deploy Secret e fai clic su Reset Secret. Looker genererà automaticamente un nuovo token segreto. Puoi utilizzare questo secret generato automaticamente o digitare un nuovo token secret.
- Che tu stia utilizzando il secret generato automaticamente o ne stia creando uno tuo, copia il secret di deployment del webhook e incollalo in un file di testo in modo da averlo a portata di mano se devi aggiungerlo al webhook per il tuo repository. Assicurati di copiarlo dagli appunti a questo punto. Una volta uscito dalla pagina Configurazione progetto o dopo averla aggiornata, perderai l'accesso al segreto di deployment del webhook e dovrai tornare indietro e modificarlo o rimuoverlo completamente.
- Fai clic su Salva configurazione progetto.
Se il tuo progetto è configurato con l'integrazione delle richieste di pull Git, devi anche accedere all'interfaccia del tuo provider Git per aggiornare il secret del webhook per il tuo repository.
Rimozione di un secret di deployment
Una volta che un segreto di deployment del webhook è stato aggiunto al tuo progetto, se sei un amministratore di Looker, puoi rimuoverlo nel seguente modo:
- Dal progetto, seleziona l'icona Impostazioni nella barra di navigazione.
- Scorri fino alla sezione Webhook Deploy Secret e fai clic su Remove Secret (Rimuovi secret). A questo punto, puoi annullare l'operazione e conservare il segreto di deployment facendo clic su Non rimuovere.
- Per rimuovere definitivamente il segreto 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 tuo progetto è configurato con l'integrazione delle richieste di pull Git, ora puoi accedere all'interfaccia del tuo provider Git per rimuovere il secret webhook dal repository. Looker non verificherà più la presenza di un secret all'estremità del provider Git, quindi non è un problema se il webhook del repository Git ha ancora un secret configurato. Se vuoi rimuovere il secret dal repository Git, consulta Configurare il secret per il webhook del repository Git per informazioni sulla modifica del secret nell'interfaccia di un provider Git.