Produktionsfertigungsjobs erstellen und konfigurieren

Um Erweiterungen in der PROD-Instanz der Oracle Cloud-Anwendung bereitzustellen, können Sie entweder die Seite "Erweiterungslebenszyklus verwalten" verwenden oder eine CI/CD-Pipeline einrichten. Wenn Sie eine Pipeline verwenden möchten, müssen Sie einige Packaging- und Deployment-Jobs einrichten.

  1. Migrieren Sie die Konfigurationen zur Oracle Cloud Application-Produktionsinstanz. Weitere Anweisungen finden Sie unter Überblick über den Konfigurationslebenszyklus und Überblick über Migration in Anwendungen konfigurieren und erweitern.
  2. Erstellen Sie einen Build-Job, in dem die Erweiterung gepackt wird. Anweisungen finden Sie unter Build-Job für Production Packaging erstellen.
  3. Erstellen Sie einen Build-Job, der die Erweiterung für die Produktionsinstanz bereitstellt. Anweisungen finden Sie unter Produktions-Deployment-Build-Job erstellen.
  4. (Optional) Beschränken Sie, wer die Produktions-Build-Jobs anzeigen oder bearbeiten oder deren Builds ausführen kann. Anweisungen hierzu finden Sie unter Jobschutzeinstellungen konfigurieren.
  5. Konfigurieren Sie die Pipelines, um die Packaging- und Deployment-Jobs nacheinander auszuführen. Anweisungen hierzu finden Sie unter Produktionspipeline erstellen und konfigurieren.
  6. Führen Sie die Produktionspipeline aus, um die Erweiterung zu verpacken und in der Produktionsinstanz bereitzustellen. Anweisungen finden Sie unter Produktions-Pipelines ausführen.

Vor der Konfiguration von Build-Jobs und -Pipelines

Sie müssen Folgendes wissen, bevor Sie Build-Jobs und -Pipelines konfigurieren und ausführen:

  • Stellen Sie sicher, dass die Quell- und Zielinstanzen dasselbe Release aufweisen, wobei die gleichen Standard- und One-off-Patches in beiden Umgebungen eingespielt werden.
  • 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 konfigurieren den Packaging-Job der Produktion so, dass dieselbe Version verwendet wird.
  • VB Studio kann stattdessen die Build-Jobs und die Pipeline für Sie erstellen und aktivieren. Wählen Sie im Einstellungseditor der Erweiterung 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. 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.

Build-Job für Produktionsverpackung erstellen

Der Packaging-Job generiert ein Erweiterungsartefakt, das zur Bereitstellung in der Produktionsinstanz bereit ist.

  1. Klicken Sie im linken Navigator auf Builds Erstellungen.
  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 in der Vorlage die Vorlage Systemstandard OL7 für Visual Builder aus.
  6. Klicken Sie auf Erstellen.
  7. Klicken Sie auf Konfigurieren Konfigurieren Sie.
  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 Steps.
  12. Wählen Sie unter Schritt hinzufügen die Option Anwendungserweiterung und dann Package aus.
  13. Standardmäßig verkleinert der Packaging-Schritt den Quellcode der Anwendung, bevor der Build ausgeführt wird. Wenn Sie die Quelldateien nicht verkleinern möchten, deaktivieren Sie das Kontrollkästchen Erweiterung optimieren.

    Die Minifizierung ist ein Prozess, um unnötige Zeichen (wie Leerstellen, neue Zeilen und Kommentare) aus dem Quellcode zu entfernen und die Größe der Dateien zu reduzieren, wodurch die Übertragung von Dateien weniger Bandbreite und Speicher verbraucht.

    Hinweis

    Wenn Sie das Kontrollkästchen Erweiterung optimieren deaktivieren, wird diese Warnung angezeigt: Optimierung nicht ausgewählt. Packages ohne Optimierung können Performanceprobleme verursachen. Daher sollten Sie diese Option nur für das Debugging oder die Fehlerbehebung verwenden.
  14. (Optional) Wenn Sie den Namen der Artefaktdatei ändern möchten, geben Sie unter Artefakt erstellen den neuen Namen ein. Als Best Practice wird empfohlen, den Standardwert extension.vx beizubehalten. Sie können ihn jedoch ändern.
    Wenn Sie den Namen ändern, müssen Sie auch den neuen Namen im Feld Zu archivierende Dateien (Schritt 18) sowie im Feld Artefakt erstellen des Deployment-Jobs verwenden. Siehe Build-Job für Produktions-Deployment erstellen.
  15. (Optional) Wenn Sie den Entwicklungs-Packaging-Job so konfiguriert haben, dass die in der Datei visual-application.json definierte Standardversion der Erweiterung überschrieben wird, geben Sie dieselbe Version in der Erweiterungsversion an.
  16. Klicken Sie im Fenster "Jobkonfiguration" auf die Registerkarte Nach Erstellung.
  17. Wählen Sie unter Aktion nach Build hinzufügen die Option Artefakt-Archiver aus.
  18. Geben Sie unter Zu archivierende Dateien den Namen des Build-Artefakts ein.

    Sie können Platzhalter verwenden. Beispiel: *.vx. Stellen Sie sicher, dass Sie den Pfad für das Build-Artefakt der Anwendungserweiterung einschließen.

    Wenn Sie einen Wert in das Feld Zielverzeichnis unter Artefakte kopieren für den Deployment-Job eingegeben haben, wird er als Unterverzeichnis des Workspace betrachtet und muss Teil des Artefaktpfads im Feld Artefakt erstellen sein.

  19. Wenn Sie die alten Artefakte des Builds verwerfen möchten, klicken Sie auf Einstellungen Das Zahnradsymbol. Aktivieren Sie auf der Registerkarte Allgemein das Kontrollkästchen Alte Builds verwerfen, und geben Sie die Verwerfungsoptionen an.
  20. Klicken Sie auf Speichern.

Build-Job für Produktions-Deployment erstellen

Der Deployment-Job stellt das Artefakt der Erweiterung bereit, das im Packaging-Job generiert wurde, in der Produktionsinstanz der Oracle Cloud-Anwendung. Bevor Sie den Job erstellen, stellen Sie sicher, dass Sie über Zugangsdaten verfügen, mit denen VB Studio auf die PROD-Instanz der Oracle Cloud-Anwendung zugreifen kann.

  1. Klicken Sie im linken Navigator auf Builds Erstellungen.
  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 in der Vorlage die Vorlage Systemstandard OL7 für Visual Builder aus.
  6. Klicken Sie auf Erstellen.
  7. Klicken Sie auf Konfigurieren Konfigurieren Sie.
  8. Klicken Sie auf die Registerkarte Vor Erstellung.
  9. Wählen Sie unter Aktion vor Build hinzufügen die Option Artefakte kopieren aus.
  10. Wählen Sie unter Von Job den Packaging-Job aus, der das Artefakt der Erweiterung generiert hat.
  11. Wählen Sie unter Welcher Build eine der folgenden Optionen aus:
    • Letzter erfolgreicher Build (Standard)
    • Letzter unbegrenzt beibehaltener Build
    • Upstream Build in dieser Pipelineinstanz
    • Von Permalink angegeben
    • Spezifischer Build
    • Von Build-Parameter angegeben
    Je nachdem, was Sie auswählen, werden Sie möglicherweise aufgefordert, den Permalink-, Build- oder Build-Parameter auszuwählen, den Sie verwenden möchten.
  12. Übernehmen Sie für die anderen Felder den Standardwert oder das Feld leer.
  13. Klicken Sie auf die Registerkarte Steps.
  14. Wählen Sie unter Schritt hinzufügen die Option Anwendungserweiterung aus, und wählen Sie Bereitstellen aus.

    Diese Abbildung zeigt die Seite "Build-Job bereitstellen", die teilweise ausgefüllt wurde.
    Beschreibung von oracle-deploy-build-step.png folgt
    Beschreibung der Abbildung oracle-deploy-build-step.png

  15. Wählen Sie unter Zielinstanz die Umgebung mit der Produktionsinstanz der Oracle Cloud-Anwendung 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 Oracle Cloud Applications-Instanz Ihrer Umgebung zu verarbeiten. Klicken Sie auf Autorisieren, und geben Sie Zugangsdaten für den Zugriff auf die Oracle Cloud Applications-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 und 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 beim Einrichten einer OAuth-Verbindung Probleme auftreten. Um die Basisauthentifizierung zu verwenden, wählen Sie Basic verwenden aus, und geben Sie die Zugangsdaten eines Benutzers ein, der auf die Oracle Cloud Applications-Instanz in Benutzername und Kennwort zugreifen kann. Diese Zugangsdaten müssen die eines lokalen Benutzers und keine föderierte Identität sein und dürfen keine Multifaktor-Authentifizierung erfordern.

    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-Ressourcen-App 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 Inaktivitätszeiträume abläuft (z.B. im Urlaub), klicken Sie auf Autorisierung erneuern (oder führen Sie den Job manuell aus, sodass Sie aufgefordert werden, abgelaufene OAuth-Token zu autorisieren).

    Im Feld Artefakt erstellen muss derselbe Artefaktname angezeigt werden, der im Packaging-Build-Schritt verwendet wurde. Bestätigen Sie diesen Wert, insbesondere wenn der Packaging-Job einen anderen Artefaktnamen als den Standardnamen extension.vx verwendet hat.
  17. Klicken Sie auf Speichern.
Hinweis

Wenn Sie z.B. eine Erweiterung für 24D in Ihrer Testumgebung entwickeln und die Erweiterung dann in Ihrer 24C-Produktionsumgebung bereitstellen möchten, müssen Sie warten, bis Ihre Produktionsinstanz auf 24D upgegradet wurde, bevor Sie sie erfolgreich bereitstellen können. In den meisten Fällen sollte es nicht mehr als eine zweiwöchige Lücke zwischen Pod-Upgrades geben.

Jobschutzeinstellungen konfigurieren

Um den Zugriff einzuschränken, kann der Projekteigentümer einen Job als privat markieren. Benutzer, die keinen Zugriff haben, können den Build-Job auf der Seite Überblick über Jobs anzeigen. Sie können jedoch nicht die Seite Jobdetails anzeigen oder die Build-Details anzeigen. Sie können die Jobkonfiguration auch nicht anzeigen oder bearbeiten oder den Build-Job löschen/aktivieren/deaktivieren. Darüber hinaus kann der Projekteigentümer ein glob-Muster verwenden, das in einer Regel definiert ist, um jeden Job zu schützen, dessen Name dem angegebenen Muster entspricht.

Hinweis

Bevor Sie Schutzmaßnahmen auf einen Job anwenden, sollten Sie Folgendes beachten:
  • Eine mit einem Glob-Muster definierte Schutzregel überschreibt keinen mit einem Namen definierten Jobschutz (kein Glob-Muster oder keine Regel).
  • Ein Schutz, der auf einen einzelnen Job angewendet wird, überschreibt einen Schutz, der mithilfe einer Regel (definiert durch ein glob-Muster) angewendet wird.
  • Wenn zwei Regeln kombiniert werden, wird der Schutz durch die restriktivste Regel bestimmt. Sie müssen sich die Ereignisse im Feed "Aktivitäten" ansehen und die Benachrichtigungen prüfen. Diese enthalten Informationen zu den Einschränkungen, wenn eine Regel eine andere überschreibt.
  • Ein Job wird nicht erstellt, wenn der Benutzer, der den Job erstellt, nicht auf seinen eigenen Job zugreifen kann. Dasselbe Prinzip gilt für die Umbenennung von Jobs.
  1. Klicken Sie im linken Navigator auf Projektadministration Projektadministration.
  2. Wählen Sie die Kachel Builds aus.
  3. Wählen Sie die Registerkarte Jobschutz aus.

    Die Seite "Jobschutz" wird angezeigt.


    Beschreibung von job-protection-page-initial.png folgt
    Beschreibung der Abbildung job-protection-page-initial.png

  4. Wählen Sie im Bereich "Regeln suchen nach" oberhalb der Liste "Jobs/Regeln" eines der folgenden Optionsfelder:
    • Wählen Sie Jobname aus, um einen Job in der Liste auszuwählen.

      Wenn Ihr Projekt viele Jobs hat, haben Sie möglicherweise Schwierigkeiten, den spezifischen Job zu finden, den Sie schützen möchten. Mit der Leiste Filterjob Suchen können Sie schnell den Job suchen, dem Sie die eingeschränkten Einstellungen hinzufügen möchten.

      Wenn ein Job in der Liste der Jobs links neben ihm das Sperrsymbol Sperrsymbol enthält, wurde er bereits geschützt. Die Einschränkungen eines geschützten Jobs können weiterhin geändert, entfernt oder die Liste der autorisierten Benutzer und Gruppen geändert werden.

      Das Dialogfeld Jobschutz wird angezeigt.


      Beschreibung von job-protection-open.png folgt
      Beschreibung der Abbildung job-protection-open.png

      Wenn ein Job nicht direkt geschützt, sondern stattdessen durch eine Regel geschützt wird, werden in einer Informationsmeldung wie der folgenden die Regeln angezeigt, die den spezifischen Job schützen (in diesem Fall <ExampleRegex05>):
      This job is protected by the following glob pattern rules matching this job name: <ExampleRegex05>
    • Wählen Sie Glob-Muster aus, um eine Zeichenfolge anzugeben, die mit dem Jobnamen abgeglichen wird.

      Dies ist, was Sie sehen würden, wenn noch keine Regeln definiert wurden.


      Beschreibung von job-protection-page-glob-pattern-selected.png folgt
      Beschreibung der Abbildung job-protection-page-glob-pattern-selected.png

      Mit der glob-Syntax kann das Verhalten beim Mustervergleich angegeben werden. Diese Platzhalterzeichen können in Glob-Mustern verwendet werden: *, **, ?, [], {} und \.

      Wählen Sie entweder eine vorhandene Schutzregel aus der Liste aus, oder klicken Sie auf + Regel, um das Dialogfeld Neue Schutzregel anzuzeigen und eine neue zu erstellen.

      Das Dialogfeld "Schutzregel" wird angezeigt.
      Beschreibung von protection-rule-dialog-populated.png folgt
      Beschreibung der Abbildung protection-rule-dialog-populated.png

      Hier haben wir einen Namen (Testregel) und ein glob-Muster (Test*) eingegeben, und wir sind dabei, auf Erstellen zu klicken, um eine neue Jobschutzregel zu erstellen.

  5. Aktivieren Sie das Kontrollkästchen PRIVATE.
    Dies wird angezeigt, nachdem Sie die Option "Privat" für einen Job ausgewählt haben.


    Beschreibung von job-protection-private.png folgt
    Beschreibung der Abbildung job-protection-private.png

    Wenn nur diese Option ausgewählt ist, können nur autorisierte Benutzer und Gruppen die Seite "Jobdetails" anzeigen, den Job bearbeiten oder manuell ausführen. Wenn der Job in einer Pipeline von einem nicht autorisierten Benutzer oder einer nicht autorisierten Gruppe oder von SCM oder einem Timer ausgelöst wird, wird er nicht initiiert.

    Dies wird angezeigt, nachdem Sie die Option "Privat" für eine Schutzregel ausgewählt haben.


    Beschreibung von job-protection-rule-private.png folgt
    Beschreibung der Abbildung job-protection-rule-private.png

  6. Klicken Sie in das Feld Autorisierte Benutzer/Gruppen, um ein Dialogfeld anzuzeigen, in dem die Gruppen und Benutzer des Projekts aufgeführt sind, aus denen Sie auswählen können.

    Unter "Benutzer" wird eine vereinfachte Liste aller Benutzer angezeigt, die Mitglieder der Gruppe(n) sind, sowie der Benutzer, die einzeln hinzugefügt wurden. Beispiel: Die Mitglieder der Entwicklungsgruppe (Clara Coder, Don Developer und Tina Testsuite) werden zusammen mit Alex Admin, der einzeln hinzugefügt wurde, in der Benutzerliste angezeigt. Wählen Sie in der Liste eine oder mehrere Gruppen und/oder Benutzer. Vergessen Sie nicht, sich selbst hinzuzufügen.


    Beschreibung von authorized-groups-and-users.png folgt
    Beschreibung der Abbildung authorisierte Gruppen und users.png

    Dies wird für den Job myProtectedJob angezeigt, nachdem Sie Alex Admin als autorisierten Benutzer ausgewählt haben.


    Beschreibung von job-protection-private-authorized-user.png folgt
    Beschreibung der Abbildung job-protection-private-authorized-user.png

    Dies wird für die Schutzregel "Testregel" angezeigt, nachdem Sie Alex Admin als autorisierten Benutzer ausgewählt haben.


    Beschreibung von job-protection-rule-authorized-user.png folgt
    Beschreibung der Abbildung job-protection-rule-authorized-user.png

  7. Aktivieren Sie die Kontrollkästchen, damit Projektmitglieder private Jobs manuell starten und/oder Commits und Trigger automatisch private Jobs starten können:
    • Aktivieren Sie das Kontrollkästchen Manuelles Starten dieses privaten Jobs durch jedes Projektmitglied und nicht nur durch autorisierte Benutzer zulassen, damit der Job manuell gestartet werden kann.

      Dies wird angezeigt, nachdem Sie das Kontrollkästchen Einem Mitglied des Projekts erlauben, diesen privaten Job manuell zu starten für den Job myProtectedJob aktiviert haben.


      Beschreibung von job-protection-private-both-checkboxes-selected.png folgt
      Beschreibung der Abbildung job-protection-private-both-checkboxes-selected.png

      Wenn Sie das erste Kontrollkästchen aktivieren, aktiviert VB Studio automatisch das zweite Kontrollkästchen, mit dem Commits und Trigger den privaten Job starten und ausgrauen können. Mit dieser Einstellung können nur autorisierte Benutzer und Gruppen die Seite "Jobdetails" anzeigen oder den Job bearbeiten. Jeder Projektmitarbeiter kann den Job jedoch starten und ausführen. Außerdem werden SCM-Commits oder Trigger den Job automatisch starten und ausführen.

      Dies wird angezeigt, nachdem Sie das Kontrollkästchen Einem Mitglied des Projekts erlauben, diesen privaten Job manuell zu starten für die Schutzregel "Testregel" aktiviert haben.


      Beschreibung von job-protection-page-both-check-boxes.png folgt
      Beschreibung der Abbildung job-protection-page-both-check-boxes.png

    • Aktivieren Sie nur das Kontrollkästchen Zulassen, dass Commits und Trigger diesen privaten Job starten können, wenn SCM-Commits und Trigger diesen Job automatisch ausführen können sollen.


      Beschreibung von job-protection-private-allow-commits-and-triggers.png folgt
      Beschreibung der Abbildung job-protection-private-allow-commits-and-triggers.png

      Wenn nur dieses Kontrollkästchen aktiviert ist, werden periodische Trigger jeden Job oder jede Pipeline ausführen, einschließlich privater Jobs, die festgelegt sind, damit Commits und Trigger den privaten Job starten können. Wenn eine Pipeline jedoch einen privaten Job enthält, für den diese Option ausgewählt ist, und ein nicht autorisierter Benutzer versucht, die Pipeline manuell auszuführen, wird der private Job nicht ausgeführt, jedoch werden periodische Trigger und SCM-Commits ausgeführt.

      Lassen Sie das Kontrollkästchen deaktiviert, wenn der Job nicht gestartet werden soll, wenn er von einem SCM-Commit oder -Timer ausgelöst wird.
      Hinweis

      Best Practice:

      Wenn Sie das Kontrollkästchen verwenden, um zu aktivieren, dass der geschützte Build von einem SCM-Commit ausgelöst wird, müssen Sie die Verzweigung schützen, an die der Build-Job gebunden ist. Wenn Sie dies nicht tun, kann jeder den geschützten Build auslösen, indem er einen Commit auslöst, um ihn auszulösen.

      Dies wird angezeigt, wenn Sie für die Testregel die Option Commits und Trigger das Starten von Jobs zulassen, die diesem GLOB-Muster entsprechen ausgewählt haben.


      Beschreibung von job-protection-page-allow-commits-and-triggers.png folgt
      Beschreibung der Abbildung job-protection-page-allow-commits-and-triggers.png

  8. Klicken Sie auf Speichern.

    Der Aktivitätsstream zeigt alle Änderungen am Schutzstatus eines Jobs an, z.B. die Änderung des Jobschutzes von öffentlich in privat oder privat in öffentlich oder die Änderung eines privaten Jobs, um Commits und Trigger zuzulassen.

Sie können sehen, ob ein Job von mehreren Stellen in der VB Studio-Benutzeroberfläche privat ist. Ein privater Job wird durch das Symbol Sperren Schloss gekennzeichnet:

  • In der Jobliste auf der Registerkarte Jobschutz auf der Kachel Builds der Seite Projektadministration rechts neben dem Namen jedes geschützten Jobs.

  • In der Spalte Privat auf der Registerkarte Jobs auf der Seite Builds.

  • In den Jobs, die auf der Registerkarte Pipelines auf der Seite Builds angezeigt werden.

Ein nicht autorisierter Benutzer kann einen privaten Build-Job nicht manuell, über eine Pipeline oder mit einem SCM-/periodischen Trigger ausführen.