本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# Confluence 连接器 V1.0
<a name="data-source-v1-confluence"></a>

Confluence 是一款协作式工作管理工具，专为共享、存储和处理项目规划、软件开发和产品管理而设计。您可以使用 Amazon Kendra 索引 Confluence 空间、页面（包括嵌套页面）、博客以及已编入索引的页面和博客的评论和附件。

**注意**  
Confluence 连接器 V1.0/ ConfluenceConfiguration API 于 2023 年结束。我们建议迁移到或使用 Confluence 连接器 V2.0/API。 TemplateConfiguration 

要对 Amazon Kendra Confluence 数据源连接器进行故障排除，请参阅。[数据来源故障排除](troubleshooting-data-sources.md)

**Topics**
+ [支持的功能](#supported-features-v1-confluence)
+ [先决条件](#prerequisites-v1-confluence)
+ [连接说明](#data-source-procedure-v1-confluence)
+ [了解详情](#confluence-v1-learn-more)

## 支持的功能
<a name="supported-features-v1-confluence"></a>

Amazon Kendra Confluence 数据源连接器支持以下功能：
+ 字段映射
+ 用户访问控制
+ 包含/排除筛选条件
+ （仅适用于 Confluence Server）虚拟私有云（VPC）

## 先决条件
<a name="prerequisites-v1-confluence"></a>

在使用 Amazon Kendra 索引您的 Confluence 数据源之前，请先在您的 Confluence 和账户中进行这些更改。 AWS 

**在 Confluence 中，请确保：**
+ 通过以下 Amazon Kendra 方式授予查看您的 Confluence 实例中所有内容的权限：
  +  Amazon Kendra 成为`confluence-administrators`群组成员。
  + 授予所有现有空间、博客和页面的站点管理员权限。
+ 复制 Confluence 实例的 URL。
+ **对于 SSO（单点登录）用户**：在 Confluence 数据中心配置 Confluence **身份验证方法**时，激活了**显示登录页面**以输入用户名和密码。
+ **对于 Confluence Server**
  + 记下了您的基本身份验证凭证，其中包含要连接到 Amazon Kendra的 Confluence 管理账户用户名和密码。
**注意**  
我们建议您定期刷新或轮换您的凭证和密码。为了安全起见，请仅提供必要的访问权限级别。我们建议**不要**跨数据来源以及连接器版本 1.0 和 2.0（如果适用）重复使用凭证和密钥。
  + **可选：**在您的 Confluence 账户中生成了要连接的个人访问令牌。 Amazon Kendra有关更多信息，请参阅[有关生成个人访问令牌的 Confluence 文档](https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html)。
+ **对于 Confluence Cloud**
  + 记下了您的基本身份验证凭证，其中包含要连接到 Amazon Kendra的 Confluence 管理账户用户名和密码。
+ 在 Confluence 以及计划用于编制同一索引的其他数据来源中，已检查每个文档都是唯一的。您要用于编制索引的每个数据来源在所有数据来源中都不能包含相同的文档。文档对索引来说 IDs 是全局的，并且每个索引必须是唯一的。

**在你的 AWS 账户，请确保你有：**
+ [已创建 Amazon Kendra 索引](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)，如果使用 API，则记下索引 ID。
+ 为您的数据源@@ [创建了一个 IAM 角色](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)，如果使用 API，请记下该角色的 ARN。 IAM 
**注意**  
如果您更改了身份验证类型和证书，则必须更新您的 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。

## 连接说明
<a name="data-source-procedure-v1-confluence"></a>

 Amazon Kendra 要连接到您的 Confluence 数据源，您必须提供您的 Confluence 凭据的详细信息， Amazon Kendra 以便访问您的数据。如果您尚未配置 Confluence，请参阅。 Amazon Kendra [先决条件](#prerequisites-v1-confluence)

------
#### [ Console ]

**连接到 Con Amazon Kendra fluence** 

1. 登录 AWS 管理控制台并打开[Amazon Kendra 控制台](https://console.aws.amazon.com/kendra/)。

1. 在左侧导航窗格中，选择**索引**，然后从索引列表中选择要使用的索引。
**注意**  
您可以选择在**索引设置**下配置或编辑您的**用户访问控制**设置。

1. 在**入门**页面上，选择**添加数据来源**。

1. 在**添加数据来源**页面上，选择 ** Confluence 连接器 V1.0**，然后选择**添加数据来源**。

1. 在**指定数据来源详细信息**页面上输入以下信息：

   1. 在**名称和描述**中，在**数据来源名称**中输入您的数据来源的名称。可以包含连字符，但不能包含空格。

   1. （可选）**描述**：输入数据来源的描述信息。

   1. 在**默认语言**中，选择用于筛选文档以编制索引的语言。除非另行指定，否则语言默认为英语。在文档元数据中指定的语言会覆盖所选语言。

   1. 在**标签**中，用于**添加新标签**-包括可选标签以搜索和筛选您的资源或跟踪您的 AWS 成本。

   1. 选择**下一步**。

1. 在**定义访问权限和安全性**页面上，请输入以下信息：

   1. 选择 **Confluence Cloud** 或 **Confluence Server**。

   1. 如果选择 **Confluence Cloud**，请输入以下信息：

      1. **Confluence URL** - 您的 Confluence URL。

      1. AWS Secrets Manager s@@ **ecret** —选择现有密钥或创建新 Secrets Manager 密钥来存储您的 Confluence 身份验证凭据。如果您选择创建新密钥，则会打开 AWS Secrets Manager 密钥窗口。

         1. 在**创建 AWS Secrets Manager 密钥窗口**中输入以下信息：

           1. **密钥名称** - 密钥的名称。前缀 “AmazonKendra-Confluence-” 会自动添加到您的密钥名称中。

           1. 对于**用户名**和**密码** – 输入您的 Confluence 用户名和密码。

           1. 选择**保存身份验证**。

   1. 如果选择 **Confluence Server**，请输入以下信息：

      1. **Confluence URL** - 您的 Confluence 用户名和密码。

      1. （可选）对于 **Web 代理** - 请输入以下信息：

         1.  **主机名** - 您的 Confluence 账户的主机名。

         1.  **端口号** - 主机 URL 传输协议使用的端口。

      1. 对于**身份验证**，请选择**基本身份验证**或（仅限 Confluence Server）**个人访问令牌**。

      1. AWS Secrets Manager s@@ **ecret** —选择现有密钥或创建新 Secrets Manager 密钥来存储您的 Confluence 身份验证凭据。如果您选择创建新密钥，则会打开 AWS Secrets Manager 密钥窗口。

         1. 在**创建 AWS Secrets Manager 密钥窗口**中输入以下信息：

           1. **密钥名称** - 密钥的名称。前缀 “AmazonKendra-Confluence-” 会自动添加到您的密钥名称中。

           1. 对于**用户名**和**密码** - 输入您在 Confluence 中配置的身份验证凭证值。如果使用基本身份验证，请使用您的 Confluence 用户名（电子邮件 ID）和密码（API 令牌）。如果使用个人访问令牌，请输入您在 Confluence 账户中配置的**个人访问令牌**的详细信息。

           1. 保存并添加您的密钥。

   1. **IAM ro** le —选择现有 IAM 角色或创建新 IAM 角色来访问您的存储库凭据和索引内容。
**注意**  
IAM 用于索引的角色不能用于数据源。如果您不确定是否将现有角色用于编制索引或常见问题解答，为了避免出错，请选择**创建新角色**。

   1. 选择**下一步**。

1. 在**配置同步设置**页面上，请输入以下信息：

   1. 对于**包括个人空间**和**包括存档空间** - 选择要包含在此数据来源中的可选空间类型。

   1. 对于**其他配置** - 指定正则表达式模式以包含或排除某些文件。最多可以添加 100 个模式。

   1. 您还可以选择**在所选空间内爬取附件**。

   1. 在 “**同步运行计划**” 中，“**频率**”-选择与数据源同步的频率。 Amazon Kendra 

   1. 选择**下一步**。

1. 在**设置字段映射**页面上，请输入以下信息：

   1. 对于 **Spac** **e、Page**、**Blog**-从 Amazon Kendra 生成的默认数据源字段或其他**建议的字段映射**中选择以添加索引字段。

   1.  **添加字段** - 添加自定义数据来源字段以创建要映射到的索引字段名称和字段数据类型。

   1. 选择**下一步**。

1. 在**查看和创建**页面上，请检查输入的信息是否正确，然后选择**添加数据来源**。您也可以选择在此页面上编辑信息。成功添加数据来源后，您的数据来源将显示在**数据来源**页面上。

------
#### [ API ]

**连接到 Con Amazon Kendra fluence**

您必须使用 [ConfluenceConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_ConfluenceConfiguration.html)API 指定以下内容：
+ **Confluence 版本** - 指定您用作 `CLOUD` 或 `SERVER` 的 Confluence 实例的版本。
+ **亚马逊秘密资源名称 (ARN)**-提供包含您的 Confluence 身份验证凭证的 Secrets Manager 密钥的亚马逊资源名称 (ARN)。

  如果您使用的是 Confluence Server，则可以使用您的 Confluence 用户名和密码或您的个人访问令牌作为身份验证凭证。

  如果您使用 Confluence 用户名和密码作为身份验证凭证，您将在 Secrets Manager 密钥中以 JSON 结构的形式存储以下凭证：

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

  如果您使用个人访问令牌连接 Confluence Server Amazon Kendra，则可以将以下凭据作为 JSON 结构存储在您的 Secrets Manager 密钥中：

  ```
  {
      "patToken": "personal access token"
  }
  ```

  如果您使用 Confluence Cloud，则可以使用您的 Confluence 用户名和在 Confluence 配置的 API 令牌作为密码。您将以下凭证作为 JSON 结构存储在您的 Secrets Manager 密钥中：

  ```
  {
      "username": "user name",
      "password": "API token"
  }
  ```
+ **IAM 角色** —指定`RoleArn`何时调用`CreateDataSource`以向 IAM 角色提供访问您的 Secrets Manager 密钥的权限以及致电 Confluence 连接器 APIs 所需的公众的权限，以及。 Amazon Kendra有关更多信息，请参阅 [Confluence 数据来源的IAM 角色](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)。

您还可以添加以下可选功能：
+ **Web 代理** - 是否通过 Web 代理连接到您的 Confluence URL 实例。您可以将此选项用于 Confluence Server。
+ （仅适用于 Confluence Server）**虚拟私有云（VPC）**- 在数据来源配置中指定 `VpcConfiguration`。请参阅[配置 Amazon Kendra 以使用 VPC](https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html)。
+  **包含和排除筛选条件** - 指定用于包含或排除特定空间、博客文章、页面、空间和附件的正则表达式。如果您选择为附件编制索引，则仅对已编入索引的页面和博客的附件编制索引。
**注意**  
大多数数据来源使用正则表达式模式，即称为筛选条件的包含或排除模式。如果您指定包含筛选条件，则只会为与包含筛选条件匹配的内容编制索引。不会为任何与包含筛选条件不匹配的文档编制索引。如果您指定包含和排除筛选条件，则不会为与排除筛选条件匹配的文档编制索引，即使它们与包含筛选条件相匹配。
+  **字段映射** - 选择将 Confluence 数据来源字段映射到 Amazon Kendra 索引字段。有关更多信息，请参阅[映射数据来源字段](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)。
**注意**  
要搜索您的文档，必须输入文档正文字段或文档正文等效字段。 Amazon Kendra 您必须将数据来源中的文档正文字段名映射到索引字段名称 `_document_body`。其他所有字段均为可选字段。
+  **用户上下文筛选和访问控制** – 如果文档有 ACL，则Amazon Kendra 会爬取文档的访问控制列表（ACL）。ACL 信息用于根据用户或其所在组对文档的访问权限来筛选搜索结果。有关更多信息，请参阅[用户上下文筛选](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter)。

------

## 了解详情
<a name="confluence-v1-learn-more"></a>

要了解有关 Amazon Kendra 与 Confluence 数据源集成的更多信息，请参阅：
+ [配置您的 Amazon Kendra Confluence 服务器连接器](https://aws.amazon.com/blogs/machine-learning/configuring-your-amazon-kendra-confluence-server-connector/)