Erweiterter Bereitstellungsmodus

Bei der standardmäßigen Looker-Git-Integration führen Looker-Entwickler einen Commit ihrer Änderungen in ihrem Entwicklungszweig durch und führen dann ihren Entwicklungszweig in den Produktionszweig zusammen. Wenn Sie dann in der Looker-Umgebung bereitstellen, verwendet Looker den letzten Commit im Produktionszweig. Informationen zum standardmäßigen Git-Workflow und zu anderen Optionen für erweiterte Git-Implementierungen finden Sie auf der Dokumentationsseite Versionsverwaltung verwenden und bereitstellen.

Für erweiterte Git-Implementierungen, bei denen der letzte Commit in Ihrem Produktionszweig nicht für Ihre Looker-Umgebung verwendet werden soll, kann ein Looker-Administrator den erweiterten Bereitstellungsmodus aktivieren. Wenn aktiviert ist, kann ein Entwickler mit der Berechtigung deploy anstelle des letzten Commits im Produktionszweig einen anderen Commit-SHA oder ein anderes Tag angeben, der bzw. das in Ihrer Looker-Produktionsumgebung bereitgestellt werden soll. Wenn Sie einen Commit aus einem anderen Zweig bereitstellen möchten, können Sie den Webhook für den erweiterten Bereitstellungsmodus oder den API-Endpunkt verwenden.

Der erweiterte Bereitstellungsmodus trägt dazu bei, Repositories in Entwickler-Workflows mit mehreren Umgebungen zu konsolidieren, wobei jede Umgebung auf eine andere Version einer Codebasis verweist. Außerdem erhalten ein oder mehrere Entwickler oder Administratoren mehr Kontrolle über die Änderungen, die in der Produktion bereitgestellt werden.

Wenn der erweiterte Bereitstellungsmodus aktiviert ist, werden Entwickler von Looker nicht aufgefordert, ihre Änderungen in der Produktion bereitzustellen. Stattdessen werden sie aufgefordert, ihre Änderungen in den Produktionszweig zusammenzuführen. Von dort aus können Änderungen nur auf folgende Arten bereitgestellt werden:

• Mit dem Deployment Manager
• Durch Auslösen eines Webhooks
• Mit einem API-Endpunkt

Hinweis: Wenn der erweiterte Bereitstellungsmodus für Projekte aktiviert ist, die noch nie in der Produktion bereitgestellt wurden, muss die erste Bereitstellung in der Produktion mit dem Deployment Manager erfolgen. Die API oder der Webhook können nicht für die erste Bereitstellung eines Projekts verwendet werden, für das der erweiterte Bereitstellungsmodus aktiviert ist. Nach der ersten Bereitstellung in der Produktion (auch wenn sie ursprünglich ohne erweiterten Bereitstellungsmodus erfolgt ist) können Sie den Webhook oder die API verwenden, um nachfolgende Änderungen mit dem erweiterten Bereitstellungsmodus in der Produktion bereitzustellen.

Erweiterten Bereitstellungsmodus aktivieren

So aktivieren Sie den erweiterten Bereitstellungsmodus:

1. Rufen Sie in der Looker-IDE die Seite Projektkonfiguration auf. Wählen Sie dazu im Symbolmenü das Symbol Einstellungen und dann den Tab Konfiguration aus.
2. Wählen Sie auf der Seite Projektkonfiguration im Bereich Bereitstellung das Kästchen neben Erweiterten Bereitstellungsmodus aktivieren aus.
3. Wählen Sie die Schaltfläche Projektkonfiguration speichern aus, um die Änderung zu speichern.

Versionsverwaltung mit erweitertem Bereitstellungsmodus

Wenn der erweiterte Bereitstellungsmodus aktiviert ist, können Entwickler nicht mehr aus Looker heraus in der Produktion bereitstellen. Stattdessen werden sie beim Ausführen eines Commits über die Schaltfläche Git aufgefordert, ihre Änderungen in den primären Zweig zusammenzuführen, anstatt sie in der Produktion bereitzustellen.

Änderungen werden mit einem Webhook, der API oder dem Deployment Manager in der Produktion bereitgestellt.

Deployment Manager

Bei Projekten, für die der erweiterte Bereitstellungsmodus aktiviert ist, können Looker-Entwickler mit der deploy Berechtigung den Deployment Manager verwenden, um einen Commit oder ein Tag in ihrer Looker-Produktionsumgebung bereitzustellen.

Sie können den Deployment Manager aufrufen, indem Sie im Symbolmenü das Symbol Bereitstellen auswählen.

Im Deployment Manager werden alle Commits und Tags angezeigt, die zuvor mit dem erweiterten Bereitstellungsmodus bereitgestellt wurden.

Hinweis: Wie im Abschnitt Commit aus dem Deployment Manager bereitstellen auf dieser Seite beschrieben, können Sie einen Commit mit oder ohne Tag bereitstellen. Wenn Sie einen Commit mit einem Tag bereitstellen, zeigt der Deployment Manager den Tag-SHA an, der sich von einem Commit-SHA unterscheidet. Sie können den Commit-Verlauf Ihres Looker-Projekts verwenden, um den Commit-SHA aufzurufen, der mit einem Tag verknüpft ist. Wenn Sie einen Commit ohne Tag bereitstellen, zeigt der Deployment Manager den Commit-SHA an. Dieser ist identisch mit dem Commit-SHA, der auf der Benutzeroberfläche Ihres Git-Anbieters oder im Commit-Verlauf Ihres Looker-Projekts zu sehen ist.

Wenn Sie den erweiterten Bereitstellungsmodus noch nicht zum Bereitstellen eines Commits verwendet haben, klicken Sie auf die Schaltfläche Commit auswählen , um den Commit-Verlauf mit den Commits aufzurufen, die Ihre Looker-Entwickler in den Produktionszweig zusammengeführt haben.

Bei Projekten, bei denen der erweiterte Bereitstellungsmodus zum Bereitstellen eines Commits verwendet wurde, werden im Commit-Verlauf auch die zugehörigen Tags eines Commits angezeigt (falls vorhanden). Außerdem wird angegeben, welcher Commit die aktuelle Version ist, die für die Produktion verwendet wird.

Wenn der Produktionszweig neuere Commits als der bereitgestellte Commit enthält, werden diese Informationen im Deployment Manager angezeigt. Außerdem wird der letzte Commit angezeigt, den Ihre Looker-Entwickler in den Produktionszweig zusammengeführt haben.

Commit aus dem Deployment Manager bereitstellen

Es gibt mehrere Möglichkeiten, einen Commit aus dem Deployment Manager bereitzustellen:

1. Wenn Sie einen Commit bereitstellen möchten, der noch nicht bereitgestellt wurde, klicken Sie auf die Schaltfläche Commit auswählen , um einen der Commits auszuwählen, die in den Remote-Produktionszweig zusammengeführt wurden. Wenn Sie einen Commit aus einem anderen Zweig bereitstellen möchten, verwenden Sie den Webhook für den erweiterten Bereitstellungsmodus oder den API-Endpunkt.
2. Wenn Sie den zuletzt zusammengeführten Commit im Remote-Produktionszweig bereitstellen möchten, klicken Sie auf die Schaltfläche Neueste bereitstellen.
3. Wenn Sie einen Commit oder ein Tag bereitstellen möchten, der bzw. das bereits bereitgestellt wurde, klicken Sie im Deployment Manager auf das Dreipunkt-Menü Optionen und dann auf Für Produktion bereitstellen.

Wenn Sie einen Commit auswählen, der noch nicht bereitgestellt wurde, wird im Deployment Manager das Menü Commit bereitstellen angezeigt. So stellen Sie einen Commit über das Menü Commit bereitstellen bereit:

1. Wenn Sie den Commit bereitstellen möchten, ohne ihm ein Tag zuzuweisen, wählen Sie Ohne Tag bereitstellen und dann In Umgebung bereitstellen aus. Andernfalls lassen Sie die Option Tag und Bereitstellung ausgewählt.

2. Geben Sie ein Tag für den Commit an. Ein Git-Tag kennzeichnet die Bedeutung des Commits im Verlauf des Repository, z. B. eine Release-Nummer oder einen Versionsnamen. Beachten Sie Folgendes zu Git-Tags:

   • Git-Tags müssen im Git-Repository eindeutig sein. Sie können nicht dasselbe Tag für zwei verschiedene Commits in Ihrem Repository verwenden.
   • Git-Tags dürfen keine Leerzeichen oder bestimmte Sonderzeichen enthalten. Die Regeln für die Benennung von Referenzen in Git finden Sie in der Git-Referenz dokumentation.

3. Optional können Sie eine Beschreibung für das Tag hinzufügen, um weitere Details zum Commit anzugeben.

4. Wählen Sie In Umgebung bereitstellen aus, um den Commit in der Produktionsversion Ihrer Looker-Instanz bereitzustellen.

Sobald Sie einen Commit bereitstellen, wird er im Deployment Manager als aktuelle Version in Ihrer Looker-Produktionsumgebung gekennzeichnet.

Mit Webhooks bereitstellen

Bei Projekten mit erweitertem Bereitstellungsmodus können Sie den Bereitstellungs-Webhook verwenden, um Änderungen in der Produktion bereitzustellen.

Hinweis: Wenn der erweiterte Bereitstellungsmodus für ein neues Projekt aktiviert ist, müssen Sie den Deployment Manager für die erste Bereitstellung des Projekts in der Produktion verwenden. Sobald Ihr Projekt in der Produktion bereitgestellt wurde (auch wenn es ursprünglich ohne erweiterten Bereitstellungsmodus bereitgestellt wurde), können Sie den Bereitstellungs-Webhook verwenden, um nachfolgende Änderungen mit dem erweiterten Bereitstellungsmodus in der Produktion bereitzustellen.

Wenn Sie den Bereitstellungs-Webhook einrichten möchten, müssen Sie zuerst ein Webhook-Secret hinzufügen für Ihr Looker-Projekt von der Seite Projektkonfiguration. Durch das Hinzufügen eines Webhook-Secrets wird sichergestellt, dass nur autorisierte Parteien den Bereitstellungs-Webhook auslösen können.

Es gibt zwei Webhooks, mit denen Sie Änderungen mit aktiviertem erweitertem Bereitstellungsmodus in der Produktion bereitstellen können. Ein Webhook dient zum Bereitstellen des Zweigkopfs und der andere zum Bereitstellen eines bestimmten Git-SHA oder -Tags.

Der Webhook zum Bereitstellen des Zweigkopfs verwendet dieses Format:

<Looker URL>/webhooks/projects/<LookML project name>/deploy/branch/<Git branch name>

Der Webhook zum Bereitstellen eines Commit-SHA oder -Tags verwendet dieses Format:

<Looker URL>/webhooks/projects/<LookML project name>/deploy/ref/<commit SHA or tag>

Ersetzen Sie die Informationen in den spitzen Klammern < > durch die Informationen, die für Ihre Instanzadresse, Ihr LookML-Projekt und Ihren Zweignamen oder Commit-SHA/Tag spezifisch sind. Hier ist ein Beispiel-Webhook zum Bereitstellen des Tag-Namens v1.0 für das Projekt e_faa in der Looker-Instanz docsexamples.dev.looker.com:

https://docsexamples.dev.looker.com/webhooks/projects/e_faa/deploy/ref/v1.0

Mit der API bereitstellen

Bei Projekten mit erweitertem Bereitstellungsmodus können Sie die Looker API verwenden, um Änderungen in der Produktion bereitzustellen.

Hinweis: Wenn der erweiterte Bereitstellungsmodus für ein neues Projekt aktiviert ist, müssen Sie den Deployment Manager für die erste Bereitstellung des Projekts in der Produktion verwenden. Sobald Ihr Projekt in der Produktion bereitgestellt wurde (auch wenn es ursprünglich ohne erweiterten Bereitstellungsmodus bereitgestellt wurde), können Sie die API verwenden, um nachfolgende Änderungen mit dem erweiterten Bereitstellungsmodus in der Produktion bereitzustellen.

Wenn Sie mit der API bereitstellen möchten, muss der API-Nutzer, der den Aufruf ausführt, die Berechtigung deploy haben. Weitere Informationen zur Authentifizierung und Verwendung der Looker API finden Sie auf den Dokumentationsseiten Looker API-Authentifizierung und Erste Schritte mit der API.

Verwenden Sie den deploy_ref_to_production Endpunkt, um mit der API bereitzustellen. Dieser Endpunkt kann auf verschiedene Arten aufgerufen werden. Die folgenden Beispiele gelten für die HTTPS- und SDK-Methoden.

HTTPS

Hinweis: Ersetzen Sie in den folgenden Beispielen die Informationen in den spitzen Klammern < > durch die Informationen, die für Ihre Instanzadresse, Ihr LookML-Projekt, Ihren Zweignamen, SHA oder Tag spezifisch sind.

Informationen zum manuellen Bereitstellen mit dem deploy_ref_to_production API-Endpunkt finden Sie in den folgenden Beispielen, in denen die HTTPS-Methode verwendet wird. Weitere Informationen und Beispiele zum manuellen Aufrufen der API mit CURL-Anfragen finden Sie in der GitHub-Readme zur Authentifizierung bei der API oder im API Explorer. Sie können den API Explorer über den Looker Marketplace in Ihrer Looker-Instanz installieren.

Verwenden Sie die folgenden Beispiele in einer HTTPS-Anfrage, um entweder den Zweigkopf oder einen bestimmten Commit-SHA oder ein bestimmtes Tag über den deploy_ref_to_production API-Endpunkt bereitzustellen:

Zweigkopf bereitstellen: <HOST_URL>/api/4.0/projects/<PROJECT_ID>/deploy_ref_to_production?branch=<BRANCH_NAME>

Commit-SHA oder -Tag bereitstellen: <HOST_URL>/api/4.0/projects/<PROJECT_ID>/deploy_ref_to_production?ref=<SHA_OR_TAG>

SDK

Hinweis: Ersetzen Sie in den folgenden Beispielen die Informationen in den spitzen Klammern < > durch die Informationen, die für Ihr LookML-Projekt, Ihren Zweignamen, SHA oder Tag spezifisch sind.

Alternativ können Sie eines der SDKs von Looker verwenden, anstatt manuelle Anfragen an die API zu senden. SDKs übernehmen die Details der Authentifizierung, der Serialisierung von Parametern und Antworten sowie andere Aufgaben.

Die Bereitstellung mit deploy_ref_to_production mit der SDK-Methode sieht so aus:

Zweigkopf bereitstellen: deploy_ref_to_production(<PROJECT_ID>, {branch: <BRANCH_NAME>})

Commit-SHA oder -Tag bereitstellen: deploy_ref_to_production(<PROJECT_ID>, {ref: <SHA_OR_TAG>})