Synchronisation des utilisateurs

Présentation

Lorsque le déploiement est une ferme de publication, les membres doivent pouvoir se connecter et voir leurs données sur n’importe quel nœud public.

Les utilisateurs et les groupes d’utilisateurs (données utilisateur) créés dans l’environnement de publication ne sont pas nécessaires dans l’environnement de création.

La plupart des données utilisateur créées dans l’environnement de création sont destinées à rester dans l’environnement de création et à ne pas être copiées vers les instances de publication.

L’enregistrement et les modifications effectués sur une instance de publication doivent être synchronisés avec d’autres instances de publication afin de pouvoir accéder aux mêmes données utilisateur.

Depuis AEM 6.1, lorsque la synchronisation des utilisateurs est activée, les données utilisateur sont automatiquement synchronisées sur les instances de publication dans la ferme et ne sont pas créées en mode de création.

Distribution Sling

Les données utilisateur, avec leurs ACL, sont stockées dans le cœur Oak, la couche située en dessous du JCR Oak, et sont accessibles via l’API Oak. Du fait de mises à jour peu fréquentes, il est judicieux que les données utilisateur soient synchronisées avec d’autres instances de publication à l’aide de la Distribution de contenu Sling.

Les avantages de la synchronisation des utilisateurs à l’aide de la distribution Sling par rapport à la réplication traditionnelle sont les suivants :

  • Les utilisateurs, les profils d’utilisateur et les groupes d’utilisateurs créés à la publication ne sont pas créés en mode de création.

  • La distribution Sling définit des propriétés dans les événements JCR, permettant d’agir au niveau des écouteurs d’événements du côté publication sans se préoccuper des boucles de réplication infinies.

  • La distribution Sling envoie uniquement les données utilisateur à des instances de publication non originaires, ce qui élimine le trafic inutile.

  • Les ACL définies dans le nœud d’utilisateur sont incluses dans la synchronisation.

REMARQUE

Si des sessions sont requises, il est conseillé d’utiliser une solution SSO ou une session persistante et de demander aux client(e)s de se connecter s’ils basculent vers une autre instance de publication.

ATTENTION

La synchronisation du groupe d’administration n’est pas prise en charge, même si la synchronisation des utilisateurs est activée. À la place, un échec de l’importation de la comparaison est consigné dans le journal des erreurs.

Par conséquent, lorsque le déploiement est une batterie de publication, si un utilisateur ou une utilisatrice est ajouté(e) ou supprimé(e) dans le groupe d’administration, la modification doit être effectuée manuellement sur chaque instance de publication.

Activation de la synchronisation des utilisateurs

REMARQUE

Par défaut, la synchronisation des utilisateurs est disabled.

Activer la synchronisation des utilisateurs implique de modifier les configurations OSGi existantes.

Aucune configuration nouvelle ne doit être ajoutée suite à l’activation de la synchronisation des utilisateurs.

La synchronisation des utilisateurs repose sur l’environnement de création pour gérer les distributions de données utilisateur, même si les données utilisateur ne sont pas créées en mode de création. Une grande partie, mais pas l’intégralité, de la configuration a lieu dans l’environnement de création et chaque étape identifie clairement si elle doit être effectuée en mode de création ou en mode de publication.

Vous trouverez ci-dessous les étapes nécessaires pour activer la synchronisation des utilisateurs, suivies d’une section Résolution des incidents :

Prérequis

  1. Si les utilisateurs et utilisatrices et les groupes d’utilisateurs ont déjà été créés sur une instance de publication, il est recommandé de synchroniser manuellement les données utilisateur sur toutes les instances de publication avant de configurer et d’activer la synchronisation des utilisateurs.

Une fois la synchronisation des utilisateurs activée, seuls les utilisateurs et utilisatrices et les groupes nouvellement créés sont synchronisés.

  1. Assurez-vous que la dernière version du code a été installée :

1. Agent de distribution Apache Sling - Fabrique d’agents de synchronisation

Activer la synchronisation des utilisateurs

  • en mode de création

    • connectez-vous avec des autorisations d’administrateur

    • accédez à la console Web

    • localisez Apache Sling Distribution Agent - Sync Agents Factory

      • sélectionnez la configuration existante à ouvrir pour modification (icône de crayon)
        Vérifiez name : socialpubsync

      • sélectionnez la case à cocher Enabled

      • sélectionnez Save

2. Créez l’utilisateur autorisé

Configurez des autorisations
Cet utilisateur autorisé sera utilisé à l’étape 3 pour configurer la distribution Sling en mode de création.

ATTENTION

Un nouvel utilisateur doit être créé.

  • L’utilisateur affecté par défaut est l’utilisateur admin.
  • Ne pas utiliser communities-user-admin user.

Comment ajouter une ACL

  • accédez à CRXDE Lite

  • sélectionnez le nœud /home

  • dans le volet de droite, sélectionnez l’onglet Access Control

  • sélectionnez le bouton + pour ajouter une entrée ACL

    • Principal : recherchez l’utilisateur créé pour la synchronisation des utilisateurs
    • Type : Allow
    • Autorisations : jcr:all
    • Restrictions rep:glob: */activities/*
    • sélectionnez OK

  • sélectionnez Enregistrer tout

Voir également

3. Distribution Adobe Granite - Fournisseur secret du transport de mot de passe chiffré

Configurer les autorisations

Une fois qu’un utilisateur autorisé, membre du groupe d’utilisateurs administrators, a été créé sur toutes les instances de publication, cet utilisateur autorisé doit être identifié en mode de création comme étant autorisé à synchroniser les données utilisateur de la création à la publication.

  • en mode de création

    • connectez-vous avec des autorisations d’administrateur

    • accédez à la console Web

    • localisez com.adobe.granite.distribution.core.impl.CryptoDistributionTransportSecretProvider.name

    • sélectionnez la configuration existante à ouvrir pour modification (icône de crayon)
      Vérifiez property name : socialpubsync-publishUser

    • définissez le nom d’utilisateur et le mot de passe de l’utilisateur autorisé créé en mode de publication à l’étape 2

      • par exemple, usersync-admin

4. Agent de distribution Apache Sling - Fabrique d’agents de file d’attente

Activer la synchronisation des utilisateurs

  • sur chaque instance de publication :

    • connectez-vous avec des autorisations d’administrateur

    • accédez à la console Web

    • localisez Apache Sling Distribution Agent - Queue Agents Factory

      • sélectionnez la configuration existante à ouvrir pour modification (icône de crayon)
        Vérifiez Name : socialpubsync-reverse

      • sélectionnez la case à cocher Enabled

      • sélectionnez Save

    • répétez l’opération pour chaque instance de publication.

5. Synchronisation Adobe Social - Fabrique d’observateurs diff.

Activez la synchronisation des groupes

  • sur chaque instance de publication :

    • connectez-vous avec des autorisations d’administrateur

    • accédez à la console Web

    • localisez Adobe Social Sync - Diff Observer Factory

      • sélectionnez la configuration existante à ouvrir pour modification (icône de crayon)

        Vérifier agent name : socialpubsync-reverse

      • sélectionnez la case à cocher Enabled

      • sélectionnez Save

6. Déclencheur de distribution Apache Sling - Fabrique de déclencheurs planifiés

(Facultatif) modifiez l’intervalle d’interrogation

Par défaut, l’auteur interroge les modifications toutes les 30 secondes. Pour modifier cet intervalle :

  • en mode de création

    • connectez-vous avec des autorisations d’administrateur

    • accédez à la console Web

    • localisez Apache Sling Distribution Trigger - Scheduled Triggers Factory

      • sélectionnez la configuration existante à ouvrir pour modification (icône de crayon)

        • Vérifier Name : socialpubsync-scheduled-trigger

      • définissez l’Interval in Seconds à l’intervalle souhaité.

      • sélectionnez Save

Configuration de plusieurs instances de publication

La configuration par défaut couvre une instance de publication unique. Puisque l’objectif de l’activation de la synchronisation des utilisateurs est de synchroniser plusieurs instances de publication (par exemple, pour une ferme de publication), les instances de publication supplémentaires doivent être ajoutées à la fabrique d’agents de synchronisation.

7. Agent de distribution Apache Sling - Fabrique d’agents de synchronisation

Ajoutez des instances de publication :

  • en mode de création

    • connectez-vous avec des autorisations d’administrateur

    • accédez à la console Web

    • localisez Apache Sling Distribution Agent - Sync Agents Factory

      • sélectionnez la configuration existante à ouvrir pour modification (icône de crayon)
        Vérifiez Name : socialpubsync

  • Points d’entrée de l’exportateur
    Il doit exister un point d’entrée de l’exportateur pour chaque instance de publication. Par exemple, s’il existe 2 instances de publication, localhost:4503 et 4504, il doit y avoir 2 entrées :

    • https://localhost:4503/libs/sling/distribution/services/exporters/socialpubsync-reverse
    • https://localhost:4504/libs/sling/distribution/services/exporters/socialpubsync-reverse

  • Points d’entrée de l’importateur
    Il doit exister un point d’entrée de l’importateur pour chaque instance de publication. Par exemple, s’il existe 2 instances de publication, localhost:4503 et 4504, il doit y avoir 2 entrées :

    • https://localhost:4503/libs/sling/distribution/services/importers/socialpubsync
    • https://localhost:4504/libs/sling/distribution/services/importers/socialpubsync

  • sélectionnez Save

8. Écouteur de synchronisation des utilisateurs AEM Communities

(Facultatif) Synchroniser les nœuds JCR supplémentaires

S’il existe des données personnalisées à synchroniser sur plusieurs instances de publication, alors :

  • sur chaque instance de publication :

    • connectez-vous avec des autorisations d’administrateur

    • accédez à la console Web

      • par exemple, https://localhost:4503/system/console/configMgr

    • localisez AEM Communities User Sync Listener

    • sélectionnez la configuration existante à ouvrir pour modification (icône de crayon)
      Vérifiez Name : socialpubsync-scheduled-trigger

  • Types de nœuds
    Il s’agit de la liste des types de nœuds qui vont être synchronisés. Tout type de nœud autre que sling:Folder doit être répertorié ici (sling:folder est traité séparément).
    Liste par défaut des types de nœuds à synchroniser :

    • rep:User
    • nt:unstructured
    • nt:resource

  • Propriétés à ignorer
    Il s’agit de la liste des propriétés qui seront ignorées si une modification est détectée. Les modifications apportées à ces propriétés peuvent être synchronisées comme effet secondaire d’autres modifications (la synchronisation ayant toujours lieu au niveau du nœud), mais les modifications apportées à ces propriétés ne déclenchent pas en elles-mêmes de synchronisation.
    Propriété par défaut à ignorer :

    • cq:lastModified

  • Nœuds à ignorer
    Sous-chemins d’accès allant être entièrement ignorés pendant la synchronisation. Aucun élément figurant dans ces sous-chemins d’accès ne sera synchronisé à un moment donné.
    Nœuds par défaut à ignorer :

    • .tokens
    • system

  • Dossiers distribués
    La plupart des nœuds sling:Folders sont ignorés, car la synchronisation n’est pas nécessaire. Les quelques exceptions sont répertoriées ici.
    Dossiers par défaut à synchroniser

    • segments/scoring
    • social/relationships
    • activities

9. Identifiant Sling unique

ATTENTION

Si l’identifiant Sling correspond à deux instances de publication ou plus, la synchronisation de groupe d’utilisateurs échoue.

Si l’identifiant Sling est identique pour plusieurs instances de modification dans une ferme de publication, les groupes d’utilisateurs ne sont pas synchronisés.

Pour vérifier que toutes les valeurs d’identifiant Sling diffèrent, sur chaque instance de publication :

  1. accédez à http://<host>:<port>/system/console/status-slingsettings
  2. vérifiez la valeur de l’identifiant Sling

Si l’identifiant Sling d’une instance de publication correspond à l’identifiant Sling d’une autre instance de publication, alors :

  1. arrêtez l’une des instances de publication qui possède un identifiant Sling correspondant

  2. dans le répertoire crx-quickstart/launchpad/felix

    • recherchez et supprimez le fichier nommé sling.id.file

      • par exemple, sur un système Linux :
        rm -i $(find . -type f -name sling.id.file)

      • par exemple, sur un système Windows :
        use windows explorer and search for *sling.id.file*

  3. démarrez l’instance de publication

    • au démarrage, un nouvel identifiant Sling lui est affecté

  4. vérifiez que l’identifiant Sling est à présent unique

Répétez ces étapes jusqu’à ce que toutes les instances de publication aient un identifiant Sling unique.

Fabrique de générateur de module vault

Pour que les mises à jour soient correctement synchronisées, il est nécessaire de modifier le générateur de module vault en vue de la synchronisation des utilisateurs :

  • pour chaque instance de publication AEM

  • accédez à la console Web

  • localisez Apache Sling Distribution Packaging - Vault Package Builder Factory

    • Builder name: socialpubsync-vlt

  • sélectionnez l’icône de modification

  • ajouter deux Package Node Filters :

    • /home/users|-.*/.tokens
    • /home/users|-.*/rep:cache

  • gestion des stratégies :

    • pour remplacer les nœuds rep:policy existants par de nouveaux nœuds, ajoutez un troisième filtre de module :

      • /home/users|+.*/rep:policy

    • pour empêcher la distribution des stratégies, définissez

      • Acl Handling: IGNORE

Fabrique de générateur de modules vault

Ce qui se produit si…

L’utilisateur s’inscrit lui-même ou modifie le profil à la publication

Par défaut, les utilisateurs et les profils créés dans l’environnement de publication (inscription automatique) n’apparaissent pas dans l’environnement de création.

Lorsque la topologie consiste en une batterie de publication et que la synchronisation des utilisateurs a été correctement configurée, l’utilisateur et le profil utilisateur sont synchronisés dans la batterie de publication à l’aide de la distribution Sling.

Les utilisateurs ou les groupes d’utilisateurs sont créés à l’aide de la console Sécurité.

Par défaut, les données utilisateur créées dans l’environnement de publication ne sont pas visibles dans l’environnement de création, et vice versa.

Lorsque la console Administration et sécurité des utilisateurs est utilisée pour ajouter de nouveaux utilisateurs dans l’environnement de publication, la synchronisation des utilisateurs synchronise les nouveaux utilisateurs et leur appartenance à un groupe sur d’autres instances de publication, si nécessaire. La synchronisation des utilisateurs synchronise également les groupes d’utilisateurs créés via la console de sécurité.

Résolution des problèmes

Comment mettre la synchronisation des utilisateurs hors ligne

Pour que la synchronisation des utilisateurs puisse être mise hors ligne, afin de supprimer une instance de publication ou de synchroniser manuellement les données, la file d’attente de distribution doit être vide et inactive.

Pour vérifier le statut de la file d’attente de distribution :

  • en mode de création :

    • utilisation de CRXDE Lite

      • recherchez des entrées dans /var/sling/distribution/packages

        • nœuds de dossier nommés selon le motif distrpackage_*

    • à l’aide du gestionnaire de modules

      • recherchez les modules en attente (pas encore installés)

        • nommés selon le motif socialpubsync-vlt*
        • créés par communities-user-admin

Lorsque la file d’attente de distribution est vide, désactivez la synchronisation des utilisateurs :

Une fois les tâches accomplies, pour réactiver la synchronisation des utilisateurs :

Diagnostics de synchronisation des utilisateurs

L’outil Diagnostics de synchronisation des utilisateurs est un outil qui vérifie la configuration et tente d’identifier les éventuels problèmes.

En mode de création, de la console principale accédez simplement à Outils, Opérations, Diagnostics, Diagnostics de synchronisation des utilisateurs.

Entrer simplement dans la console Diagnostics de synchronisation des utilisateurs a pour effet d’afficher les résultats.

Voici ce qui s’affiche lorsque la synchronisation des utilisateurs n’a pas été activée :

Comment exécuter des diagnostics pour les instances de publication

Lorsque le diagnostic est exécuté à partir de l’environnement de création, les résultats de réussite/échec incluent une section [INFO] la liste des instances de publication pour confirmation.

La liste comprend une URL de chaque instance de publication allant exécuter les diagnostics de cette instance. Le paramètre d’URL syncUser est ajouté à l’URL de diagnostic avec sa valeur définie sur l’utilisateur de synchronisation autorisé créé à l’Étape 2.

Remarque : avant le lancement de l’URL, l’utilisateur de synchronisation autorisé doit déjà être connecté à cette instance de publication.

Configuration ajoutée de manière incorrecte

Lorsque la synchronisation des utilisateurs ne fonctionne pas, le problème le plus courant est que des configurations supplémentaires ont été ajoutées. À la place, la configuration par défaut existante aurait dû être modifiée.

Voici comment les configurations par défaut modifiées doivent apparaître dans la console web. Si plusieurs instances apparaissent, la configuration supplémentaire doit être supprimée.

(création) Un agent de distribution Apache Sling - Fabrique d’agents de synchronisation

(création) Des informations d’identification de transfert de distribution Apache Sling - Fournisseur secret du transfert de distribution basé sur les informations d’identification de l’utilisateur

(publication) Un agent de distribution Apache Sling - Fabrique d’agents de file d’attente

(publication) Une synchronisation Adobe Social - Fabrique d’observateurs diff.

(création) Un déclencheur de distribution Apache Sling - Fabrique de déclencheurs planifiés

Modification de l’exception d’opération pendant le traitement des réponses

Si les éléments suivants sont visibles dans le journal :

org.apache.sling.servlets.post.impl.operations.ModifyOperation Exception during response processing.

java.lang.IllegalStateException: This tree does not exist

Vérifiez alors que la section 2. Création d’un utilisateur autorisé a été correctement suivie.

Cette section décrit la création d’un utilisateur autorisé, qui existe sur toutes les instances de publication, et son identification dans la configuration OSGi « Fournisseur secret » en mode de création. Par défaut, l’utilisateur est admin.

L’utilisateur autorisé doit être fait membre du groupe utilisateurs administrators et les autorisations de ce groupe ne doivent pas être modifiées.

L’utilisateur autorisé doit avoir explicitement les autorisations et la restriction suivante sur les instances de publication :

path jcr:all rep:glob
/home X */activities/*
/home/users X */activities/*
/home/groups X */activities/*

En tant que membre du groupe d’administrators, l’utilisateur autorisé doit disposer des autorisations suivantes sur toutes les instances de publication :

path jcr:all jcr:read rep:write
/etc/packages/sling/distribution X
/libs/sling/distribution X
/var X
/var/eventing X X
/var/sling/distribution X X

La synchronisation du groupe d’utilisateurs a échoué

Si l’identifiant Sling correspond à deux instances de publication ou plus, la synchronisation de groupe d’utilisateurs échoue.

Voir la section 9. Identifiant Sling unique.

Synchronisation manuelle d’utilisateurs et de groupes d’utilisateurs

Pour configurer ou activer la synchronisation des groupes, allez à l’étape 1 : Agent de distribution Apache Sling - Fabrique d’agents de synchronisation.

Lorsqu’une instance de publication n’est plus disponible.

Lorsqu’une instance de publication n’est plus disponible, elle ne doit pas être supprimée si elle doit être de nouveau en ligne à l’avenir. Les modifications sont mises en file d’attente pour l’instance de publication et, une fois l’instance de nouveau en ligne, elles sont traitées.

Si l’instance de publication ne doit pas être remise en ligne, si elle est définitivement hors ligne, elle doit être supprimée, car l’accumulation dans la file d’attente entraînera une utilisation notable de l’espace disque dans l’environnement de création.

Lorsqu’une instance de publication est hors service, le journal de création comporte des exceptions similaires à :

28.01.2016 15:57:48.475 ERROR
 [pool-12-thread-34-org_apache_sling_distribution_queue_socialpubsync_endpoint1
 (org/apache/sling/distribution/queue/socialpubsync/endpoint1)]
 org.apache.sling.distribution.agent.impl.SimpleDistributionAgent [agent][socialpubsync] could not deliver package distrpackage_1454014575838_a2b45ec8-0400-42f3-bed8-ae09b66381cb
 org.apache.sling.distribution.packaging.DistributionPackageImportException: failed in importing package ...

Comment supprimer une instance de publication

Pour supprimer une instance de publication de l’Agent de distribution Apache Sling - Fabrique d’agents de synchronisation, la file d’attente de distribution doit être vide et inactive.

Sur cette page