Confluence-Konnektor V1.0 - Amazon Kendra
Unterstützte FeaturesVoraussetzungenAnweisungen zur VerbindungWeitere Informationen

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Confluence-Konnektor V1.0

Confluence ist ein kollaboratives Arbeitsmanagement-Tool, das für die gemeinsame Nutzung, Speicherung und Bearbeitung von Projekten, Softwareentwicklung und Produktmanagement entwickelt wurde. Sie können Amazon Kendra es verwenden, um Ihre Confluence-Bereiche, Seiten (einschließlich verschachtelter Seiten), Blogs sowie Kommentare und Anhänge zu indexierten Seiten und Blogs zu indizieren.

Anmerkung

Confluence Connector V1.0/ endete 2023. ConfluenceConfiguration API Wir empfehlen, zu Confluence Connector V2.0/zu migrieren oder diesen zu verwenden. TemplateConfiguration API

Informationen zur Fehlerbehebung bei Ihrem Amazon Kendra Confluence-Datenquellen-Connector finden Sie unter. Problembehandlung bei Datenquellen

Unterstützte Features

Amazon Kendra Der Confluence-Datenquellen-Connector unterstützt die folgenden Funktionen:

  • Feldzuordnungen

  • Steuerung des Benutzerzugriffs

  • Einschluss-/Ausschlussfilter

  • (Nur für Confluence Server) Virtuelle private Cloud () VPC

Voraussetzungen

Bevor Sie Ihre Confluence-Datenquelle Amazon Kendra zum Indizieren verwenden können, nehmen Sie diese Änderungen in Ihrem Confluence und Ihren Konten vor. AWS

Stellen Sie in Confluence sicher, dass Sie:

  • Du hast mir die Amazon Kendra Erlaubnis erteilt, alle Inhalte in deiner Confluence-Instanz anzusehen, indem du:

    • Mitglied Amazon Kendra einer Gruppe werden. confluence-administrators

    • Gewährung von Site-Admin-Rechten für alle vorhandenen Bereiche, Blogs und Seiten.

  • Die Ihrer URL Confluence-Instanz wurde kopiert.

  • Für SSO (Single Sign-On) -Benutzer: Bei der Konfiguration der Confluence-Authentifizierungsmethoden in Confluence Data Center wurde die Option Auf der Anmeldeseite anzeigen für den Benutzernamen und das Passwort aktiviert.

  • Für Confluence Server

    • Haben Sie Ihre grundlegenden Authentifizierungsdaten notiert, die den Benutzernamen und das Passwort Ihres Confluence-Administratorkontos für die Verbindung enthalten. Amazon Kendra

      Anmerkung

      Wir empfehlen, dass du deine Anmeldedaten und dein Passwort regelmäßig aktualisierst oder wechselst. Stellen Sie zu Ihrer eigenen Sicherheit nur die Zugriffsebene bereit, die erforderlich ist. Wir raten davon ab, Anmeldeinformationen und geheime Daten für alle Datenquellen und Connector-Versionen 1.0 und 2.0 (sofern zutreffend) wiederzuverwenden.

    • Optional: Es wurde ein persönliches Zugriffstoken in Ihrem Confluence-Konto generiert, mit dem Sie sich verbinden können. Amazon Kendra Weitere Informationen finden Sie in der Confluence-Dokumentation zur Generierung persönlicher Zugriffstoken.

  • Für Confluence Cloud

    • Du hast dir deine grundlegenden Authentifizierungsdaten notiert, die den Benutzernamen und das Passwort deines Confluence-Administratorkontos für die Verbindung enthalten. Amazon Kendra

  • Aktiviert, dass jedes Dokument in Confluence und in anderen Datenquellen, die Sie für denselben Index verwenden möchten, einzigartig ist. Jede Datenquelle, die Sie für einen Index verwenden möchten, darf nicht dasselbe Dokument in allen Datenquellen enthalten. Dokumente IDs gelten für einen Index global und müssen pro Index eindeutig sein.

Stellen Sie in Ihrem sicher AWS-Konto, dass Sie Folgendes haben:

  • Hat einen Amazon Kendra Index erstellt und, falls Sie den verwendet habenAPI, die Index-ID notiert.

  • Sie haben eine IAM Rolle für Ihre Datenquelle erstellt und, falls Sie die verwendenAPI, ARN die IAM Rolle notiert.

    Anmerkung

    Wenn Sie Ihren Authentifizierungstyp und Ihre Anmeldeinformationen ändern, müssen Sie Ihre IAM Rolle aktualisieren, um auf die richtige AWS Secrets Manager geheime ID zugreifen zu können.

  • Du hast deine Confluence-Authentifizierungsdaten AWS Secrets Manager geheim gespeichert und, falls du den verwendestAPI, den Geheimcode notiert. ARN

    Anmerkung

    Wir empfehlen dir, deine Anmeldedaten und dein Secret regelmäßig zu aktualisieren oder zu wechseln. Stellen Sie zu Ihrer eigenen Sicherheit nur die Zugriffsebene bereit, die erforderlich ist. Wir raten davon ab, Anmeldeinformationen und geheime Daten für alle Datenquellen und Connector-Versionen 1.0 und 2.0 (sofern zutreffend) wiederzuverwenden.

Wenn du noch keine IAM Rolle oder keinen Schlüssel hast, kannst du die Konsole verwenden, um eine neue IAM Rolle und ein neues Secrets Manager Geheimnis zu erstellen, wenn du deine Confluence-Datenquelle mit verbindest. Amazon Kendra Wenn Sie das verwendenAPI, müssen Sie die einer vorhandenen IAM Rolle und ARN eines Secrets Manager Geheimnisses sowie eine Index-ID angeben.

Anweisungen zur Verbindung

Um eine Verbindung Amazon Kendra zu Ihrer Confluence-Datenquelle herzustellen, müssen Sie Details zu Ihren Confluence-Anmeldeinformationen angeben, damit Sie auf Ihre Daten zugreifen Amazon Kendra können. Falls Sie Confluence noch nicht konfiguriert haben, finden Sie weitere Informationen unter. Amazon Kendra Voraussetzungen

Console

Um eine Verbindung zu Confluence herzustellen Amazon Kendra

  1. Melden Sie sich bei der AWS Management Console an und öffnen Sie die Amazon Kendra Konsole.

  2. Wählen Sie im linken Navigationsbereich Indizes und dann den Index, den Sie verwenden möchten, aus der Indexliste aus.

    Anmerkung

    Sie können Ihre Einstellungen für die Benutzerzugriffskontrolle unter Indexeinstellungen konfigurieren oder bearbeiten.

  3. Wählen Sie auf der Seite Erste Schritte die Option Datenquelle hinzufügen aus.

  4. Wählen Sie auf der Seite Datenquelle hinzufügen die Option Confluence Connector V1.0 und dann Datenquelle hinzufügen aus.

  5. Geben Sie auf der Seite „Datenquellendetails angeben“ die folgenden Informationen ein:

    1. Geben Sie im Feld Name und Beschreibung für Datenquellenname einen Namen für Ihre Datenquelle ein. Sie können Bindestriche, aber keine Leerzeichen verwenden.

    2. (Optional) Beschreibung — Geben Sie eine optionale Beschreibung für Ihre Datenquelle ein.

    3. In Standardsprache — Wählen Sie eine Sprache aus, um Ihre Dokumente nach dem Index zu filtern. Sofern Sie nichts anderes angeben, ist die Standardsprache Englisch. Die in den Metadaten des Dokuments angegebene Sprache hat Vorrang vor der ausgewählten Sprache.

    4. Unter Tags für Neues Tag hinzufügen — Fügen Sie optionale Tags hinzu, um Ihre Ressourcen zu durchsuchen und zu filtern oder Ihre Kosten nachzuverfolgen. AWS

    5. Wählen Sie Weiter.

  6. Geben Sie auf der Seite Zugriff und Sicherheit definieren die folgenden Informationen ein:

    1. Wählen Sie zwischen Confluence Cloud und Confluence Server.

    2. Wenn Sie sich für Confluence Cloud entscheiden, geben Sie die folgenden Informationen ein:

      1. Confluence — Ihr Confluence URL. URL

      2. AWS Secrets Manager geheim — Wählen Sie ein vorhandenes Geheimnis oder erstellen Sie ein neues Secrets Manager Geheimnis, um Ihre Confluence-Authentifizierungsdaten zu speichern. Wenn Sie sich dafür entscheiden, ein neues Geheimnis zu erstellen, wird ein AWS Secrets Manager geheimes Fenster geöffnet.

        1. Geben Sie die folgenden Informationen in das Fenster Create an AWS Secrets Manager Secret ein:

          1. Geheimer Name — Ein Name für Ihr Geheimnis. Das Präfix 'AmazonKendra-Confluence-' wird Ihrem geheimen Namen automatisch hinzugefügt.

          2. Für Benutzername und Passwort — Geben Sie Ihren Confluence-Benutzernamen und Ihr Passwort ein.

          3. Wählen Sie Authentifizierung speichern.

    3. Wenn Sie Confluence Server wählen, geben Sie die folgenden Informationen ein:

      1. Confluence URL — Ihr Confluence-Benutzername und Ihr Passwort.

      2. (Optional) Geben Sie für den Web-Proxy die folgenden Informationen ein:

        1. Hostname — Hostname für Ihr Confluence-Konto.

        2. Portnummer — Port, der vom Host-Transportprotokoll verwendet wird. URL

      3. Wählen Sie für Authentifizierung entweder Standardauthentifizierung oder Personal Access Token (nur Confluence Server).

      4. AWS Secrets Manager geheim — Wählen Sie ein vorhandenes Geheimnis oder erstellen Sie ein neues Secrets Manager Geheimnis, um Ihre Confluence-Authentifizierungsdaten zu speichern. Wenn Sie sich dafür entscheiden, ein neues Geheimnis zu erstellen, wird ein AWS Secrets Manager geheimes Fenster geöffnet.

        1. Geben Sie die folgenden Informationen in das Fenster Create an AWS Secrets Manager Secret ein:

          1. Geheimer Name — Ein Name für Ihr Geheimnis. Das Präfix 'AmazonKendra-Confluence-' wird Ihrem geheimen Namen automatisch hinzugefügt.

          2. Für Benutzername und Passwort — Geben Sie die Werte für die Authentifizierungsdaten ein, die Sie in Confluence konfiguriert haben. Wenn Sie die Standardauthentifizierung verwenden, verwenden Sie Ihren Confluence-Benutzernamen (E-Mail-ID) und Ihr Passwort (Token). API Wenn Sie ein persönliches Zugriffstoken verwenden, geben Sie die Details des persönlichen Zugriffstokens ein, das Sie im Confluence-Konto konfiguriert haben.

          3. Speichern Sie Ihr Geheimnis und fügen Sie es hinzu.

    4. IAM Rolle — Wählen Sie eine bestehende IAM Rolle oder erstellen Sie eine neue IAM Rolle, um auf Ihre Repository-Anmeldeinformationen und Indexinhalte zuzugreifen.

      Anmerkung

      IAM Rollen, die für Indizes verwendet werden, können nicht für Datenquellen verwendet werden. Wenn Sie sich nicht sicher sind, ob eine vorhandene Rolle für einen Index verwendet wirdFAQ, wählen Sie Neue Rolle erstellen, um Fehler zu vermeiden.

    5. Wählen Sie Weiter.

  7. Geben Sie auf der Seite „Synchronisierungseinstellungen konfigurieren“ die folgenden Informationen ein:

    1. Für Persönliche Bereiche einbeziehen und Archivierte Bereiche einbeziehen — Wählen Sie die optionalen Bereichstypen aus, die in diese Datenquelle aufgenommen werden sollen.

    2. Für zusätzliche Konfigurationen — Geben Sie Muster für reguläre Ausdrücke an, um bestimmte Inhalte ein- oder auszuschließen. Sie können bis zu 100 Muster hinzufügen.

    3. Sie können auch festlegen, dass Anlagen innerhalb bestimmter Bereiche gecrawlt werden.

    4. Wählen Sie im Zeitplan für die Synchronisierungsausführung unter Häufigkeit aus, wie oft mit Ihrer Datenquelle synchronisiert Amazon Kendra werden soll.

    5. Wählen Sie Weiter.

  8. Geben Sie auf der Seite Feldzuordnungen festlegen die folgenden Informationen ein:

    1. Für Space, Page, Blog — Wählen Sie aus den Amazon Kendra generierten Standard-Datenquellenfeldern oder Zusätzliche vorgeschlagene Feldzuordnungen, um Indexfelder hinzuzufügen.

    2. Feld hinzufügen — Um benutzerdefinierte Datenquellenfelder hinzuzufügen, um einen Indexfeldnamen für die Zuordnung und den Felddatentyp zu erstellen.

    3. Wählen Sie Weiter.

  9. Überprüfen Sie auf der Seite Überprüfen und erstellen, ob die von Ihnen eingegebenen Informationen korrekt sind, und wählen Sie dann Datenquelle hinzufügen aus. Sie können Ihre Informationen auch auf dieser Seite bearbeiten. Ihre Datenquelle wird auf der Seite Datenquellen angezeigt, nachdem die Datenquelle erfolgreich hinzugefügt wurde.

API

Um eine Verbindung Amazon Kendra zu Confluence herzustellen

Sie müssen Folgendes angeben mit: ConfluenceConfigurationAPI

  • Confluence-Version — Geben Sie die Version der Confluence-Instanz an, die Sie als oder verwenden. CLOUD SERVER

  • Geheimer Amazon-Ressourcenname (ARN) — Geben Sie den Amazon-Ressourcennamen (ARN) eines Secrets Manager Geheimnisses ein, das Ihre Confluence-Authentifizierungsdaten enthält.

    Wenn Sie Confluence Server verwenden, können Sie entweder Ihren Confluence-Benutzernamen und Ihr Passwort oder Ihr persönliches Zugriffstoken als Authentifizierungsdaten verwenden.

    Wenn Sie Ihren Confluence-Benutzernamen und Ihr Passwort als Authentifizierungsdaten verwenden, speichern Sie die folgenden Anmeldeinformationen als Struktur in Ihrem Secret: JSON Secrets Manager 

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

    Wenn Sie ein persönliches Zugriffstoken verwenden, um sich mit Confluence Server zu verbinden Amazon Kendra, speichern Sie die folgenden Anmeldeinformationen als JSON Struktur in Ihrem Geheimnis: Secrets Manager 

    {
    "patToken": "personal access token"
}

    Wenn Sie Confluence Cloud verwenden, verwenden Sie Ihren Confluence-Benutzernamen und ein in Confluence konfiguriertes API Token als Passwort. Sie speichern die folgenden Zugangsdaten als Struktur in Ihrem Secret: JSON Secrets Manager 

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

  • IAM Rolle — Geben Sie anRoleArn, wann Sie anrufenCreateDataSource, um einer IAM Rolle Berechtigungen für den Zugriff auf Ihr Secrets Manager Geheimnis zu gewähren und die erforderliche Öffentlichkeit APIs für den Confluence-Connector aufzurufen und. Amazon Kendra Weitere Informationen finden Sie unter IAM Rollen für Confluence-Datenquellen.

Sie können auch die folgenden optionalen Funktionen hinzufügen:

  • Web-Proxy — Gibt an, ob Sie über einen Web-Proxy eine Verbindung zu Ihrer URL Confluence-Instanz herstellen möchten. Sie können diese Option für Confluence Server verwenden.

  • (Nur für Confluence Server) Virtual Private Cloud (VPC) — Geben Sie dies VpcConfiguration als Teil der Datenquellenkonfiguration an. Siehe Konfiguration für die Verwendung von Amazon Kendra . VPC

  • Inklusions- und Ausschlussfilter — Geben Sie Muster für reguläre Ausdrücke an, um bestimmte Bereiche, Blogbeiträge, Seiten, Leerzeichen und Anlagen ein- oder auszuschließen. Wenn Sie Anlagen indexieren möchten, werden nur Anlagen zu den indizierten Seiten und Blogs indexiert.

    Anmerkung

    Die meisten Datenquellen verwenden Muster für reguläre Ausdrücke, bei denen es sich um Ein- oder Ausschlussmuster handelt, die als Filter bezeichnet werden. Wenn Sie einen Einschlussfilter angeben, werden nur Inhalte indexiert, die dem Einschlussfilter entsprechen. Jedes Dokument, das nicht dem Einschlussfilter entspricht, wird nicht indexiert. Wenn Sie einen Ein- und Ausschlussfilter angeben, werden Dokumente, die dem Ausschlussfilter entsprechen, nicht indexiert, auch wenn sie dem Einschlussfilter entsprechen.

  • Feldzuordnungen — Wählen Sie diese Option, um Ihre Confluence-Datenquellenfelder Ihren Indexfeldern zuzuordnen. Amazon Kendra Weitere Informationen finden Sie unter Zuweisen von Datenquellenfeldern.

    Anmerkung

    Das Textfeld oder das entsprechende Textfeld für Ihre Dokumente ist erforderlich, um Ihre Dokumente durchsuchen zu können. Amazon Kendra Sie müssen den Feldnamen Ihres Dokumenthauptteils in Ihrer Datenquelle dem Namen des Indexfeldes zuordnen_document_body. Alle anderen Felder sind optional.

  • Benutzerkontextfilterung und ZugriffskontrolleAmazon Kendra — durchsucht die Zugriffskontrollliste (ACL) für Ihre Dokumente, sofern Sie eine ACL für Ihre Dokumente haben. Die ACL Informationen werden verwendet, um Suchergebnisse nach dem Benutzer- oder Gruppenzugriff auf Dokumente zu filtern. Weitere Informationen finden Sie unter Benutzerkontextfilterung.

Weitere Informationen

Weitere Informationen zur Integration Amazon Kendra mit Ihrer Confluence-Datenquelle finden Sie unter: