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. Wenn Sie dann in der Looker-Umgebung bereitstellen, verwendet Looker das neueste Commit im Produktions-Branch. 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 deploy-Berechtigung ein anderes Commit-SHA oder Tag für die Bereitstellung in Ihrer Looker-Produktionsumgebung angeben, anstatt das neueste Commit im Produktionszweig zu verwenden. Wenn Sie einen Commit aus einem anderen Branch bereitstellen möchten, können Sie den erweiterten Bereitstellungsmodus Webhook oder API-Endpunkt verwenden.

Der erweiterte Bereitstellungsmodus hilft dabei, Repositories in Entwicklerworkflows mit mehreren Umgebungen zu konsolidieren, in denen 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 zu implementieren. Stattdessen werden Entwickler von Looker aufgefordert, ihre Änderungen in den Produktionszweig zusammenzuführen. Änderungen können dort nur auf folgende Arten bereitgestellt werden:

Erweiterten Bereitstellungsmodus aktivieren

So aktivieren Sie den erweiterten Bereitstellungsmodus:

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

Versionsverwaltung mit erweitertem Bereitstellungsmodus

Wenn der erweiterte Bereitstellungsmodus aktiviert ist, können Entwickler keine Bereitstellung in der Produktion mehr über Looker vornehmen. 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.

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, bei denen ein Commit mit dem erweiterten Bereitstellungsmodus bereitgestellt wurde, werden im Commit-Verlauf auch die zugehörigen Tags eines Commits angezeigt (falls vorhanden) und es wird angegeben, welcher Commit die aktuelle Version ist, die für die Produktion verwendet wird.

Wenn der Produktionszweig neuere Commits als der bereitgestellte Commit hat, 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 noch nicht bereitgestellten Commit bereitstellen möchten, klicken Sie auf die Schaltfläche Commit auswählen und wählen Sie einen der Commits aus, die mit dem Remote-Produktionszweig zusammengeführt wurden. Wenn Sie einen Commit aus einem anderen Branch bereitstellen möchten, verwenden Sie den erweiterten Bereitstellungsmodus Webhook oder API-Endpunkt.
  2. Klicken Sie auf die Schaltfläche Deploy Neueste, um den zuletzt zusammengeführten Commit im Remote-Produktionszweig bereitzustellen.
  3. Wenn Sie einen Commit oder ein Tag bereitstellen möchten, der bzw. das bereits bereitgestellt wurde, klicken Sie im Bereitstellungsmanager auf das Dreipunkt-Menü Optionen  und dann auf 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 den Commit in der Produktionsversion Ihrer Looker-Instanz bereitzustellen.

Sobald Sie einen Commit bereitgestellt haben, wird er vom 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.

Um den Deploy-Webhook einzurichten, müssen Sie zuerst auf der Seite Projektkonfiguration ein Webhook-Secret für Ihr Looker-Projekt hinzufügen. Wenn Sie ein Webhook-Secret hinzufügen, können nur autorisierte Parteien den Bereitstellungs-Webhook auslösen.

Für die Bereitstellung von Änderungen in der Produktion mit aktiviertem erweiterten Bereitstellungsmodus sind zwei Webhooks verfügbar. Ein Webhook dient zum Bereitstellen des Verzweigungskopfs 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 hat 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 den Zweignamen oder das Commit-SHA/-Tag spezifisch sind. Hier ist ein Beispiel-Webhook zum Bereitstellen des v1.0-Tag-Namens für das e_faa-Projekt in der docsexamples.dev.looker.com-Looker-Instanz:

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.

Für die Bereitstellung mit der API benötigt der API-Nutzer, der den Aufruf ausführt, die Berechtigung deploy. 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 Endpunkt deploy_ref_to_production, um die Bereitstellung mit der API vorzunehmen. Dieser Endpunkt kann auf verschiedene Arten aufgerufen werden. Die folgenden Beispiele beziehen sich auf die Methoden HTTPS und SDK.

HTTPS

In den folgenden Beispielen wird die HTTPS-Methode verwendet, um manuell über den API-Endpunkt deploy_ref_to_production bereitzustellen. Weitere Informationen und Beispiele zum manuellen Aufrufen der API mit CURL-Anfragen findest du in der GitHub-Readme How to Authenticate to the API (So authentifizierst du dich bei der API) oder im API Explorer. Sie können den API Explorer über den Looker-Marktplatz in 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 Branch-Head 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

Alternativ können Sie eines der SDKs von Looker verwenden, anstatt manuelle Anfragen an die API zu senden. SDKs übernehmen die Details der Authentifizierung, Parameter- und Antwortserialisierung sowie andere Aspekte.

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

Leiter eines Zweigs bereitstellen: 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>})