Connecteur Confluence V1.0 - Amazon Kendra
Fonctionnalités prises en chargePrérequisInstructions de connexionEn savoir plus

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 V1.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 utiliser … Amazon Kendra pour indexer vos espaces Confluence, vos pages (y compris les pages imbriquées), vos blogs, ainsi que les commentaires et pièces jointes des pages et blogs indexés.

Note

Support pour le connecteur Confluence V1.0/ ConfluenceConfiguration APIdevrait prendre fin en 2023. Nous vous recommandons de migrer vers ou d'utiliser le connecteur Confluence V2.0/. TemplateConfiguration API

Pour résoudre vos problèmes Amazon Kendra Connecteur de source de données Confluence, voirDé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 des utilisateurs

  • Filtres d'inclusion/exclusion

  • (Pour Confluence Server uniquement) Cloud privé virtuel () VPC

Prérequis

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

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

  • Accordé Amazon Kendra autorisations pour afficher tout le contenu de votre instance Confluence en :

    • Fabrication Amazon Kendra un membre du confluence-administrators groupe.

    • Accorder des autorisations d'administrateur de site pour tous les espaces, blogs et pages existants.

  • Vous avez copié le fichier URL de votre instance Confluence.

  • Pour les utilisateurs SSO (authentification unique) : activation de la page Afficher sur la page de connexion pour le nom d'utilisateur et le mot de passe lorsque vous configurez les méthodes d'authentification Confluence dans Confluence Data Center.

  • Pour Confluence Server

    • Vous avez noté vos informations d'authentification de base contenant le nom d'utilisateur et le mot de passe de votre compte administratif Confluence pour vous connecter à Amazon Kendra.

      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 : vous avez généré un jeton d'accès personnel dans votre compte Confluence pour vous connecter à Amazon Kendra. Pour plus d'informations, consultez la documentation de Confluence sur la génération de jetons d'accès personnels.

  • Pour Confluence Cloud

    • Vous avez noté vos informations d'authentification de base contenant le nom d'utilisateur et le mot de passe de votre compte administratif Confluence pour vous connecter à Amazon Kendra.

  • Il est vérifié que chaque document est unique dans Confluence et dans les autres sources de données que vous prévoyez d'utiliser pour le même index. Chaque source de données que vous souhaitez utiliser pour un index ne doit pas contenir le même document dans toutes les sources de données. IDsLes documents sont globaux par rapport à un index et doivent être uniques par index.

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

  • A créé un Amazon Kendra index et, si vous utilisez leAPI, notez l'identifiant de l'index.

  • A créé un IAM rôle pour votre source de données et, si vous utilisez leAPI, notez le ARN 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 AWS Secrets Manager identifiant secret.

  • Vous avez enregistré vos identifiants d'authentification Confluence dans un AWS Secrets Manager secret et, si vous utilisez leAPI, notez le 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 secret, vous pouvez utiliser la console pour créer un nouveau IAM rôle et Secrets Manager secret lorsque vous connectez votre source de données Confluence à Amazon Kendra. Si vous utilisez leAPI, vous devez fournir le ARN IAM rôle et Secrets Manager secret et un identifiant d'index.

Instructions de connexion

Pour vous connecter Amazon Kendra à votre source de données Confluence, vous devez fournir les détails de vos informations d'identification Confluence afin que Amazon Kendra peuvent accéder à vos données. Si vous n'avez pas encore configuré Confluence pour Amazon Kendra voir Prérequis.

Console

Pour vous connecter Amazon Kendra vers Confluence

  1. Connectez-vous au AWS Console de gestion et ouvrez le Amazon Kendra console.

  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 Confluence connector V1.0, puis sélectionnez Ajouter une source de données.

  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 tirets, 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 votre AWS coûts.

    5. Choisissez Suivant.

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

    1. Choisissez entre Confluence Cloud et Confluence Server.

    2. Si vous choisissez Confluence Cloud, saisissez les informations suivantes :

      1. Confluence URL — Votre confluence. URL

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

        1. Entrez les informations suivantes dans le champ Créer un AWS Secrets Manager fenêtre secrète  :

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

          2. Pour le nom d'utilisateur et le mot de passe : entrez votre nom d'utilisateur et votre mot de passe Confluence.

          3. Choisissez Enregistrer l'authentification.

    3. Si vous choisissez Confluence Server, entrez les informations suivantes :

      1. Confluence URL : votre nom d'utilisateur et votre mot de passe Confluence.

      2. (Facultatif) Pour le proxy Web, entrez les informations suivantes :

        1. Nom d'hôte : nom d'hôte de votre compte Confluence.

        2. Numéro de port —Port utilisé par le protocole de URL transport hôte.

      3. Pour l'authentification, choisissez l'authentification de base ou le jeton d'accès personnel (Confluence Server uniquement).

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

        1. Entrez les informations suivantes dans le champ Créer un AWS Secrets Manager fenêtre secrète  :

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

          2. Pour le nom d'utilisateur et le mot de passe : entrez les valeurs d'identification d'authentification que vous avez configurées dans Confluence. Si vous utilisez l'authentification de base, utilisez votre nom d'utilisateur (identifiant e-mail) et votre mot de passe (APIjeton) Confluence. Si vous utilisez un jeton d'accès personnel, saisissez les détails du jeton d'accès personnel que vous avez configuré dans le compte Confluence.

          3. Enregistrez et ajoutez votre secret.

    4. IAM rôle —Choisissez un rôle existant IAM rôle ou création d'un nouveau IAM rôle pour accéder aux informations d'identification de votre référentiel et au contenu de l'index.

      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 indexFAQ, choisissez Créer un nouveau rôle pour éviter les erreurs.

    5. Choisissez Suivant.

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

    1. Pour Inclure les espaces personnels et Inclure les espaces archivés, choisissez les types d'espaces facultatifs à inclure dans cette source de données.

    2. Pour une configuration supplémentaire : spécifiez des modèles d'expressions régulières pour inclure ou exclure certains contenus. Vous pouvez ajouter jusqu'à 100 motifs.

    3. Vous pouvez également choisir d'explorer les pièces jointes dans les espaces choisis.

    4. Dans le calendrier d'exécution synchronisé, pour Fréquence : choisissez la fréquence Amazon Kendra se synchronisera avec votre source de données.

    5. Choisissez Suivant.

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

    1. Pour l'espace, la page, le blog, sélectionnez l'une des Amazon Kendra champs de source de données par défaut générés ou mappages de champs suggérés supplémentaires pour ajouter des champs d'index.

    2. Ajouter un champ —Pour ajouter des champs de source de données personnalisés afin de créer un nom de champ d'index à mapper et le type de données du champ.

    3. 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 vers Confluence

Vous devez spécifier les éléments suivants à l'aide de ConfluenceConfigurationAPI:

  • Version Confluence —Spécifiez la version de l'instance Confluence que vous utilisez en tant que ou. CLOUD SERVER

  • Nom secret de la ressource Amazon (ARN) : indiquez le nom de la ressource Amazon (ARN) d'un Secrets Manager secret contenant vos identifiants d'authentification Confluence.

    Si vous utilisez Confluence Server, vous pouvez utiliser soit votre nom d'utilisateur et votre mot de passe Confluence, soit votre jeton d'accès personnel comme identifiants d'authentification.

    Si vous utilisez votre nom d'utilisateur et votre mot de passe Confluence comme informations d'authentification, vous stockez les informations d'identification suivantes sous forme de JSON structure dans votre Secrets Manager secret :

    {
    "username": "user name",
    "password": "password"
}

    Si vous utilisez un jeton d'accès personnel pour connecter Confluence Server à Amazon Kendra, vous stockez les informations d'identification suivantes sous forme de JSON structure dans votre Secrets Manager secret :

    {
    "patToken": "personal access token"
}

    Si vous utilisez Confluence Cloud, vous utilisez votre nom d'utilisateur Confluence et un API jeton, configuré dans Confluence, comme mot de passe. Vous stockez les informations d'identification suivantes sous forme de JSON structure dans votre Secrets Manager secret :

    {
    "username": "user name",
    "password": "API token"
}

  • IAM role —Spécifiez le RoleArn moment où vous appelez CreateDataSource pour fournir un IAM rôle autorisé à accéder à votre Secrets Manager secret et pour appeler le public requis APIs pour le connecteur Confluence et Amazon Kendra Pour de plus amples informations, veuillez consulter .IAM rôles pour les sources de données Confluence.

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

  • Proxy Web : s'il faut se connecter à votre URL instance Confluence via un proxy Web. Vous pouvez utiliser cette option pour Confluence Server.

  • (Pour Confluence Server uniquement) Virtual Private Cloud (VPC) : spécifiez dans le VpcConfiguration cadre de la configuration de la source de données. Voir Configuration Amazon Kendra pour utiliser un VPC.

  • Filtres d'inclusion et d'exclusion : spécifiez des modèles d'expressions régulières pour inclure ou exclure certains espaces, articles de blog, pages, espaces et pièces jointes. Si vous choisissez d'indexer les pièces jointes, seules les pièces jointes aux pages et aux blogs indexés sont indexées.

    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.

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

    Note

    Le champ « corps du document » ou l'équivalent du corps du document pour vos documents est requis afin de Amazon Kendra pour rechercher 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.

  • Filtrage du contexte utilisateur et contrôle d'accès —Amazon Kendra explore la liste de contrôle d'accès (ACL) de vos documents, si vous en avez une ACL pour vos documents. Les ACL informations 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.

En savoir plus

Pour en savoir plus sur l'intégration Amazon Kendra avec votre source de données Confluence, consultez :