Erweiterter Bereitstellungsmodus

Bei der standardmäßigen Looker-Git-Integration committen Looker-Entwickler ihre Änderungen in ihrem Entwicklungszweig und führen ihn dann mit dem Produktionszweig zusammen. Wenn Sie dann in der Looker-Umgebung bereitstellen, verwendet Looker das neueste Commit im Produktions-Branch. Auf der Seite Versionskontrolle und Bereitstellung verwenden finden Sie den Standard-Git-Workflow und andere Optionen für erweiterte Git-Implementierungen.

Bei erweiterten Git-Implementierungen, bei denen der letzte Commit in Ihrem Produktions-Branch nicht für Ihre Looker-Umgebung verwendet werden soll, 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 haben 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 in Looker nicht aufgefordert, ihre Änderungen in der Produktion bereitzustellen. Stattdessen werden Entwickler von Looker aufgefordert, ihre Änderungen in den Produktionszweig zusammenzuführen. Änderungen können dort nur auf folgende Arten bereitgestellt werden:

• Deployment Manager verwenden
• webhook
• API-Endpunkt verwenden

Hinweis: Wenn für ein Projekt der erweiterte Bereitstellungsmodus aktiviert ist und es noch nie in der Produktion bereitgestellt wurde, muss die Erstbereitstellung in der Produktion mit dem Deployment Manager erfolgen. 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 Erstbereitstellung in der Produktionsumgebung (auch wenn die Bereitstellung ursprünglich ohne erweiterten Bereitstellungsmodus erfolgte) können Sie über den Webhook oder die API nachfolgende Änderungen mit dem erweiterten Bereitstellungsmodus in der Produktionsumgebung bereitstellen.

Erweiterten Bereitstellungsmodus aktivieren

So aktivieren Sie den erweiterten Bereitstellungsmodus:

1. Rufen Sie in der Looker IDE die Seite Projektkonfiguration auf. Klicken Sie dazu im Symbolmenü auf das Symbol Einstellungen und dann auf den Tab Konfiguration.
2. Setzen Sie auf der Seite Projektkonfiguration im Bereich Bereitstellung ein Häkchen neben Erweiterten Bereitstellungsmodus aktivieren.
3. Klicken Sie auf die Schaltfläche Projektkonfiguration speichern, um die Änderung zu speichern.

Versionskontrolle mit erweitertem Bereitstellungsmodus

Wenn der erweiterte Bereitstellungsmodus aktiviert ist, können Entwickler keine Bereitstellung in der Produktion mehr über Looker vornehmen. Stattdessen werden Entwickler, die einen Commit vornehmen, über die Git-Schaltfläche aufgefordert, ihre Änderungen mit dem Hauptzweig zusammenzuführen, anstatt sie für die Produktion bereitzustellen.

Änderungen werden über einen webhook, die API oder den Deployment Manager in der Produktion bereitgestellt.

Deployment Manager

Bei Projekten, für die 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 Bereitstellen auswählen.

Der Deployment Manager zeigt alle Commits und Tags an, die zuvor mit dem erweiterten Bereitstellungsmodus bereitgestellt wurden.

Hinweis :Wie im Abschnitt Commits über 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 die SHA des Tags angezeigt, die sich von der SHA des Commits unterscheidet. Im Commit-Verlauf Ihres Looker-Projekts können Sie die SHA des Commits aufrufen, die mit einem Tag verknüpft ist. Wenn Sie einen Commit ohne Tag bereitstellen, wird im Deployment Manager die SHA des Commits angezeigt. Diese SHA entspricht der SHA des Commits, die Sie in der Benutzeroberfläche Ihres Git-Anbieters oder im Commit-Verlauf Ihres Looker-Projekts sehen.

Wenn Sie noch keinen Commit im erweiterten Bereitstellungsmodus bereitgestellt 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 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 Produktions-Branch neuere Commits als der bereitgestellte Commit hat, zeigt der Deployment Manager diese Informationen und den letzten Commit an, den Ihre Looker-Entwickler in den Produktions-Branch zusammengeführt haben.

Commits über Deployment Manager bereitstellen

Es gibt mehrere Möglichkeiten, einen 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. Wenn Sie den zuletzt zusammengeführten Commit im Remote-Produktionszweig bereitstellen möchten, klicken Sie auf die Schaltfläche Letzte Version 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 In Produktion bereitstellen.

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

1. Wenn Sie den Commit bereitstellen möchten, ohne ihm ein Tag zuzuweisen, wählen Sie Deploy without tagging (Ohne Tagging bereitstellen) und dann Deploy to Environment (In Umgebung bereitstellen) aus. Andernfalls lassen Sie die Option Taggen und implementieren ausgewählt.

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

   • Git-Tags müssen innerhalb des Git-Repositories eindeutig sein. Sie können dasselbe Tag nicht 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.

3. Optional können Sie dem Tag eine Beschreibung 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 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.

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

Wenn Sie den Deploy-Webhook einrichten möchten, 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.

Wenn der erweiterte Bereitstellungsmodus aktiviert ist, stehen zwei Webhooks zum Bereitstellen von Änderungen in der Produktion zur Verfügung. Ein Webhook dient der Bereitstellung des Verzweigungskopfs und der andere der Bereitstellung eines bestimmten Git-SHA oder -Tags.

Der Webhook zum Bereitstellen des Head eines Branches hat 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 Branchnamen oder 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.

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

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 Einstieg in die 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

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 Branchnamen, Ihre SHA oder Ihr Tag spezifisch sind.

In den folgenden Beispielen, die die HTTPS-Methode verwenden, wird gezeigt, wie Sie die Bereitstellung manuell über den deploy_ref_to_production API-Endpunkt vornehmen. 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 Branches oder einen bestimmten Commit-SHA oder ein Tag über den deploy_ref_to_production API-Endpunkt bereitzustellen:

Leiter eines Zweigs 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 und den Branchnamen, SHA oder das 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, Parameter- und Antwortserialisierung sowie andere Aufgaben.

Das Bereitstellen 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>})

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