匯流連接器 V1.0

Confluence 是一種協作工作管理工具，專為共享，存儲和工作項目規劃，軟件開發和產品管理而設計。您可以使用... Amazon Kendra 索引您的匯流空間，頁面（包括嵌套頁面），博客，以及索引頁面和博客的評論和附件。

注意

對於匯流連接器 V1.0 的 Support/計劃 ConfluenceConfiguration API在 2023 年結束。我們建議遷移到或使用匯流連接器 V2.0/. TemplateConfiguration API

對於故障排除 Amazon Kendra 匯流資料來源連接器，請參閱。疑難排解資料來

主題

支援的功能
必要條件
連接說明
進一步了解

支援的功能

Amazon Kendra 匯流資料來源連接器支援以下功能：

欄位對映
使用者存取控制
包含/排除過濾器
(僅適用於匯流伺服器) 虛擬私有雲 () VPC

必要條件

在您可以使用 Amazon Kendra 為您的匯流資料來源建立索引，請在您的匯流中進行這些變更 AWS 帳戶。

在匯流中，確保您具有：

授予 Amazon Kendra 通過以下方式查看匯流實例中所有內容的權限：
- 製作 Amazon Kendra confluence-administrators群組的成員。
- 授予所有現有空間、部落格和頁面的網站管理員權限。
複製您URL的匯流實例。
對於SSO（單一登入）使用者：在 Confluence 資料中心中設定 Confluence 驗證方法時，啟動使用者名稱和密碼的「在登入時顯示」頁面。
對於匯流服務器
- 記下您的基本身份驗證憑據，其中包含您的 Confluence 管理帳戶用戶名和密碼以連接到 Amazon Kendra.
  
  注意
  我們建議您定期重新整理或輪換您的認證和密碼。僅為您自己的安全提供必要的訪問級別。我們不建議您跨資料來源以及連接器 1.0 和 2.0 版 (如果適用) 重複使用認證和密碼。
- 可選：在您的匯流帳戶中生成一個個人訪問令牌以連接到 Amazon Kendra。有關更多信息，請參閱有關生成個人訪問令牌的匯合文檔。
適用於匯流雲
- 記下您的基本身份驗證憑據，其中包含您的 Confluence 管理帳戶用戶名和密碼以連接到 Amazon Kendra.
核取每個文件在 Confluence 中以及您打算用於相同索引的其他資料來源中都是唯一的。您要用於索引的每個資料來源不得包含跨資料來源的相同文件。文件對索引來說IDs是全域的，而且每個索引必須是唯一的。

在您的 AWS 帳戶，請確定您有：

創建了一個 Amazon Kendra 索引，如果使用API，則註明索引 ID。
創建了一個 IAM 您的資料來源的角色，如果使用API，請註明 ARN IAM 角色。

注意
如果您變更驗證類型和認證，則必須更新您的 IAM 角色訪問正確 AWS Secrets Manager 秘密識別碼。
將您的匯流身份驗證憑據存儲在 AWS Secrets Manager 秘密和, 如果使用API, 注意到ARN的秘密.

注意
我們建議您定期重新整理或輪換您的認證和密碼。僅為您自己的安全提供必要的訪問級別。我們不建議您跨資料來源以及連接器 1.0 和 2.0 版 (如果適用) 重複使用認證和密碼。

如果您沒有現有 IAM 角色或秘密，您可以使用控制台創建一個新的 IAM 角色和 Secrets Manager 秘密，當你連接你的匯流數據源 Amazon Kendra。如果您使用的是API，您必須提供現有ARN的 IAM 角色和 Secrets Manager 秘密和索引識別碼。

連接說明

若要連線 Amazon Kendra 到您的匯流數據源，您必須提供您的匯流憑據的詳細信息，以便 Amazon Kendra 可以訪問您的數據。如果您尚未設定「匯流」 Amazon Kendra 請參閱必要條件。

Console

若要連線 Amazon Kendra 至匯合

登入 AWS 管理主控台並開啟 Amazon Kendra 控制台。
在左側導覽窗格中，選擇 [索引]，然後從索引清單中選擇要使用的索引。

注意
您可以選擇在索引設置下配置或編輯您的用戶訪問控制設置。
在 [開始使用] 頁面上，選擇 [新增資料來源]。
在 [新增資料來源] 頁面上，選擇 [匯流連接器 V1.0]，然後選擇 [新增資料來源]。
在 [指定資料來源詳細資訊] 頁面上，輸入下列資訊：
1. 在名稱和說明中，對於資料來源名稱 — 輸入資料來源的名稱。您可以包含連字號，但不能包含空格。
2. (選擇性) 說明 — 輸入資料來源的選用說明。
3. 在預設語言中 — 選擇一種語言來篩選索引的文件。除非另有指定，否則語言預設為英文。文件中繼資料中指定的語言會覆寫選取的語言。
4. 在「標籤」中，針對「新增標籤」— 包含可選標籤以搜尋和篩選您的資源或追蹤您的資源 AWS 成本。
5. 選擇 Next (下一步)。
在 [定義存取權和安全性] 頁面上，輸入下列資訊：
1. 在匯流雲和匯流服務器之間進行選擇。
2. 如果您選擇「匯流雲」，請輸入以下資訊：
  1. 匯流 URL — 您的匯合。URL
  2. AWS Secrets Manager 秘密 — 選擇現有密碼或建立新密碼 Secrets Manager 秘密存儲您的匯流身份驗證憑據。如果您選擇建立新密碼 AWS Secrets Manager 秘密窗口打開。
    1. 在創建一個中輸入以下信息 AWS Secrets Manager 秘密窗口：
      1. 秘密名稱 — 您秘密的名稱。前綴 'AmazonKendra-匯流-' 會自動添加到您的密碼名稱中。
      2. 對於使用者名稱和密碼 — 輸入您的 Confluence 使用者名稱和密碼。
      3. 選擇 [儲存驗證]。
3. 如果您選擇「匯流伺服器」，請輸入下列資訊：
  1. 匯合 URL — 您的匯合使用者名稱和密碼。
  2. (選擇性) 若為 Web 代理伺服器，請輸入下列資訊：
    1. 主機名稱 — 您的匯流帳戶的主機名稱。
    2. 連接埠號碼 — 主機URL傳輸通訊協定使用的連接埠。
  3. 對於「驗證」，請選擇「基本驗證」或「（僅限 Confluence 伺服器）個人存取權杖」。
  4. AWS Secrets Manager 秘密 — 選擇現有密碼或建立新密碼 Secrets Manager 秘密存儲您的匯流身份驗證憑據。如果您選擇建立新密碼 AWS Secrets Manager 秘密窗口打開。
    1. 在創建一個中輸入以下信息 AWS Secrets Manager 秘密窗口：
      1. 秘密名稱 — 您秘密的名稱。前綴 'AmazonKendra-匯流-' 會自動添加到您的密碼名稱中。
      2. 對於使用者名稱和密碼 — 輸入您在 Confluence 中設定的驗證認證值。如果使用基本身份驗證，請使用您的 Confluence 用戶名（電子郵件 ID）和密碼（API令牌）。如果使用個人訪問令牌，請輸入您在 Confluence 帳戶中配置的個人訪問令牌的詳細信息。
      3. 保存並添加您的秘密。
4. IAM 角色 — 選擇現有的 IAM 角色或新建 IAM 角色來存取您的儲存庫認證和索引內容。
  
  注意
  IAM 用於索引的角色不能用於資料來源。如果您不確定索引是否使用現有角色FAQ，或選擇建立新角色以避免發生錯誤。
5. 選擇 Next (下一步)。
在 [設定同步設定] 頁面上，輸入下列資訊：
1. 對於「包括個人空間」和「包含封存空間」— 選擇要包含在此資料來源中的選用空間類型。
2. 對於其他組態 — 指定要包含或排除某些內容的規則運算式模式。您最多可以添加 100 個圖案。
3. 您也可以選擇在所選空間內搜索附件。
4. 同步執行排程，針對頻率 — 選擇頻率 Amazon Kendra 將與您的資料來源同步。
5. 選擇 Next (下一步)。
在 [設定欄位對映] 頁面上，輸入下列資訊：
1. 對於空間，頁面，博客-從中選擇 Amazon Kendra 產生的預設資料來源欄位或其他建議欄位對應以新增索引欄位。
2. 新增欄位 — 新增自訂資料來源欄位，以建立要對映的索引欄位名稱和欄位資料類型。
3. 選擇 Next (下一步)。
在 [檢閱並建立] 頁面上，檢查您輸入的資訊是否正確，然後選取 [新增資料來源]。您也可以從此頁面選擇編輯您的資訊。成功新增資料來源後，您的資料來源將顯示在 [資料來源] 頁面上。

API

若要連線 Amazon Kendra 至匯合

您必須使用以下指定 ConfluenceConfigurationAPI：

匯流版本 — 指定要用作或的匯流例證版本。CLOUD SERVER
秘密 Amazon 資源名稱（ARN）-提供 Amazon 資源名稱（ARN） Secrets Manager 包含您的匯流身份驗證憑據的秘密。

如果您使用 Confluence 服務器，則可以使用您的 Confluence 用戶名和密碼，或者您的個人訪問令牌作為身份驗證憑據。

如果您使用 Confluence 使用者名稱和密碼作為驗證認證，則將以下認證作為JSON結構儲存在 Secrets Manager 秘密：
```
{
    "username": "user name",
    "password": "password"
}
```
如果您使用個人訪問令牌將匯流服務器連接到 Amazon Kendra，您可以將以下憑據作為JSON結構存儲在您的 Secrets Manager 秘密：
```
{
    "patToken": "personal access token"
}
```
如果您使用匯流雲，則使用您的匯流使用者名稱和API權杖 (在匯流中設定) 作為您的密碼。您將以下認證作為JSON結構存儲在 Secrets Manager 秘密：
```
{
    "username": "user name",
    "password": "API token"
}
```
IAM role — 指定您RoleArn何時打電話CreateDataSource提供 IAM 具有存取您的權限的角色 Secrets Manager 秘密和調用所需的公眾APIs匯流連接器和 Amazon Kendra如需詳細資訊，請參閱。IAM 匯流資料來源的角色。

您還可以添加以下可選功能：

Web 代理伺服器 — 是否透過網路代理連線到您的匯流URL執行個體。您可以將此選項用於匯流伺服器。
(僅適用於 Confluence 伺服器) 虛擬私人雲端 (VPC) — 指定VpcConfiguration為資料來源組態的一部分。請參閱設定 Amazon Kendra 若要使用 VPC.
包含和排除篩選器 — 指定規則運算式模式，以包含或排除特定空格、部落格貼文、頁面、空格和附件。如果您選擇索引附件，則只會編製索引頁面和部落格的附件編製索引。

注意
大多數資料來源使用規則運算式模式，這些模式是稱為篩選器的包含或排除模式。如果您指定包含篩選器，則只有符合包含項目篩選器的內容會編製索引。不符合包含篩選器的任何文件都不會建立索引。如果您指定包含和排除篩選器，符合排除篩選器的文件將不會建立索引，即使它們符合包含篩選器也是如此。
欄位對映 — 選擇將您的匯流資料來源欄位對映至 Amazon Kendra 索引欄位。如需詳細資訊，請參閱映射資料來源欄位。

注意
您的文檔的文檔正文字段或文檔正文等效是必需的，以便 Amazon Kendra 以搜尋您的文件。您必須將資料來源中的文件內文欄位名稱對應至索引欄位名稱_document_body。所有其他欄位是選用的。
用戶上下文過濾和訪問控制-Amazon Kendra 探索文件的存取控制清單 (ACL) (如果您有文件ACL的話)。此資ACL訊可用來根據使用者或使用者對文件的群組存取權來篩選搜尋結果。如需詳細資訊，請參閱使用者內容篩選。

進一步了解

若要進一步瞭解整合 Amazon Kendra 與您的匯流數據源，請參閱：

配置您的 Amazon Kendra 匯流服務器連接器

您的瀏覽器已停用或無法使用 Javascript。

您必須啟用 Javascript，才能使用 AWS 文件。請參閱您的瀏覽器說明頁以取得說明。

文件慣用形式

Confluence

匯流連接器 V2.0