Un endpoint di deployment del webhook richiede all'istanza di Looker di eseguire il deployment delle modifiche da un ramo Git, da un SHA o dal nome di un tag di commit e quindi dal push delle modifiche alla versione di produzione del progetto. Per la maggior parte dei progetti, Looker gestisce le integrazioni Git e esegui il deployment degli aggiornamenti in produzione, quindi non è necessario configurare un webhook di deployment.
Tuttavia, è necessario utilizzare un webhook di deployment per eseguire il push delle modifiche alla produzione se si verifica una delle seguenti circostanze:
- Esegui il push degli aggiornamenti al ramo production da remoto al di fuori dell'IDE Looker, cosa comune nei flussi di lavoro di sviluppo con ambienti di gestione temporanea.
- Vuoi usare un webhook per il deployment con la modalità di deployment avanzata, che ti consente di specificare il ramo, il SHA di 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 Git, il che significa che devi attivare un webhook di deployment dopo aver unito una richiesta di pull per inviare le modifiche al tuo ambiente di produzione Looker. La maggior parte dei servizi di hosting Git prevede modi per automatizzarla se aggiungi il webhook all'interfaccia del 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
Per impostare un secret di webhook di deployment 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 verso il basso fino alla sezione Webhook Deploy Secret e fai clic su Set Webhook Secret. Looker genera automaticamente un token segreto. Puoi utilizzare questo secret generato automaticamente oppure puoi digitare il tuo token secret.
- Se utilizzi il secret generato automaticamente o ne crei uno tuo, copia il secret di deployment webhook e incollalo in un file di testo per averlo se devi aggiungere il secret al webhook per il repository. Assicurati di copiarlo in questa fase. Se esci o aggiorni la pagina Impostazioni progetto, perderai l'accesso al secret di deployment webhook e dovrai modificare o rimuovere il secret di deployment 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 temporanea di Looker, devi includere il secret di webhook di deployment nell'intestazione HTTP per eseguire il deployment in produzione. Per i progetti con integrazione della richiesta di pull Git, devi accedere all'interfaccia del provider Git per aggiungere il secret al webhook per il repository.
Configurazione del secret per il webhook del repository Git
Per i progetti con integrazione della richiesta di pull Git, se hai aggiunto un secret webhook di deployment al tuo progetto LookML, devi aggiungere l'interfaccia del provider Git al secret per il tuo repository. Ad esempio, ecco come fare utilizzando GitHub:
Accedi alle impostazioni del repository del tuo progetto sul sito web del tuo provider Git.
SUGGERIMENTO: se hai configurato l'integrazione Git per il tuo progetto, 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.
Nella casella di testo Secret, incolla il secret di webhook di deployment che hai copiato dalla sezione Webhook Deploy Secret in Looker.
Fai clic su Aggiorna webhook.
Ora il secret webhook è necessario per eseguire il deployment delle modifiche alla versione di produzione del progetto. Se necessario, puoi modificare il secret o rimuovere il secret dal progetto.
Modifica di un secret di deployment
Una volta aggiunto un secret di deployment webhook al progetto, se sei un amministratore di Looker, puoi modificare il secret seguendo questi passaggi:
- Dal tuo progetto, seleziona l'icona Impostazioni dalla barra di navigazione.
- Scorri verso il basso fino alla sezione Secret webhook di deployment e fai clic su Reimposta secret. Looker genererà automaticamente un nuovo token del secret. Puoi utilizzare questo secret generato automaticamente oppure puoi digitare il tuo nuovo token secret.
- Se utilizzi il secret generato automaticamente o crei un secret, copia il secret di deployment webhook e incollalo in un file di testo in modo da averlo a portata di mano se devi aggiungere il secret al webhook per il repository. Assicurati di copiarlo dagli appunti a questo punto. Se esci o aggiorni la pagina Impostazioni progetto, perderai l'accesso al secret di deployment webhook e dovrai tornare indietro e modificarlo o rimuoverlo completamente.
- Fai clic su Salva configurazione progetto.
Se il tuo progetto è configurato con l'integrazione della richiesta di pull Git, devi anche accedere all'interfaccia del provider Git per aggiornare il secret del webhook per il repository.
Rimozione di un secret di deployment
Una volta aggiunto un secret di deployment webhook al progetto, se sei un amministratore di Looker, puoi rimuovere il secret seguendo questi passaggi:
- Dal tuo progetto, seleziona l'icona Impostazioni dalla barra di navigazione.
- Scorri verso il basso fino alla sezione Webhook Deploy Secret e fai clic su Remove 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 webhook dal progetto, fai clic su Salva configurazione del progetto.
Il tuo progetto non richiede più un secret per il webhook di deployment. Se il tuo progetto è configurato con l'integrazione della richiesta di pull di Git, ora puoi accedere all'interfaccia del provider Git per rimuovere il secret del webhook dal tuo repository. Looker non verificherà più la presenza di un secret da parte del provider Git, quindi non è dannoso se il tuo webhook repository Git ha ancora un secret configurato. Se vuoi rimuovere il secret dal repository Git, consulta la sezione Configurazione del secret per il webhook webhook del tuo Git per informazioni sulla modifica del secret sull'interfaccia di un provider Git.