Ein Webhook-Bereitstellungsendpunkt veranlasst Ihre Looker-Instanz, Änderungen aus einem Git-Branch, einer Commit-SHA oder einem Tag-Namen bereitzustellen und dann in die Produktionsversion Ihres Projekts zu übertragen. Weitere Informationen zum Bereitstellen von Webhook-Formaten in Looker finden Sie im Abschnitt Mit Webhooks bereitstellen. Bei den meisten Projekten übernimmt Looker die Git-Integrationen und führt Updates in der Produktion aus. Sie müssen also keinen Deploy-Webhook einrichten.
Sie müssen jedoch einen Deploy-Webhook verwenden, um Änderungen in die Produktionsumgebung zu übertragen, wenn einer der folgenden Umstände zutrifft:
- Updates werden außerhalb der Looker-IDE an den Remote-Produktionszweig gesendet, was bei Entwicklungsworkflows mit Staging-Umgebungen üblich ist.
- Sie möchten einen Webhook verwenden, um mit dem erweiterten Bereitstellungsmodus bereitzustellen. Dabei können Sie den Branch, die Commit-SHA oder den Tagnamen angeben, der für die Produktionsversion des Looker-Projekts verwendet wird.
- Sie haben Ihr Looker-Projekt mit Git-Pull-Anfragen konfiguriert. Das bedeutet, dass Sie einen Bereitstellungs-Webhook auslösen müssen, sobald Sie eine Pull-Anfrage zusammenführen, um diese Änderungen in Ihre Looker-Produktionsumgebung zu übertragen. Die meisten Git-Hostingdienste bieten Möglichkeiten, dies zu automatisieren, wenn Sie den Webhook der Schnittstelle Ihres Git-Anbieters hinzufügen.
Wenn Sie Looker-Administrator sind, können Sie den Bereitstellungs-Webhook so konfigurieren, dass ein Secret erforderlich ist, damit nur autorisierte Parteien es auslösen können. Looker-Entwickler, die keine Administratoren sind, können die Seite Projektkonfiguration aufrufen, aber dort die Optionen nicht ändern.
Bereitstellungssecret hinzufügen
Looker unterstützt Web-Secrets für die folgenden Git-Anbieter: GitHub, Bitbucket Server und GitLab.
So legen Sie ein Webhook-Bereitstellungssecret für Ihr Projekt fest:
- Öffnen Sie im Entwicklungsmodus Ihr Projekt und wählen Sie in der IDE-Navigationsleiste das Einstellungssymbol aus, um den Bereich mit den Projekteinstellungen zu öffnen.
- Wählen Sie im Bereich für Projekteinstellungen die Option Konfiguration aus.
- Scrollen Sie zum Abschnitt Webhook Deploy Secret (Webhook-Deployment-Secret) und klicken Sie auf Set Webhook Secret (Webhook-Secret festlegen). Looker generiert automatisch ein geheimes Token. Sie können dieses automatisch generierte Secret verwenden oder Ihr eigenes geheimes Token eingeben.
- Unabhängig davon, ob Sie das automatisch generierte Secret verwenden oder ein eigenes erstellen, kopieren Sie das Webhook-Deployment-Secret und fügen Sie es in eine Textdatei ein, damit Sie es zur Hand haben, wenn Sie das Secret dem Webhook für Ihr Repository hinzufügen müssen. Kopieren Sie es an dieser Stelle. Wenn Sie die Seite Projektkonfiguration verlassen oder aktualisieren, verlieren Sie den Zugriff auf das Webhook-Bereitstellungs-Secret und müssen das Webhook-Bereitstellungs-Secret ändern oder entfernen, um wieder Zugriff auf Ihr Projekt zu erhalten.
- Klicken Sie auf Projektkonfiguration speichern.
Der Bereitstellungs-Webhook für Ihr Projekt benötigt dieses Secret jetzt. Bei Projekten, die eine Looker-Staging-Instanz verwenden, müssen Sie das Webhook-Bereitstellungs-Secret in den HTTP-Header aufnehmen, um die Bereitstellung in der Produktion vorzunehmen. Bei Projekten mit Git-Pull-Anfrage-Integration müssen Sie die Benutzeroberfläche Ihres Git-Anbieters aufrufen, um das Secret dem Webhook für Ihr Repository hinzuzufügen.
Secret für den Webhook Ihres Git-Repositories konfigurieren
Wenn Sie Ihrem LookML-Projekt ein Deploy-Webhook-Secret hinzugefügt haben, müssen Sie in der Benutzeroberfläche Ihres Git-Anbieters das Secret dem Webhook für Ihr Repository hinzufügen. Hier sehen Sie ein Beispiel dafür, wie Sie dies mit GitHub tun:
Rufen Sie die Repository-Einstellungen Ihres Projekts auf der Website Ihres Git-Anbieters auf.
TIPP: Wenn Sie Ihr Projekt für die Git-Integration eingerichtet haben, können Sie die Option View Project on Git aus dem Git-Menü Ihres Projekts in Looker verwenden.
Klicken Sie in den Einstellungen Ihres Repositorys auf Webhooks.
Suchen Sie den Webhook für Ihr LookML-Projekt und klicken Sie dann auf die Schaltfläche Edit (Bearbeiten).
Fügen Sie in das Feld Secret das Webhook-Deploy-Secret ein, das Sie aus dem Abschnitt Webhook-Deploy-Secret in Looker kopiert haben.
Klicken Sie auf Webhook aktualisieren.
Das Webhook-Secret ist jetzt erforderlich, um Änderungen an der Produktionsversion Ihres Projekts bereitzustellen. Bei Bedarf können Sie das Secret ändern oder aus Ihrem Projekt entfernen.
Bereitstellungs-Secret ändern
Wenn Sie Looker-Administrator sind und Ihrem Projekt ein Webhook-Bereitstellungssecret hinzugefügt wurde, können Sie das Secret so ändern:
- Wählen Sie in Ihrem Projekt in der Navigationsleiste das Symbol Einstellungen aus.
- Scrollen Sie zum Abschnitt Webhook Deploy Secret (Secret für Webhook-Bereitstellung) und klicken Sie auf Reset Secret (Secret zurücksetzen). Looker generiert automatisch ein neues geheimes Token. Sie können dieses automatisch generierte Secret verwenden oder ein eigenes neues Secret-Token eingeben.
- Unabhängig davon, ob Sie das automatisch generierte Secret verwenden oder ein eigenes erstellen, kopieren Sie das Webhook-Deployment-Secret und fügen Sie es in eine Textdatei ein, damit Sie es zur Hand haben, wenn Sie das Secret dem Webhook für Ihr Repository hinzufügen müssen. Kopieren Sie es an dieser Stelle aus der Zwischenablage. Wenn Sie die Seite Projektkonfiguration verlassen oder aktualisieren, verlieren Sie den Zugriff auf das Webhook-Bereitstellungssecret und müssen zurückgehen und es ändern oder vollständig entfernen.
- Klicken Sie auf Projektkonfiguration speichern.
Wenn Ihr Projekt mit der Git-Pull-Anfrage-Integration konfiguriert ist, müssen Sie auch die Benutzeroberfläche Ihres Git-Anbieters aufrufen, um das Webhook-Secret für Ihr Repository zu aktualisieren.
Bereitstellungssecret entfernen
Looker-Administratoren können das Secret nach dem Hinzufügen eines Webhook-Bereitstellungs-Secrets so entfernen:
- Wählen Sie in Ihrem Projekt in der Navigationsleiste das Symbol Einstellungen aus.
- Scrollen Sie zum Abschnitt Webhook-Deploy-Secret und klicken Sie auf Secret entfernen. Nun können Sie den Vorgang abbrechen und das Bereitstellungs-Secret beibehalten. Klicken Sie dazu auf Nicht entfernen.
- Klicken Sie auf Save Project Configuration (Projektkonfiguration speichern), um das Webhook-Bereitstellungs-Secret dauerhaft aus Ihrem Projekt zu entfernen.
Ihr Projekt benötigt kein Secret mehr für den Bereitstellungs-Webhook. Wenn Ihr Projekt mit der Integration der Git-Pull-Anfrage konfiguriert ist, können Sie jetzt die Benutzeroberfläche Ihres Git-Anbieters aufrufen, um das Webhook-Secret aus Ihrem Repository zu entfernen. Looker selbst prüft nicht mehr auf ein Secret beim Git-Anbieter. Es schadet also nicht, wenn für den Webhook Ihres Git-Repositories weiterhin ein Secret konfiguriert ist. Wenn Sie das Secret aus Ihrem Git-Repository entfernen möchten, finden Sie unter Secret für den Webhook Ihres Git-Repositorys konfigurieren Informationen zum Bearbeiten des Secrets auf der Benutzeroberfläche eines Git-Anbieters.