Konfigurieren von produktionsfremden Pipelines

Letzte Aktualisierung: 2023-11-18

Erfahren Sie, wie Sie produktionsfremde Pipelines so konfigurieren, dass die Qualität des Codes vor seiner Bereitstellung in Produktionsumgebungen getestet wird.

Ein Benutzer muss über die Bereitstellungsmanager Rolle zum Konfigurieren von Nicht-Produktions-Pipelines.

Produktionsfremde Pipelines

Zusätzlich zu Produktions-Pipelines, die in Staging- und Produktionsumgebungen bereitstellen, können Sie auch produktionsfremde Pipelines zur Validierung Ihres Codes einrichten.

Es gibt zwei Arten von produktionsfremden Pipelines:

  • Code-Qualitäts-Pipelines: Diese Pipelines führen Code-Qualitätsprüfungen für den Code in einer Git-Verzweigung durch und sie führen die Build- und Code-Qualitätsschritte aus.
  • Bereitstellungs-Pipelines: Diese Pipelines führen nicht nur wie die Code-Qualitäts-Pipelines die Build- und Code-Qualitätsschritte aus, sondern stellen den Code auch in einer produktionsfremden Umgebung bereit.
HINWEIS

Nach der Ersteinrichtung können Sie Pipeline-Einstellungen bearbeiten.

Hinzufügen einer neuen produktionsfremden Pipeline

Sobald Sie mit der Benutzeroberfläche von Cloud Manager Ihr Programm eingerichtet und mindestens eine Umgebung haben, können Sie eine produktionsfremde Pipeline hinzufügen, indem Sie die folgenden Schritte ausführen.

  1. Melden Sie sich unter my.cloudmanager.adobe.com bei Cloud Manager an und wählen Sie die entsprechende Organisation und das entsprechende Programm aus.

  2. Rufen Sie die Karte Pipelines über den Startbildschirm von Cloud Manager auf. Klicken Sie auf +Hinzufügen und wählen Sie Produktionsfremde Pipeline hinzufügen aus.

    Produktionsfremde Pipeline hinzufügen

  3. Wählen Sie im Dialogfeld Hinzufügen einer produktionsfremden Pipeline auf der Registerkarte Konfiguration den Typ der produktionsfremden Pipeline aus, die Sie hinzufügen möchten.

    • Code-Qualitäts-Pipeline – Erstellen Sie eine Pipeline, die Ihren Code erstellt, Komponententests durchführt und die Code-Qualität auswertet, aber NICHT implementiert.
    • Implementierungs-Pipeline – Erstellen Sie eine Pipeline, die Ihren Code erstellt, Komponententests durchführt, die Code-Qualität auswertet und in einer Umgebung implementiert.

    Dialogfeld „Produktionsfremde Pipeline hinzufügen“

  4. Geben Sie einen Namen für die produktionsfremde Pipeline an, um Ihre Pipeline zu identifizieren, sowie die folgenden zusätzlichen Informationen.

    • Bereitstellungsauslöser: Beim Definieren der Bereitstellungsauslöser für den Start der Pipeline haben Sie die folgenden Optionen.

      • Manuell: Verwenden Sie diese Option, um die Pipeline manuell zu starten.
      • Bei Git-Änderungen: Diese Option startet die CI/CD-Pipeline, wenn zur konfigurierten Git-Verzweigung bestätigte Änderungen hinzugefügt werden. Mit dieser Option können Sie die Pipeline bei Bedarf immer noch manuell starten.
  5. Wenn Sie eine Bereitstellungs-Pipeline erstellen möchten, müssen Sie auch das Verhalten bei bedeutenden Metrikfehlern definieren.

    • Jedes Mal fragen: Dieses Verhalten ist die Standardeinstellung und erfordert ein manuelles Eingreifen bei einem bedeutenden Fehler.
    • Sofortiger Ausfall: Wenn diese Option ausgewählt ist, wird die Pipeline bei einem bedeutenden Fehler abgebrochen. Damit werden im Grunde Benutzende simuliert, die manuell jeden Fehler ablehnen.
    • Sofort fortfahren: Wenn diese Option ausgewählt ist, wird die Pipeline bei einem bedeutenden Fehler automatisch fortgesetzt. Damit werden im Grunde Benutzende simuliert, die manuell jeden Fehler genehmigen.
  6. Klicken Sie auf Weiter.

  7. Auf der Registerkarte Quell-Code im Dialogfeld Produktionsfremde Pipeline hinzufügen müssen Sie auswählen, welche Art von Code die Pipeline verarbeiten soll.

Siehe CI/CD Pipelines für weitere Informationen zu den Pipelinetypen.

Die Schritte zum Erstellen Ihrer produktionsfremden Pipeline variieren je nach ausgewähltem Quellcode. Folgen Sie den oben stehenden Links, um zum nächsten Abschnitt dieses Dokuments zu springen und die Konfiguration Ihrer Pipeline abzuschließen.

Full-Stack-Code

Eine Pipeline mit Full-Stack-Code stellt gleichzeitig Backend- und Frontend-Code-Builds bereit, die ein oder mehrere AEM-Server-Programme zusammen mit der HTTPD-/Dispatcher-Konfiguration enthalten.

HINWEIS

Wenn für die ausgewählte Umgebung bereits eine Pipeline mit Full-Stack-Code vorhanden ist, wird diese Auswahl deaktiviert.

Führen Sie die folgenden Schritte aus, um die Konfiguration der produktionsfremden Full-Stack-Code-Pipeline abzuschließen.

  1. In der Registerkarte Quell-Code müssen Sie die folgenden Optionen definieren.

    • Berechtigte Bereitstellungsumgebungen: Wenn es sich bei Ihrer Pipeline um eine Bereitstellungs-Pipeline handelt, müssen Sie auswählen, in welche Umgebungen sie bereitstellen soll.
    • Repository: Diese Option legt fest, aus welchem Git-Repository die Pipeline den Code abrufen soll.
    TIPP

    Weitere Informationen dazu, wie Sie Repositorys in Cloud Manager hinzufügen und verwalten, finden Sie unter Hinzufügen und Verwalten von Repositorys.

    • Git-Verzweigung: Mit dieser Option wird festgelegt, von welcher Verzweigung in der ausgewählten Pipeline der Code abgerufen werden soll.

      • Geben Sie die ersten Zeichen des Verzweigungsnamens und die Funktion zur automatischen Vervollständigung dieses Felds ein. Dies hilft Ihnen, die entsprechenden auswählbaren Verzweigungen zu suchen.
    • Konfiguration der Web-Stufe ignorieren: Wenn diese Option aktiviert ist, stellt die Pipeline Ihre Web-Stufenkonfiguration nicht bereit.

    • Pipeline: Wenn es sich bei Ihrer Pipeline um eine Bereitstellungs-Pipeline handelt, können Sie eine Testphase ausführen. Aktivieren Sie die Optionen, die Sie in dieser Phase aktivieren möchten. Wenn keine der Optionen ausgewählt ist, wird die Testphase während der Pipeline-Ausführung nicht angezeigt.

    Full-Stack-Pipeline

  2. Klicken Sie auf Speichern.

Die Pipeline wird gespeichert und auf der Karte Pipelines auf der Seite Programmübersicht können Sie jetzt Pipelines verwalten.

Zielgerichtete Implementierung

Bei einer zielgerichteten Bereitstellung wird Code nur für ausgewählte Teile Ihrer AEM bereitgestellt. In einer solchen Bereitstellung können Sie auswählen, Einschließen einen der folgenden Code-Typen:

  • Konfiguration - Konfigurieren Sie Einstellungen für Ihre AEM-Umgebung, Wartungsaufgaben, CDN-Regeln und mehr.
  • Frontend-Code - Konfigurieren Sie JavaScript und CSS für das Frontend Ihrer AEM.
    • Mit Frontend-Pipelines erhalten Frontend-Entwicklern mehr Unabhängigkeit und der Entwicklungsprozess kann beschleunigt werden.
    • Weitere Informationen dazu, wie dieser Prozess abläuft und was dabei zu beachten ist, um das volle Potenzial dieses Prozesses auszuschöpfen, finden Sie im Dokument Entwickeln von Sites mit der Frontend-Pipeline.
  • Web-Ebene-Konfiguration - Konfigurieren Sie die Dispatcher-Eigenschaften zum Speichern, Verarbeiten und Bereitstellen von Webseiten für den Client.
HINWEIS
  • Wenn für die ausgewählte Umgebung bereits eine Web-Stufen-Code-Pipeline vorhanden ist, wird diese Auswahl deaktiviert.
  • Wenn Sie über eine vorhandene Full-Stack-Pipeline verfügen, die in einer Umgebung bereitgestellt wird, wird beim Erstellen einer Web-Stufen-Konfigurations-Pipeline für dieselbe Umgebung die vorhandene Web-Stufen-Konfiguration in der Full-Stack-Pipeline ignoriert.
  • Es kann immer nur eine Konfigurationspipeline pro Umgebung geben.

Die Schritte zum Erstellen Ihrer nicht produktionsbezogenen, zielgerichteten Implementierungs-Pipeline sind dieselben, wenn Sie einen Bereitstellungstyp auswählen.

  1. Wählen Sie den benötigten Bereitstellungstyp aus.

Zielgerichtete Bereitstellungsoptionen

  1. Definieren Sie die Förderfähige Bereitstellungsumgebungen.

    • Wenn es sich bei Ihrer Pipeline um eine Bereitstellungs-Pipeline handelt, müssen Sie auswählen, in welchen Umgebungen sie bereitgestellt werden soll.
  2. under Quellcode, definieren Sie die folgenden Optionen:

    • Repository: Diese Option legt fest, aus welchem Git-Repository die Pipeline den Code abrufen soll.
    TIPP

    Weitere Informationen dazu, wie Sie Repositorys in Cloud Manager hinzufügen und verwalten, finden Sie unter Hinzufügen und Verwalten von Repositorys.

    • Git-Verzweigung: Mit dieser Option wird festgelegt, von welcher Verzweigung in der ausgewählten Pipeline der Code abgerufen werden soll.
      • Geben Sie die ersten Zeichen des Verzweigungsnamens und die Funktion zur automatischen Vervollständigung dieses Felds ein. Es werden die entsprechenden auswählbaren Verzweigungen gesucht.
    • Speicherort des Codes: Mit dieser Option wird der Pfad in der Verzweigung des ausgewählten Repositorys festgelegt, aus dem die Pipeline den Code abrufen soll.

    Config-Pipeline

  3. Klicken Sie auf Speichern.

Die Pipeline wird gespeichert und auf der Karte Pipelines auf der Seite Programmübersicht können Sie jetzt Pipelines verwalten.

Beim Ausführen einer zielgerichteten Bereitstellungs-Pipeline Konfigurationen wie WAF-Konfigurationen wird bereitgestellt, sofern sie in der Umgebung, im Repository und in der Verzweigung gespeichert werden, die Sie in der Pipeline definiert haben.

Überspringen von Dispatcher-Paketen

Wenn Sie möchten, dass Dispatcher-Pakete als Teil Ihrer Pipeline erstellt werden, sie aber nicht im Build-Speicher veröffentlicht werden sollen, können Sie die Veröffentlichung deaktivieren, was die Laufzeit der Pipeline verkürzen kann.

Die folgende Konfiguration zum Deaktivieren von Veröffentlichungs-Dispatcher-Paketen muss über die pom.xml-Datei Ihres Projekts hinzugefügt werden. Sie basiert auf einer Umgebungsvariablen, die als Markierung dient, welche Sie im Cloud Manager-Build-Container festlegen können, um zu definieren, wann Dispatcher-Pakete ignoriert werden sollen.

<profile>
  <id>only-include-dispatcher-when-it-isnt-ignored</id>
  <activation>
    <property>
      <name>env.IGNORE_DISPATCHER_PACKAGES</name>
      <value>!true</value>
    </property>
  </activation>
  <modules>
    <module>dispatcher</module>
  </modules>
</profile>

Auf dieser Seite