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. Informationen zu den Looker-Deploy-Webhook-Formaten 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:
- Sie übertragen Updates außerhalb der Looker-IDE in den Remote-Produktionszweig. Das ist in Entwicklungsabläufen mit Staging-Umgebungen üblich.
- Sie möchten einen Webhook mit dem erweiterten Bereitstellungsmodus verwenden, mit dem Sie den Branch, die Commit-SHA oder den Tagnamen 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 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 zur Automatisierung, wenn Sie den Webhook der Benutzeroberfläche Ihres Git-Anbieters hinzufügen.
Wenn Sie ein Looker-Administrator sind, können Sie den Deploy-Webhook so konfigurieren, dass ein Secret erforderlich ist, damit nur autorisierte Parteien ihn auslösen können. Looker-Entwickler, die keine Administratoren sind, können die Seite Projektkonfiguration aufrufen, aber die Optionen dort 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 Navigationsleiste der IDE das Symbol „Einstellungen“ aus, um den Bereich „Projekteinstellungen“ zu öffnen.
- Wählen Sie im Bereich „Projekteinstellungen“ die Option Konfiguration aus.
- Scrollen Sie zum Abschnitt Webhook-Bereitstellungssecret und klicken Sie auf Webhook-Secret festlegen. Looker generiert automatisch ein geheimes Token. Sie können dieses automatisch generierte Secret verwenden oder ein eigenes 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 ihn an dieser Stelle. Wenn Sie die Seite Projektkonfiguration verlassen oder aktualisieren, verlieren Sie den Zugriff auf das Webhook-Bereitstellungssecret und müssen es ändern oder entfernen, um wieder Zugriff auf Ihr Projekt zu erhalten.
- Klicken Sie auf Projektkonfiguration speichern.
Für den Deploy-Webhook Ihres Projekts ist jetzt dieses Secret erforderlich. Bei Projekten, für die eine Looker-Staging-Instanz verwendet wird, müssen Sie das Webhook-Bereitstellungs-Secret in Ihren HTTP-Header aufnehmen, um eine Produktionsbereitstellung durchzuführen. 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. So gehts beispielsweise mit GitHub:
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 Projekt in Git ansehen verwenden.
Klicken Sie in den Einstellungen Ihres Repositories auf Webhooks.
Suchen Sie den Webhook für Ihr LookML-Projekt und klicken Sie auf die Schaltfläche 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.
Bereitstellungssecret ä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 (Webhook-Bereitstellungs-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 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 ihn jetzt 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
Wenn Sie Looker-Administrator sind und Ihrem Projekt ein Webhook-Deploy-Secret hinzugefügt wurde, können Sie es 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. Sie können den Vorgang abbrechen und das Bereitstellungssecret behalten, indem Sie auf Nicht entfernen klicken.
- Wenn Sie das Webhook-Bereitstellungssecret endgültig aus Ihrem Projekt entfernen möchten, klicken Sie auf Projektkonfiguration speichern.
Für Ihr Projekt ist kein Secret mehr für den Deploy-Webhook erforderlich. Wenn Ihr Projekt mit der Git-Pull-Anfrage-Integration konfiguriert ist, können Sie das Webhook-Secret jetzt über die Benutzeroberfläche Ihres Git-Anbieters aus Ihrem Repository 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-Repositories konfigurieren Informationen zum Bearbeiten des Secrets in der Benutzeroberfläche eines Git-Anbieters.