Projektinställningar

Lär dig hur AEM byggs med Maven och de standarder du måste följa när du skapar ditt eget projekt.

Information om projektinställningar

För att byggas och driftsättas med Cloud Manager måste AEM följa dessa riktlinjer:

• Projekt måste byggas med Apache Maven.
• Det måste finnas en pom.xml -filen i Git-databasens rot. Detta pom.xml filen kan referera till så många undermoduler (som i sin tur kan ha andra undermoduler osv.) vid behov.
• Du kan lägga till referenser till ytterligare Maven-artefaktdatabaser i dina pom.xml filer.
  • Åtkomst till lösenordsskyddade artefaktarkiv stöds vid konfigurering. Åtkomst till nätverksskyddade artefaktdatabaser stöds dock inte.
• Distribuerbara innehållspaket identifieras genom sökning efter innehållspaket .zip filer som finns i en katalog med namnet target.
  • Ett valfritt antal undermoduler kan producera innehållspaket.
• Distribuerbara dispatcherartefakter upptäcks vid sökning efter .zip filer (finns även i katalogen med namnet target), som har kataloger med namn conf och conf.d.
• Om det finns mer än ett innehållspaket är det inte säkert att paketdistributioner ordnas.
  • Om en viss ordning behövs kan innehållspaketets beroenden användas för att definiera ordningen.
• Paket kan vara överhoppad under driftsättningen.

Aktivera Maven-profiler i Cloud Manager

I vissa begränsade fall kan du behöva ändra din byggprocess något när du kör i Cloud Manager i stället för när du kör på arbetsstationer för utvecklare. I dessa fall Maven profiles kan användas för att definiera hur bygget ska vara olika i olika miljöer, inklusive Cloud Manager.

Aktivering av en Maven-profil i Cloud Manager-byggmiljön bör göras genom att leta efter CM_BUILD systemvariabel. På samma sätt bör en profil som bara är avsedd att användas utanför Cloud Manager-byggmiljön göras genom att leta efter denna variabel som saknas.

Om du till exempel bara vill visa ett enkelt meddelande när bygget körs i Cloud Manager gör du det här.

        <profile>
            <id>cmBuild</id>
            <activation>
                  <property>
                        <name>env.CM_BUILD</name>
                  </property>
            </activation>
            <build>
                <plugins>
                    <plugin>
                        <artifactId>maven-antrun-plugin</artifactId>
                        <version>1.8</version>
                        <executions>
                            <execution>
                                <phase>initialize</phase>
                                <configuration>
                                    <target>
                                        <echo>I'm running inside Cloud Manager!</echo>
                                    </target>
                                </configuration>
                                <goals>
                                    <goal>run</goal>
                                </goals>
                            </execution>
                        </executions>
                    </plugin>
                </plugins>
            </build>
        </profile>

Och om du bara vill få ut ett enkelt meddelande när bygget körs utanför Cloud Manager gör du det här.

        <profile>
            <id>notCMBuild</id>
            <activation>
                  <property>
                        <name>!env.CM_BUILD</name>
                  </property>
            </activation>
            <build>
                <plugins>
                    <plugin>
                        <artifactId>maven-antrun-plugin</artifactId>
                        <version>1.8</version>
                        <executions>
                            <execution>
                                <phase>initialize</phase>
                                <configuration>
                                    <target>
                                        <echo>I'm running outside Cloud Manager!</echo>
                                    </target>
                                </configuration>
                                <goals>
                                    <goal>run</goal>
                                </goals>
                            </execution>
                        </executions>
                    </plugin>
                </plugins>
            </build>
        </profile>

Lösenordsskyddat databasstöd för Maven

Så här använder du en lösenordsskyddad Maven-databas i Cloud Manager:

1. Ange lösenordet (och eventuellt användarnamnet) som en hemlighet pipeline-variabel.
2. Referera sedan hemligheten inuti en fil med namnet .cloudmanager/maven/settings.xml i Git-databasen, som följer Maven Settings-fil schema.

När Cloud Manager-byggprocessen startar:

• The <servers> -elementet i den här filen kommer att sammanfogas med standardvärdet settings.xml som tillhandahålls av Cloud Manager.
  • Server-ID:n som börjar med adobe och cloud-manager betraktas som reserverade och bör inte användas av anpassade servrar.
  • Server-ID:n som inte matchar något av dessa prefix eller standard-ID:t central kommer aldrig att speglas av Cloud Manager.
• När den här filen är på plats refereras server-ID:t inifrån en <repository> och/eller <pluginRepository> -element inuti pom.xml -fil.
• I allmänhet gäller följande <repository> och/eller <pluginRepository> -element finns inuti en Cloud Manager-specifik profiläven om det inte är absolut nödvändigt.

Låt oss till exempel säga att databasen är https://repository.myco.com/maven2bör användarnamnet Cloud Manager använda cloudmanageroch lösenordet är secretword. Du gör så här:

1. Ange lösenordet som en hemlighet i pipeline.

   $ aio cloudmanager:set-pipeline-variables PIPELINEID --secret CUSTOM_MYCO_REPOSITORY_PASSWORD secretword`
   

2. Referera detta från .cloudmanager/maven/settings.xml -fil.

   <?xml version="1.0" encoding="UTF-8"?>
   <settings xmlns="https://maven.apache.org/SETTINGS/1.0.0" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
           xsi:schemaLocation="https://maven.apache.org/SETTINGS/1.0.0 https://maven.apache.org/xsd/settings-1.0.0.xsd">
       <servers>
           <server>
               <id>myco-repository</id>
               <username>cloudmanager</username>
              <password>${env.CUSTOM_MYCO_REPOSITORY_PASSWORD}</password>
           </server>
       </servers>
   </settings>
   

3. Referera slutligen till server-ID:t i pom.xml fil:

   <profiles>
       <profile>
           <id>cmBuild</id>
           <activation>
                   <property>
                       <name>env.CM_BUILD</name>
                   </property>
           </activation>
           <repositories>
                <repository>
                    <id>myco-repository</id>
                    <name>MyCo Releases</name>
                    <url>https://repository.myco.com/maven2</url>
                    <snapshots>
                        <enabled>false</enabled>
                    </snapshots>
                    <releases>
                        <enabled>true</enabled>
                    </releases>
                </repository>
            </repositories>
            <pluginRepositories>
                <pluginRepository>
                    <id>myco-repository</id>
                    <name>MyCo Releases</name>
                    <url>https://repository.myco.com/maven2</url>
                    <snapshots>
                        <enabled>false</enabled>
                    </snapshots>
                    <releases>
                        <enabled>true</enabled>
                    </releases>
                </pluginRepository>
            </pluginRepositories>
       </profile>
   </profiles>
   

Distribuera källor

Det är en god vana att driftsätta Java-källorna tillsammans med binärfilen i en Maven-databas.

Det gör du genom att konfigurera maven-source-plugin i projektet.

         <plugin>
             <groupId>org.apache.maven.plugins</groupId>
             <artifactId>maven-source-plugin</artifactId>
             <executions>
                 <execution>
                     <id>attach-sources</id>
                     <goals>
                         <goal>jar-no-fork</goal>
                     </goals>
                 </execution>
             </executions>
         </plugin>

Distribuera projektkällor

Det är en god vana att driftsätta hela projektkällan tillsammans med binärfilen i en Maven-databas. Detta gör att den exakta artefakten kan återskapas.

Det gör du genom att konfigurera maven-assembly-plugin i ditt projekt.

         <plugin>
             <groupId>org.apache.maven.plugins</groupId>
             <artifactId>maven-assembly-plugin</artifactId>
             <executions>
                 <execution>
                     <id>project-assembly</id>
                     <phase>package</phase>
                     <goals>
                         <goal>single</goal>
                     </goals>
                     <configuration>
                         <descriptorRefs>
                             <descriptorRef>project</descriptorRef>
                         </descriptorRefs>
                     </configuration>
                 </execution>
             </executions>
         </plugin>

Hoppar över innehållspaket

I Cloud Manager kan byggen producera valfritt antal innehållspaket. Det kan av olika skäl vara önskvärt att skapa ett innehållspaket men inte distribuera det. Ett exempel kan vara när innehållspaket som bara används för testning skapas eller som paketeras om med ett annat steg i byggprocessen, dvs. som ett underpaket till ett annat paket.

För att hantera dessa scenarier söker Cloud Manager efter egenskapen cloudManagerTarget i egenskaperna för de byggda innehållspaketen. Om den här egenskapen är inställd på none, hoppas paketet över och distribueras inte.

Mekanismen för att ange den här egenskapen beror på hur bygget skapar innehållspaketet. Med filevault-maven-plugin konfigurerar du plugin-programmet enligt följande.

        <plugin>
            <groupId>org.apache.jackrabbit</groupId>
            <artifactId>filevault-package-maven-plugin</artifactId>
            <extensions>true</extensions>
            <configuration>
                <properties>
                    <cloudManagerTarget>none</cloudManagerTarget>
                </properties>
        <!-- other configuration -->
            </configuration>
        </plugin>

The content-package-maven-plugin har en liknande konfiguration.

        <plugin>
            <groupId>com.day.jcr.vault</groupId>
            <artifactId>content-package-maven-plugin</artifactId>
            <extensions>true</extensions>
            <configuration>
                <properties>
                    <cloudManagerTarget>none</cloudManagerTarget>
                </properties>
        <!-- other configuration -->
            </configuration>
        </plugin>

Bygg återanvändning av felaktigheter

I många fall distribueras samma kod till flera AEM miljöer. Om det är möjligt kommer Cloud Manager att undvika att återskapa kodbasen när det upptäcker att samma Git-implementering används i flera fullständiga pipeline-körningar.

När en körning startas extraheras den aktuella HEAD-implementeringen för förgreningsflödet. Hash för implementeringen visas i användargränssnittet och via API:t. När byggsteget har slutförts lagras de resulterande artefakterna baserat på den implementeringshashen och kan återanvändas i efterföljande pipeline-körningar.

Paket återanvänds i alla rörledningar om de ingår i samma program. När du söker efter paket som kan återanvändas ignorerar AEM grenar och återanvänder artefakter över grenar.

När en återanvändning sker ersätts stegen för bygg- och kodkvalitet effektivt med resultaten från den ursprungliga körningen. Loggfilen för byggsteget innehåller artefakter och körningsinformation som användes för att skapa dem från början.

Här följer ett exempel på sådana loggutdata.

The following build artifacts were reused from the prior execution 4 of pipeline 1 which used commit f6ac5e6943ba8bce8804086241ba28bd94909aef:
build/aem-guides-wknd.all-2021.1216.1101633.0000884042.zip (content-package)
build/aem-guides-wknd.dispatcher.cloud-2021.1216.1101633.0000884042.zip (dispatcher-configuration)

Loggen för kodkvalitetssteget innehåller liknande information.

Exempel

Exempel 1

Tänk på att ditt program har två utvecklingspipelines:

• Pipeline 1 på förgrening foo
• Pipeline 2 på förgrening bar

Båda grenarna har samma implementerings-ID.

1. Om du kör pipeline 1 först byggs paketen normalt.
2. När du sedan kör Pipeline 2 återanvänds paket som skapats med Pipeline 1.

Exempel 2

Programmet har två grenar:

• Gren foo
• Gren bar

Båda grenarna har samma implementerings-ID.

1. En utvecklingsprocess bygger och verkställer foo.
2. Därefter byggs och körs en produktionsprocess bar.

I det här fallet är artefakten från foo kommer att återanvändas för produktionsflödet eftersom samma implementeringshash identifierades.

Avmarkera

Om du vill kan återanvändningsbeteendet inaktiveras för specifika rörledningar genom att ange rörledningsvariabeln CM_DISABLE_BUILD_REUSE till true. Om den här variabeln är inställd extraheras fortfarande implementeringshashen och de resulterande artefakterna lagras för senare användning, men eventuella tidigare lagrade artefakter återanvänds inte. Tänk på följande scenario om du vill förstå det här beteendet.

1. En ny pipeline skapas.
2. Pipelinen körs (exekvering nr 1) och den aktuella implementeringen i HEAD är becdddb. Körningen är klar och de resulterande artefakterna sparas.
3. The CM_DISABLE_BUILD_REUSE variabeln är inställd.
4. Pipelinen körs igen utan att koden ändras. Även om lagrade artefakter är associerade med becdddb, används de inte på grund av CM_DISABLE_BUILD_REUSE variabel.
5. Koden ändras och pipeline körs. HEAD har bekräftat f6ac5e6. Körningen är klar och de resulterande artefakterna sparas.
6. The CM_DISABLE_BUILD_REUSE variabeln tas bort.
7. Pipelinen körs igen utan att koden ändras. Eftersom lagrade artefakter är associerade med f6ac5e6, återanvänds dessa artefakter.

Caveats

• Skapa artefakter återanvänds inte i olika program, oavsett om implementeringshashen är identisk.
• Artefakter återanvänds i samma program även om grenen och/eller pipeline är annorlunda.
• Hantering av versioner av Maven ersätter endast projektversionen i produktionspipelines. Om samma implementering används både för en körning av en utvecklingsdistribution och en körning av en produktionspipeline och utvecklingsdistributionen körs först, distribueras versionerna till fas och produktion utan att ändras. I det här fallet kommer dock en tagg fortfarande att skapas.
• Om hämtningen av de lagrade artefakterna inte lyckas kommer byggsteget att utföras som om inga artefakter hade lagrats.
• Andra rörledningsvariabler än CM_DISABLE_BUILD_REUSE tas inte med i beräkningen när Cloud Manager bestämmer sig för att återanvända tidigare skapade byggartefakter.

Resurser för Business.Adobe.com