Hinzufügen einer produktionsfremden Pipeline configuring-non-production-pipelines

Erfahren Sie, wie Sie mit Cloud Manager produktionsfremde Pipelines erstellen und konfigurieren, um Code bereitzustellen. Wenn Sie sich zunächst einen konzeptionellen Überblick über die Funktionsweise von Pipelines in Cloud Manager verschaffen möchten, finden Sie unter CI/CD-Pipelines entsprechende Informationen.

Überblick overview

Über die Kachel Pipelines in Cloud Manager kann der Bereitstellungs-Manager zwei verschiedene Arten von Pipelines erstellen.

  • Produktions-Pipelines: Eine Produktions-Pipeline ist eine speziell entwickelte Pipeline, die eine Reihe aufeinander abgestimmter Schritte umfasst, um Quell-Code vollständig in die Produktion zu übernehmen.
  • Produktionsfremde Pipelines: Eine produktionsfremde Pipeline dient dazu, Code-Qualitätsprüfungen durchzuführen oder Quell-Code in einer Entwicklungsumgebung bereitzustellen.

Dieses Dokument konzentriert sich auf produktionsfremde Pipelines. Weitere Informationen zur Konfiguration von Produktions-Pipelines finden Sie unter Konfigurieren von Produktions-Pipelines.

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 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.
NOTE
Sie können eine Pipeline erst einrichten, wenn das zugehörige Git-Repository mindestens eine Verzweigung hat und Programm-Setup abgeschlossen ist. Informationen zum Hinzufügen und Verwalten von Repositorys in Cloud Manager finden Sie unter Cloud Manager-Repositorys.

Hinzufügen einer neuen produktionsfremden Pipeline add-non-production-pipeline

Nachdem Sie ein Programm und mindestens eine Umgebung in der Cloud Manager-Benutzeroberfläche eingerichtet haben, können Sie produktionsfremde Pipelines hinzufügen. Verwenden Sie diese Pipelines, um Ihre Code-Qualität zu testen, bevor Sie sie in Produktionsumgebungen bereitstellen.

  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. Öffnen Sie im Cloud Manager-Startbildschirm die Karte Pipelines und klicken Sie auf Hinzufügen und wählen Sie dann Produktionsfremde Pipeline hinzufügen aus.

    Produktionsfremde Pipeline hinzufügen

  3. Wählen Sie auf Registerkarte im Dialogfeld Produktionsfremde Pipeline hinzufügen den zu erstellenden Pipeline-Typ aus:

    • Code-Qualitäts-Pipeline: Erstellt eine Pipeline, die den Code erstellt, Komponententests durchführt und die Code-Qualität auswertet, ohne in einer Umgebung bereitgestellt zu werden.
    • Bereitstellungs-Pipeline: Erstellt eine Pipeline, die den Code erstellt, Komponententests durchführt, die Code-Qualität auswertet und in einer Umgebung implementiert.

    Pipeline-Typ wählen

Code-Qualitäts-Pipeline - Registerkarte „Konfiguration“
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3
Abschnitt Option Beschreibung
Pipeline-Konfiguration Name der produktionsfremden Pipeline Geben Sie im Feld Name der produktionsfremden Pipeline eine Beschreibung für die Pipeline ein.
Testen

Nur beim Bearbeiten einer produktionsfremden Pipeline sichtbar.
Die Benutzeroberfläche zeigt die Testkategorien an, die die Pipeline im Rahmen der Validierung der Code-Qualität ausführt.

  • Statische Code-: Analysiert den Code auf Qualitäts- und Korrektheitsprobleme.
  • Belastungs-/Leistungstests : Evaluiert leistungsbezogenes Verhalten im Rahmen von Pipeline-Tests.
  • Sicherheitstests: Überprüft den Code und die Pipeline-Ausgabe auf sicherheitsbezogene Probleme.
Bereitstellungsoptionen Bereitstellungs-Trigger
  • Manuell: Die Option ermöglicht es Ihnen, die Pipeline manuell zu starten.
  • Bei Git-Änderungen: Diese Option startet die Pipeline, wenn zur konfigurierten Git-Verzweigung bestätigte Änderungen hinzugefügt werden. Damit können Sie die Pipeline bei Bedarf immer noch manuell starten.
Verhalten bei bedeutenden Metrikfehlern
  • Jedes Mal fragen: Dieses Verhalten ist die Standardeinstellung und erfordert ein manuelles Eingreifen bei einem bedeutenden Fehler.
  • Sofort fehlschlagen - Wenn diese Option ausgewählt ist, wird die Pipeline bei einem gravierenden Fehler abgebrochen. Im Wesentlichen wird damit ein Benutzer simuliert, der manuell jeden Fehler ablehnt.
  • Sofort fortfahren - Wenn diese Option ausgewählt ist, wird die Pipeline bei einem wichtigen Fehler automatisch fortgesetzt. Im Wesentlichen wird damit eine Benutzerin oder ein Benutzer simuliert, die bzw. der manuell jeden Fehler genehmigt.
Kontrollkästchen Nach Staging-Bereitstellung genehmigen Nur beim Bearbeiten einer produktionsfremden Pipeline sichtbar.
Wählen Sie diese Option, um nach der Bereitstellung in der Staging-Umgebung eine Genehmigung einzuholen, bevor die Pipeline fortgesetzt werden kann. Wenn diese Option nicht ausgewählt ist, wird die Pipeline basierend auf dem konfigurierten Verhalten fortgesetzt.
Bereitstellungs-Pipeline - Registerkarte „Konfiguration“
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 8-row-3 9-row-3
Abschnitt Option Beschreibung
Pipeline-Konfiguration Name der produktionsfremden Pipeline Geben Sie im Feld Name der produktionsfremden Pipeline eine Beschreibung für die Pipeline ein.
Mögliche Bereitstellungsumgebung Wenn es sich bei Ihrer Pipeline um eine Bereitstellungs-Pipeline handelt, müssen Sie auswählen, in welchen Umgebungen Cloud Manager den Code bereitstellt.
Testen

Nur beim Bearbeiten einer produktionsfremden Pipeline sichtbar.
Die Benutzeroberfläche zeigt die Testkategorien an, die die Pipeline im Rahmen der Validierung der Code-Qualität ausführt.

  • Statische Code-: Analysiert den Code auf Qualitäts- und Korrektheitsprobleme.
  • Belastungs-/Leistungstests : Evaluiert leistungsbezogenes Verhalten im Rahmen von Pipeline-Tests.
  • Sicherheitstests: Überprüft den Code und die Pipeline-Ausgabe auf sicherheitsbezogene Probleme.
Bereitstellungsoptionen Bereitstellungs-Trigger
  • Manuell: Die Option ermöglicht es Ihnen, die Pipeline manuell zu starten.
  • Bei Git-Änderungen: Diese Option startet die Pipeline, wenn zur konfigurierten Git-Verzweigung bestätigte Änderungen hinzugefügt werden. Damit können Sie die Pipeline bei Bedarf immer noch manuell starten.
Verhalten bei bedeutenden Metrikfehlern
  • Jedes Mal fragen - Die Standardeinstellung, bei der der Benutzer aufgefordert wird, zu entscheiden, wie er vorgehen soll, wenn eine wichtige Metrik fehlschlägt.
  • Sofort fehlschlagen: Die Pipeline wird abgebrochen, wenn eine wichtige Metrik fehlschlägt. Damit werden im Grunde Benutzende simuliert, die manuell jeden Fehler ablehnen.
  • Sofort fortfahren: Die Pipeline wird automatisch fortgesetzt, wenn eine wichtige Metrik fehlschlägt. Damit werden im Grunde Benutzende simuliert, die manuell jeden Fehler genehmigen.
Kontrollkästchen Nach Staging-Bereitstellung genehmigen Nur beim Bearbeiten einer produktionsfremden Pipeline sichtbar.
Wählen Sie diese Option, um nach der Bereitstellung in der Staging-Umgebung eine Genehmigung einzuholen, bevor die Pipeline fortgesetzt werden kann. Wenn diese Option nicht ausgewählt ist, wird die Pipeline basierend auf dem konfigurierten Verhalten fortgesetzt.
Kontrollkästchen Änderungen am Load-Balancer​überspringen) Wählen Sie diese Option aus, um zu verhindern, dass die Pipeline während der Bereitstellung Änderungen am Lastenausgleich vornimmt.
Dispatcher-Konfiguration

Die Bereitstellungs-Manager-Rolle kann eine Reihe von Inhaltspfaden konfigurieren, die entweder ungültig gemacht oder aus dem AEM Dispatcher-Cache gelöscht werden, wenn eine Pipeline ausgeführt wird. Cloud Manager führt diese Cache-Aktionen als Teil des Bereitstellungs-Pipeline-Schritts aus, unmittelbar nachdem alle Inhaltspakete bereitgestellt wurden. Diese Einstellungen verwenden das Standardverhalten von AEM Dispatcher. Gehen Sie wie folgt vor, um Dispatcher zu konfigurieren:

  • Geben unter einen Inhaltspfad an, den die Pipeline leeren oder ungültig machen soll.

  • Wählen Sie unter TYPE die Aktion aus, die mit dem Pfad durchgeführt werden soll.

    • Flush: Löschen des Cache-Inhalts unter dem angegebenen Pfad.
    • Invalidieren: Eine Cache-Invalidierung durchführen, ähnlich wie bei der Aktivierung von Inhalten von einer Autoreninstanz auf einer Veröffentlichungsinstanz.
    • Klicken Sie auf Pfad hinzufügen, um den angegebenen Pfad hinzuzufügen. Sie können bis zu 100 Pfade pro Umgebung hinzufügen.
Pipeline Experience Audit-Kontrollkästchen Wählen Sie diese Option aus, um einen Experience Audit-Schritt in die Pipeline aufzunehmen. Nach der Aktivierung umfasst die Pipeline den Experience Audit-Schritt nach der Registerkarte "Source-Code“.
  1. Klicken Sie unten rechts im Dialogfeld Produktionsfremde Pipeline hinzufügen auf Weiter.
  2. Wählen Sie den Code-Typ aus, den die Pipeline erstellen und bereitstellen soll.
Registerkarte "Source-Code“ - Full-Stack-Code

Stellt die gesamte AEM-Anwendung bereit, einschließlich Anwendungs-Code und standardmäßig der Web-Stufen-Konfiguration.

table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3
Abschnitt Option Beschreibung
Source-Code Repository Wählen Sie aus der Dropdown-Liste das Git-Repository aus, das die Pipeline als Quelle verwendet. Cloud Manager erstellt Code aus dem Repository, das Sie hier auswählen.
Git-Verzweigung Wählen Sie aus der Dropdown-Liste die Verzweigung im ausgewählten Repository aus, aus der die Pipeline erstellen soll. Der Standardwert lautet main. Die Pipeline verwendet die ausgewählte Verzweigung als Quelle für die Erstellung und Bereitstellung. Klicken Sie bei Bedarf auf Aktualisieren, um die Liste der verfügbaren Verzweigungen für das ausgewählte Repository zu aktualisieren. Verwenden Sie diese Option, wenn eine kürzlich erstellte Verzweigung nicht in der Liste angezeigt wird.
Strategie erstellen
  • Vollständiger Build: Erstellt jedes Mal alle Module im Repository.
  • BETA Smart Build - Erstellt nur Module, die sich seit dem letzten Commit geändert haben.
    Weitere Informationen Verwenden von Smart Build in einer produktionsfremden Pipeline. Wichtig : Smarter Build ist nur für Code-Qualitäts-Pipelines und Bereitstellungs-Pipelines für Entwicklungs-Full-Stack-Code verfügbar.
Kontrollkästchen Konfiguration der Web-Stufe ignorieren) Wählen Sie diese Option, um die Bereitstellung der Web-Stufen-Konfiguration in einer Full-Stack-Code-Pipeline zu überspringen. Lassen Sie die Option deaktiviert, um die Web-Stufen-Konfiguration zusammen mit dem Code der Pipeline bereitzustellen.
Pipeline Experience Audit-Kontrollkästchen Wählen Sie diese Option aus, um einen Experience Audit-Schritt in die Pipeline aufzunehmen. Nach der Aktivierung umfasst die Pipeline den Experience Audit-Schritt nach der Registerkarte "Source-Code“.
Source-Code - Web-Stufen-Konfiguration

Stellt nur Web-Stufen-Konfigurationen bereit, z. B. Dispatcher-Eigenschaften, die zum Speichern, Verarbeiten und Bereitstellen von Web-Seiten für den Client verwendet werden. Wenn Sie Web-Stufen-Konfiguration auswählen, erstellt Cloud Manager eine Pipeline für die Bereitstellung der Web-Stufen-Konfiguration.

Wenn bereits eine Full-Stack-Pipeline vorhanden ist, zeigt Cloud Manager einen Hinweis an, dass die vorhandene Full-Stack-Pipeline durch das Erstellen einer Web-Stufen-Konfigurations-Pipeline die Web-Stufen-Konfiguration ignoriert. Nachdem Sie die Web-Stufen-Konfigurations-Pipeline erstellt haben, verwaltet Cloud Manager Web-Stufen-Konfigurationsbereitstellungen über diese Pipeline anstelle der Full-Stack-Pipeline.

table 0-row-3 1-row-3 2-row-3 3-row-3
Abschnitt Option Beschreibung
Source-Code Repository Wählen Sie aus der Dropdown-Liste das Git-Repository aus, das die Web-Stufen-Konfiguration enthält.
Git-Verzweigung Wählen Sie die Verzweigung im ausgewählten Repository aus, die Cloud Manager für die Bereitstellung verwendet. Klicken Sie bei Bedarf auf Aktualisieren, um die Liste der verfügbaren Verzweigungen für das ausgewählte Repository zu aktualisieren. Verwenden Sie diese Option, wenn eine kürzlich erstellte Verzweigung nicht in der Liste angezeigt wird.
Code-Speicherort Geben Sie den Pfad in das ausgewählte Repository ein, das die bereitzustellende Web-Stufen-Konfiguration enthält. Der Standardspeicherort ist der Repository-Stamm (/).
  1. Klicken Sie auf Speichern.

Über die Verwendung von Smart Build in einer produktionsfremden Pipeline about-smart-build

Smart Build in Cloud Manager ist eine optimierte Build-Strategie für produktionsfremde Pipelines. Smartes Erstellen reduziert Build-Zeiten, indem Module zwischengespeichert und nur die Module neu erstellt werden, die seit der letzten erfolgreichen Ausführung geändert wurden. Unveränderte Module werden aus dem Cache wiederverwendet, während nur geänderte Module und ihre Abhängigkeiten neu erstellt werden, was die Effizienz für Workflows für die iterative Entwicklung verbessert.

Smart Build ist derzeit nur für Folgendes verfügbar:

  • Code-Qualitäts-Pipelines
  • Entwickeln Sie Full-Stack-Bereitstellungs-Pipelines.
NOTE
Die erste Ausführung nach der Aktivierung von Smart Build verhält sich wie ein vollständiger Build, da der Cache leer ist.

Smartes Erstellen wird empfohlen, wenn Folgendes zutrifft:

  • Sie entwickeln aktiv und nehmen häufige inkrementelle Änderungen vor.
  • Ihr Projekt enthält mehrere Maven-Module.
  • Vollständige Builds beanspruchen viel Zeit.

Smartes Erstellen ist nicht immer ideal, wenn Folgendes zutrifft:

  • Ihr Build beruht in hohem Maße auf Plug-ins, die Vorgänge außerhalb des Abhängigkeitsdiagramms von Maven durchführen.
  • Sie benötigen bei jeder Ausführung eine vollständige Neuaufbauvalidierung.

Grundlegendes zur Build-Leistung smart-build-performance

Der Leistungsgewinn durch die Verwendung von Smart Build hängt von mehreren Faktoren ab, darunter den folgenden:

  • Die Anzahl der Module im Projekt.
  • Häufigkeit und Umfang von Code-Änderungen.
  • Die Verteilung von Abhängigkeiten über Module hinweg.

Im Allgemeinen können Projekte mit vielen unabhängigen Modulen die größte Verbesserung verzeichnen.

Opt-out aus dem Cache pro Modul smart-build-cache-optout

Smart Build bietet eine differenzierte Steuerung, mit der Sie das Caching für bestimmte Module deaktivieren können. Diese Funktion ist nützlich, wenn bestimmte Module:

  • Verwenden Sie Plug-ins wie exec-maven-plugin oder maven-antrun-plugin.
  • Führen Sie Dateivorgänge aus, die nicht von Maven-Abhängigkeiten verfolgt werden.
  • Erzeugt im Cache inkonsistente Ergebnisse.

Deaktivieren der Zwischenspeicherung für ein Modul smart-build-disable-caching

Sie können die folgende Eigenschaft zum pom.xml des betroffenen Moduls hinzufügen:

<properties>
  <maven.build.cache.enabled>false</maven.build.cache.enabled>
</properties>

Diese Syntax zwingt das Modul bei jeder Pipeline-Ausführung neu zu erstellen, während andere Module weiterhin vom Caching profitieren.

Einschränkungen und Überlegungen bei der Verwendung von Smart Build smart-build-limitations

Beachten Sie bei der Verwendung von Smart Build Folgendes:

  • Smarter Build beruht auf Maven-Abhängigkeitsanalyse.
  • Bei Änderungen außerhalb des Abhängigkeitsdiagramms werden Trigger-Neuaufbauten möglicherweise nicht unterstützt.
  • Einige Plug-ins sind möglicherweise nicht vollständig mit der Zwischenspeicherung kompatibel.
  • Sie können jederzeit wieder zu Vollständiger Build wechseln, indem Sie die produktionsfremde Pipeline bearbeiten.

Wenn Sie auf unerwartetes Build-Verhalten stoßen, sollten Sie das Caching für bestimmte Module deaktivieren oder Ihre Build-Strategie vorübergehend auf Vollständiger Build umstellen.

Fehlerbehebung bei Problemen mit Smart Build smart-build-troubleshoot

Problem
Lösungsvorschläge
Buildergebnisse sind inkonsistent
・ Deaktivierung der Zwischenspeicherung für betroffene Module.
・ Überprüfen des Plug-in-Verhaltens (insbesondere exec/antrun-Plug-ins).
Keine Leistungsverbesserung
・ Stellen Sie sicher, dass mehrere Durchgänge stattgefunden haben (Aufwärmen des Cache).
・ Prüfen Sie, ob die meisten Module häufig wechseln.
Unerwartete Artefakte oder fehlende Änderungen
・ Überprüfen, ob Änderungen außerhalb des Maven-Abhängigkeits-Trackings liegen
・ Verwenden Sie Vollständiger Build zur Überprüfung.

Siehe Hinzufügen einer produktionsfremden Pipeline Aktivieren von Smart Build.

Die nächsten Schritte the-next-steps

Nachdem Sie die Pipeline konfiguriert haben, können Sie Ihren Code bereitstellen. Weitere Informationen finden Sie unter Bereitstellung von Code.

Video-Tutorial video-tutorial

In diesem Video erhalten Sie einen Überblick über den Pipeline-Erstellungsprozess, der in diesem Dokument beschrieben wird.

recommendation-more-help
experience-manager-cloud-manager-help-main-toc