One-Click-Deployment in Jitterbit App Builder

Einführung

Seit App Builder 4.52 können Sie einen halbautomatisierten Prozess einrichten, um eine App von einer App-Builder-Umgebung (Quelle) in eine andere (Ziel) bereitzustellen. (Seit App Builder 4.53 können Sie Pakete automatisch mit einem Klick bereitstellen und installieren, indem Sie eine Zielumgebung als Standard markieren.)

Nachfolgend finden Sie einen Überblick über die Schritte:

In der Zielumgebung:
1. API-Schlüssel einrichten.
2. Umgebung konfigurieren.
In der Quellumgebung:
1. HTTP-Sicherheitsanbieter einrichten.
2. Quellumgebung konfigurieren.

Tipp

Ein typischer Anwendungsfall für diese Funktion besteht darin, die Bereitstellung von Apps zu optimieren, beispielsweise von Entwicklung zu QA oder von QA zu Produktion. In diesen Beispielen wären Quelle und Ziel wie folgt:

%%{init: {"themeVariables": {"lineColor": "#6b7280", "edgeLabelBackground": "#f5f5f5"}}}%% flowchart LR DEV["Development
(Source)"] --> QA1["QA
(Target)"] QA2["QA
(Source)"] --> PROD["Production
(Target)"]

Voraussetzungen

Der Benutzer der Zielumgebung (der Benutzer, für den der API-Schlüssel erstellt wird), muss die Deployment-Rolle haben.

Der Benutzer der Quellumgebung (der Benutzer, der die Bereitstellung durchführt) benötigt entweder die Rolle Administrator oder Developer.

In der Zielumgebung

API-Schlüssel einrichten

Führen Sie folgende Schritte aus, um einen API-Schlüssel in der Zielumgebung einzurichten:

Erstellen Sie einen API-Schlüssel-Sicherheitsanbieter:
1. Wählen Sie IDE > Sicherheitsanbieter.
2. Klicken Sie auf die Schaltfläche + Sicherheitsanbieter.
3. Konfigurieren, aktivieren und speichern Sie auf der Seite Anbieter einen Anbieter vom Typ API Key:
Richten Sie einen Benutzer für One-Click-Bereitstellungen ein:
1. (Optional) Erstellen Sie einen neuen Benutzer. Wenn Sie One-Click-Bereitstellungen mit einem vorhandenen Benutzer durchführen möchten, fahren Sie mit dem nächsten Schritt fort.
2. Gehen Sie zu IDE > Benutzerverwaltung und öffnen Sie die Registerkarte Gruppen.
3. Wählen Sie im Bereich Gruppen die Option Deployment aus.
4. Der Bereich Mitgliedschaft listet nun alle Benutzer auf, die zur ausgewählten Gruppe gehören. Klicken Sie auf die Schaltfläche + Mitgliedschaft.
5. Wählen Sie mithilfe des Dropdown-Menüs den Benutzer aus, den Sie verwenden möchten, und klicken Sie auf das Symbol . Dieser Benutzer gehört nun zur Gruppe mit den erforderlichen Berechtigungen für die Bereitstellung einer Version.
Generieren Sie einen API-Schlüssel für den Benutzer, der die Bereitstellungen durchführt:
1. Wenn Sie die Seite Benutzerverwaltung verlassen haben, kehren Sie zu ihr zurück, indem Sie zu IDE > Benutzerverwaltung gehen.
2. Auf der Registerkarte Benutzer listet der Bereich Benutzer alle Benutzer auf. Suchen Sie den Benutzer, den Sie zur Durchführung von Bereitstellungen berechtigen möchten, und wählen Sie ihn aus.
3. Klicken Sie auf das Symbol für den ausgewählten Benutzer. Das Dialogfeld Benutzer wird geöffnet.
4. Gehen Sie zu Mehr > Schlüssel. Das Dialogfeld Schlüssel wird geöffnet.
5. Klicken Sie auf Erstellen. Das Dialogfeld Schlüssel generieren wird geöffnet.
6. Wählen Sie im Feld Anbieter den Sicherheitsanbieter aus, den Sie oben erstellt haben. Klicken Sie auf Speichern. App Builder erstellt einen API-Schlüssel für den Benutzer.
  
  Warnung
  
  Der API-Schlüssel wird nur einmal angezeigt. Stellen Sie sicher, dass Sie ihn kopieren und sicher speichern.
(Seit App Builder 4.68.) Ordnen Sie den Sicherheitsanbieter dem Webdienst der Anwendung Vinyl - Release Management zu. Dies ist die versiegelte, integrierte Systemanwendung, deren REST-API One-Click-Deployment-Anfragen in dieser Umgebung empfängt. Der Webdienst einer versiegelten Anwendung kann nicht von innen in der App neu konfiguriert werden, daher wird dies stattdessen über Anwendungen durchgeführt:
1. Wählen Sie unter Sicherheitsanbieter im Bereich Sicherheitsanbieter die Option Mehr > Anwendungen.
2. Suchen Sie Vinyl - Release Management und klicken Sie auf das Symbol in der Spalte Webdienst. Das Dialogfeld Authentifizierungsanbieter wird geöffnet.
Klicken Sie auf + Authentication. Das Dialogfeld Provider wird geöffnet.
Wählen Sie den oben erstellten Sicherheitsanbieter aus. Falls die Zielumgebung einen HTTP-Anbieter mit Authentication Type auf Basic oder einen Authorization Server-Anbieter verwendet, wählen Sie stattdessen diesen aus. Klicken Sie auf Save.

Zielumgebung konfigurieren

Gehen Sie folgendermaßen vor, um die Zielumgebung zu konfigurieren:

Wählen Sie IDE > Create Release aus.
Wählen Sie die Registerkarte Environments aus.
Klicken Sie unter Current Environment auf die Schaltfläche Configure.
Legen Sie im Popup Werte für die folgenden Felder fest:
- Name: Ein Name für diese Zielumgebung.
- URL: Die URL dieser (Ziel-)Umgebung.
- Authentication: Wählen Sie den API-Schlüssel aus, der im vorherigen Abschnitt erstellt wurde.
- Enable Deployment: Ausgewählt.
- Allow Install On Deploy: Ausgewählt.
Klicken Sie auf die Schaltfläche Save:

Auf der Quelle

HTTP-Sicherheitsanbieter einrichten

Gehen Sie folgendermaßen vor, um einen HTTP-Sicherheitsanbieter in der Quellumgebung einzurichten:

Wählen Sie IDE > Security Providers aus.
Klicken Sie auf die Schaltfläche + Security Provider.
Konfigurieren, aktivieren und speichern Sie auf der Seite Provider einen Anbieter vom Typ HTTP (unter dem Abschnitt Data Source Authentication aufgelistet) mit Authentication Type auf API Key.
Klicken Sie auf die Schaltfläche Save. Zusätzliche Felder werden angezeigt.
Klicken Sie unter Endpoints auf die Schaltfläche + Credential. Das Popup Credential wird geöffnet.
Legen Sie die folgenden Felder fest:
- Type: API Key
- Key: Geben Sie den API-Schlüssel des Ziels ein, den Sie zuvor erstellt haben.
Schließen Sie das Popup Credential.

Quellumgebung konfigurieren

Gehen Sie folgendermaßen vor, um die Quellumgebung zu konfigurieren:

Legen Sie die aktuelle Umgebung fest:
1. Wählen Sie IDE > Create Release aus.
2. Wählen Sie die Registerkarte Environments aus.
3. Klicken Sie unter Current Environment auf die Schaltfläche Configure.
4. Legen Sie im Popup Werte für die folgenden Felder fest:
  - Name: Ein Name für diese Quellumgebung.
  - URL: Die URL dieser (Quell-)Umgebung.
  - Enable Deployment: Ausgewählt.
  - Allow Install On Deploy: Ausgewählt.
5. Klicken Sie auf die Schaltfläche Save.
Legen Sie die Zielumgebung fest:
1. Klicken Sie unter Target Environments auf die Schaltfläche + Target Environment.
2. Legen Sie Werte für die folgenden Felder fest:
  - Name: Geben Sie einen Namen für die Zielumgebung ein.
  - URL: Die Zugriffs-URL der Zielumgebung.
  - Authentication: Wählen Sie den HTTP-Anbieter aus, der im vorherigen Abschnitt erstellt wurde.
  - Supports Deployment: Ausgewählt.
    - Default: (Optional, wird angezeigt, wenn Supports Deployment ausgewählt ist.) Wählen Sie diese Option aus, um automatisch in dieser Umgebung bereitzustellen, sofern keine andere ausgewählt ist.
  - Supports Install On Deploy: Ausgewählt.
    - Default: (Optional, wird angezeigt, wenn Supports Install on Deploy ausgewählt ist.) Wählen Sie diese Option aus, um Pakete während der Bereitstellung automatisch zu installieren.
3. Klicken Sie auf die Schaltfläche Save und schließen Sie das Popup Environment.

One-Click-Bereitstellung durchführen

Gehen Sie folgendermaßen vor, um die One-Click-Deploy-Funktion zu verwenden:

Erstellen Sie eine Version:
1. Wählen Sie IDE > Create Release aus.
2. Wählen Sie die Registerkarte Create a Release aus.
3. Klicken Sie auf die Schaltfläche + Solution.
4. Verwenden Sie den Solution-Assistenten, um zu definieren, was bereitgestellt werden soll.
Erstellen Sie die Lösung:
1. Klicken Sie auf die Schaltfläche Build für die neue Release-Vorlage.
Release bereitstellen:
1. Warten Sie auf eine Benachrichtigung von App Builder, die anzeigt, dass der Build abgeschlossen ist.
2. Führen Sie eines der folgenden Schritte aus:
  1. Klicken Sie auf die Schaltfläche See Release der Benachrichtigung. Die Registerkarte All Releases wird geöffnet.
  2. Schließen Sie die Benachrichtigung, und wählen Sie dann die Registerkarte All Releases aus.
3. Klicken Sie auf die Schaltfläche Deploy für die erstellte Lösung.
4. Wenn Default für Supports Deployment und Supports Install On Deploy in der Zielumgebung aktiviert ist, sind keine weiteren Maßnahmen erforderlich.
  
  Führen Sie anderenfalls die folgenden Schritte aus:
  1. Öffnen Sie im Popup Deploy Release das Menü Environment, und wählen Sie dann die Zielumgebung aus.
  2. Aktivieren Sie das Kontrollkästchen Install On Deploy.
  3. Klicken Sie auf die Schaltfläche Deploy.

Bestätigen Sie, dass eine Release bereitgestellt wurde

Nach einer One-Click-Bereitstellung können Sie sicherstellen, dass die Release bereitgestellt wurde, indem Sie Folgendes tun:

Melden Sie sich bei der Zielumgebung an.
Navigieren Sie zu IDE > Install Release.
Vergewissern Sie sich, dass das Paket vorhanden ist und installiert wurde.