Déploiement sur AEM as a Cloud Service

Présentation

Les principes fondamentaux du développement de code sont similaires dans AEM as a Cloud Service par rapport aux solutions AEM On Premise et Managed Services. Les développeurs écrivent du code et le testent localement. Il est ensuite envoyé vers les environnements distants AEM as a Cloud Service. Cloud Manager, qui était un outil de diffusion de contenu facultatif pour Managed Services, est requis. Il s’agit désormais du seul mécanisme de déploiement du code pour AEM les environnements de développement, d’évaluation et de production as a Cloud Service. Pour une validation rapide des fonctionnalités et un débogage avant de déployer ces environnements, le code peut être synchronisé d’un environnement local à un Environnement de développement rapide.

La mise à jour de la version d’AEM est toujours un événement de déploiement distinct de la publication de code personnalisé. Il en résulte que les versions de code personnalisé doivent être testées par rapport à la version d’AEM en cours de production, car c’est sur celle-ci qu’elles seront déployées. Les mises à jour de version d’AEM ayant lieu par la suite seront fréquentes et appliquées automatiquement. Elles sont conçues pour être rétrocompatibles avec le code client déjà déployé.

Le reste de ce document décrit la manière dont les développeurs doivent adapter leurs pratiques afin de s’adapter aux mises à jour de version d’AEM as a Cloud Service et aux mises à jour client.

Versions client

Codage par rapport à la version appropriée d’AEM

Pour les solutions AEM précédentes, la version la plus récente d’AEM était rarement modifiée (environ une fois par an avec des Service Packs trimestriels) et les clients mettaient à jour les instances de production au moment voulu vers le quickstart le plus récent, en référençant le fichier Jar de l’API. Toutefois, les applications AEM as a Cloud Service sont automatiquement mises à jour vers la dernière version d’AEM à une fréquence plus élevée, de sorte que le code personnalisé pour les versions internes doit être créé par rapport à la dernière version d’AEM.

Comme pour les versions existantes d’AEM hors cloud, un développement local hors ligne basé sur un quickstart spécifique sera pris en charge et devrait être l’outil de choix pour le débogage dans la plupart des cas.

Pour développer du code personnalisé pour une version interne, vous devez télécharger et installer la version appropriée du SDK AEM as a Cloud Service. Pour plus d’informations sur l’utilisation des outils Dispatcher d’AEM as a Cloud Service, voir cette page.

La vidéo suivante présente un aperçu général du déploiement du code vers AEM as a Cloud Service :

Déploiement de packages de contenu via Cloud Manager et le gestionnaire de packages

Déploiements via Cloud Manager

Les clients déploient le code personnalisé dans les environnements cloud via Cloud Manager. Il est à noter que Cloud Manager transforme des packages de contenu assemblés localement en artefact conforme au modèle de fonctionnalité Sling, qui décrit une application AEM as a Cloud Service lors de l’exécution dans un environnement cloud. Par conséquent, lorsque vous examinez les packages dans le Gestionnaire de package sur les environnements cloud, le nom inclut « cp2fm » et toutes les métadonnées des packages transformés sont supprimées. Ils ne peuvent pas être interactifs, ce qui signifie qu’ils ne peuvent pas être téléchargés, répliqués, ni ouverts. Vous trouverez ici une documentation détaillée sur le convertisseur.

Les packages de contenu écrits pour les applications AEM as a Cloud Service doivent présenter une distinction claire entre le contenu modifiable et non modifiable, et Cloud Manager n’installera que le contenu modifiable, en renvoyant un message du type :

Generated content-package <PACKAGE_ID> located in file <PATH> is of MIXED type

Le reste de cette section décrit la composition et les implications des packages modifiables et non modifiables.

Packages de contenu non modifiables

L’ensemble du contenu et du code conservés dans le référentiel non modifiable doit être archivé dans git et déployé via Cloud Manager. En d’autres termes, contrairement aux solutions AEM actuelles, le code n’est jamais déployé directement sur une instance AEM en cours d’exécution. Cela garantit que le code en cours d’exécution est identique pour une version donnée dans n’importe quel environnement cloud, ce qui élimine le risque de variation non intentionnelle du code en production. Par exemple, la configuration OSGI doit être validée dans le contrôle de code source plutôt que d’être gérée au moment de l’exécution via le gestionnaire de configuration de la console web AEM.

Les modifications d’application dues au modèle de déploiement bleu/vert étant activées par un commutateur, elles ne peuvent pas dépendre des modifications du référentiel modifiable, à l’exception des utilisateurs du service, de leurs listes de contrôle d’accès, de leurs types de nœuds et des modifications de la définition d’index.

Pour les clients qui disposent de bases de code, il est essentiel de passer par l’exercice de restructuration du référentiel décrit dans la documentation d’AEM en vue de s’assurer que le contenu qui se trouvait auparavant sous /etc est déplacé vers le bon emplacement.

Certaines restrictions supplémentaires s’appliquent à ces packages de code, les hooks d’installation ne sont par exemple pas pris en charge.

Configuration OSGI

Comme mentionné ci-dessus, la configuration OSGI doit être validée dans le contrôle de code source plutôt que par le biais de la console web. Pour ce faire, les techniques suivantes sont disponibles :

• Apporter les modifications nécessaires à l’environnement AEM local du développeur avec le gestionnaire de configuration de la console web AEM, puis exporter les résultats vers le projet AEM sur le système de fichiers local
• Créer manuellement la configuration OSGI dans le projet AEM sur le système de fichiers local et faire référence au gestionnaire de configuration de la console AEM pour les noms de propriétés

Pour plus d’informations sur la configuration d’OSGI, voir la section Configuration d’OSGi pour AEM as a Cloud Service.

Contenu modifiable

Dans certains cas, il peut s’avérer utile de préparer les changements de contenu dans le contrôle de code source afin qu’il puisse être déployé par Cloud Manager chaque fois qu’un environnement est mis à jour. Par exemple, il peut être raisonnable d’amorcer certaines structures de dossiers racine ou d’aligner les modifications dans les modèles modifiables afin d’y activer les stratégies pour les composants qui ont été mis à jour par le déploiement de l’application.

Il existe deux stratégies pour décrire le contenu qui sera déployé par Cloud Manager vers le référentiel modifiable, les packages de contenu modifiable et les instructions repoinit.

Packages de contenu modifiables

Les contenus tels que les hiérarchies de chemins de dossier, les utilisateurs du service et les contrôles d’accès (ACL) sont généralement validés dans un projet AEM Maven basé sur l’archétype. Les techniques incluent l’exportation depuis AEM ou l’écriture directe au format XML. Au cours du processus de création et de déploiement, Cloud Manager crée le package de contenu modifiable résultant. Le contenu modifiable est installé à 3 reprises lors de la phase de déploiement du pipeline :

Avant le démarrage de la nouvelle version de l’application :

• Définitions d’index (ajout, modification, suppression)

Au démarrage d’une nouvelle version de l’application, mais avant le basculement :

• Utilisateurs du service (ajout)
• Liste de contrôle d’accès des utilisateurs du service (ajout)
• Types de nœuds (ajout)

Après le basculement vers la nouvelle version de l’application :

• Tous les autres contenus pouvant être définis via le coffre jackrabbit. Par exemple :
  • Dossiers (ajout, modification, suppression)
  • Modèles modifiables (ajout, modification, suppression)
  • Configuration tenant compte du contexte (tout sous /conf) (ajout, modification, suppression)
  • Scripts (les packages peuvent déclencher des hooks d’installation à diverses étapes du processus d’installation de package : Voir la documentation Jackrabbit filevault sur les hooks d’installation. Notez qu’AEM CS utilise actuellement la version 3.4.0 de Filevault, qui limite les hooks d’installation aux administrateurs, aux utilisateurs système et aux membres du groupe administrateurs).

Il est possible de limiter l’installation de contenu modifiable à la création ou à la publication en incorporant des packages dans un dossier install.author ou install.publish sous /apps. Une restructuration pour refléter cette séparation a été réalisée dans AEM 6.5 et les détails relatifs à la restructuration de projet recommandée sont disponibles dans la documentation d’AEM 6.5.

En outre, il n’existe aucun mécanisme permettant d’annuler les modifications du package de contenu modifiable après leur application. Si les clients détectent un problème, ils peuvent choisir de le résoudre dans la prochaine version de leur code ou, en dernier recours, restaurer l’ensemble du système à un moment donné avant le déploiement.

Les packages tiers inclus doivent être validés comme compatibles avec AEM as a Cloud Service, sans quoi leur inclusion entraînera un échec du déploiement.

Comme mentionné ci-dessus, les clients disposant de bases de code doivent se conformer à l’exercice de restructuration du référentiel rendu nécessaire par les modifications de référentiel dans la version 6.5 comme décrit dans la documentation d’AEM 6.5.

Repoinit

Dans les cas suivants, il est préférable d’utiliser l’approche du codage manuel des instructions repoinit de création de contenu explicite dans les configurations OSGI d’usine :

• Création/suppression/désactivation d’utilisateurs du service

• Création/suppression de groupes

• Création/suppression d’utilisateurs

• Ajout de listes de contrôle d’accès

  REMARQUE

  La définition des listes de contrôle d’accès requiert que les structures de nœud soient déjà présentes. Par conséquent, il peut être nécessaire de créer au préalable des instructions de chemin.

• Ajout d’un chemin (par exemple, pour les structures de dossiers racine)

• Ajout de CND (définitions de types de nœuds)

Il est préférable d’opter pour repoinit pour ces scénarios de modification de contenu pris en charge en raison des avantages suivants :

• Repoinit crée des ressources au démarrage si bien que la logique peut prendre l’existence de ces ressources pour acquise. Dans l’approche du package de contenu modifiable, les ressources sont créées après le démarrage. Le code de l’application reposant sur ces ressources peut donc échouer.
• Repoinit est un jeu d’instructions relativement sûr, car vous contrôlez explicitement l’action à entreprendre. En outre, les seules opérations prises en charge sont les ajouts, à l’exception de quelques cas liés à la sécurité qui permettent de supprimer des utilisateurs, des utilisateurs du service et des groupes. En revanche, la suppression d’un élément dans l’approche du package de contenu modifiable est explicite ; lorsque vous définissez un filtre, tout élément couvert par ce filtre sera supprimé. Néanmoins, il faut être prudent car, pour tout contenu, il existe des scénarios où la présence d’un nouveau contenu peut modifier le comportement de l’application.
• Repoinit effectue des opérations atomiques et rapides. Cependant, les packages de contenu modifiable peuvent fortement dépendre des performances selon les structures couvertes par un filtre. Même si vous mettez à jour un nœud unique, un instantané d’une grande arborescence peut être créé.
• Il est possible de valider les instructions repoinit sur un environnement de développement local au moment de l’exécution, car elles seront exécutées lorsque la configuration OSGi sera enregistrée.
• Les instructions repoinit sont atomiques et explicites, et sont ignorées si le statut correspond déjà.

Lorsque Cloud Manager déploie l’application, il exécute ces instructions, indépendamment de l’installation des packages de contenu.

Pour créer des instructions repoinit, procédez comme suit :

1. Ajoutez une configuration OSGi pour le PID d’usine org.apache.sling.jcr.repoinit.RepositoryInitializer dans un dossier de configuration du projet. Utilisez un nom explicite pour la configuration, tel que org.apache.sling.jcr.repoinit.RepositoryInitializer~initstructure.
2. Ajoutez des instructions repoinit à la propriété de script de la configuration. La syntaxe et les options sont décrites dans la documentation Sling. Notez que vous devez créer explicitement un dossier parent avant leurs dossiers enfants. Par exemple, une création explicite de /content avant /content/myfolder, et avant /content/myfolder/mysubfolder. Pour que les listes de contrôle d’accès soient définies sur des structures de bas niveau, il est recommandé de les définir sur un niveau supérieur et de travailler avec une restriction rep:glob. Par exemple, (allow jcr:read on /apps restriction(rep:glob,/msm/wcm/rolloutconfigs)).
3. Validez l’environnement de développement local au moment de l’exécution.

Pour plus d’informations sur repoinit, voir la documentation Sling.

Utilisation ponctuelle du gestionnaire de packages pour les packages de contenu modifiables

Il existe des cas d’utilisation où un package de contenu doit être installé de façon ponctuelle. Par exemple, pour déboguer un problème de production, vous devez importer du contenu spécifique de la production vers l’évaluation. Pour ces scénarios, le Gestionnaire de package peut être utilisé dans les environnements AEM as a Cloud Service.

Le gestionnaire de packages étant un concept d’exécution, il n’est pas possible d’installer du contenu ni du code dans le référentiel non modifiable. Par conséquent, ces packages doivent être constitués uniquement de contenu modifiable (principalement /content ou /conf). Si le package comprend du contenu mixte (modifiable et non modifiable), seul le contenu modifiable sera installé.

Les packages de contenu (modifiable ou non) installés via Cloud Manager s’affichent dans un statut figé au sein de l’interface utilisateur du gestionnaire de packages AEM. Ces packages ne peuvent pas être réinstallés, recréés, ni même téléchargés. Ils sont répertoriés avec le suffixe « cp2fm », indiquant que leur installation a été gérée par Cloud Manager.

Inclusion de packages tiers

Il est courant pour les clients d’inclure des packages préconfigurés provenant de sources tierces, telles que des fournisseurs de logiciels comme les partenaires de traduction d’Adobe. Il est recommandé d’héberger ces packages au sein d’un référentiel distant et de les référencer dans le pom.xml. Cela est possible pour les référentiels publics et pour les référentiels privés avec protection par mot de passe, comme décrit dans Référentiels Maven protégés par mot de passe.

S’il n’est pas possible de stocker le package dans un référentiel distant, les clients peuvent le placer dans un référentiel Maven local basé sur un système de fichiers, qui est validé dans SCM dans le cadre du projet et référencé par toutes les dépendances. Ce référentiel serait alors déclaré dans les fichiers POM du projet, comme illustré ci-dessous :

<repository>
    <id>project.local</id>
    <name>project</name>
    <url>file:${maven.multiModuleProjectDirectory}/repository</url>
</repository>

Les modules tiers inclus doivent être conformes aux directives de codage et de création de package d’AEM as a Cloud Service décrites dans cet article. Sinon, leur inclusion entraînera un échec du déploiement.

Le fragment POM.xml Maven suivant montre comment les packages tiers peuvent être intégrés dans le package « Conteneur » du projet, généralement appelé « all », au moyen de la configuration du plug-in Maven filevault-package-maven-plugin.

...
<plugin>
  <groupId>org.apache.jackrabbit</groupId>
  <artifactId>filevault-package-maven-plugin</artifactId>
  <extensions>true</extensions>
  <configuration>
      ...
      <embeddeds>

          ...

          <!-- Include any other extra packages  -->
          <embedded>
              <groupId>com.vendor.x</groupId>
              <artifactId>vendor.plug-in.all</artifactId>
              <type>zip</type>
              <target>/apps/vendor-packages/container/install</target>
          </embedded>
      <embeddeds>
  </configuration>
</plugin>
...

Fonctionnement des déploiements en continu

Comme les mises à jour d’AEM, les versions des clients sont déployées à l’aide d’une stratégie de déploiement en continu afin d’éliminer les temps d’arrêt de la grappe d’auteurs dans les bonnes circonstances. La séquence générale des événements est décrite ci-dessous, où Bleu est l’ancienne version du code client et Vert est la nouvelle version. Les versions bleue et verte exécutent toutes deux la même version du code AEM.

• La version bleue est active, tandis qu’une version finale verte est créée et disponible.
• S’il existe des définitions d’index nouvelles ou mises à jour, les index correspondants sont traités. Notez que le déploiement bleu utilisera toujours les anciens index, mais le vert utilisera toujours les nouveaux.
• La version verte commence alors que la version bleue est encore en service.
• La version bleue fonctionne et reste en service pendant que la version verte est contrôlée pour vérifier le statut de préparation au moyen de contrôles d’intégrité.
• Les nœuds verts qui sont prêts acceptent le trafic et remplacent les nœuds bleus, qui sont désactivés.
• Au fil du temps, les nœuds bleus sont remplacés par des nœuds verts jusqu’à ce que seuls les nœuds verts restent, ce qui permet de terminer le déploiement.
• Tout contenu modifiable nouveau ou modifié est déployé.

Index

Les nouveaux index ou les index modifiés entraîneront une étape supplémentaire d’indexation ou de réindexation avant que la nouvelle version (verte) puisse prendre en charge le trafic. Vous trouverez dans cet article des informations détaillées sur la gestion des index dans AEM as a Cloud Service. Vous pouvez vérifier le statut de la tâche d’indexation sur la page de version Cloud Manager et vous recevrez une notification lorsque la nouvelle version sera prête à recevoir le trafic.

Pour le moment, AEM as a Cloud Service ne fonctionne pas avec les outils de gestion d’index tels que ACS Commons Verify Oak Index.

Réplication

Le mécanisme de publication est rétrocompatible avec les API Java de réplication AEM.

Pour développer et tester avec la réplication en utilisant le fichier Quickstart AEM prêt pour le cloud, les fonctionnalités classiques de réplication doivent être utilisées avec une configuration Auteur/Publication. Dans le cas où le point d’entrée de l’interface utilisateur sur l’auteur AEM a été supprimé pour le cloud, les utilisateurs accèdent à http://localhost:4502/etc/replication pour la configuration.

Code rétrocompatible pour les déploiements en continu

Comme indiqué ci-dessus, la stratégie de déploiement en continu d’AEM as a Cloud Service implique que les anciennes et nouvelles versions peuvent être opérationnelles en même temps. Par conséquent, soyez prudent par rapport aux modifications de code qui ne sont pas rétrocompatibles avec l’ancienne version d’AEM qui est encore utilisée.

En outre, l’ancienne version doit être testée pour vérifier sa compatibilité avec toute nouvelle structure de contenu modifiable appliquée par la nouvelle version en cas de restauration, puisque le contenu modifiable n’est pas supprimé.

Utilisateurs du service et modifications des listes de contrôle d’accès

La modification des utilisateurs du service ou des listes de contrôle d’accès nécessaires pour accéder au contenu ou au code peut entraîner des erreurs dans les anciennes versions d’AEM, ce qui permet à des personnes qui ne sont plus des utilisateurs du service d’accéder à ce contenu ou à ce code. Pour remédier à ce problème, il est recommandé d’effectuer des modifications réparties sur au moins 2 versions, la première version jouant le rôle de passerelle avant de procéder au nettoyage dans la version suivante.

Modifications des index

Si des modifications sont apportées aux index, il est important que la version bleue continue à utiliser ses index jusqu’à son arrêt, tandis que la version verte utilise son propre jeu d’index modifié. Le développeur doit suivre les techniques de gestion des index décrites dans cet article.

Codage conservateur pour les restaurations

Si un échec est signalé ou détecté après le déploiement, il est possible qu’une restauration de la version bleue soit nécessaire. Il serait judicieux de s’assurer que le code bleu est compatible avec toutes les structures créées par la version verte puisque les nouvelles structures (tout contenu modifiable) ne seront pas annulées. Si l’ancien code n’est pas compatible, des correctifs devront être appliqués dans les versions ultérieures du client.

Environnements de développement rapide (RDE)

Environnements de développement rapide (ou les RDE pour abréger) permettent aux développeurs de déployer et d’examiner rapidement les modifications, ce qui réduit le temps nécessaire au test des fonctionnalités qui ont déjà fait leurs preuves dans un environnement de développement local.

Contrairement aux environnements de développement standard qui déploient le code via le pipeline Cloud Manager, les développeurs utilisent des outils de ligne de commande pour synchroniser le code d’un environnement de développement local avec l’éditeur de texte enrichi. Une fois les modifications testées dans un éditeur de texte enrichi, elles doivent être déployées dans un environnement de développement cloud standard via le pipeline Cloud Manager, qui placera le code par le biais des points de contrôle qualité appropriés.

Modes d’exécution

Dans les solutions AEM existantes, les clients peuvent exécuter des instances avec des modes d’exécution arbitraires et appliquer la configuration OSGI ou installer des lots OSGI sur ces instances. Les modes d’exécution définis incluent généralement la variable service (création et publication) et l’environnement (code, développement, évaluation, production).

AEM as a Cloud Service, en revanche, est plus précis sur les modes d’exécution disponibles et sur la manière dont les lots OSGI et la configuration OSGI peuvent être mappés sur ces modes :

• Les modes d’exécution de la configuration OSGI doivent faire référence à RDE, dev, stage, prod pour l’environnement ou author, publish pour le service. La combinaison de <service>.<environment_type> est prise en charge dans cet ordre particulier (par exemple, author.dev ou publish.prod). Les jetons OSGI doivent être référencés directement à partir du code plutôt que d’utiliser la méthode getRunModes, qui n’inclut plus environment_type au moment de l’exécution. Pour plus d’informations, voir Configuration d’OSGi pour AEM as a Cloud Service.
• Les modes d’exécution des lots OSGI sont limités au service (auteur et publication). Les lots OSGI par mode d’exécution doivent être installés dans le package de contenu sous install.author ou install.publish.

AEM as a Cloud Service ne permet pas d’utiliser des modes d’exécution pour installer du contenu pour des environnements ou des services spécifiques. Si un environnement de développement doit être ensemencé avec des données ou un HTML qui ne se trouve pas dans les environnements d’évaluation ou de production, le gestionnaire de modules peut être utilisé.

Les configurations de mode d’exécution prises en charge sont les suivantes :

• config (La valeur par défaut s’applique à tous les services AEM.)
• config.author (s’applique à tous les services Auteur AEM)
• config.author.dev (s’applique au service Auteur de développement AEM)
• config.author.rde (S’applique au service d’auteur RDE AEM)
• config.author.stage (s’applique au service Auteur d’évaluation AEM)
• config.author.prod (s’applique au service Auteur de production AEM)
• config.publish (s’applique au service Publication AEM)
• config.publish.dev (s’applique au service de publication de développement AEM)
• config.publish.rde (S’applique au service de publication RDE AEM)
• config.publish.stage (s’applique au service Publication d’évaluation AEM)
• config.publish.prod (s’applique au service Publication de production AEM)
• config.dev (s’applique aux services de développement AEM)
• config.rde (S’applique aux services RDE)
• config.stage (s’applique aux services d’évaluation AEM)
• config.prod (s’applique aux services de production AEM)

La configuration OSGI qui possède le plus grand nombre de modes d’exécution correspondants est utilisée.

Lors d’un développement local, un paramètre de démarrage en mode d’exécution, -r, est utilisé pour spécifier la configuration OSGI du mode d’exécution.

$ java -jar aem-sdk-quickstart-xxxx.x.xxx.xxxx-xxxx.jar -r publish,dev

Configuration des tâches de maintenance dans le contrôle de code source

Les configurations de tâches de maintenance doivent être conservées dans le contrôle de code source, car l’écran Outils > Opérations ne sera plus disponible dans les environnements cloud. Cela a l’avantage d’assurer que les changements sont maintenus de manière intentionnelle, plutôt qu’appliqués de manière réactive et peut-être oubliés. Pour plus d’informations, voir l’article consacré aux tâches de maintenance.

Ressources Business.Adobe.com