Erweiterter Bereitstellungsmodus

Mit der standardmäßigen Looker-Git-Integration übernehmen Looker-Entwickler ihre Änderungen auf ihren Entwicklungszweig und führen dann ihre Entwicklungszweige mit der Produktions-Verzweigung zusammen. Bei der Bereitstellung in der Looker-Umgebung verwendet Looker dann das neueste Commit im Produktionszweig. Auf der Dokumentationsseite Versionsverwaltung und Bereitstellung verwenden finden Sie den Standard-Git-Workflow und weitere Optionen für erweiterte Git-Implementierungen.

Bei erweiterten Git-Implementierungen, bei denen Sie nicht möchten, dass das neueste Commit in Ihrem Produktionszweig für Ihre Looker-Umgebung verwendet wird, kann ein Looker-Administrator den erweiterten Bereitstellungsmodus aktivieren. Wenn der erweiterte Bereitstellungsmodus aktiviert ist, kann ein Entwickler mit der Berechtigung deploy ein anderes Commit-SHA oder -Tag für die Bereitstellung in Ihrer Looker-Produktionsumgebung angeben, anstatt den neuesten Commit im Produktionszweig zu verwenden. Wenn Sie einen Commit aus einem anderen Zweig bereitstellen möchten, können Sie den Webhook oder den API-Endpunkt im erweiterten Bereitstellungsmodus verwenden.

Mit dem erweiterten Bereitstellungsmodus können Sie Repositories in Entwicklerworkflows mit mehreren Umgebungen 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 fordert Looker die Entwickler auf, ihre Änderungen in der Produktionsumgebung zusammenzuführen. Von dort aus können Änderungen nur auf die folgenden Arten bereitgestellt werden:

• Mit Deployment Manager
• Webhook auslösen
• API-Endpunkt verwenden

Hinweis: Bei Projekten mit aktiviertem erweiterten Bereitstellungsmodus muss die erste Bereitstellung in der Produktion mit Deployment Manager erfolgen, wenn das Projekt noch nie in der Produktion bereitgestellt wurde. Sie können die API oder den Webhook nicht für die Erstbereitstellung eines Projekts verwenden, für das der erweiterte Bereitstellungsmodus aktiviert ist. Nach der ersten Bereitstellung in der Produktion können Sie mit dem Webhook oder der API nachfolgende Änderungen in der Produktion im erweiterten Bereitstellungsmodus bereitstellen, selbst wenn sie ursprünglich ohne erweiterten Bereitstellungsmodus bereitgestellt wurde.

Erweiterten Bereitstellungsmodus aktivieren

So aktivieren Sie den erweiterten Bereitstellungsmodus:

1. Gehen Sie zum Tab Konfiguration der Seite Projekteinstellungen, indem Sie das Symbol Einstellungen aus dem Symbolmenü auswählen.
2. Klicken Sie im Abschnitt Bereitstellung das Kästchen neben Erweiterten Bereitstellungsmodus aktivieren an.
3. Klicken Sie auf die Schaltfläche Save Project Configuration (Projektkonfiguration speichern), um die Änderung zu speichern.

Versionsverwaltung mit erweitertem Bereitstellungsmodus

Wenn der erweiterte Bereitstellungsmodus aktiviert ist, ist die Bereitstellung in der Produktion über Looker für Entwickler nicht mehr möglich. Wenn der Entwickler einen Commit ausführt, wird er stattdessen über die Git-Schaltfläche aufgefordert, seine Änderungen mit dem primären Zweig zusammenzuführen, anstatt eine Bereitstellung in der Produktion vorzunehmen.

Änderungen werden mithilfe eines Webhooks, der API oder des Deployment Managers für die Produktion bereitgestellt.

Deployment Manager

Bei Projekten, bei denen der erweiterte Bereitstellungsmodus aktiviert ist, können Looker-Entwickler mit der Berechtigung deploy über den Deployment Manager ein Commit oder Tag in ihrer Looker-Produktionsumgebung bereitstellen.

Sie können auf den Deployment Manager zugreifen, indem Sie im Symbolmenü das Symbol Deploy (Bereitstellen) auswählen.

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

Hinweis: Wie im Abschnitt Commit über den 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, wird im Deployment Manager der Tag-SHA angezeigt, der sich von einem Commit-SHA unterscheidet. Sie können den Commit-Verlauf Ihres Looker-Projekts verwenden, um sich den mit einem Tag verknüpften Commit-SHA anzusehen. Wenn Sie einen Commit ohne Tag bereitstellen, zeigt der Deployment Manager den Commit-SHA an. Dieser ist mit dem Commit-SHA identisch, die Sie auf der Benutzeroberfläche Ihres Git-Anbieters oder im Commit-Verlauf Ihres Looker-Projekts sehen können.

Wenn Sie noch keinen erweiterten Bereitstellungsmodus zur Bereitstellung 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 mit dem Produktionszweig zusammengeführt haben.

Bei Projekten, in denen ein Commit im erweiterten Bereitstellungsmodus bereitgestellt wurde, werden im Commit-Verlauf gegebenenfalls auch die zugehörigen Tags eines Commits und gegebenenfalls die aktuelle Version angezeigt, die in der Produktion verwendet wird.

Wenn der Produktionszweig über neuere Commits verfügt als der bereitgestellte Commit, zeigt der Deployment Manager diese Informationen sowie den letzten Commit an, den Ihre Looker-Entwickler mit dem Produktionszweig zusammengeführt haben.

Commit über Deployment Manager bereitstellen

Es gibt mehrere Möglichkeiten, ein Commit über den 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 aus allen Commits auszuwählen, die mit dem Remote-Produktionszweig zusammengeführt wurden. Wenn Sie einen Commit aus einem anderen Zweig bereitstellen möchten, verwenden Sie den Webhook oder den API-Endpunkt im erweiterten Bereitstellungsmodus.
2. Klicken Sie auf die Schaltfläche Deploy Neueste, um den zuletzt zusammengeführten Commit im Remote-Produktionszweig bereitzustellen.
3. Wenn Sie ein bereits bereitgestelltes Commit oder Tag bereitstellen möchten, klicken Sie im Deployment Manager auf das Dreipunkt-Menü Options und dann auf Deploy to Production (In Produktion bereitstellen).

Wenn Sie ein Commit auswählen, das noch nicht bereitgestellt wurde, zeigt der Deployment Manager das Menü Deploy Commit (Commit bereitstellen) an. So stellen Sie ein Commit über das Menü Commit bereitstellen bereit:

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

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

   • Git-Tags müssen innerhalb des Git-Repositorys 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 Namensreferenzen in Git finden Sie in der Git-Referenzdokumentation.

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

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

Nachdem Sie ein Commit bereitgestellt haben, markiert der Deployment Manager dieses als aktuelle Version in Ihrer Looker-Produktionsumgebung.

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. Nachdem Ihr Projekt für die Produktion bereitgestellt wurde (selbst wenn es ursprünglich ohne den erweiterten Bereitstellungsmodus bereitgestellt wurde), können Sie mit dem Bereitstellungs-Webhook nachfolgende Änderungen im erweiterten Bereitstellungsmodus in der Produktion bereitstellen.

Wenn Sie den Bereitstellungs-Webhook einrichten möchten, müssen Sie zuerst auf der Seite Projekteinstellungen ein Webhook-Secret für Ihr Looker-Projekt hinzufügen. So wird sichergestellt, dass nur autorisierte Parteien den Bereitstellungs-Webhook auslösen können.

Für die Bereitstellung von Änderungen in der Produktion mit aktiviertem erweiterten Bereitstellungsmodus sind zwei Webhooks verfügbar. Ein Webhook dient zum Bereitstellen des Heads eines Zweigs und der andere zum Bereitstellen eines bestimmten Git-SHA oder ‐Tags.

Der Webhook zum Bereitstellen des Zweigskopfs verwendet folgendes Format:

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

Der Webhook zum Bereitstellen eines Commit-SHA oder -Tags verwendet folgendes 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 den Zweignamen oder das 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 für die Produktion bereitgestellt wurde (auch wenn es ursprünglich ohne den erweiterten Bereitstellungsmodus bereitgestellt wurde), können Sie mithilfe der API nachfolgende Änderungen in der Produktion mithilfe des erweiterten Bereitstellungsmodus bereitstellen.

Zur Bereitstellung mit der API muss der API-Nutzer, der den Aufruf tätigt, 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 für die Bereitstellung mit der API den Endpunkt deploy_ref_to_production. Dieser Endpunkt kann auf verschiedene Arten aufgerufen werden. Die folgenden Beispiele gelten für die Methoden HTTPS und SDK.

HTTPS

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

In den folgenden Beispielen wird die HTTPS-Methode verwendet, um manuell über den API-Endpunkt deploy_ref_to_production bereitzustellen. Weitere Informationen und Beispiele für den manuellen API-Aufruf mithilfe von CURL-Anfragen finden Sie in der GitHub-Readme-Datei Authentifizieren bei der API oder im API Explorer. Sie können den API Explorer über den Looker Marketplace auf Ihrer Looker-Instanz installieren.

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

Stellen Sie den Zweigkopf bereit: <HOST_URL>/api/4.0/projects/<PROJECT_ID>/deploy_ref_to_production?branch=<BRANCH_NAME>

Stellen Sie ein Commit-SHA oder -Tag bereit: <HOST_URL>/api/4.0/projects/<PROJECT_ID>/deploy_ref_to_production?ref=<SHA_OR_TAG>

SDK

Hinweis: Achten Sie bei den folgenden Beispielen darauf, die Informationen in den spitzen Klammern < > durch die für Ihr LookML-Projekt spezifischen Informationen sowie den Zweignamen, SHA- oder Tag-Code zu ersetzen.

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

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

Stellen Sie den Zweigkopf bereit: deploy_ref_to_production(<PROJECT_ID>, {branch: <BRANCH_NAME>})

Stellen Sie ein Commit-SHA oder -Tag bereit: deploy_ref_to_production(<PROJECT_ID>, {ref: <SHA_OR_TAG>})