Ein Endpunkt für die Webhook-Bereitstellung fordert Ihre Looker-Instanz auf, Änderungen über einen Git-Zweig, einen Commit-SHA oder einen Tag-Namen bereitzustellen und die Änderungen dann an die Produktionsversion Ihres Projekts zu übertragen. Weitere Informationen zu den Webhook-Formaten zum Bereitstellen von Looker finden Sie im Abschnitt Mit Webhooks bereitstellen. Bei den meisten Projekten kümmert sich Looker um die Git-Integrationen und stellt Updates für die Produktion bereit, sodass Sie keinen Bereitstellungs-Webhook einrichten müssen.
Sie müssen jedoch einen Bereitstellungs-Webhook verwenden, um Änderungen an die Produktion zu übertragen, wenn einer der folgenden Umstände zutrifft:
- Sie übertragen Updates in den Remote-Produktionszweig außerhalb der Looker-IDE, was in Entwicklungs-Workflows mit Staging-Umgebungen üblich ist.
- Sie möchten einen Webhook für die Bereitstellung im erweiterten Bereitstellungsmodus verwenden, in dem Sie den Zweig, den Commit-SHA oder den Tag-Namen angeben können, der für die Produktionsversion des Looker-Projekts verwendet wird.
- Sie haben Ihr Looker-Projekt mit Git-Pull-Anfragen konfiguriert. Das bedeutet, dass Sie nach dem Zusammenführen einer Pull-Anfrage einen Bereitstellungs-Webhook auslösen müssen, um diese Änderungen in die Looker-Produktionsumgebung zu übertragen. Bei den meisten Git-Hostingdiensten gibt es Möglichkeiten, diesen Vorgang zu automatisieren, wenn Sie den Webhook der Benutzeroberfläche Ihres Git-Anbieters hinzufügen.
Als Looker-Administrator können Sie den Bereitstellungs-Webhook so konfigurieren, dass ein Secret erforderlich ist, sodass nur autorisierte Parteien ihn auslösen können. Looker-Entwickler, die keine Administratoren sind, können die Seite Projekteinstellungen aufrufen, aber die Optionen dort nicht ändern.
Bereitstellungs-Secret hinzufügen
Looker unterstützt Web-Secrets für die folgenden Git-Anbieter: GitHub, Bitbucket Server und GitLab.
So legen Sie ein Webhook-Bereitstellungs-Secret für Ihr Projekt fest:
- Öffnen Sie Ihr Projekt im Entwicklungsmodus und wählen Sie in der IDE-Navigationsleiste das Symbol „Einstellungen“ aus, um den Bereich für die Projekteinstellungen zu öffnen.
- Wählen Sie im Bereich für Projekteinstellungen die Option Konfiguration aus.
- Scrollen Sie zum Abschnitt Webhook Deploy-Secret und klicken Sie dann 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 Secret erstellen, kopieren Sie das Webhook-Bereitstellungs-Secret und fügen Sie es in eine Textdatei ein, wenn Sie das Secret dem Webhook für Ihr Repository hinzufügen müssen. Denken Sie daran, sie an dieser Stelle zu kopieren. Wenn Sie die Seite Projekteinstellungen verlassen oder aktualisieren, verlieren Sie den Zugriff auf das Webhook-Bereitstellungs-Secret und müssen es ä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 jetzt dieses Secret. 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 durchzuführen. Bei Projekten mit Integration von Git-Pull-Anfragen müssen Sie die Oberfläche Ihres Git-Anbieters aufrufen, um das Secret dem Webhook für Ihr Repository hinzuzufügen.
Secret für den Webhook Ihres Git-Repositorys konfigurieren
Wenn Sie bei Projekten mit Git-Pull-Anfrage-Integration ein Bereitstellungs-Webhook-Secret zu Ihrem LookML-Projekt hinzugefügt haben, müssen Sie das Secret auf der Schnittstelle Ihres Git-Anbieters dem Webhook für Ihr Repository hinzufügen. Hier ist ein Beispiel dafür, wie Sie das mit GitHub tun können:
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 in Looker im Git-Menü Ihres Projekts die Option View Project on Git (Projekt in Git ansehen) 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-Bereitstellungs-Secret ein, das Sie in Looker aus dem Abschnitt Webhook-Bereitstellungs-Secret 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
Nachdem Sie Ihrem Projekt ein Webhook-Bereitstellungs-Secret hinzugefügt haben, können Sie es als Looker-Administrator so ändern:
- Wählen Sie in Ihrem Projekt in der Navigationsleiste das Symbol Einstellungen aus.
- Scrollen Sie zum Abschnitt Webhook Deploy-Secret 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 Ihr eigenes neues geheimes Token eingeben.
- Unabhängig davon, ob Sie das automatisch generierte Secret verwenden oder ein eigenes Secret erstellen, kopieren Sie das Webhook-Bereitstellungs-Secret und fügen Sie es in eine Textdatei ein, wenn Sie das Secret dem Webhook für Ihr Repository hinzufügen müssen. Denk daran, sie an dieser Stelle aus der Zwischenablage zu kopieren. Wenn Sie die Seite Projekteinstellungen verlassen oder aktualisieren, verlieren Sie den Zugriff auf das Webhook-Bereitstellungs-Secret und müssen es entweder noch einmal ändern oder vollständig entfernen.
- Klicken Sie auf Projektkonfiguration speichern.
Wenn für Ihr Projekt die Integration von Git-Pull-Anfragen konfiguriert ist, müssen Sie auch die Benutzeroberfläche Ihres Git-Anbieters aufrufen, um das Webhook-Secret für Ihr Repository zu aktualisieren.
Bereitstellungs-Secret entfernen
Nachdem Sie Ihrem Projekt ein Webhook-Bereitstellungs-Secret hinzugefügt haben, können Sie es als Looker-Administrator 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 Remove Secret (Secret entfernen). An dieser Stelle können Sie den Vorgang abbrechen und das Bereitstellungsgeheimnis behalten, indem Sie auf Nicht entfernen klicken.
- Klicken Sie auf 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 von Git-Pull-Anfragen konfiguriert ist, können Sie das Webhook-Secret jetzt über die Benutzeroberfläche Ihres Git-Anbieters aus Ihrem Repository entfernen. Looker selbst wird nicht mehr auf der Seite des Git-Anbieters nach einem Secret suchen, sodass es nicht schadet, wenn für Ihren Git-Repository-Webhook noch 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 Schnittstelle eines Git-Anbieters.