Déploiement sur AEM as a Cloud Service deploying-to-aem-as-a-cloud-service

Présentation introduction

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 et développeuses é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. Cet outil de diffusion est désormais l’unique mécanisme permettant de déployer du code vers les environnements de production, d’évaluation et de développement d’AEM 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 vers 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 sont déployées. AEM mises à jour de version qui se produisent par la suite (qui sont fréquentes et sont automatiquement appliquées), 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 et développeuses 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 customer-releases

Codage par rapport à la version appropriée d’AEM coding-against-the-right-aem-version

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 sur 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 est pris en charge et devrait être l’outil de choix pour le débogage en général.

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 AEM as a Cloud Service, voir Dispatcher in the Cloud.

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 au moyen de Cloud Manager et du gestionnaire de modules deploying-content-packages-via-cloud-manager-and-package-manager

Déploiements par le biais de Cloud Manager deployments-via-cloud-manager

Les clients et clientes 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 sur 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 modules sur les environnements cloud, le nom comprend « 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. Pour obtenir une documentation détaillée sur le convertisseur, voir 🔗
sling-org-apache-sling-feature-cpconverter sur GitHub.

Les packages de contenu écrits pour les applications sur 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 immutabe-content-packages

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. Ce processus 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 par le biais du gestionnaire de configuration de la console web AEM.

Les modifications d’application dues au modèle de déploiement étant activées par un commutateur, elles ne peuvent pas dépendre des modifications du référentiel modifiable, à l’exception des utilisateurs et utilisatrices 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 et clientes 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 modules de code, par exemple, les hooks d’installation ne sont pas pris en charge.

Configuration OSGI osgi-configuration

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 :

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

Contenu modifiable mutable-content

Il peut parfois 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. Vous pouvez également aligner les modifications apportées aux modèles modifiables pour activer les composants de politiques qui ont été mis à jour par le déploiement de l’application.

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

Packages de contenu modifiables mutable-content-packages

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é à trois reprises lors de la phase de déploiement du pipeline :

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

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

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

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 et clientes 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îne un échec du déploiement.

Comme mentionné ci-dessus, les clients et clientes 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 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 :

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 :

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 :

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

Utilisation ponctuelle du gestionnaire de packages pour les packages de contenu modifiables package-manager-oneoffs-for-mutable-content-packages

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 packages peut être utilisé dans les environnements sur 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 est 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.

Inclure des packages tiers including-third-party

Il est courant pour les clientes et 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. Cette méthode 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 clientes et 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. Il est référencé par tout ce qui en dépend. Ce référentiel est 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 packages 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.

L’extrait de code 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 how-rolling-deployments-work

Comme les mises à jour d’AEM, les versions clientes sont déployées à l’aide d’une stratégie de déploiement en continu, afin d’éliminer les temps d’arrêt du cluster de création dans de bonnes circonstances. La séquence générale des événements est décrite ci-dessous, où les nœuds comportant à la fois l’ancienne version et la nouvelle version du code client exécutent la même version du code AEM.

Index indexes

Les nouveaux index ou les index modifiés entraînent une étape supplémentaire d’indexation ou de réindexation avant que la nouvelle version puisse prendre en charge le trafic. Vous trouverez des informations détaillées sur la gestion des index dans AEM as a Cloud Service sous Recherche et indexation de contenu. Vous pouvez vérifier le statut d’indexation des pages de création sur Cloud Manager et recevoir une notification lorsque la nouvelle version est prête à recevoir le trafic.

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

Réplication replication

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

Afin d’effectuer le développement et le test avec la réplication en utilisant le fichier de démarrage rapide AEM prêt pour le cloud, les fonctionnalités classiques de réplication doivent être utilisées avec une configuration Création/Publication. Si le point d’entrée de l’interface utilisateur sur l’instance de création AEM est supprimé pour le cloud, les personnes utilisatrices accèdent à http://localhost:4502/etc/replication pour la configuration.

Code rétrocompatible pour les déploiements en continu backwards-compatible-code-for-rolling-deployments

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 et utilisatrices du service et modifications des listes de contrôle d’accès service-users-and-acl-changes

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

Modifications des index index-changes

Si des modifications sont apportées aux index, il est important que la nouvelle version continue à utiliser ses index jusqu’à son arrêt, tandis que l’ancienne version utilise son propre jeu d’index modifié. Le développeur doit suivre les techniques de gestion des index décrites sous Recherche et indexation de contenu.

Codage conservateur pour les restaurations conservative-coding-for-rollbacks

Si un échec est signalé ou détecté après le déploiement, il est possible qu’une restauration de l’ancienne version soit nécessaire. Assurez-vous que le nouveau code est compatible avec toutes les nouvelles structures créées par cette nouvelle version. En effet, les nouvelles structures (tout contenu modifiable) ne sont pas restaurées. Si l’ancien code n’est pas compatible, des correctifs doivent être appliqués dans les versions clientes ultérieures.

Environnements de développement rapide (RDE) rde

Les Environnements de développement rapide (RDE) permettent aux développeurs et aux développeuses de déployer et d’examiner rapidement les modifications afin de réduire la durée nécessaire aux tests des fonctionnalités ayant 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 de Cloud Manager, les développeurs et les développeuses utilisent des outils de ligne de commande pour synchroniser le code d’un environnement de développement local avec le RDE. Une fois les modifications testées avec succès dans un RDE, déployez-les dans un environnement de développement Cloud standard via le pipeline de Cloud Manager, qui place le code par le biais des points de contrôle qualité appropriés.

Modes d’exécution runmodes

Dans les solutions AEM existantes, les clients et les clientes 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 le service (création et publication) et l’environnement (RDE, développement, évaluation et 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 bundles OSGI et la configuration OSGI peuvent être mappés sur ces modes :

AEM as a Cloud Service ne permet pas d’utiliser des modes d’exécution pour installer du contenu destiné à des environnements ou des services spécifiques. Si un environnement de développement doit être alimenté avec des données ou un HTML qui ne se trouvent 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 :

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 maintenance-tasks-configuration-in-source-control

Les configurations de tâches de maintenance doivent être conservées dans le contrôle de la source, car l’écran Outils > Opérations n’est plus disponible dans les environnements cloud. Cet avantage permet de s’assurer que les modifications sont intentionnellement conservées, plutôt qu’appliquées de manière réactive et oubliées. Voir Tâches de maintenance dans AEM as a Cloud Service pour plus d’informations.