Dokumentation AEM as a Cloud Service Benutzerhandbuch

Pipeline-Variablen in Cloud Manager

30. Dezember 2024

Gilt für:
Experience Manager as a Cloud Service

Erstellt für:

Admin
Entwickler

Ihr Build-Prozess basiert möglicherweise auf bestimmten Konfigurationsvariablen, die nicht im Git-Repository gespeichert werden sollen. Oder Sie müssen sie ggf. zwischen Pipeline-Ausführungen in derselben Verzweigung anpassen. Mit Cloud Manager können Sie diese Einstellungen als Pipeline-Variablen verwalten.

Über Pipeline-Variablen

Mithilfe von Cloud Manager können Sie Pipeline-Variablen auf verschiedene Arten konfigurieren.

Verwenden der Cloud Manager-Benutzeroberfläche
Verwenden der Cloud Manager-CLI
Verwenden der Cloud Manager-API

Variablen können entweder als reiner Test oder im Ruhezustand verschlüsselt gespeichert werden. In beiden Fällen werden Variablen innerhalb der Build-Umgebung als Umgebungsvariable bereitgestellt, die dann in der Datei pom.xml oder anderen Build-Skripten referenziert werden kann.

Hinzufügen einer Pipeline-Variablen über Cloud Manager

Pipeline-Variablen können über die Cloud Manager-Benutzeroberfläche konfiguriert und verwaltet werden. Sie helfen beim Optimieren der Pipeline-Verwaltung, insbesondere wenn unterschiedliche Konfigurationen in verschiedenen Schritten erforderlich sind.

Sie müssen über Berechtigungen zum Bearbeiten der Pipeline verfügen, um Pipeline-Variablen hinzufügen, bearbeiten und löschen zu können.

Wenn eine Pipeline ausgeführt wird, wird die Variablenverwaltung blockiert.

So fügen Sie eine Pipeline-Variable über Cloud Manager hinzu:

Klicken Sie beim Verwalten Ihrer Pipelines auf das Symbol der Pipeline, für die Pipeline-Variablen erstellt werden sollen.
Klicken Sie im Dropdown-Menü auf Variablen anzeigen/bearbeiten.
Geben Sie im Dialogfeld Variablenkonfiguration die Details in die erste Zeile der Tabelle ein.
Feld
Beschreibung
Name
Ein eindeutiger Name der Konfigurationsvariablen. Er identifiziert die spezifische Variable, die in der Pipeline verwendet wird, und muss den folgenden Namenskonventionen entsprechen:

Variablen dürfen nur alphanumerische Zeichen und einen Unterstrich (_) enthalten.

Die Namen sollten in Großbuchstaben geschrieben sein.

Pro Pipeline sind maximal 200 Variablen zulässig.

Jeder Name darf maximal 100 Zeichen lang sein.

Jede string-Variable darf höchstens 2047 Zeichen enthalten.

Jede Variable des Typs secretString darf maximal 500 Zeichen enthalten.
Wert
Der Wert, den die Variable enthält.
Angewendeter Schritt
Erforderlich. Der Schritt in der Pipeline, für den die Variable gilt:

Build: Die Variable wird während des Build-Prozesses angewendet.

Funktionsprüfung: Die Variable wird während des Schritts „Funktionsprüfung“ verwendet.

UI-Tests – Die Variable wird während der UI-Testphase verwendet.
Typ
Wählen Sie aus, ob es sich bei der Variablen um reinen Text handelt oder ob sie als geheim verschlüsselt wurde.
Klicken Sie auf Hinzufügen.

Fügen Sie nach Bedarf weitere Variablen hinzu.
Klicken Sie auf Speichern.

Bearbeiten einer Pipeline-Variablen

Klicken Sie bei der Verwaltung Ihrer Pipelinesauf neben der Pipeline, für die Sie Pipeline-Variablen bearbeiten möchten.
Klicken Sie im Dropdown-Menü auf Variablen anzeigen/bearbeiten.
Klicken Sie im Dialogfeld Variablenkonfiguration auf der Variable, die Sie ändern möchten.
Klicken Sie im Dropdown-Menü auf Bearbeiten.
Aktualisieren Sie den Wert der Variablen nach Bedarf.

Nur der Wert der Variablen kann geändert werden.
Führen Sie einen der folgenden Schritte aus:
- Klicken Sie auf , um die Änderung anzuwenden.
- Klicken Sie auf , um die Änderung zurückzusetzen.
Klicken Sie auf Speichern.

Löschen einer Pipeline-Variablen

Klicken Sie bei der Verwaltung Ihrer Pipelinesauf neben der Pipeline, für die Sie Pipeline-Variablen löschen möchten.
Klicken Sie im Dropdown-Menü auf Variablen anzeigen/bearbeiten.
Klicken Sie im Dialogfeld Variablenkonfiguration auf neben der Variable, die Sie entfernen möchten. Klicken Sie anschließend auf Löschen.

Festlegen von Pipeline-Variablen mithilfe der Cloud Manager-Befehlszeilenschnittstelle

Dieser Befehl in der Befehlszeilenschnittstelle legt eine Variable fest.

$ aio cloudmanager:set-pipeline-variables PIPELINEID --variable MY_CUSTOM_VARIABLE test

Dieser Befehl listet Variablen auf.

$ aio cloudmanager:list-pipeline-variables PIPELINEID

Bei Verwendung in einer Maven-Datei pom.xml ist es in der Regel hilfreich, diese Variablen Maven-Eigenschaften mithilfe einer Syntax zuzuordnen, die dem folgenden Beispiel ähnelt:

        <profile>
            <id>cmBuild</id>
            <activation>
                <property>
                    <name>env.CM_BUILD</name>
                </property>
            </activation>
            <properties>
                <my.custom.property>${env.MY_CUSTOM_VARIABLE}</my.custom.property>
            </properties>
        </profile>

recommendation-more-help