Produktions-Build-Jobs erstellen und konfigurieren

Sie müssen einige Packaging- und Deployment-Jobs einrichten, bevor Sie visuelle Anwendungen in der Visual Builder-Produktionsinstanz bereitstellen können. In diesem Thema wird erläutert, wie Sie dies tun.

Tipp:

Wenn Sie möchten, kann VB Studio die Build-Jobs und Pipeline für Sie erstellen und aktivieren. Wählen Sie im Einstellungseditor der visuellen Anwendung unter "Erstellen und Veröffentlichen" die Produktionsverzweigung aus, und klicken Sie auf CI/CD-Pipeline erstellen. Anschließend können Sie die neu erstellten Build-Jobs nach Bedarf ändern (weitere Konfigurationsschritte finden Sie in der unten stehenden Anleitung). Beispiel: Im Deployment-Job ist das Deployment-Ziel immer die Umgebung, die mit dem Workspace verknüpft ist. Daher müssen Sie die Zielinstanz in die Produktionsinstanz ändern.

Bevor Sie Produktions-Build-Jobs konfigurieren, notieren Sie sich Folgendes:

  • Verwenden Sie im Production Packaging-Job die Produktionsverzweigung des Git-Repositorys, um Produktionsartefakte zu generieren.
  • Wenn Sie im Entwicklungs-Packaging-Job die Standarddateinamen von Archivartefaktdateien geändert haben, rufen Sie die neuen Namen und deren Pfade ab. Sie benötigen sie, wenn Sie den Produktionsverpackungsauftrag konfigurieren.
  • Wenn Sie den Entwicklungs-Packaging-Job so konfiguriert haben, dass die in visual-application.json definierte Version der Anwendung überschrieben wird, rufen Sie die neue Version ab. Sie benötigen es, wenn Sie den Produktionsverpackungsauftrag konfigurieren.
  • Beim Konfigurieren von Deployment-Build-Jobs geben Sie an, ob die Version der Anwendung in ihre URL aufgenommen werden soll. Eine visuelle Anwendung ohne die Version in ihrer URL wird als Live-Anwendung bezeichnet. In der Regel stellen Sie eine Liveanwendung in einer Produktionsinstanz bereit.
  • Wenn Sie eine Version einer visuellen Anwendung bereitstellen, die noch nie bereitgestellt wurde, überschreibt VB Studio die zuletzt bereitgestellte Version mit der neuen Version.

    Das Deployment der zuvor bereitgestellten Version in der Produktionsinstanz wird von VB Studio nicht aufgehoben. Sie bleibt weiterhin auf der Zielinstanz, ist jedoch nicht zugänglich.

  • Wenn Sie eine Liveanwendung oder eine zuvor bereitgestellte Version erneut bereitstellen möchten, heben Sie das Deployment zunächst auf. Andernfalls verläuft der Deployment-Build nicht erfolgreich. Um das Deployment einer zuvor bereitgestellten visuellen Anwendungsversion aufzuheben, konfigurieren Sie einen Build-Job zum Aufheben des Deployments, und führen Sie ihn aus. Sie können das Deployment nicht manuell auf der Seite Umgebungen rückgängig machen.
  • Wenn Sie eine App für eine benutzerdefinierte URL bereitstellen, müssen Sie den Deployment-Job für das Deployment in der Umgebung konfigurieren, in der die benutzerdefinierte URL gehostet wird. Sie können die App nur mit der Basisauthentifizierung bereitstellen. Daher müssen Sie bestätigen, dass die für die Verbindung und Bereitstellung in der Umgebung erforderlichen Zugangsdaten korrekt sind.
  • Wenn Sie ein Anwendungsprofil für die Produktion erstellt haben, rufen Sie dessen Namen ab. Sie benötigen es, wenn Sie den Produktions-Deployment-Job konfigurieren.

Build-Job für Produktions-Packaging erstellen

Der Production Packaging-Job generiert ein visuelles Anwendungsartefakt, das bereit zur Bereitstellung ist.

  1. Klicken Sie im linken Navigator auf Builds Builds.
  2. Klicken Sie auf der Registerkarte Jobs auf + Job erstellen.
  3. Geben Sie im Dialogfeld "Neuer Job" unter Name einen eindeutigen Namen ein.
  4. Geben Sie unter Beschreibung die Beschreibung des Jobs ein.
  5. Wählen Sie unter Vorlage die Vorlage Systemstandard OL7 für Visual Builder aus.
  6. Klicken Sie auf Erstellen.
  7. Klicken Sie auf Konfigurieren Builds.
  8. Klicken Sie auf die Registerkarte Git.
  9. Wählen Sie in der Liste Git hinzufügen die Option Git aus.
  10. Wählen Sie unter Repository das Git-Repository aus. Wählen Sie unter Verzweigung oder Tag die Produktionsverzweigung aus.
  11. Klicken Sie auf die Registerkarte Schritte.
  12. Wählen Sie unter Schritt hinzufügen die Option Visuelle Anwendung und dann Package aus.
  13. Standardmäßig werden mit den Build-Jobs der Quellcode der Anwendung minimiert, bevor der Build ausgeführt wird. Wenn Sie die Quelldateien nicht minifizieren möchten, deaktivieren Sie das Kontrollkästchen Anwendung optimieren.
    Minifizierung ist ein Prozess, bei dem unnötige Zeichen (wie Leerräume, neue Zeilen und Kommentare) aus dem Quellcode entfernt und die Größe der Dateien reduziert werden, sodass die Übertragung von Dateien weniger Bandbreite und Speicherplatz verbraucht.
  14. Wenn Sie die Standardnamen der Archivdateien ändern möchten, wählen Sie unter Dateinamen die Option Benutzerdefinierte Dateinamen verwenden aus.
    Geben Sie unter Quellen den Namen und Pfad der Archivdatei der visuellen Anwendungsquelle an. Geben Sie unter Artefakt erstellen den Namen und den Pfad der Build-Artefaktarchivdatei an.

    Sie benötigen beide Archivdateien, um die visuelle Anwendung bereitzustellen.

  15. Klicken Sie auf die Registerkarte Nach Erstellung.
  16. Wählen Sie unter Aktion nach Build hinzufügen die Option Artefakt-Archiver aus.
  17. Geben Sie unter Zu archivierende Dateien den Build-Artefaktnamen ein. Sie können auch Platzhalter verwenden. Beispiel: *.zip.
  18. Wenn Sie alte Artefakte des Builds verwerfen möchten, klicken Sie auf Einstellungen Das Zahnradsymbol. Aktivieren Sie in der Registerkarte Allgemein das Kontrollkästchen Alte Builds verwerfen, und geben Sie die Verwerfen-Optionen an.
  19. Klicken Sie auf Speichern.

Build-Job für Produktions-Deployment erstellen

Der Produktions-Deployment-Job stellt das Artefakt der visuellen Anwendung bereit, das im Produktions-Packaging-Job generiert wurde, in der Visual Builder-Produktionsinstanz. Bevor Sie den Job erstellen, rufen Sie die Zugriffszugangsdaten eines Benutzers ab, der eine Verbindung zur Visual Builder-Produktionsinstanz herstellen und diese bereitstellen kann.

  1. Klicken Sie im linken Navigator auf Builds Builds.
  2. Klicken Sie auf der Registerkarte Jobs auf + Job erstellen.
  3. Geben Sie im Dialogfeld "Neuer Job" unter Name einen eindeutigen Namen ein.
  4. Geben Sie unter Beschreibung die Beschreibung des Jobs ein.
  5. Wählen Sie unter Vorlage die Vorlage Systemstandard OL7 für Visual Builder aus.
  6. Klicken Sie auf Erstellen.
  7. Klicken Sie auf Konfigurieren Builds.
  8. Klicken Sie auf die Registerkarte Vor Erstellung.
  9. Wählen Sie unter Aktion vor Erstellung hinzufügen die Option Artefakte kopieren aus.
  10. Wählen Sie unter Aus Job den Produktions-Packaging-Job aus, der das Artefakt der visuellen Anwendung generiert hat.
  11. Wählen Sie unter Welcher Build die Option Letzter erfolgreicher Build aus.
  12. Übernehmen Sie für andere Felder die Standardwerte, oder lassen Sie sie leer.
  13. Klicken Sie auf die Registerkarte Schritte.
  14. Wählen Sie unter Schritt hinzufügen die Option Visuelle Anwendung und dann Bereitstellen aus.
  15. Wählen Sie unter Zielinstanz die Visual Builder-Produktionsinstanz aus.
  16. Geben Sie im Abschnitt "Autorisierung" den Autorisierungstyp an, um diesen Build-Schritt auszuführen. Wenn OAuth verwenden standardmäßig ausgewählt ist, wird die Meldung Authorization is required angezeigt, die angibt, dass dieser Build-Schritt eine einmalige Autorisierung benötigt, um OAuth-Anforderungen an die Visual Builder-Instanz Ihrer Umgebung zu verarbeiten. Klicken Sie auf Autorisieren, und geben Sie Zugangsdaten für den Zugriff auf Ihre Visual Builder-Instanz ein. Sie können den Job auch manuell ausführen und die Zugangsdaten eingeben, wenn Sie dazu aufgefordert werden.

    In beiden Fällen wird empfohlen, die OAuth-Verbindung während der anfänglichen Konfiguration zu autorisieren. Wenn Sie diesen Schritt überspringen, können Sie Ihre Änderungen nicht im Designer veröffentlichen. Sie müssen die erforderliche Autorisierung abschließen, bevor Sie versuchen, Änderungen bereitzustellen.

    Nach der Autorisierung wird die Meldung Authorization has been provided angezeigt.

    Hinweis

    OAuth ist der empfohlene Autorisierungstyp. Verwenden Sie die Basisauthentifizierung nur, wenn Probleme beim Einrichten einer OAuth-Verbindung auftreten. Um die Basisauthentifizierung zu verwenden, wählen Sie Basisauthentifizierung verwenden aus, und geben Sie dann die Zugangsdaten eines Benutzers ein, der auf die Visual Builder-Instanz zugreifen kann, unter Benutzername und Kennwort.

    OAuth-Token (Zugriff und Aktualisierung) werden während der regulären Verwendung neu gestartet. Ein Aktualisierungstoken wird verwendet, um ein Zugriffstoken abzurufen, wenn ein Benutzer auf die Zielinstanz zugreift. Dieses Aktualisierungstoken ist in der Regel sieben Tage lang gültig. (Die Tokenablaufzeit wird in der IDCS-Ressourcenanwendung festgelegt und kann je nach Ihren Sicherheitsanforderungen unterschiedlich sein.) Wenn sich der Benutzer innerhalb des Zeitraums von sieben Tagen bei der Zielinstanz authentifiziert, generiert das aktive Aktualisierungstoken ein neues Zugriffstoken und ein neues Aktualisierungstoken. Dieser Zyklus wird unbegrenzt fortgesetzt, solange das Aktualisierungstoken gültig bleibt. Wenn das Aktualisierungstoken während längerer Zeiträume der Inaktivität abläuft (z.B. wenn Sie im Urlaub sind), klicken Sie auf Autorisierung erneuern (oder führen Sie den Job manuell aus, sodass Sie aufgefordert werden, abgelaufene OAuth-Token zu autorisieren).

  17. Wenn Sie im Production Packaging-Job die Standarddateinamen von Archivartefaktdateien geändert haben, wählen Sie unter Dateinamen die Option Benutzerdefinierte Dateinamen verwenden aus.
    Geben Sie unter Quellen und Build-Artefakt dieselben Dateinamen (mit Pfad) ein, die Sie im Packaging-Job angegeben haben.

    Wenn Sie die Dateinamen nicht geändert haben, verwenden Sie die Standardoption.

  18. (Optional) Wenn Sie den Entwicklungs-Deployment-Job so konfiguriert haben, dass die Standardversion der Anwendung überschrieben wird, geben Sie dieselbe Version in der Anwendungsversion an. Lassen Sie das Feld leer, um die in der Datei visual-application.json der Anwendung definierte Version zu verwenden.
    Wenn die Version bereits bereitgestellt ist, heben Sie das Deployment zunächst auf.
  19. Deaktivieren Sie das Kontrollkästchen Anwendungsversion in URL einschließen.
    Nehmen Sie beim Deployment in einer Produktionsinstanz nicht die Version der Anwendung in die URL der bereitgestellten Anwendung auf.
  20. (Optional) Geben Sie unter Anwendungsprofil das Profil der Produktionsanwendung an. Lassen Sie das Feld leer, um das Standardprofil der Anwendung zu verwenden.

    Ihre visuelle Anwendung greift für REST-Services auf Daten von verschiedenen Servern zu und benötigt möglicherweise unterschiedliche Sicherheitseinstellungen für verschiedene Umgebungen, wie Entwicklung und Produktion. Mit Anwendungsprofilen können Sie verschiedene Kombinationen von Servern und Sicherheitseinstellungen für jede Ihrer Umgebungen definieren und diese beim Deployment der Anwendung in einer Umgebung verwenden. Dies vereinfacht die Verwaltung der visuellen Anwendung beim Übergang von der Entwicklung zur Produktion. Weitere Informationen finden Sie unter Info über Anwendungsprofile.

  21. Um eine bereinigte Datenbank für die Anwendung zu verwenden, wählen Sie in Datenmanagement die Option Bereinigte Datenbank verwenden aus.
  22. Klicken Sie auf Speichern.

Datenschutzeinstellung eines Produktionsjobs konfigurieren

Markieren Sie einen Job als privat, um einzuschränken, wer die Konfiguration eines Jobs anzeigen oder bearbeiten oder dessen Build ausführen kann.

Ein privater Job muss manuell ausgeführt werden. Er wird nicht ausgeführt, wenn ein nicht autorisierter Benutzer versucht, den Job direkt über einen SCM/periodischen Trigger oder eine Pipeline auszuführen.
  1. Klicken Sie im linken Navigator auf Projektadministration Projektadministration.
  2. Klicken Sie auf Builds.
  3. Klicken Sie auf die Registerkarte Jobschutz.
  4. Wählen Sie in der Auftragsliste einen Produktionsauftrag aus.
  5. Wählen Sie die Option Privat aus.
  6. Fügen Sie unter Autorisierte Benutzer sich selbst hinzu.
    Um weitere Benutzer hinzuzufügen, wählen Sie sie einzeln aus, oder wählen Sie unter "Gruppen" eine Gruppe (oder Gruppen) von Benutzern aus.
  7. Wiederholen Sie die Schritte 4-6 für den Deployment-Produktionsjob.
  8. Klicken Sie auf Speichern.

Ein privater Job zeigt in der Jobliste auf der rechten Seite der Seite "Jobschutz" auf der Registerkarte Jobs der Seite Builds und in den Pipelines das Symbol Sperren Sperren an.

Pipeline erstellen und konfigurieren

Um sicherzustellen, dass der Produktions-Deployment-Job automatisch nach dem Produktions-Packaging-Job ausgeführt wird, erstellen Sie eine Pipeline, und legen Sie die Abhängigkeit fest.

  1. Klicken Sie im linken Navigator auf Builds Builds.
  2. Klicken Sie auf die Registerkarte Pipelines.
  3. Klicken Sie auf + Pipeline erstellen.
  4. Geben Sie im Dialogfeld "Pipeline erstellen" unter Name und Beschreibung einen eindeutigen Namen und eine eindeutige Beschreibung ein.
  5. Klicken Sie auf Erstellen.
  6. Klicken Sie auf der Seite "Pipelinekonfiguration" mit der rechten Maustaste auf den Knoten Start, und wählen Sie Neuen Start hinzufügen aus.
  7. Klicken Sie in das Feld Neue erfolgreiche Jobs auswählen, wählen Sie den Packaging-Job aus, und klicken Sie auf Speichern.
  8. Klicken Sie mit der rechten Maustaste auf den Packaging-Job, und wählen Sie Hinzufügen, Neue erfolgreiche Jobs hinzufügen aus.
  9. Klicken Sie in das Feld Neue Jobs bei Erfolg auswählen, wählen Sie den Deployment-Job aus, und klicken Sie auf Speichern.

    Hier ein Beispiel für die fertiggestellte Pipeline:

  10. Klicken Sie auf Speichern.

Pipeline ausführen

Wenn Sie die visuelle Anwendung für die Produktionsinstanz bereitstellen möchten, führen Sie die Produktionspipeline aus.

  1. Klicken Sie im linken Navigator auf Builds Builds.
  2. Klicken Sie auf die Registerkarte Pipelines.
  3. Klicken Sie in der Zeile der Entwicklungspipeline auf das Menü Aktionen Aktionen, und wählen Sie Pipeline ausführen aus.

Nach einem erfolgreichen Build wird der Link der bereitgestellten Anwendung auf der Registerkarte Deployments der Seite Umgebungen angezeigt.

Um das neueste Build-Log eines Jobs anzuzeigen, öffnen Sie die Seite Builds, klicken auf den Jobnamen und dann auf Build-Log.