Connecteur Confluence V2.0 - Amazon Kendra
Fonctionnalités prises en chargePrérequisInstructions de connexion

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Connecteur Confluence V2.0

Confluence est un outil de gestion du travail collaboratif conçu pour partager, stocker et travailler sur la planification de projets, le développement de logiciels et la gestion de produits. Vous pouvez l'utiliser Amazon Kendra pour indexer vos espaces Confluence, vos pages (y compris les pages imbriquées), vos blogs, ainsi que vos commentaires et pièces jointes vers des pages et des blogs indexés.

Pour résoudre les problèmes liés à votre connecteur de source de données Amazon Kendra Confluence, consultezDépannage des sources de données.

Fonctionnalités prises en charge

Amazon Kendra Le connecteur de source de données Confluence prend en charge les fonctionnalités suivantes :

  • Mappages de champs

  • Contrôle d'accès utilisateur

  • Schémas d'inclusion/exclusion

  • Synchronisation complète et incrémentielle du contenu

  • Cloud privé virtuel (VPC)

Prérequis

Avant de pouvoir Amazon Kendra indexer votre source de données Confluence, apportez ces modifications à votre Confluence et AWS à vos comptes.

Dans Confluence, assurez-vous que vous disposez des éléments suivants :

  • Vous avez copié l'URL de votre instance Confluence. Par exemple : https://example.confluence.com, https://www.example.confluence.com/ ou https ://atlassian.net/. Vous avez besoin de l'URL de votre instance Confluence pour vous connecter Amazon Kendra.

    Si vous utilisez Confluence Cloud, l'URL de votre hôte doit se terminer par atlassian.net/.

    Note

    Les formats d'URL suivants ne sont pas pris en charge :

    • https://example.confluence.com/xyz

    • https://www.example.confluence.com//wiki/spacekey/xxx

    • https://atlassian.net/xyz

    Note

    (Sur place/sur serveur) Amazon Kendra vérifie si les informations de point de terminaison incluses sont les mêmes AWS Secrets Manager que celles spécifiées dans les détails de configuration de votre source de données. Cela permet de se protéger contre le problème de confusion des adjoints, qui est un problème de sécurité lorsqu'un utilisateur n'est pas autorisé à effectuer une action mais l'utilise Amazon Kendra comme proxy pour accéder au secret configuré et exécuter l'action. Si vous modifiez ultérieurement les informations de votre point de terminaison, vous devez créer un nouveau secret pour synchroniser ces informations.

  • Identifiants d'authentification de base configurés contenant un nom d'utilisateur (identifiant e-mail utilisé pour se connecter à Confluence) et un mot de passe (jeton d'API Confluence comme mot de passe). Consultez Gérer les jetons d'API pour votre compte Atlassian.

    Note

    Nous vous recommandons d'actualiser ou de modifier régulièrement vos informations d'identification et votre code secret. Fournissez uniquement le niveau d'accès nécessaire pour votre propre sécurité. Nous vous déconseillons de réutiliser les informations d'identification et les secrets entre les sources de données et les versions 1.0 et 2.0 du connecteur (le cas échéant).

  • Facultatif : informations d'identification OAuth 2.0 configurées contenant une clé d'application Confluence, un secret d'application Confluence, un jeton d'accès Confluence et un jeton d'actualisation Confluence pour permettre Amazon Kendra la connexion à votre instance Confluence. Si votre jeton d'accès expire, vous pouvez utiliser le jeton d'actualisation pour régénérer votre jeton d'accès et actualiser la paire de jetons. Vous pouvez également répéter le processus d'autorisation. Pour plus d'informations sur les jetons d'accès, voir Gérer les jetons d'accès OAuth.

  • (Pour le serveur ou le centre de données Confluence uniquement) Facultatif : vous avez configuré un jeton d'accès personnel (PAT) dans Confluence. Consultez la section Utilisation de jetons d'accès personnels.

Dans votre Compte AWS, assurez-vous d'avoir :

  • Création d'un Amazon Kendra index et, si vous utilisez l'API, notez l'ID de l'index.

  • Vous avez créé un IAM rôle pour votre source de données et, si vous utilisez l'API, notez l'ARN du IAM rôle.

    Note

    Si vous modifiez votre type d'authentification et vos informations d'identification, vous devez mettre à jour votre IAM rôle pour accéder au bon identifiant AWS Secrets Manager secret.

  • Stockez vos informations d'authentification Confluence dans un AWS Secrets Manager secret et, si vous utilisez l'API, notez l'ARN du secret.

    Note

    Nous vous recommandons d'actualiser ou de modifier régulièrement vos informations d'identification et votre code secret. Fournissez uniquement le niveau d'accès nécessaire pour votre propre sécurité. Nous vous déconseillons de réutiliser les informations d'identification et les secrets entre les sources de données et les versions 1.0 et 2.0 du connecteur (le cas échéant).

Si vous n'avez pas de IAM rôle ou de secret existant, vous pouvez utiliser la console pour créer un nouveau IAM rôle et un nouveau Secrets Manager secret lorsque vous connectez votre source de données Confluence à Amazon Kendra. Si vous utilisez l'API, vous devez fournir l'ARN d'un IAM rôle et d'un Secrets Manager secret existants, ainsi qu'un identifiant d'index.

Instructions de connexion

Pour vous connecter Amazon Kendra à votre source de données Confluence, vous devez fournir les informations nécessaires sur votre source de données Confluence afin de Amazon Kendra pouvoir accéder à vos données. Si vous n'avez pas encore configuré Confluence pour Amazon Kendra voirPrérequis.

Console

Pour vous connecter Amazon Kendra à Confluence

  1. Connectez-vous à la Amazon Kendra console AWS Management Console et ouvrez-la.

  2. Dans le volet de navigation de gauche, choisissez Index, puis choisissez l'index que vous souhaitez utiliser dans la liste des index.

    Note

    Vous pouvez choisir de configurer ou de modifier vos paramètres de contrôle d'accès utilisateur dans les paramètres de l'index.

  3. Sur la page de démarrage, choisissez Ajouter une source de données.

  4. Sur la page Ajouter une source de données, choisissez le connecteur Confluence, puis sélectionnez Ajouter un connecteur. Si vous utilisez la version 2 (le cas échéant), choisissez le connecteur Confluence avec le tag « V2.0 ».

  5. Sur la page Spécifier les détails de la source de données, entrez les informations suivantes :

    1. Dans Nom et description, pour Nom de la source de données : entrez le nom de votre source de données. Vous pouvez inclure des traits d'union, mais pas des espaces.

    2. (Facultatif) Description : entrez une description facultative pour votre source de données.

    3. Dans la langue par défaut : choisissez une langue pour filtrer vos documents pour l'index. Sauf indication contraire, la langue par défaut est l'anglais. La langue spécifiée dans les métadonnées du document remplace la langue sélectionnée.

    4. Dans Balises, pour Ajouter une nouvelle balise : incluez des balises facultatives pour rechercher et filtrer vos ressources ou suivre vos AWS coûts.

    5. Choisissez Suivant.

  6. Sur la page Définir l'accès et la sécurité, entrez les informations suivantes :

    1. Dans Source, choisissez Confluence Cloud ou Confluence Server/Data Center.

    2. URL de confluence —Entrez l'URL de l'hôte Confluence. Par exemple, https://example.confluence.com.

    3. (Pour Confluence Server/Data Center uniquement) Emplacement du certificat SSL - facultatif —Entrez le Amazon S3 chemin d'accès à votre fichier de certificat SSL pour Confluence Server.

    4. (Pour le serveur Confluence ou le centre de données uniquement) Proxy Web - facultatif : entrez le nom d'hôte du proxy Web (sans le https:// protocole http:// or) et le numéro de port (port utilisé par le protocole de transport d'URL de l'hôte). Le numéro de port doit être une valeur numérique comprise entre 0 et 65535.

    5. Autorisation : activez ou désactivez les informations de la liste de contrôle d'accès (ACL) pour vos documents, si vous disposez d'une ACL et que vous souhaitez l'utiliser pour le contrôle d'accès. L'ACL indique les documents auxquels les utilisateurs et les groupes peuvent accéder. Les informations ACL sont utilisées pour filtrer les résultats de recherche en fonction de l'accès de l'utilisateur ou de son groupe aux documents. Pour plus d'informations, consultez la section Filtrage du contexte utilisateur.

    6. Authentification : choisissez l'authentification de base, l'authentification Oauth 2.0 ou (pour Confluence Server/Data Center uniquement) l'authentification par jeton d'accès personnel.

    7. AWS Secrets Manager secret —Choisissez un secret existant ou créez-en un nouveau Secrets Manager pour stocker vos identifiants d'authentification Confluence. Si vous choisissez de créer un nouveau secret, une fenêtre AWS Secrets Manager secrète s'ouvre. Entrez les informations suivantes dans la fenêtre :

      1. Nom secret : le nom de votre secret. Le préfixe « AmazonKendra -Confluence-» est automatiquement ajouté à votre nom secret.

      2. Si vous utilisez l'authentification de base, entrez le nom secret, le nom d'utilisateur et le mot de passe (jeton d'API Confluence comme mot de passe) que vous avez configurés dans Confluence.

        Si vous utilisez l'authentification OAuth2.0, entrez le nom secret, la clé de l'application, le secret de l'application, le jeton d'accès et le jeton d'actualisation que vous avez configurés dans Confluence.

        (Serveur/centre de données Confluence uniquement) Si vous utilisez l'authentification par jeton d'accès personnel, entrez le nom secret et le jeton Confluence que vous avez configurés dans votre Confluence.

      3. Enregistrez et ajoutez votre secret.

    8. Virtual Private Cloud (VPC) —Vous pouvez choisir d'utiliser un VPC. Dans ce cas, vous devez ajouter des sous-réseaux et des groupes de sécurité VPC.

    9. Identity Crawler : spécifiez s'il faut activer l'explorateur Amazon Kendra d'identité. Le robot d'exploration d'identité utilise les informations de la liste de contrôle d'accès (ACL) de vos documents pour filtrer les résultats de recherche en fonction de l'accès de l'utilisateur ou de son groupe aux documents. Si vous disposez d'une ACL pour vos documents et que vous choisissez de l'utiliser, vous pouvez également choisir d'activer le robot d'exploration Amazon Kendra d'identité pour configurer le filtrage des résultats de recherche par contexte utilisateur. Sinon, si le robot d'identification est désactivé, tous les documents peuvent être consultés publiquement. Si vous souhaitez utiliser le contrôle d'accès pour vos documents et que le robot d'exploration d'identité est désactivé, vous pouvez également utiliser l'PutPrincipalMappingAPI pour télécharger les informations d'accès des utilisateurs et des groupes afin de filtrer le contexte utilisateur.

    10. IAM rôle —Choisissez un IAM rôle existant ou créez-en un nouveau IAM pour accéder aux informations d'identification de votre référentiel et indexer le contenu.

      Note

      IAM les rôles utilisés pour les index ne peuvent pas être utilisés pour les sources de données. Si vous ne savez pas si un rôle existant est utilisé pour un index ou une FAQ, choisissez Créer un nouveau rôle pour éviter les erreurs.

    11. Choisissez Suivant.

  7. Sur la page Configurer les paramètres de synchronisation, entrez les informations suivantes :

    1. Dans la zone de synchronisation, pour Synchroniser le contenu : choisissez de synchroniser les types de contenu suivants : pages, commentaires de page, pièces jointes de page, blogs, commentaires de blog, pièces jointes de blog, espaces personnels et espaces archivés.

      Note

      Les commentaires de page et les pièces jointes aux pages ne peuvent être sélectionnés que si vous choisissez de synchroniser les pages. Les commentaires de blog et les pièces jointes de blog ne peuvent être sélectionnés que si vous choisissez de synchroniser les blogs.

      Important

      Si vous ne spécifiez pas de modèle d'expression régulière avec touche d'espace dans Configuration supplémentaire, toutes les pages et tous les blogs seront explorés par défaut.

    2. Dans Configuration supplémentaire, pour Taille de fichier maximale : spécifiez la taille maximale du fichier à analyser, en Mo Amazon Kendra . Amazon Kendra explorera uniquement les fichiers dans la limite de taille que vous avez définie. La taille de fichier par défaut est de 50 Mo. La taille maximale du fichier doit être supérieure à 0 Mo et inférieure ou égale à 50 Mo.

      Pour les modèles de regex Spaces : spécifiez si vous souhaitez inclure ou exclure des espaces spécifiques dans votre index en utilisant :

      • Touche espace (par exemple, my-space-123)

        Note

        Si vous ne spécifiez pas de modèle d'expression régulière avec une touche espace, toutes les pages et tous les blogs seront explorés par défaut.

      • URL (par exemple,. *//MySiteMyDocuments/)

      • Type de fichier (par exemple, .* \ .pdf, .* \ .txt)

      Pour les modèles d'expression régulière des titres d'entités : spécifiez des modèles d'expressions régulières pour inclure ou exclure certains blogs, pages, commentaires et pièces jointes par titre.

      Note

      Si vous souhaitez inclure ou exclure l'exploration d'une page ou d'une sous-page spécifique, vous pouvez utiliser des modèles réguliers de titre de page.

    3. Mode de synchronisation : choisissez la manière dont vous souhaitez mettre à jour votre index lorsque le contenu de votre source de données change. Lorsque vous synchronisez votre source de données Amazon Kendra pour la première fois, tout le contenu est analysé et indexé par défaut. Vous devez exécuter une synchronisation complète de vos données en cas d'échec de la synchronisation initiale, même si vous ne choisissez pas l'option de synchronisation complète comme mode de synchronisation.

      • Synchronisation complète : Indexez tout le contenu fraîchement, en remplaçant le contenu existant chaque fois que votre source de données se synchronise avec votre index.

      • Synchronisation nouvelle, modifiée ou supprimée : Indexez uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données se synchronise avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.

    4. Dans Calendrier d'exécution de la synchronisation, pour Fréquence : choisissez la fréquence à laquelle vous souhaitez synchroniser le contenu de votre source de données et mettre à jour votre index.

    5. Choisissez Suivant.

  8. Sur la page Définir les mappages de champs, entrez les informations suivantes :

    1. Sélectionnez parmi les champs de source de données par défaut Amazon Kendra générés que vous souhaitez mapper à votre index. Pour ajouter des champs de source de données personnalisés, créez un nom de champ d'index à mapper et le type de données du champ.

    2. Choisissez Suivant.

  9. Sur la page Réviser et créer, vérifiez que les informations saisies sont correctes, puis sélectionnez Ajouter une source de données. Vous pouvez également choisir de modifier vos informations depuis cette page. Votre source de données apparaîtra sur la page Sources de données une fois que la source de données aura été ajoutée avec succès.

API

Pour vous connecter Amazon Kendra à Confluence

Vous devez spécifier un JSON du schéma de source de données à l'aide de l'TemplateConfigurationAPI. Vous devez fournir les informations suivantes :

  • Source de données —Spécifiez le type de source de données tel que CONFLUENCEV2 lorsque vous utilisez le schéma TemplateConfigurationJSON. Spécifiez également la source de données TEMPLATE lorsque vous appelez l'CreateDataSourceAPI.

  • URL de l'hôte —Spécifiez l'instance de l'URL hôte Confluence. Par exemple, https://example.confluence.com.

  • Mode de synchronisation : spécifiez comment Amazon Kendra mettre à jour votre index lorsque le contenu de votre source de données change. Lorsque vous synchronisez votre source de données Amazon Kendra pour la première fois, tout le contenu est analysé et indexé par défaut. Vous devez exécuter une synchronisation complète de vos données en cas d'échec de la synchronisation initiale, même si vous ne choisissez pas l'option de synchronisation complète comme mode de synchronisation. Vous pouvez choisir entre :

    • FORCED_FULL_CRAWLpour indexer à nouveau tout le contenu, en remplaçant le contenu existant chaque fois que votre source de données se synchronise avec votre index.

    • FULL_CRAWLpour indexer uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données se synchronise avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.

  • Type d'authentification : spécifiez le type d'authentification, siBasic,OAuth2, (Confluence Server uniquement). Personal-token

  • (Facultatif, pour Confluence Server uniquement) Emplacement du certificat SSL : spécifiez le S3bucketName et que s3certificateName vous avez utilisé pour stocker votre certificat SSL.

  • Nom de ressource Amazon (ARN) secret : indiquez le nom de ressource Amazon (ARN) d'un Secrets Manager secret contenant les informations d'authentification que vous avez configurées dans Confluence. Si vous utilisez l'authentification de base, le secret est stocké dans une structure JSON avec les clés suivantes : 

    {
    "username": "email ID or user name",
    "password": "Confluence API token"
}

    Si vous utilisez l'authentification OAuth 2.0, le secret est stocké dans une structure JSON avec les clés suivantes :

    {
    "confluenceAppKey": "app key",
    "confluenceAppSecret": "app secret",
    "confluenceAccessToken": "access token",
    "confluenceRefreshToken": "refresh token"
}

    (Pour Confluence Server uniquement) Si vous utilisez l'authentification de base, le secret est stocké dans une structure JSON avec les clés suivantes :

    {
    "hostUrl": "Confluence Server host URL",
    "username": "Confluence Server user name",
    "password": "Confluence Server password"
}

    (Pour Confluence Server uniquement) Si vous utilisez l'authentification par jeton d'accès personnel, le secret est stocké dans une structure JSON avec les clés suivantes :

    {
    "hostUrl": "Confluence Server host URL",
    "patToken": "personal access token"
}

  • IAM role —Spécifiez à quel RoleArn moment vous appelez CreateDataSource pour fournir à un IAM rôle les autorisations d'accéder à votre Secrets Manager secret et pour appeler les API publiques requises pour le connecteur Confluence et. Amazon Kendra Pour plus d'informations, consultez la section IAM Rôles des sources de données Confluence.

Vous pouvez également ajouter les fonctionnalités optionnelles suivantes :

  • Virtual Private Cloud (VPC) VpcConfiguration —Spécifiez le moment de votre appel. CreateDataSource Pour plus d’informations, consultez Configuration Amazon Kendra pour utiliser un Amazon VPC.

  • Taille du fichier —Spécifiez la taille maximale du fichier à analyser.

  • Types de documents/contenus : indiquez si vous souhaitez explorer les pages, les commentaires de page, les pièces jointes aux pages, les blogs, les commentaires de blog, les pièces jointes de blog, les espaces et les espaces archivés.

  • Filtres d'inclusion et d'exclusion : indiquez s'il faut inclure ou exclure certains espaces, pages, blogs, ainsi que leurs commentaires et pièces jointes.

    Note

    La plupart des sources de données utilisent des modèles d'expressions régulières, qui sont des modèles d'inclusion ou d'exclusion appelés filtres. Si vous spécifiez un filtre d'inclusion, seul le contenu correspondant au filtre d'inclusion est indexé. Tout document qui ne correspond pas au filtre d'inclusion n'est pas indexé. Si vous spécifiez un filtre d'inclusion et d'exclusion, les documents correspondant au filtre d'exclusion ne sont pas indexés, même s'ils correspondent au filtre d'inclusion.

  • Proxy Web —Spécifiez les informations de votre proxy Web si vous souhaitez vous connecter à votre instance d'URL Confluence via un proxy Web. Vous pouvez utiliser cette option pour Confluence Server.

  • Liste de contrôle d'accès (ACL) : indiquez si vous souhaitez analyser les informations ACL de vos documents, si vous disposez d'une ACL et souhaitez l'utiliser pour le contrôle d'accès. L'ACL indique les documents auxquels les utilisateurs et les groupes peuvent accéder. Les informations ACL sont utilisées pour filtrer les résultats de recherche en fonction de l'accès de l'utilisateur ou de son groupe aux documents. Pour plus d'informations, consultez la section Filtrage du contexte utilisateur.

  • Identity Crawler : spécifiez s'il faut activer l'explorateur Amazon Kendra d'identité. Le robot d'exploration d'identité utilise les informations de la liste de contrôle d'accès (ACL) de vos documents pour filtrer les résultats de recherche en fonction de l'accès de l'utilisateur ou de son groupe aux documents. Si vous disposez d'une ACL pour vos documents et que vous choisissez de l'utiliser, vous pouvez également choisir d'activer le robot d'exploration Amazon Kendra d'identité pour configurer le filtrage des résultats de recherche par contexte utilisateur. Sinon, si le robot d'identification est désactivé, tous les documents peuvent être consultés publiquement. Si vous souhaitez utiliser le contrôle d'accès pour vos documents et que le robot d'exploration d'identité est désactivé, vous pouvez également utiliser l'PutPrincipalMappingAPI pour télécharger les informations d'accès des utilisateurs et des groupes afin de filtrer le contexte utilisateur.

  • Mappages de champs : choisissez de mapper les champs de votre source de données Confluence à vos Amazon Kendra champs d'index. Pour plus d'informations, veuillez consulter la rubrique Mappage des champs de source de données.

    Note

    Le champ du corps du document ou l'équivalent du corps du document pour vos documents est requis pour Amazon Kendra effectuer une recherche dans vos documents. Vous devez associer le nom du champ du corps du document dans votre source de données au nom du champ d'index_document_body. Tous les autres champs sont facultatifs.

Pour obtenir la liste des autres clés JSON importantes à configurer, consultez le schéma du modèle Confluence.

Remarques

  • Le jeton d'accès personnel (PAT) n'est pas disponible pour Confluence Cloud.