CRX2Oak est un outil qui a été conçu pour effectuer la migration des données entre différents référentiels.
Il peut être utilisé pour migrer des données à partir d’anciennes versions CQ basées sur Apache Jackrabbit 2 vers Oak, et peut aussi être utilisé pour copier des données entre référentiels Oak.
Vous pouvez télécharger la dernière version de crx2oak à partir du référentiel public Adobe à cet emplacement :
https://repo1.maven.org/maven2/com/adobe/granite/crx2oak/
La liste de modifications et correctifs pour la dernière version est disponible via les notes de mise à jour pour CRX2Oak.
Pour en savoir plus sur Apache Oak les conceptes clés de persistence AEM, voir Introduction à la plateforme AEM.
L’outil peut être utilisé pour :
La prise en charge pour la migration des référentiels à l’aide d’entrepôts Blob externes (communément appelés entrepôts de données) est fournie selon différentes combinations. Un chemin de migration possible est issu d’un référentiel CRX2 qui utilise une FileDataStore
vers un référentiel Oak à l’aide d’une S3DataStore
.
Le diagramme ci-dessous montre toutes les combinaisons de migration possibles prises en charge par CRX2Oak :
CRX2Oak est appelé durant les mises à niveau d’AEM d’une façon permettant à l’utilisateur de spécifier un profile de migration prédéfini qui automatise la reconfiguration des modes de persistence. Cela s’appelle le mode quickstart.
Il peut également être exécuté séparément s’il requiert plus de personnalisations. Toutefois, veuillez noter qu’avec ce mode, les modifications s’appliquent uniquement au référentiel et toute reconfiguration supplémentaire d’AEM doit être effectuée manuellement. Cela s’appelle le mode autonome.
Veuillez aussi noter que si les paramètres par défaut sont en mode autonome, seuls les entrepôts de nœuds seront migrés, et le nouveau référentiel réutilisera l’ancien entrepôt binaire.
Depuis AEM 6.3, CRX2Oak est capable de gérer les profils de migration définis par l’utilisateur pouvant être configurés avec toutes les options de migration disponibles. Cela offre plus de flexibilité et donne la capacité d’automatiser la configuration d’AEM; des caractéristiques qui ne sont pas disponibles si vous utilisez l’outil en mode autonome.
Pour passer CRX2Oak en mode de démarrage rapide, vous avez besoin de définir le chemin vers le dossier crx-quickstart dans le répertoire d’installation d’AEM via cette variable d’environnement du système d’exploitation :
Pour les systèmes basés sur UNIX et Mac OS :
export SLING_HOME="/path/to/crx-quickstart"
Pour Windows :
SET "SLING_HOME=/path/to/crx-quickstart"
La migration peut être interrompue à tout moment avec la possibilité de la redémarrer par la suite.
La logique Java personnalisé peut également être mise en œuvre en utilisant CommitHooks
. Les classes RepositoryInitializer
personnalisées peuvent être mises en œuvre pour initialiser le référentiel avec des valeures personnalisées.
CRX2Oak prend également en charge les opérations de mappage de la mémoire par défaut. Le mappage de la mémoire permet d’améliorer grandement la performance et doit être utilisé chaque fois que cela est possible.
Veuillez noter toutefois que les opérations de mappage de la mémoire ne sont pas prises en charge pour les plateformes Windows. Il est donc recommandé d’ajouter la variable —disable-mmap lors de la migration sous Windows.
Par défaut, l’outil migre l’ensemble du référentiel sous la "/"
chemin d’accès. Néanmoins, vous avez un contrôle total du contenu devant être migré.
Si une partie du contenu n’est pas requise sur la nouvelle instance, vous pouvez utiliser la variable --exclude-path
pour exclure le contenu et optimiser la procédure de mise à niveau.
Si des données doivent être copiées entre deux référentiels et que vous disposez d’un chemin de contenu différent sur les deux instances, vous pouvez le définir dans la variable --merge-path
. Une fois que cela est fait, CRX2Oak copie uniquement les nouveaux nœuds dans le référentiel de destination tout en gardant les anciens en place.
AEM crée par défaut une version de chaque nœud ou page modifié, pour ensuite le stocker dans le référentiel. Les versions peuvent alors être utilisées pour restaurer la page à un état antérieur.
Néanmoins, ces versions ne sont jamais purgées, même si la page originale est supprimée. Les migrations effectuées avec des référentiels utilisés depuis très longtemps peuvent avoir besoin de traiter beaucoup de données redondantes, à cause des versions orphelines.
L’ajout de la variable --copy-versions
. Il peut être utilisé pour ignorer les noeuds de version pendant la migration ou la copie d’un référentiel.
Vous pouvez aussi choisir de copier des versions orphelines en ajoutant le paramètre --copy-orphaned-versions=true
.
Les deux paramètres prennent également en charge une YYYY-MM-DD
format de date, au cas où vous souhaitez copier des versions au plus tard à une date spécifique.
Une version Open Source de CRX2Oak est disponible sous forme de mise à niveau Oak. Elle prend en charge toutes les fonctions, sauf :
Voir Documentation Apache pour plus d’informations.
--cache
: Taille du cache en Mo (la valeur par défaut est 256
)
--mmap
: Activation de l’accès aux fichiers mappés en mémoire pour le magasin de segments
--src-password:
Mot de passe de la base de données RDB source
--src-user:
Utilisateur de la RDB source
--user
: Utilisateur de la base de données régionale ciblée
--password
: Mot de passe de la RDB cible.
--early-shutdown
: Ferme le référentiel source JCR2 après la copie des noeuds et avant l’application des commit hooks.
--fail-on-error
: Force l’échec de la migration si les noeuds ne peuvent pas être lus à partir du référentiel source.
--ldap
: Migration des utilisateurs LDAP d’une instance CQ 5.x vers une instance Oak. Pour que cela fonctionne, le fournisseur d’identité dans la configuration Oak doit être nommé ldap. Pour plus d’informations, consultez la documentation LDAP.
--ldap-config:
Utilisez-le conjointement avec la fonction --ldap
pour les référentiels CQ 5.x qui utilisaient plusieurs serveurs LDAP pour l’authentification. Vous pouvez l’utiliser pour pointer vers CQ 5.x. ldap_login.conf
ou jaas.conf
fichiers de configuration. Le format est --ldapconfig=path/to/ldap_login.conf
.
--copy-orphaned-versions
: Ignore la copie des versions orphelines. Les paramètres pris en charge sont les suivants : true
, false
et yyyy-mm-dd
. La valeur par défaut est true
.
--copy-versions:
Copie le stockage de la version. Paramètres: true
, false
, yyyy-mm-dd
. La valeur par défaut est true
.
--include-paths:
Liste séparée par des virgules des chemins à inclure lors de la copie--merge-paths
: Liste séparée par des virgules des chemins à fusionner lors de la copie--exclude-paths:
Liste séparée par des virgules des chemins à exclure lors de la copie.--src-datastore:
Répertoire de la banque de données à utiliser comme source FileDataStore
--src-fileblobstore
: Répertoire de la banque de données à utiliser comme source FileBlobStore
--src-s3datastore
: Répertoire de la banque de données à utiliser pour la source S3DataStore
--src-s3config
: Le fichier de configuration de la source S3DataStore
.
--datastore:
Répertoire de la banque de données à utiliser comme cible FileDataStore
--fileblobstore:
Répertoire de la banque de données à utiliser comme cible FileBlobStore
--s3datastore
: Répertoire de la banque de données à utiliser pour la cible S3DataStore
--s3config
: Le fichier de configuration de la cible S3DataStore
.
-?, -h, --help:
Affiche les informations d’aide.Vous pouvez aussi activer les informations de débogage pour le processus de migration afin de pouvoir résoudre tout problème pouvant survenir durant le processus. Vous pouvez effectuer cette opération différemment selon le mode sur lequel vous souhaitez exécuter l’outil :
Mode CRX2Oak | Action |
Mode démarrage rapide | Vous pouvez ajouter la variable —TRACE de niveau journal ou —log-level DEBUG options de la ligne de commande lors de l’exécution de CRX2Oak. Dans ce mode, les journaux sont automatiquement redirigés vers fichier upgrade.log. |
Mode autonome | Ajoutez la variable —trace options de la ligne de commande CRX2Oak pour afficher les événements de TRACE sur la sortie standard (vous devez rediriger les journaux vous-même à l’aide du caractère de redirection : Commande ">" ou "tee" pour une inspection ultérieure). |
Lors de la migration vers un ensemble de réplications MongoDB, assurez-vous de configurer le paramètre WriteConcern
sur 2
pour toutes les connexions aux bases de données Mongo.
Vous pouvez le faire en ajoutant le paramètre w=2
à la fin de la chaîne de connexion, comme suit :
java -Xmx4092m -XX:MaxPermSize=1024m -jar crx2oak.jar crx-quickstart/repository/ mongodb://localhost:27017/aem-author?replicaset=replica1&w=2
Pour plus d’informations, voir la documentation de chaîne de connexion MongoDB sur les problèmes d’écriture.