Confluence コネクタ V2.0

Confluence は、プロジェクト計画、ソフトウェア開発、製品管理の共有、保存、作業を目的とした共同作業管理ツールです。 Amazon Kendra を使用して、Confluence のスペース、ページ (ネストされたページを含む）、ブログ、およびインデックス付きページやブログへのコメントや添付ファイルのインデックスを作成できます。

Amazon Kendra Confluence データソースコネクタのトラブルシューティングについては、「」を参照してくださいデータソースのトラブルシューティング。

トピック

サポートされている機能
前提条件
接続手順

サポートされている機能

Amazon Kendra Confluence データソースコネクタは、次の機能をサポートしています。

フィールドマッピング
ユーザーアクセスコントロール
包含/除外パターン
完全および増分コンテンツ同期
仮想プライベートクラウド (VPC）

前提条件

Amazon Kendra を使用して Confluence データソースのインデックスを作成する前に、Confluence とアカウントでこれらの変更を行ってください AWS 。

Confluence で以下を確認してください。

Confluence インスタンスの URL をコピーしました。例えば：https://example.confluence.com、または https://www.example.confluence.com/、または https:// atlassian.net/。接続するには Confluence インスタンスの URL が必要です Amazon Kendra。

Confluence Cloud を使用している場合、ホスト URL はで終わる必要があります。atlassian.net/.
注記
次の URL 形式はサポートされていません。
- https://example.confluence.com/xyz
- https://www.example.confluence.com//wiki/spacekey/xxx
- https://atlassian.net/xyz
注記
（オンプレミス/サーバー) Amazon Kendra に含まれるエンドポイント情報が、データソース設定の詳細で指定されたエンドポイント情報 AWS Secrets Manager と同じかどうかを確認します。混乱する代理問題は、ユーザーがアクションを実行するアクセス許可がないにもかかわらず、 Amazon Kendra をプロキシとして使用して設定された秘密にアクセスし、アクションを実行するセキュリティの問題です。後でエンドポイント情報を変更する場合は、新しいシークレットを作成してこの情報を同期する必要があります。
ユーザー名 (Confluence へのログインに使用される E メール ID) とパスワード (Confluence API トークンをパスワードとして使用) を含む基本認証情報を設定しました。「Manage API tokens for your Atlassian account」を参照してください。

注記
認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨しません。
オプション： Confluence アプリケーションキー、Confluence アプリケーションシークレット、Confluence アクセストークン、Confluence 更新トークンを含む OAuth 2.0 認証情報を設定して、 Amazon Kendra が Confluence インスタンスに接続できるようにしました。アクセストークンの有効期限が切れた場合は、更新トークンを使用してアクセストークンと更新トークンのペアを再生成できます。または、認可プロセスを繰り返すこともできます。アクセストークンの詳細については、OAuth アクセストークンの管理」を参照してください。
(Confluence サーバー/データセンターのみ) オプション： Confluence で個人用アクセストークン (PAT) を設定しました。「個人用アクセストークンの使用」を参照してください。

で 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 を指定する必要があります。

接続手順

Confluence データソース Amazon Kendra に接続するには、がデータ Amazon Kendra にアクセスできるように Confluence データソースの必要な詳細を指定する必要があります。の Confluence をまだ設定していない場合は、 Amazon Kendra 「」を参照してください前提条件。

Console

Confluence Amazon Kendra に接続するには

にサインイン AWS Management Console し、 Amazon Kendra コンソールを開きます。
左側のナビゲーションペインで、[インデックス] を選択し、インデックスのリストから使用するインデックスを選択します。

注記
[インデックスの設定] で、[ユーザーアクセスコントロール] 設定を設定または編集できます。
[使用開始] ページで、[データソースを追加] を選択します。
データソースの追加ページで、Confluence コネクタを選択し、コネクタの追加を選択します。バージョン 2 を使用している場合 (該当する場合）、「V2.0」タグの付いた Confluence コネクタを選択します。
[データソースの詳細を指定] ページで、次の情報を入力します。
1. [名前と説明] の [データソース名] に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。
2. (オプション) [説明] - オプションで、データソースの説明を入力します。
3. デフォルト言語 - インデックスのドキュメントをフィルタリングする言語を選択します。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。
4. タグで新しいタグを追加する - リソースを検索およびフィルタリングしたり、 AWS コストを追跡したりするためのオプションのタグを含めます。
5. [Next (次へ)] を選択します。
[アクセスとセキュリティの定義] ページで、次の情報を入力します。
1. Source で、Confluence Cloud または Confluence Server/Data Center を選択します。
2. Confluence URL - Confluence ホストの URL を入力します。例えば、などです https://example.confluence.com.
3. (Confluence Server/データセンターのみ) SSL 証明書の場所 - オプション - Confluence Server の SSL 証明書ファイルへの Amazon S3 パスを入力します。
4. (Confluence サーバー/データセンターのみ) ウェブプロキシ - オプション - ウェブプロキシのホスト名 ( http://または https://プロトコルなし) とポート番号 (ホスト URL トランスポートプロトコルで使用されるポート) を入力します。ポート番号は 0～65535 の数字である必要があります。
5. 認可 - ACL があり、それをアクセスコントロールに使用する場合は、ドキュメントのアクセスコントロールリスト (ACL) 情報をオンまたはオフにします。ACL は、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて検索結果をフィルタリングするために使用されます。詳細については、「User context filtering」を参照してください。
6. 認証 - 基本認証、Oauth 2.0 認証、または (Confluence サーバー/データセンターのみ) 個人用アクセストークン認証を選択します。
7. [AWS Secrets Manager シークレット] - Confluence の認証情報を保存する既存のシークレットを選択するか、新しい Secrets Manager シークレットを作成します。新しいシークレットの作成を選択すると、 AWS Secrets Manager シークレットウィンドウが開きます。ウィンドウで、以下の情報を入力します。
  1. [シークレット名] - シークレットの名前。シークレット名には、プレフィックスAmazonKendra-Confluence-」が自動的に追加されます。
  2. 基本認証を使用する場合 - Confluence で設定したシークレット名、ユーザー名、パスワード (Confluence API トークンをパスワードとして) を入力します。
    
    OAuth2.0 認証を使用する場合 - Confluence で設定したシークレット名、アプリキー、アプリシークレット、アクセストークン、更新トークンを入力します。
    
    (Confluence サーバー/データセンターのみ) 個人用アクセストークン認証を使用する場合 - Confluence で設定したシークレット名と Confluence トークンを入力します。
  3. シークレットを保存して追加します。
8. Virtual Private Cloud (VPC） — VPC の使用を選択できます。その場合は、サブネットと VPC セキュリティグループを追加する必要があります。
9. ID クローラー - Amazon Kendraの ID クローラーを有効にするかどうかを指定します。ID クローラは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて検索結果をフィルタリングします。ドキュメントに ACL があり、ACL の使用を選択した場合は、 Amazon Kendra ID クローラーをオンにして検索結果のユーザーコンテキストフィルタリングを設定することもできます。それ以外の場合、ID クローラがオフになっていると、すべてのドキュメントをパブリックに検索できます。ドキュメントのアクセスコントロールを使用し、ID クローラがオフになっている場合は、API PutPrincipalMapping を使用してユーザーコンテキストフィルタリングのためにユーザーおよびグループのアクセス情報をアップロードできます。
10. IAM role - 既存の IAM ロールを選択するか、新しい IAM ロールを作成してリポジトリ認証情報にアクセスし、コンテンツにインデックスを作成します。
  
  注記
  IAM インデックスに使用されるロールは、データソースには使用できません。既存のロールがインデックスまたは FAQ に使用されているかどうかが不明な場合は、エラーを避けるために新しいロールの作成を選択します。
11. [Next (次へ)] を選択します。
[同期設定の構成] ページで、次の情報を入力します。
1. 同期スコープの同期コンテンツの場合 - ページ、ページコメント、ページ添付ファイル、ブログ、ブログコメント、ブログ添付ファイル、個人スペース、アーカイブスペースのコンテンツタイプから同期を選択します。
  
  注記
  ページコメントとページ添付ファイルは、ページを同期することを選択した場合にのみ削除できます。ブログコメントとブログ添付ファイルは、ブログを同期することを選択した場合のみ削除できます。
  
  重要
  追加設定でスペースキー正規表現パターンを指定しない場合、すべてのページとブログはデフォルトでクロールされます。
2. 追加設定で、最大ファイルサイズ - Amazon Kendra クロールするファイルサイズ制限を MBs で指定します。 Amazon Kendra は、定義したサイズ制限内のファイルのみをクロールします。デフォルトのファイルサイズは 50 MB です。最大ファイルサイズは 0 MB より大きく、50 MB 以下である必要があります。
  
  Spaces 正規表現パターンの場合 - 以下を使用して、インデックスに特定のスペースを含めるか除外するかを指定します。
  - スペースキー (例：my-space-123)
    
    注記
    スペースキー正規表現パターンを指定しない場合、すべてのページとブログはデフォルトでクロールされます。
  - URL (例：.*/MySite/MyDocuments/)
  - ファイルタイプ (例：.*\.pdf, .*\.txt)
  エンティティタイトル正規表現パターンの場合 - 特定のブログ、ページ、コメント、添付ファイルをタイトルで含めたり除外したりするには、正規表現パターンを指定します。
  
  注記
  特定のページまたはサブページのクロールを含めたり除外したりする場合は、ページタイトル正規表現パターンを使用できます。
3. [同期モード] - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。データソースをと Amazon Kendra 初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択しなくても、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。
  - 完全同期: データソースがインデックスと同期するたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを作成します。
  - 新規、変更、削除された同期: データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのみをインデックス化します。 Amazon Kendra は、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツとインデックスコンテンツを追跡できます。
4. 同期実行スケジュールで、頻度 - データソースコンテンツを同期してインデックスを更新する頻度を選択します。
5. [Next (次へ)] を選択します。
[フィールドマッピングを設定] ページで、次の情報を入力します。
1. インデックスにマッピングする、 Amazon Kendra 生成されたデフォルトのデータソースフィールドから選択します。カスタムデータソースフィールドを追加するには、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。
2. [Next (次へ)] を選択します。
[確認と作成] ページで、入力した情報が正しいことを確認し、[データソースを追加] を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが [データソース] ページに表示されます。

API

Confluence Amazon Kendra に接続するには

JSON を使用してデータソーススキーマの TemplateConfigurationWord を指定する必要があります。 APIこれには、以下の情報を入力する必要があります。

データソース - を使用するCONFLUENCEV2ときにデータソースタイプをとして指定します。 TemplateConfiguration JSONスキーマ。また、を呼び出すTEMPLATEときにデータソースをとして指定します。 CreateDataSource API.
Host URL - Confluence ホスト URL インスタンスを指定します。例えば、などです https://example.confluence.com.
同期モード - データソースコンテンツが変更されたときにがインデックスを更新する方法 Amazon Kendra を指定します。データソースを Amazon Kendra と初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択しなくても、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。以下のいずれかから選択できます。
- FORCED_FULL_CRAWL データソースがインデックスと同期するたびに既存のコンテンツを置き換えて、すべてのコンテンツに新しいインデックスを作成します。
- FULL_CRAWL は、データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendra は、データソースのメカニズムを使用して、コンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。
認証タイプ - 認証のタイプを指定します。Basic、OAuth2、 (Confluence Server のみ) のいずれかを指定しますPersonal-token。
（オプション - Confluence サーバーのみ) SSL 証明書の場所 - SSL 証明書の保存s3certificateNameに使用した S3bucketNameとを指定します。
シークレット Amazon リソースネーム (ARN） - Confluence で設定した認証情報を含む Secrets Manager シークレットの Amazon リソースネーム (ARN) を指定します。基本認証を使用する場合、シークレットは次のキーを持つ JSON 構造に保存されます。
```
{
    "username": "email ID or user name",
    "password": "Confluence API token"
}
```
OAuth 2.0 認証を使用する場合、シークレットは次のキーを持つ JSON 構造に保存されます。
```
{
    "confluenceAppKey": "app key",
    "confluenceAppSecret": "app secret",
    "confluenceAccessToken": "access token",
    "confluenceRefreshToken": "refresh token"
}
```
(Confluence Server のみ) 基本認証を使用する場合、シークレットは次のキーを持つ JSON 構造に保存されます。
```
{
    "hostUrl": "Confluence Server host URL",
    "username": "Confluence Server user name",
    "password": "Confluence Server password"
}
```
(Confluence サーバーのみ) 個人用アクセストークン認証を使用する場合、シークレットは次のキーを持つ JSON 構造に保存されます。
```
{
    "hostUrl": "Confluence Server host URL",
    "patToken": "personal access token"
}
```
IAM role - を呼び出しCreateDataSourceて IAM ロールに Secrets Manager シークレットへのアクセス許可を付与し、Confluence コネクタとに必要なパブリック APIs を呼び出すRoleArnタイミングを指定します Amazon Kendra。詳細については、「IAM roles for Confluence data sources」を参照してください。

オプションで、次の機能を追加することもできます。

Virtual Private Cloud (VPC） - を呼び出すVpcConfigurationときにを指定しますCreateDataSource。詳細については、「を使用する Amazon Kendra ようにを設定する Amazon VPC」を参照してください。
ファイルサイズ - クロールする最大ファイルサイズを指定します。
ドキュメント/コンテンツタイプ - ページ、ページコメント、ページアタッチメント、ブログ、ブログコメント、ブログアタッチメント、スペース、アーカイブスペースをクロールするかどうかを指定します。
包含フィルターと除外フィルター - 特定のスペース、ページ、ブログ、コメントや添付ファイルを含めるか除外するかを指定します。

注記
ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。
ウェブプロキシ - ウェブプロキシ経由で Confluence URL インスタンスに接続する場合は、ウェブプロキシ情報を指定します。このオプションは Confluence サーバーに使用できます。
アクセスコントロールリスト (ACL） - ACL があり、それをアクセスコントロールに使用する場合は、ドキュメントの ACL 情報をクロールするかどうかを指定します。ACL は、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて検索結果をフィルタリングするために使用されます。詳細については、「User context filtering」を参照してください。
ID クローラー - Amazon Kendraの ID クローラーを有効にするかどうかを指定します。ID クローラは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて検索結果をフィルタリングします。ドキュメントに ACL があり、ACL の使用を選択した場合は、 Amazon Kendra ID クローラをオンにして、検索結果のユーザーコンテキストフィルタリングを設定することもできます。それ以外の場合、ID クローラがオフになっていると、すべてのドキュメントをパブリックに検索できます。ドキュメントのアクセスコントロールを使用し、ID クローラがオフになっている場合は、PutPrincipalMapping API を使用してユーザーコンテキストフィルタリングのためにユーザーおよびグループのアクセス情報をアップロードできます。
フィールドマッピング - 選択すると、Confluence データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、データソースフィールドのマッピングを参照してください。

注記
がドキュメント Amazon Kendra を検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名にマッピングする必要があります_document_body。その他のすべてのフィールドはオプションです。

設定するその他の重要な JSON キーのリストについては、「Confluence テンプレートスキーマ」を参照してください。

メモ

個人用アクセストークン (PAT) は Confluence Cloud では使用できません。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

Confluence

Confluence コネクタ V1.0

Confluence コネクタ V2.0

トピック

サポートされている機能

前提条件

注記

注記

注記

注記

注記

接続手順

注記

注記

注記

重要

注記

注記

注記

注記

メモ