Die Build-Umgebung

Erfahren Sie mehr über die spezielle Build-Umgebung, die Cloud Manager-Benutzer zum Erstellen und Testen Ihres Codes verwenden.

Umgebungsdetails

Die Build-Umgebungen von Cloud Manager weisen die folgenden Attribute auf.

• Die Erstellungsumgebung ist Linux-basiert und von Ubuntu 18.04 abgeleitet.
• Apache Maven 3.6.0 ist installiert.
• Die installierten Java-Versionen sind Oracle JDK 8u202 und Oracle JDK 11.0.2.
• Standardmäßig wird die Umgebungsvariable JAVA_HOME auf /usr/lib/jvm/jdk1.8.0_202 festgelegt, was Oracle JDK 8u202 enthält. Weitere Einzelheiten finden Sie im Abschnitt Alternative JDK-Version für die Maven-Ausführung.
• Es sind einige zusätzliche erforderliche Systempakete installiert.
  • bzip2
  • unzip
  • libpng
  • imagemagick
  • graphicsmagick
• Andere Pakete können zur Build-Zeit installiert werden, wie im Abschnitt Installieren zusätzlicher Systempakete beschrieben.
• Jeder Build wird in einer unberührten Umgebung erstellt. Der Build-Container speichert zwischen den Ausführungen keinen Status.
• Maven wird immer mit den folgenden drei Befehlen ausgeführt:
  • mvn --batch-mode org.apache.maven.plugins:maven-dependency-plugin:3.1.2:resolve-plugins
  • mvn --batch-mode org.apache.maven.plugins:maven-clean-plugin:3.1.0:clean -Dmaven.clean.failOnError=false
  • mvn --batch-mode org.jacoco:jacoco-maven-plugin:prepare-agent package
• Maven wird auf Systemebene mit einer settings.xml-Datei konfiguriert die automatisch das öffentliche Adobe-Artefakt-Repository enthält und ein Profil namens adobe-public verwendet.
  • Weitere Informationen dazu finden Sie im öffentlichen Adobe Maven Repository.

Verwenden einer bestimmten Java-Version

Standardmäßig werden Projekte vom Cloud Manager-Build-Prozess mit dem Oracle 8 JDK erstellt. Kunden, die ein alternatives JDK verwenden möchten, haben zwei Optionen.

• Maven Toolchains
• Auswahl einer alternativen JDK-Version für den gesamten Maven-Ausführungsprozess

Maven Toolchains

Das Maven Toolchains-Plug-in ermöglicht es Projekten, ein bestimmtes JDK (oder Toolchain) auszuwählen, das im Kontext von Toolchain-fähigen Maven-Plug-ins verwendet werden soll. Dies geschieht in der pom.xml-Datei des Projekts, indem ein Anbieter und ein Versionswert angegeben werden. Ein Beispielabschnitt in der Datei pom.xml ist:

        <plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-toolchains-plugin</artifactId>
    <version>1.1</version>
    <executions>
        <execution>
            <goals>
                <goal>toolchain</goal>
            </goals>
        </execution>
    </executions>
    <configuration>
        <toolchains>
            <jdk>
                <version>11</version>
                <vendor>oracle</vendor>
            </jdk>
        </toolchains>
    </configuration>
</plugin>

Dies führt dazu, dass alle Toolchain-fähigen Maven-Plug-ins das Oracle JDK, Version 11 verwenden.

Bei Verwendung dieser Methode wird Maven selbst weiterhin mit dem standardmäßigen JDK (Oracle 8) ausgeführt und die JAVA_HOME-Umgebungsvariable wird nicht geändert. Daher funktioniert das Überprüfen oder Erzwingen der Java-Version über Plug-ins wie das Apache Maven Enforcer-Plug-in nicht und solche Plug-ins dürfen nicht verwendet werden.

Die derzeit verfügbaren Anbieter-/Versionskombinationen sind:

Alternative JDK-Version für die Maven-Ausführung

Es ist auch möglich, Oracle 8 oder Oracle 11 als JDK für die gesamte Maven-Ausführung auszuwählen. Im Gegensatz zu den Toolchain-Optionen ändert dies das für alle Plug-ins verwendete JDK, es sei denn, die Toolchain-Konfiguration ist ebenfalls festgelegt. In diesem Fall wird die Toolchain-Konfiguration weiterhin für Toolchain-fähige Maven-Plug-ins angewendet. Daher funktioniert in diesem Fall das Überprüfen und Erzwingen der Java-Version mit dem Apache Maven Enforcer-Plug-in.

Erstellen Sie dazu eine Datei mit dem Namen .cloudmanager/java-version in der von der Pipeline verwendeten Git-Repository-Verzweigung. Diese Datei kann entweder den Inhalt 11 oder 8 enthalten. Alle anderen Werte werden ignoriert. Wenn 11 angegeben ist, wird Oracle 11 verwendet und die Umgebungsvariable JAVA_HOME wird auf /usr/lib/jvm/jdk-11.0.2 festgelegt. Wenn 8 angegeben ist, wird Oracle 8 verwendet und die Umgebungsvariable JAVA_HOME wird auf /usr/lib/jvm/jdk1.8.0_202 festgelegt.

Umgebungsvariablen

Standard-Umgebungsvariablen

In einigen Fällen muss der Build-Prozess je nach Informationen zum Programm oder zur Pipeline variiert werden.

Wenn beispielsweise eine JavaScript-Minimierung während der Build-Erstellung mithilfe eines Tools wie gulp durchgeführt wird, soll beim Erstellen für eine Entwicklungsumgebung möglicherweise eine andere Minimierungsstufe verwendet werden als beim Erstellen für eine Staging- oder Produktionsumgebung.

Um dies zu unterstützen, fügt Cloud Manager diese Standard-Umgebungsvariablen bei jeder Ausführung dem Build-Container hinzu.

Verfügbarkeit von Standard-Umgebungsvariablen

Standard-Umgebungsvariablen können an verschiedenen Stellen verwendet werden.

Authoring, Vorschau und Veröffentlichung

Sowohl reguläre Umgebungsvariablen als auch Geheimnisse können in der Authoring-, Vorschau- und Veröffentlichungsumgebung verwendet werden.

Dispatcher

Nur reguläre Umgebungsvariablen können mit dem Dispatcher verwendet werden. Geheimnisse können nicht verwendet werden.

Allerdings können Umgebungsvariablen nicht in IfDefine-Richtlinien verwendet werden.

OSGi-Konfigurationen

Sowohl reguläre Umgebungsvariablen als auch Geheimnisse können in OSGi-Konfigurationen verwendet werden.

Pipeline-Variablen

In einigen Fällen kann der Build-Prozess von bestimmten Konfigurationsvariablen abhängen, die nicht im Git-Repository platziert werden können oder zwischen Pipeline-Ausführungen mit derselben Verzweigung variieren müssen.

Cloud Manager ermöglicht die Konfiguration dieser Variablen über die Cloud Manager-API oder die Cloud Manager-CLI individuell für die Pipelines. Variablen können entweder als reiner Test oder mit Data-at-Rest-Verschlüsselung gespeichert werden. In beiden Fällen werden Variablen innerhalb der Build-Umgebung als Umgebungsvariable bereitgestellt, die in der pom.xml-Datei oder anderen Build-Skripten referenziert werden kann.

Um eine Variable mithilfe der CLI festzulegen, führen Sie einen Befehl ähnlich dem folgenden aus.

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

Aktuelle Variablen können mit einem Befehl ähnlich dem folgenden aufgelistet werden.

$ aio cloudmanager:list-pipeline-variables PIPELINEID

Variablen müssen bestimmte Einschränkungen einhalten.

• Variablen dürfen nur alphanumerische Zeichen und den Unterstrich (_) enthalten.
  • Der Konvention nach sollten die Namen in Großbuchstaben geschrieben werden.
• Pro Pipeline sind maximal 200 Variablen zulässig.
• Jeder Name darf höchstens 99 Zeichen enthalten.
• Jeder Zeichenfolgenwert darf höchstens 2047 Zeichen enthalten.
• Jeder secretString-Wert darf höchstens 499 Zeichen enthalten.

Bei Verwendung in einer Maven-pom.xml-Datei ist es in der Regel hilfreich, diese Variablen Maven-Eigenschaften mithilfe einer ähnlichen Syntax wie der folgenden zuzuordnen.

        <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>

Installieren zusätzlicher Systempakete

Um vollständig zu funktionieren, benötigen einige Builds zusätzliche Systempakete, die installiert werden müssen. So ist es z. B. möglich, dass ein Build ein Python- oder Ruby-Skript aufruft, wofür der entsprechende Sprach-Interpreter installiert sein muss. Dies kann durch Abfrage von exec-maven-plugin erfolgen, wodurch APT aufgerufen wird. Diese Ausführung sollte im Allgemeinen in einem Cloud Manager-spezifischen Maven-Profil eingeschlossen sein. So installieren Sie beispielsweise Python:

        <profile>
            <id>install-python</id>
            <activation>
                <property>
                        <name>env.CM_BUILD</name>
                </property>
            </activation>
            <build>
                <plugins>
                    <plugin>
                        <groupId>org.codehaus.mojo</groupId>
                        <artifactId>exec-maven-plugin</artifactId>
                        <version>1.6.0</version>
                        <executions>
                            <execution>
                                <id>apt-get-update</id>
                                <phase>validate</phase>
                                <goals>
                                    <goal>exec</goal>
                                </goals>
                                <configuration>
                                    <executable>apt-get</executable>
                                    <arguments>
                                        <argument>update</argument>
                                    </arguments>
                                </configuration>
                            </execution>
                            <execution>
                                <id>install-python</id>
                                <phase>validate</phase>
                                <goals>
                                    <goal>exec</goal>
                                </goals>
                                <configuration>
                                    <executable>apt-get</executable>
                                    <arguments>
                                        <argument>install</argument>
                                        <argument>-y</argument>
                                        <argument>--no-install-recommends</argument>
                                        <argument>python</argument>
                                    </arguments>
                                </configuration>
                            </execution>
                        </executions>
                    </plugin>
                </plugins>
            </build>
        </profile>

Mit derselben Methode können Sie auch sprachspezifische Pakete installieren, d. h. mit gem für RubyGems oder mit pip für Python-Pakete.

Ressourcen für Business.Adobe.com