組建環境

上次更新: 2023-11-20
  • 建立對象:
  • Admin

了解 Cloud Manager 使用者用於建置和測試程式碼的專用組建環境。

環境詳細資訊

Cloud Manager 的組建環境有下列屬性。

  • 組建環境以 Linux 為基礎,衍生自 Ubuntu 18.04。
  • 已安裝 Apache Maven 3.8.8。
  • 已安裝的 Java 版本為 Oracle JDK 8u371 和 Oracle JDK 11.0.20。
    • /usr/lib/jvm/jdk1.8.0_371
    • /usr/lib/jvm/jdk-11.0.20
  • 預設的情況下,JAVA_HOME 環境變數設為 /usr/lib/jvm/jdk1.8.0_371,其中包含 Oracle JDK 8u371。如需更多詳細資訊,請參閱備用的 Maven 執行 JDK 版本 區段。
  • 安裝了一些必要的附加系統套件。
    • bzip2
    • unzip
    • libpng
    • imagemagick
    • graphicsmagick
  • 在建置時間可安裝其他套件,如安裝附加系統套件區段中所述。
  • 每個組建都是在原始環境中完成的。組建容器在執行之間不保留任何狀態。
  • 一直使用下列三個命令執行 Maven:
    • 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
  • 透過 settings.xml 檔案在系統層級設定 Maven,這會利用名為 adobe-public 的設定檔自動納入公共 Adobe 成品存放庫。
注意

雖然 Cloud Manager 並未定義 jacoco-maven-plugin 的特定版本,但使用的版本必須至少為 0.7.5.201505241946

秘訣

請參閱以下更多資源,以了解如何使用 Cloud Manager API:

使用特定 Java 版本

預設情況下,專案會由 Cloud Manager 建置流程使用 Oracle 8 JDK 來建置。希望使用備用 JDK 的客戶有兩種選擇。

Maven 工具鏈

Maven 工具鏈外掛程式讓專案可選取特定 JDK (或工具鏈),以用於工具鏈感知的 Maven 外掛程式內容中。這可透過指定廠商和版本值,在專案的 pom.xml 檔案中完成。在 pom.xml 檔案中的範例區段為:

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

這將導致所有工具鏈感知的 Maven 外掛程式使用 Oracle JDK 版本 11。

使用此方法時,Maven 本身仍使用預設的 JDK (Oracle 8) 執行,並且 JAVA_HOME 環境變數未受到變更。因此,透過 Apache Maven 強制器外掛程式之類的外掛程式來檢查或強制執行 Java 版本並不可行,且不得使用這類外掛程式。

目前可提供的廠商/版本組合為:

廠商 版本
Oracle 1.8
Oracle 1.11
Oracle 11
太陽 1.8
太陽 1.11
太陽 11
注意

從 2022 年 4 月開始,Oracle JDK 將成為 AEM 應用程式開發和操作的預設 JDK。Cloud Manager 的建置流程將自動切換成使用 Oracle JDK,即使在 Maven 工具鏈中明確選取了替代選項。如需進一步詳細資訊,請參閱四月發行說明

備用 Maven 執行 JDK 版本

也可以選取 Oracle 8 或 Oracle 11 作為整個 Maven 執行的 JDK。和工具鏈選項不同,這會變更用於所有外掛程式的 JDK,除非還設定了工具鏈設定,若是這種情況,則工具鏈設定仍適用於工具鏈感知的 Maven 外掛程式。結果,利用 Apache Maven 強制器外掛程式來檢查和強制執行 Java 版本將變得可行。

為此,可在管道使用的 Git 存放庫分支中建立名為 .cloudmanager/java-version 的檔案。本檔案可能有的內容為 118。任何其他值會受到忽略。若指定 11,會使用 Oracle 11,而 JAVA_HOME 環境變數會設為 /usr/lib/jvm/jdk-11.0.2。若指定 8,會使用 Oracle 8,而 JAVA_HOME 環境變數會設為 /usr/lib/jvm/jdk1.8.0_202

環境變數

標準環境變數

在部分情況下,您可能會發現有必要根據有關方案或管道的資訊來改變建置流程。

例如,如果透過 gulp 之類的工具完成建置時間 JavaScript 縮製,則在為開發環境建置而不是為中繼和生產環境建置時,可能希望使用不同的縮製等級。

為了支援這一點,Clo​​ud Manager 會在每次執行時將標準環境變數新增到組建容器中。

變數名稱 說明
CM_BUILD 需永遠設為 true
BRANCH 為執行設定的分支
CM_PIPELINE_ID 數值的管道識別碼
CM_PIPELINE_NAME 管道名稱
CM_PROGRAM_ID 數值的方案識別碼
CM_PROGRAM_NAME 方案名稱
ARTIFACTS_VERSION 對於中繼或生產管道,由 Cloud Manager 產生的綜合版本

標準環境變數可用性

標準環境變數可以用在很多地方。

創作、預覽和發佈

一般環境變數和密碼均可用於編寫、預覽和發佈環境。

Dispatcher

Dispatcher 只能使用一般環境變數。不能使用密碼。

但是環境變數不能在 IfDefine 指令中使用。

秘訣

在部署之前,您應該透過 本機 Dispatcher 驗證您對環境變數的使用。

OSGi 設定

一般環境變數和密碼都可以在 OSGi 設定中使用。

管道變數

在某些情況下,您的建置流程可能會依據特定的設定變數而定,這些變數不適合放入 Git 存放庫中,或者在使用同一分支的管道執行之間需要有所變化。

Cloud Manager 讓這些變數能夠經由 Cloud Manager API 或 Cloud Manager CLI 依據每個管道來設定。變數可能以純文字或加密待用的方式儲存。在任何一種情況下,都可在組建環境中以環境變數的形式取得,然後可以從 pom.xml 檔案或其他建置指令碼中加以引用。

若要使用 CLI 設定變數,請執行類似下列的命令。

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

可以使用類似下列的命令提供目前的變數清單。

$ aio cloudmanager:list-pipeline-variables PIPELINEID

變數必須遵守某些限制。

  • 變數名稱只能包含字母數字構成的字元和底線 (_)。
    • 按照慣例,上述名稱應全部大寫。
  • 每個管道限制為 200 個變數。
  • 每個名稱的長度都必須少於 100 個字元。
  • 每個字串值都必須少於 2048 個字元。
  • 每個 secretString 值都必須少於和等於 500 個字元。

在 Maven pom.xml 檔案中使用時,使用類似下列的語法將這些變數對應到 Maven 屬性通常會有幫助。

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

安裝附加系統套件

為了充分發揮作用,部分組建需要安裝附加系統套件。例如,組建可能會叫用 Python 或 Ruby 指令碼,因此需要安裝適當的語言解譯器。這可透過呼叫 exec-maven-plugin 以叫用 APT 來完成。這項執行通常應包裝在 Cloud Manager 特定的 Maven 設定檔中。例如,若要安裝 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>

此同一技術可用於安裝特定語言的套件,也就是將 gem 用於 RubyGems 或將 pip 用於 Python 套件。

注意

以這種方式安裝系統套件不會將其安裝在用於執行 Adobe​ Experience Manager 的執行階段環境中。如果您需要在 AEM 環境中安裝系統套件,請和您的 Adob​​e 代表聯絡。

此頁面上的