Configuration du projet

Dernière mise à jour : 14 octobre 2024
  • S'applique à :
  • Experience Manager as a Cloud Service

Créé pour :

  • Administration
  • Développeur

Découvrez comment AEM Projets sont créés avec Maven et les normes que vous devez respecter lors de la création de votre propre projet.

Détails de la configuration du projet

Pour créer et déployer avec succès avec Cloud Manager, AEM Projets doit respecter les directives suivantes :

  • Les projets doivent être créés à l’aide de Apache Maven.
  • Un fichier pom.xml doit se trouver à la racine du référentiel Git. Ce fichier pom.xml peut renvoyer à autant de sous-modules (qui à leur tour peuvent comporter d’autres sous-modules, et ainsi de suite) que nécessaire.
  • Vous pouvez ajouter des références à d’autres référentiels d’artefacts Maven dans vos fichiers pom.xml. L’accès aux référentiels d’artefacts protégés par mot de passe est pris en charge s’il est configuré. Cependant, l’accès aux référentiels d’artefacts protégés par réseau n’est pas pris en charge.
  • Les packages de contenu déployables sont découverts en analysant les fichiers de package de contenu .zip contenus dans un répertoire appelé target. Un nombre illimité de sous-modules peut produire des packages de contenu.
  • Les artefacts Dispatcher déployables sont découverts en analysant les fichiers .zip (également contenus dans le répertoire nommé target), dont les répertoires sont appelés conf et conf.d.
  • S’il existe plusieurs packages de contenu, l’ordre des déploiements des packages n’est pas garanti. Si un ordre spécifique est nécessaire, il est possible d’utiliser les dépendances de package pour le définir.
  • Les packages peuvent être ignorés au cours du déploiement.

Activation des profils Maven dans Cloud Manager

Dans certains cas, vous devrez peut-être légèrement modifier le processus de génération lors de l’exécution dans Cloud Manager, contrairement à celui qui s’exécute sur les postes de travail des développeurs. Dans ce cas, les profils Maven peuvent être utilisés pour définir la manière dont la génération doit être différente dans différents environnements, notamment Cloud Manager.

L’activation d’un profil Maven dans l’environnement de génération Cloud Manager doit se faire en recherchant la présence de la variable d’environnement CM_BUILD. De la même manière, un profil destiné à être utilisé uniquement en dehors de l’environnement de création Cloud Manager doit être généré en vérifiant l’absence de cette variable.

Par exemple, si vous souhaitez générer un message simple uniquement lorsque la version est exécutée dans Cloud Manager, procédez comme suit :

        <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>
REMARQUE
Pour tester ce profil sur un poste de travail de développeur, vous pouvez l’activer sur la ligne de commande (avec -PcmBuild) ou dans l’environnement de développement intégré (IDE).

Si vous souhaitez générer un message simple uniquement lorsque la version est exécutée en dehors de Cloud Manager, procédez comme suit :

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

Utiliser un référentiel Maven protégé par mot de passe dans Cloud Manager

REMARQUE
Déployez prudemment les artefacts des référentiels Maven protégés par mot de passe, car Cloud Manager n’évalue pas ce code avec ses règles de qualité du code. Cette méthode doit être réservée à de rares situations et appliquée uniquement au code sans rapport avec AEM. Adobe conseille d’inclure les sources Java et le code source du projet dans son intégralité, ainsi que le binaire. Cela garantit une plus grande transparence et une plus grande maintenabilité tout au long du processus de déploiement.

Pour utiliser un référentiel Maven protégé par mot de passe dans Cloud Manager :

  1. Indiquez le mot de passe (et éventuellement le nom d’utilisateur) comme variable de pipeline secrète.
  2. Référencez ensuite ce secret dans un fichier nommé .cloudmanager/maven/settings.xml dans le référentiel git, qui suit le schéma du fichier des paramètres Maven.

Lorsque le processus de création de Cloud Manager démarre :

  • L’élément <servers> dans ce fichier est fusionné dans le fichier settings.xml par défaut fourni par Cloud Manager.

    • Les ID de serveur commençant par adobe et cloud-manager sont considérés comme réservés. Ne les utilisez pas sur des serveurs personnalisés.
    • Cloud Manager ne reflète que les ID de serveur correspondant à des préfixes spécifiques ou à l’ID par défaut central ; tous les autres ID de serveur sont exclus de la mise en miroir.

  • Une fois ce fichier en place, l’ID de serveur est référencé à l’intérieur d’un élément <repository> et <pluginRepository> dans le fichier pom.xml.

  • En règle générale, ces éléments <repository> et <pluginRepository> sont inclus dans un profil spécifique à Cloud Manager, bien que leur inclusion ne soit pas strictement requise.

Par exemple, supposons que le référentiel se trouve à l’adresse https://repository.myco.com/maven2, que le nom d’utilisateur que Cloud Manager doit utiliser soit cloudmanager et que le mot de passe soit secretword. Procédez comme suit :

  1. Définissez le mot de passe comme secret sur le pipeline.

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

  2. Référencez ce secret à partir du fichier .cloudmanager/maven/settings.xml dans le fichier suivant :

    <?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. Enfin, référencez l’identifiant du serveur dans le fichier pom.xml :

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

Déployer des sources

Il est recommandé de déployer les sources Java avec le binaire dans un référentiel Maven.

Pour ce faire, configurez le plug-in maven-source-plugin dans votre projet.

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

Déployer des sources de projet

Il est recommandé de déployer l’ensemble des sources du projet ainsi que le binaire dans un référentiel Maven. Cela lui permet de reconstruire l’artefact exact.

Configurez le module maven-assembly-plugin dans votre projet de la manière suivante :

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

Ignorer les packages de contenu

Dans Cloud Manager, chaque compilation peut produire un certain nombre de packages de contenu. Pour diverses raisons, il peut être préférable de produire un package de contenu, mais de ne pas le déployer, Un exemple se produit lorsque des modules de contenu sont créés uniquement à des fins de test ou lorsqu’une autre étape du processus de création les recompile. C'est-à-dire un sous-package d'un autre package.

Pour tenir compte de ces scénarios, Cloud Manager recherche une propriété nommée cloudManagerTarget dans les propriétés des packages de contenu créés. Si cette propriété est définie sur none, le package est ignoré et n’est pas déployé.

Le mécanisme permettant de définir cette propriété dépend de la manière dont le build produit le package de contenu. Par exemple, avec le filevault-maven-plugin, vous devez configurer le plug-in de la manière suivante.

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

Le content-package-maven-plugin a une configuration similaire.

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

Réutilisation de l’artefact de build

Dans de nombreux cas, le même code est déployé dans plusieurs environnements AEM. Dans la mesure du possible, Cloud Manager évite de reconstruire la base du code lorsqu’il détecte que la même validation Git est utilisée dans plusieurs exécutions de pipelines de piles pleines.

Lorsqu’une exécution est lancée, la validation HEAD en cours pour le pipeline de branche est extraite. Le hachage de validation est visible dans l’interface utilisateur et via l’API. Une fois l’étape de build terminée, les artefacts obtenus sont stockés en fonction de ce hachage de validation et peuvent être réutilisés dans les exécutions ultérieures du pipeline.

Les packages sont réutilisés sur plusieurs pipelines s’ils se trouvent dans le même programme. Lorsque vous recherchez des packages qui peuvent être réutilisés, AEM ignore les branches et réutilise les artefacts entre les branches.

En cas de réutilisation, les étapes de build et de qualité du code sont effectivement remplacées par les résultats de l’exécution initiale. Le fichier journal de l’étape de création répertorie les artefacts et les informations d’exécution qui ont été utilisées pour les créer à l’origine.

Voici un exemple dʼune telle sortie de journal.

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)

Le journal de l’étape de qualité du code contient des informations similaires.

Exemples

Exemple 1

Partez du principe que votre programme comporte deux pipelines de développement :

  • Le pipeline 1 sur la branche foo
  • Le pipeline 2 sur la branche bar

Les deux branches utilisent le même identifiant de validation.

  1. L’exécution du pipeline 1 crée d’abord les modules normalement.
  2. Ensuite, l’exécution de Pipeline 2 réutilise les modules créés par Pipeline 1.

Exemple 2

Partez du principe que votre programme comporte deux branches :

  • Branche foo
  • Branche bar

Les deux branches ont le même identifiant de validation.

  1. Un pipeline de développement crée et exécute foo.
  2. Par la suite, un pipeline de production crée et exécute bar.

Dans ce cas, l’artefact de foo est réutilisé pour le pipeline de production, car le même hachage de validation a été identifié.

Désinscription

Si vous le souhaitez, le comportement de réutilisation peut être désactivé pour des pipelines spécifiques en définissant la variable de pipeline CM_DISABLE_BUILD_REUSE sur true. Si cette variable est définie, le système extrait le hachage de validation et stocke les artefacts obtenus pour une utilisation ultérieure, mais ignore la réutilisation des artefacts précédemment stockés. Pour comprendre ce comportement, considérez le scénario suivant :

  1. Un pipeline est créé.
  2. Le pipeline est exécuté (exécution #1) et la validation HEAD en cours est becdddb. L’exécution est réussie et les artefacts obtenus sont stockés.
  3. La variable CM_DISABLE_BUILD_REUSE est définie.
  4. Le pipeline est exécuté à nouveau sans modifier le code. Bien que des artefacts stockés soient associés à becdddb, ils ne sont pas réutilisés en raison de la variable CM_DISABLE_BUILD_REUSE.
  5. Le code est modifié et le pipeline est exécuté. La validation HEAD est maintenant f6ac5e6. L’exécution est réussie et les artefacts obtenus sont stockés.
  6. La variable CM_DISABLE_BUILD_REUSE est supprimée.
  7. Le pipeline est exécuté à nouveau sans modifier le code. Puisque des artefacts stockés sont associés à f6ac5e6, ces artefacts sont réutilisés.