Confluence 連接器 V1.0 - Amazon Kendra

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

Confluence 連接器 V1.0

Confluence 是一種協作工作管理工具,旨在共用、儲存和處理專案規劃、軟體開發和產品管理。您可以使用 Amazon Kendra將 Confluence 空間、頁面 (包括巢狀頁面)、部落格以及評論和附件編入索引頁面和部落格的索引。

注意

Confluence 連接器 V1.0 / ConfluenceConfiguration API 已於 2023 年結束。我們建議遷移至或使用 Confluence 連接器 V2.0 / TemplateConfiguration API。

如需 Confluence Amazon Kendra資料來源連接器的故障診斷,請參閱 對資料來源進行故障診斷

支援的功能

Amazon KendraConfluence 資料來源連接器支援下列功能:

  • 欄位對應

  • 使用者存取控制

  • 包含/排除篩選條件

  • (僅適用於 Confluence Server) Virtual Private Cloud (VPC)

先決條件

在您可以使用 Amazon Kendra為 Confluence 資料來源編製索引之前,請在 Confluence 和AWS帳戶中進行這些變更。

在 Confluence 中,請確定您有:

  • 透過下列方式授予檢視 Confluence 執行個體內所有內容的Amazon Kendra許可:

    • Amazon Kendra成為 confluence-administrators群組的成員。

    • 授予所有現有空間、部落格和頁面的網站管理員許可。

  • 已複製 Confluence 執行個體的 URL。

  • 對於 SSO (單一登入) 使用者:當您在 Confluence 資料中心設定 Confluence 身分驗證方法時,啟用使用者名稱和密碼的登入時顯示頁面

  • 針對 Confluence 伺服器

    • 記下您的基本身分驗證憑證,其中包含要連線的 Confluence 管理帳戶使用者名稱和密碼Amazon Kendra。

      注意

      建議定期更新或輪換憑證與機密。僅授予作業所需的最低存取層級,以確保自身安全。我們不建議您在資料來源以及連接器 1.0 和 2.0 版 (如適用) 之間重複使用登入資料和秘密。

    • 選用:在您的 Confluence 帳戶中產生要連線的個人存取字符Amazon Kendra。如需詳細資訊,請參閱產生個人存取字符的 Confluence 文件

  • 用於 Confluence 雲端

    • 記下您的基本身分驗證憑證,其中包含要連線的 Confluence 管理帳戶使用者名稱和密碼Amazon Kendra。

  • 已檢查每個文件在 Confluence 中以及您計劃用於相同索引的其他資料來源中是唯一的。您要用於索引的每個資料來源不得包含跨資料來源的相同文件。文件 IDs是索引的全域 ID,且每個索引必須是唯一的。

在您的 中AWS 帳戶,請確定您有:

  • 建立Amazon Kendra索引,如果使用 API, 會記下索引 ID。

  • 為您的資料來源建立 IAM角色,如果使用 API, 會記下IAM角色的 ARN。

    注意

    如果您變更身分驗證類型和登入資料,則必須更新您的IAM角色以存取正確的AWS Secrets Manager秘密 ID。

  • 將您的 Confluence 身分驗證憑證存放在AWS Secrets Manager秘密中,如果使用 API, 會記下秘密的 ARN。

    注意

    建議定期更新或輪換憑證與機密。僅授予作業所需的最低存取層級,以確保自身安全。我們不建議您在資料來源以及連接器 1.0 和 2.0 版 (如適用) 之間重複使用登入資料和秘密。

如果您沒有現有的IAM角色或秘密,則可以在將 Confluence 資料來源連線到 時,使用 主控台建立新的IAM角色和Secrets Manager秘密Amazon Kendra。如果您使用的是 API,則必須提供現有IAM角色和Secrets Manager秘密的 ARN,以及索引 ID。

連線指示

若要Amazon Kendra連線至 Confluence 資料來源,您必須提供 Confluence 登入資料的詳細資訊,以便 Amazon Kendra可以存取您的資料。如果您尚未為 設定 Confluence,Amazon Kendra請參閱 先決條件

Console

Amazon Kendra連線至 Confluence

  1. 登入 AWS管理主控台並開啟Amazon Kendra主控台

  2. 從左側導覽窗格中,選擇索引,然後從索引清單中選擇您要使用的索引。

    注意

    您可以選擇在索引設定下設定或編輯使用者存取控制設定。

  3. 入門頁面上,選擇新增資料來源

  4. 新增資料來源頁面上,選擇 Confluence 連接器 V1.0,然後選擇新增資料來源

  5. 指定資料來源詳細資訊頁面上,輸入下列資訊:

    1. 名稱和描述中,針對資料來源名稱 - 輸入資料來源的名稱。您可以包含連字號,但不能包含空格。

    2. (選用) 描述 — 輸入資料來源的選用描述。

    3. 預設語言 - 選擇語言來篩選索引的文件。除非您另有指定,否則語言預設為英文。文件中繼資料中指定的語言會覆寫選取的語言。

    4. 標籤中,針對新增標籤 - 包含選用標籤,以搜尋和篩選您的資源或追蹤您的AWS成本。

    5. 選擇下一步

  6. 定義存取和安全性頁面上,輸入下列資訊:

    1. 選擇 Confluence CloudConfluence Server

    2. 如果您選擇 Confluence Cloud,請輸入下列資訊:

      1. Confluence URL - 您的 Confluence URL。

      2. AWS Secrets Managersecret - 選擇現有的秘密或建立新的Secrets Manager秘密,以存放您的 Confluence 身分驗證憑證。如果您選擇建立新的秘密,則會AWS Secrets Manager開啟秘密視窗。

        1. 建立AWSSecrets Manager秘密視窗中輸入下列資訊:

          1. 機密名稱 - 輸入您的機密名稱。字首「AmazonKendra-Confluence-」會自動新增至您的秘密名稱。

          2. 針對使用者名稱和密碼 - 輸入您的 Confluence 使用者名稱和密碼。

          3. 選擇儲存身分驗證

    3. 如果您選擇 Confluence Server,請輸入下列資訊:

      1. Confluence URL - 您的 Confluence 使用者名稱和密碼。

      2. (選用) 針對 Web 代理輸入下列資訊:

        1. 主機名稱 - Confluence 帳戶的主機名稱。

        2. 連接埠號碼 - 主機 URL 傳輸通訊協定所使用的連接埠。

      3. 針對身分驗證,選擇基本身分驗證或 (僅限 Confluence Server) 個人存取字符

      4. AWS Secrets Managersecret - 選擇現有的秘密或建立新的Secrets Manager秘密,以存放您的 Confluence 身分驗證憑證。如果您選擇建立新的秘密,則會AWS Secrets Manager開啟秘密視窗。

        1. 建立AWSSecrets Manager秘密視窗中輸入下列資訊:

          1. 機密名稱 - 輸入您的機密名稱。字首「AmazonKendra-Confluence-」會自動新增至您的秘密名稱。

          2. 針對使用者名稱和密碼 - 輸入您在 Confluence 中設定的身分驗證憑證值。如果使用基本身分驗證,請使用 Confluence 使用者名稱 (電子郵件 ID) 和密碼 (API 字符)。如果使用個人存取字符,請輸入您在 Confluence 帳戶中設定的個人存取字符的詳細資訊。

          3. 儲存並新增您的秘密。

    4. IAMrole - 選擇現有IAM角色或建立新的IAM角色,以存取您的儲存庫登入資料和索引內容。

      注意

      IAM用於索引的 角色無法用於資料來源。如果您不確定現有角色是否用於索引或常見問答集,請選擇建立新角色以避免錯誤。

    5. 選擇下一步

  7. 設定同步設定頁面上,輸入下列資訊:

    1. 對於包含個人空間包含封存空間 - 選擇要包含在此資料來源中的選用空間類型。

    2. 對於其他組態 - 指定要包含或排除特定內容的規則表達式模式。最多可新增 100 個模式。

    3. 您也可以選擇在所選空格內編目附件

    4. 同步執行排程中,針對頻率 - 選擇與您的資料來源Amazon Kendra同步的頻率。

    5. 選擇下一步

  8. 設定欄位映射頁面上,輸入下列資訊:

    1. 對於空間頁面部落格—從Amazon Kendra產生的預設資料來源欄位或其他建議欄位映射中選取以新增索引欄位。

    2. 新增欄位 - 新增自訂資料來源欄位,以建立要映射的索引欄位名稱和欄位資料類型。

    3. 選擇下一步

  9. 檢閱和建立頁面上,檢查您輸入的資訊是否正確,然後選取新增資料來源。您也可以選擇從此頁面編輯您的資訊。成功新增資料來源後,您的資料來源將顯示在資料來源頁面上。

API

Amazon Kendra連線至 Confluence

您必須使用 ConfluenceConfiguration API 指定下列項目:

  • Confluence 版本 - 指定您用作 CLOUD或 的 Confluence 執行個體版本SERVER

  • Secret Amazon Resource Name (ARN) — 提供包含 Confluence 身分驗證憑證之Secrets Manager秘密的 Amazon Resource Name (ARN)。

    如果您使用 Confluence Server,則可以使用 Confluence 使用者名稱和密碼,或個人存取字符做為身分驗證憑證。

    如果您使用 Confluence 使用者名稱和密碼做為身分驗證登入資料,您可以將下列登入資料儲存為秘密中的Secrets Manager JSON 結構:

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

    如果您使用個人存取字符將 Confluence Server 連線到 Amazon Kendra,您可以將下列登入資料儲存為秘密中的Secrets Manager JSON 結構:

    { "patToken": "personal access token" }

    如果您使用 Confluence Cloud,您可以使用 Confluence 使用者名稱和在 Confluence 中設定的 API 字符做為密碼。您可以將下列登入資料儲存為Secrets Manager秘密中的 JSON 結構:

    { "username": "user name", "password": "API token" }
  • IAMrole—指定RoleArn您何時呼叫 CreateDataSource 以提供IAM角色存取Secrets Manager秘密的許可,以及呼叫 Confluence 連接器所需的公有 APIs 和 Amazon Kendra。如需詳細資訊,請參閱 IAMConfluence 資料來源的角色

您也可以新增下列選用功能:

  • Web 代理 — 是否透過 Web 代理連接到 Confluence URL 執行個體。您可以針對 Confluence Server 使用此選項。

  • (僅適用於 Confluence Server) Virtual Private Cloud (VPC)—指定 VpcConfiguration做為資料來源組態的一部分。請參閱設定 Amazon Kendra以使用 VPC

  • 包含和排除篩選條件 - 指定規則表達式模式,以包含或排除特定空格、部落格文章、頁面、空格和附件。如果您選擇為附件編製索引,則只會為已編製索引頁面和部落格的附件編製索引。

    注意

    大多數資料來源使用規則表達式模式,作為包含或排除的篩選規則,稱為篩選條件。若您設定包含篩選條件,則只有符合該條件的內容會被編列索引。任何不符合包含篩選條件的文件都不會編製索引。如果您指定包含和排除篩選條件,則符合排除篩選條件的文件不會編製索引,即使它們符合包含篩選條件。

  • 欄位映射 - 選擇將您的 Confluence 資料來源欄位映射至您的Amazon Kendra索引欄位。如需詳細資訊,請參閱映射資料來源欄位

    注意

    需要文件內文欄位或文件內文對等項目, Amazon Kendra才能搜尋您的文件。您必須將資料來源中的文件內文欄位名稱映射至索引欄位名稱 _document_body。所有其他欄位是選用的。

  • 使用者內容篩選和存取控制 —Amazon Kendra 如果您有文件的 ACL, 會為您的文件編目存取控制清單 (ACL)。ACL 資訊用於根據使用者或其群組對文件的存取來篩選搜尋結果。如需詳細資訊,請參閱使用者內容篩選

進一步了解

若要進一步了解Amazon Kendra如何與您的 Confluence 資料來源整合,請參閱: