Confluence-Konnektor V2.0 - Amazon Kendra
Unterstützte FeaturesVoraussetzungenAnweisungen zur Verbindung

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 V2.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.

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

  • Filterung des Benutzerkontextes

  • Einschluss-/Ausschlussmuster

  • Vollständige und inkrementelle Inhaltssynchronisierung

  • Virtual 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 über Folgendes verfügen:

  • Die URL deiner Confluence-Instanz wurde kopiert. Zum Beispiel: https://example.confluence.com oder https://www.example.confluence.com/ oder https://atlassian.net/. Du benötigst die URL deiner Confluence-Instanz, mit der du dich verbinden möchtest. Amazon Kendra

    Wenn du Confluence Cloud verwendest, muss deine Host-URL auf atlassian.net/ enden.

    Anmerkung

    Die folgenden URL-Formate werden nicht unterstützt:

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

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

    • https://atlassian.net/xyz

    Anmerkung

    (On-Premise/Server) Amazon Kendra überprüft, ob die in der Datei enthaltenen Endpunktinformationen mit den Endpunktinformationen übereinstimmen, die in AWS Secrets Manager den Konfigurationsdetails deiner Datenquelle angegeben sind. Dies trägt zum Schutz vor dem Problem des verwirrten Stellvertreters bei, bei dem es sich um ein Sicherheitsproblem handelt, bei dem ein Benutzer nicht berechtigt ist, eine Aktion auszuführen, sondern ihn Amazon Kendra als Proxy verwendet, um auf das konfigurierte Geheimnis zuzugreifen und die Aktion auszuführen. Wenn Sie Ihre Endpunktinformationen später ändern, müssen Sie ein neues Geheimnis erstellen, um diese Informationen zu synchronisieren.

  • Konfigurierte Basisauthentifizierungsdaten, die einen Benutzernamen (E-Mail-ID, mit der Sie sich bei Confluence angemeldet haben) und ein Passwort (Confluence-Serverpasswort) enthalten, um eine Verbindung Amazon Kendra zu Ihrer Confluence-Instanz herzustellen. Informationen zur Erstellung eines Confluence-API-Tokens findest du unter API-Token für dein Atlassian-Konto verwalten.

  • Optional: Konfigurierte OAuth 2.0-Anmeldeinformationen, die einen Confluence-App-Schlüssel, ein Confluence-App-Secret, ein Confluence-Zugriffstoken und ein Confluence-Aktualisierungstoken enthalten, um eine Verbindung zu deiner Confluence-Instanz herzustellen. Amazon Kendra Wenn Ihr Zugriffstoken abläuft, können Sie entweder das Aktualisierungstoken verwenden, um Ihr Zugriffstoken und Ihr Aktualisierungstokenpaar neu zu generieren. Oder Sie können den Autorisierungsvorgang wiederholen. Weitere Informationen zu Zugriffstoken finden Sie unter OAuth-Zugriffstoken verwalten.

  • (Nur für Confluence Server) Optional: Es wurde ein Personal Access Token (PAT) konfiguriert, das ein Confluence-Token enthält, um eine Verbindung zu Ihrer Confluence-Instanz Amazon Kendra herzustellen. Informationen zur Erstellung eines PAT-Tokens finden Sie unter Persönliche Zugriffstoken verwenden.

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

  • Hat einen Amazon Kendra Index erstellt und bei Verwendung der API die Index-ID notiert.

  • Sie haben eine IAM Rolle für Ihre Datenquelle erstellt und, falls Sie die API verwenden, den ARN der 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 die API verwendest, den ARN des Secrets notiert.

    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 die API verwenden, müssen Sie den ARN einer vorhandenen IAM Rolle und 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 V2.0 und dann Connector 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 aus.

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

    1. Wählen Sie unter Quelle je nach Ihrer Hosting-Methode für Confluence-Datenquellen zwischen Confluence Cloud und Confluence Server.

    2. Confluence-URL — Geben Sie die Confluence-Host-URL ein. Das Format für die Host-URL, die Sie eingeben, ist https://example.confluence.com.

    3. (Nur für Confluence Server) Speicherort des SSL-Zertifikats — optional — Geben Sie den Amazon S3 Pfad zu Ihrer SSL-Zertifikatsdatei für Confluence Server ein.

    4. (Nur für Confluence Server) Web-Proxy — optional — Geben Sie den Hostnamen des Web-Proxys (ohne das http:// https:// OR-Protokoll) und die Portnummer (Port, der vom Host-URL-Transportprotokoll verwendet wird) ein. Die Portnummer sollte ein numerischer Wert zwischen 0 und 65535 sein.

    5. (Nur für Confluence Server) Autorisierung — Wählen Sie diese Option, um die Access Control List (ACL) zu aktivieren. Wählen Sie dann zwischen Benutzername und E-Mail, um das Feld auszuwählen, das Sie für die Zugriffskontrolle verwenden möchten.

    6. Wählen Sie je nach Anwendungsfall zwischen Standardauthentifizierung, OAuth 2.0-Authentifizierung und (nur für Confluence-Server) Authentifizierung mit Personal Access Token.

    7. 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. Geben Sie die folgenden Informationen in das Fenster ein:

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

      2. Wenn Sie die Standardauthentifizierung verwenden — Geben Sie den geheimen Namen, den Benutzernamen und das Passwort (Confluence Server-Passwort) ein, die Sie von Ihrem Confluence-Konto generiert und heruntergeladen haben.

        Wenn Sie die OAuth2.0-Authentifizierung verwenden — Geben Sie den geheimen Namen, den App-Schlüssel, den geheimen App-Schlüssel, das Zugriffstoken und das Aktualisierungstoken ein, die Sie in Ihrem Confluence-Konto erstellt haben.

        (Nur Confluence-Server) Wenn Sie die Authentifizierung mit dem Personal Access Token verwenden — Geben Sie den geheimen Namen und das Confluence-Token ein, die Sie in Ihrem Confluence-Konto erstellt haben.

      3. Wählen Sie Speichern und Geheimnis hinzufügen.

    8. Unter VPC und Sicherheitsgruppe konfigurieren — optional, für Virtual Private Cloud (VPC) — können Sie wählen, ob Sie eine VPC verwenden möchten. In diesem Fall müssen Sie Subnetze und VPC-Sicherheitsgruppen hinzufügen.

    9. Identity Crawler — Geben Sie an, ob der Identity Crawler aktiviert Amazon Kendra werden soll. Der Identity Crawler verwendet die Informationen der Zugriffskontrollliste (ACL) für Ihre Dokumente, um Suchergebnisse nach dem Benutzer- oder Gruppenzugriff auf Dokumente zu filtern. Wenn Sie über eine ACL für Ihre Dokumente verfügen und sich dafür entscheiden, Ihre ACL zu verwenden, können Sie auch den Identity Crawler aktivieren, um die Benutzerkontextfilterung von Suchergebnissen zu konfigurieren. Amazon Kendra Andernfalls können alle Dokumente öffentlich durchsucht werden, wenn Identity Crawler ausgeschaltet ist. Wenn Sie die Zugriffskontrolle für Ihre Dokumente verwenden möchten und Identity Crawler ausgeschaltet ist, können Sie alternativ die PutPrincipalMappingAPI verwenden, um Benutzer- und Gruppenzugriffsinformationen für die Benutzerkontextfilterung hochzuladen.

    10. 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 oder eine häufig gestellte Frage verwendet wird, wählen Sie Neue Rolle erstellen, um Fehler zu vermeiden.

    11. Wählen Sie Weiter aus.

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

    1. Wählen Sie unter Synchronisierungsbereich für Synchronisierungsinhalte die Synchronisierung aus den folgenden Entitätstypen aus: Seiten, Seitenkommentare, Seitenanhänge, Blogs, Blogkommentare, Bloganhänge, Persönliche Bereiche und Archivierte Bereiche.

      Anmerkung

      Seitenkommentare und Seitenanhänge können nur ausgewählt werden, wenn Sie Seiten synchronisieren möchten. Blogkommentare und Bloganhänge können nur ausgewählt werden, wenn Sie Blogs synchronisieren möchten.

      Wichtig

      Wenn Sie unter Zusätzliche Konfiguration kein Regex-Muster für die Leertaste angeben, werden standardmäßig alle Seiten und Blogs gecrawlt.

    2. Geben Sie unter Zusätzliche Konfiguration für Spaces-Regex-Muster an, ob bestimmte Leerzeichen in Ihren Index aufgenommen oder ausgeschlossen werden sollen. Verwenden Sie dazu:

      • Leertaste — Zum Beispiel my-space-123.

        Anmerkung

        Wenn Sie unter Zusätzliche Konfiguration kein Regex-Muster für die Leertaste angeben, werden standardmäßig alle Seiten und Blogs gecrawlt.

      • URL — Zum Beispiel. *//MySite/MyDocuments.

      • Dateityp — Zum Beispiel .*\ .pdf, .*\ .txt.

      • Für Maximale Dateigröße — Geben Sie die Dateigrößenbeschränkung in MB an, die Amazon Kendra crawlt. Amazon Kendra crawlt nur die Dateien innerhalb der von Ihnen definierten Größenbeschränkung. Die Standarddateigröße ist 50 MB. Die maximale Dateigröße sollte größer als 0 MB und kleiner oder gleich 50 MB sein.

      • Für Regex-Muster für Entitätstitel — Geben Sie Muster für reguläre Ausdrücke an, um bestimmte Blogs, Seiten, Kommentare und Anlagen nach Titeln ein- oder auszuschließen.

      Anmerkung

      Wenn Sie eine bestimmte Seite oder Unterseite crawlen möchten, können Sie Regex-Muster für Seitentitel verwenden, um diese Seite entweder ein- oder auszuschließen.

    3. Wählen Sie für den Synchronisierungsmodus aus, wie Sie Ihren Index aktualisieren möchten, wenn sich der Inhalt Ihrer Datenquelle ändert. Wenn Sie Ihre Datenquelle Amazon Kendra zum ersten Mal synchronisieren, werden alle Inhalte standardmäßig synchronisiert.

      • Vollständige Synchronisierung — Synchronisiert alle Inhalte unabhängig vom vorherigen Synchronisierungsstatus.

      • Synchronisieren neuer, geänderter oder gelöschter Inhalte — Synchronisieren Sie nur neue, geänderte und gelöschte Inhalte.

    4. Im Zeitplan für die Synchronisierungsausführung, für Frequenz — Wie oft Amazon Kendra wird mit Ihrer Datenquelle synchronisiert?

    5. Wählen Sie Weiter aus.

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

    1. Für Space, Page, Blog, Comment und Attachment — Wählen Sie aus den Amazon Kendra generierten Standard-Datenquellenfeldern aus, die Sie Ihrem Index zuordnen möchten.

    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 aus.

  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 mithilfe der API ein JSON des Datenquellenschemas angeben. TemplateConfiguration Sie müssen die folgenden Informationen angeben:

  • Datenquelle — Geben Sie den Datenquellentyp wie CONFLUENCEV2 bei der Verwendung des TemplateConfigurationJSON-Schemas an. Geben Sie außerdem die Datenquelle so anTEMPLATE, wie Sie die CreateDataSourceAPI aufrufen.

  • Host-URL — Geben Sie die Version der Confluence-Host-Instanz an. Zum Beispiel https://example.confluence.com.

  • Synchronisierungsmodus — Geben Sie an, ob Ihr Index aktualisiert werden Amazon Kendra soll, indem alle Dokumente oder nur neue, geänderte und gelöschte Dokumente synchronisiert werden. Sie können wählen zwischen:

    • FORCED_FULL_CRAWLum den gesamten Inhalt neu zu crawlen und bestehende Inhalte bei jeder Synchronisierung Ihrer Datenquelle mit Ihrem Index zu ersetzen

    • FULL_CRAWLjedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, inkrementell nur neue, geänderte und gelöschte Inhalte durchforsten

  • Authentifizierungstyp — Geben Sie den Authentifizierungstyp (obBasic,OAuth2) für Ihre Confluence-Instanz an. Personal-token

  • (Optional — Nur für Confluence Server) Speicherort des SSL-Zertifikats — Geben Sie das Land an, das Sie zum Speichern Ihres SSL-Zertifikats verwendet haben. S3bucketName s3certificateName

  • Geheimer Amazon-Ressourcenname (ARN) — Geben Sie den Amazon-Ressourcennamen (ARN) eines Secrets Manager Geheimnisses ein, das die Authentifizierungsdaten enthält, die Sie in Ihrem Confluence-Konto erstellt haben. Wenn Sie die grundlegende Kontoauthentifizierung verwenden, wird das Geheimnis in einer JSON-Struktur mit den folgenden Schlüsseln gespeichert: 

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

    Wenn Sie die OAuth 2.0-Authentifizierung verwenden, wird das Geheimnis in einer JSON-Struktur mit den folgenden Schlüsseln gespeichert:

    {
    "confluenceAppKey": "app key for your Confluence account",
    "confluenceAppSecret": "app secret from your Confluence token",
    "confluenceAccessToken": "access token created in Confluence",
    "confluenceRefreshToken": "refresh token created in Confluence"
}

    (Nur für Confluence Server) Wenn Sie die Standardauthentifizierung verwenden, wird das Geheimnis in einer JSON-Struktur mit den folgenden Schlüsseln gespeichert:

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

    (Nur für Confluence Server) Wenn Sie die Authentifizierung mit dem Personal Access Token verwenden, wird das Geheimnis in einer JSON-Struktur mit den folgenden Schlüsseln gespeichert:

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

    Wir empfehlen Ihnen, Ihre Anmeldeinformationen und Ihr Geheimnis 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.

  • IAM role — Geben Sie anRoleArn, wann Sie anrufenCreateDataSource, um einer IAM Rolle Berechtigungen für den Zugriff auf Ihr Secrets Manager Secret und den Aufruf der erforderlichen öffentlichen APIs für den Confluence-Connector und zum Aufrufen der erforderlichen öffentlichen APIs zu erteilen. Amazon Kendra Weitere Informationen finden Sie unter IAM Rollen für Confluence-Datenquellen.

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

  • Virtual Private Cloud (VPC) — Geben Sie an, VpcConfiguration wann Sie anrufen. CreateDataSource Weitere Informationen finden Sie unter Konfigurieren von Amazon Kendra für die Verwendung eines Amazon VPC.

  • Inklusions- und Ausschlussfilter — Sie können angeben, ob bestimmte Bereiche, Seiten, Blogs sowie deren Kommentare und Anlagen ein- oder ausgeschlossen werden sollen.

    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.

  • Identity Crawler — Geben Sie an, ob der Identity Crawler aktiviert Amazon Kendra werden soll. Der Identity Crawler verwendet die Informationen der Zugriffskontrollliste (ACL) für Ihre Dokumente, um Suchergebnisse nach dem Benutzer- oder Gruppenzugriff auf Dokumente zu filtern. Wenn Sie über eine ACL für Ihre Dokumente verfügen und sich dafür entscheiden, Ihre ACL zu verwenden, können Sie auch den Identity Crawler aktivieren, um die Benutzerkontextfilterung von Suchergebnissen zu konfigurieren. Amazon Kendra Andernfalls können alle Dokumente öffentlich durchsucht werden, wenn Identity Crawler ausgeschaltet ist. Wenn Sie die Zugriffskontrolle für Ihre Dokumente verwenden möchten und Identity Crawler ausgeschaltet ist, können Sie alternativ die PutPrincipalMappingAPI verwenden, um Benutzer- und Gruppenzugriffsinformationen für die Benutzerkontextfilterung hochzuladen.

  • Feldzuordnungen — Wählen Sie, ob Sie Ihre Confluence-Datenquellenfelder Ihren Indexfeldern zuordnen möchten. 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.

Eine Liste weiterer wichtiger JSON-Schlüssel, die konfiguriert werden müssen, finden Sie unterConfluence-Vorlagenschema.

Hinweise

  • Personal Access Token (PAT) ist für Confluence Cloud nicht verfügbar.