翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
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/。 URL に接続するには Confluence インスタンスが必要です 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トークンをパスワードとして使用) を含む基本認証情報を設定しました。「Atlassian アカウントのAPIトークンを管理する」を参照してください。
認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨しません。
-
オプション： Confluence OAuth アプリキー、Confluence アプリシークレット、Confluence アクセストークン、および Confluence 更新トークンを含む 2.0 認証情報を が許可するように設定しました Amazon Kendra を Confluence インスタンスに接続します。アクセストークンの有効期限が切れた場合は、更新トークンを使用してアクセストークンと更新トークンのペアを再生成できます。または、認証プロセスを繰り返すこともできます。アクセストークンの詳細については、OAuth「アクセストークンの管理」を参照してください。
-
(Confluence サーバー/データセンターのみ) オプション： Confluence で個人用アクセストークン (PAT) を設定しました。「個人用アクセストークンの使用」を参照してください。
の AWS アカウント、以下があることを確認します。
-
を作成しました Amazon Kendra index と、 を使用している場合はAPIインデックス ID を記録しました。
-
を作成しました IAM データソースの ロール。 を使用している場合はAPI、 ARNの を記録しました。 IAM ロール。
認証タイプと認証情報を変更する場合は、 IAM 正しい にアクセスするための ロール AWS Secrets Manager シークレット ID。
-
Confluence 認証情報を に保存しました AWS Secrets Manager シークレット。 を使用している場合はAPI、シークレットARNの を記録しました。
認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨しません。
既存の がない場合 IAM ロールまたはシークレットでは、コンソールを使用して新しい を作成できます。 IAM ロールと Secrets Manager Confluence データソースを に接続するときの シークレット Amazon Kendra。 を使用している場合はAPI、既存の ARNの を指定する必要があります。 IAM ロールと Secrets Manager シークレット、およびインデックス ID。
接続手順
接続するには Amazon Kendra Confluence データソースに必要な詳細を Confluence データソースに提供して、 Amazon Kendra はデータにアクセスできます。の Confluence をまだ設定していない場合 Amazon Kendra 「」を参照してください前提条件。
- Console
-
接続するには Amazon Kendra Confluence への
-
にサインインする AWS Management Console を開き、 Amazon Kendra コンソール 。
-
左側のナビゲーションペインで、[インデックス] を選択し、インデックスのリストから使用するインデックスを選択します。
[インデックスの設定] で、[ユーザーアクセスコントロール] 設定を設定または編集できます。
-
[使用開始] ページで、[データソースを追加] を選択します。
-
データソースの追加ページで、Confluence コネクタ を選択し、コネクタの追加 を選択します。バージョン 2 を使用している場合 (該当する場合）、「V2.0」タグが付いた Confluence コネクタを選択します。
-
[データソースの詳細を指定] ページで、次の情報を入力します。
-
[名前と説明] の [データソース名] に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。
-
(オプション) [説明] - オプションで、データソースの説明を入力します。
-
デフォルト言語 - ドキュメントをフィルタリングしてインデックスを作成する言語を選択します。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。
-
タグ で、新しいタグを追加 — リソースを検索およびフィルタリングしたり、 を追跡したりするためのオプションのタグを含めます。 AWS コスト。
-
[Next (次へ)] を選択します。
-
[アクセスとセキュリティの定義] ページで、次の情報を入力します。
-
ソース で、Confluence Cloud または Confluence サーバー/データセンター を選択します。
-
Confluence URL— Confluence ホスト を入力しますURL。例えば、 などです https://example.confluence.com.
-
(Confluence サーバー/データセンターのみ) SSL証明書の場所 - オプション — を入力します Amazon S3 Confluence Server のSSL証明書ファイルへのパス。
-
(Confluence サーバー/データセンターのみ) ウェブプロキシ - オプション — ウェブプロキシのホスト名 ( http://または https://プロトコルなし) とポート番号 (ホストURLトランスポートプロトコルで使用されるポート) を入力します。ポート番号は 0～65535 の数字である必要があります。
-
認証 — があり、アクセスコントロールACLに使用する場合は、ドキュメントのアクセスコントロールリスト (ACL) 情報をオンまたはオフにします。は、ユーザーとグループがアクセスできるドキュメントACLを指定します。このACL情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて検索結果をフィルタリングするために使用されます。詳細については、「User context filtering」を参照してください。
-
認証 — 基本認証 、Oauth 2.0 認証 、または (Confluence サーバー/データセンターのみ) 個人用アクセストークン認証 を選択します。
-
AWS
Secrets Manager シークレット — 既存のシークレットを選択するか、新しいシークレットを作成します。 Secrets Manager Confluence 認証情報を保存する シークレット。新しいシークレットを作成することを選択した場合は、 AWS
Secrets Manager シークレットウィンドウが開きます。ウィンドウで、以下の情報を入力します。
-
[シークレット名] - シークレットの名前。シークレット名には、プレフィックスAmazonKendra「-Confluence-」が自動的に追加されます。
-
基本認証を使用する場合 — Confluence で設定したシークレット名、ユーザー名、パスワード (Confluence APIトークンをパスワードとして) を入力します。
OAuth2.0 認証を使用する場合 — Confluence で設定したシークレット名、アプリキー、アプリシークレット、アクセストークン、および更新トークンを入力します。
(Confluence サーバー/データセンターのみ) 個人用アクセストークン認証を使用する場合 — Confluence で設定したシークレット名と Confluence トークンを入力します。
-
シークレットを保存して追加します。
-
Virtual Private Cloud (VPC） — の使用を選択できますVPC。その場合は、サブネットとVPCセキュリティグループ を追加する必要があります。
-
ID クローラー — 有効にするかどうかを指定します Amazon Kendraの ID クローラー。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて検索結果をフィルタリングします。ドキュメントACL用の があり、 を使用することを選択した場合はACL、 をオンにすることもできます。 Amazon Kendra検索結果のユーザーコンテキストフィルタリングを設定する の ID クローラー。それ以外の場合、ID クローラーがオフになっていると、すべてのドキュメントをパブリックに検索できます。ドキュメントのアクセスコントロールを使用し、ID クローラーがオフになっている場合は、 を使用してユーザーコンテキストフィルタリングのためにユーザーおよびグループのアクセス情報PutPrincipalMappingAPIをアップロードすることもできます。
-
IAM ロール — 既存の を選択する IAM ロールまたは新しい を作成する IAM リポジトリ認証情報とインデックスコンテンツにアクセスするための ロール。
IAM インデックスに使用される ロールは、データソースには使用できません。インデックスまたは に既存のロールが使用されているかどうか不明な場合はFAQ、エラーを避けるために新しいロールを作成するを選択します。
-
[Next (次へ)] を選択します。
-
[同期設定の構成] ページで、次の情報を入力します。
-
同期スコープ で、同期コンテンツ - ページ、ページコメント、ページ添付ファイル、ブログ、ブログコメント、ブログ添付ファイル、個人スペース、アーカイブスペースのコンテンツタイプから同期することを選択します。
ページコメントとページ添付ファイルは、ページ を同期することを選択した場合のみ、削除できます。ブログコメントとブログ添付ファイルは、ブログ を同期することを選択した場合のみ、削除できます。
追加設定 でスペースキー正規表現パターンを指定しない場合、すべてのページとブログはデフォルトでクロールされます。
-
追加設定 で、最大ファイルサイズ - MBsそのファイルサイズ制限を指定します。 Amazon Kendra はクロールします。 Amazon Kendra は、定義したサイズ制限内のファイルのみをクロールします。デフォルトのファイルサイズは 50 MB です。最大ファイルサイズは 0 MB より大きく、50 MB 以下である必要があります。
Spaces 正規表現パターンの場合 — 以下を使用して、インデックスに特定のスペースを含めるか除外するかを指定します。
エンティティタイトル正規表現パターンの場合 — 特定のブログ、ページ、コメント、添付ファイルをタイトル別に含めたり除外したりするように正規表現パターンを指定します。
特定のページまたはサブページのクロールを含めたり除外したりする場合は、ページタイトル正規表現パターンを使用できます。
-
[同期モード] - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。データソースを と同期する場合 Amazon Kendra
は、すべてのコンテンツがデフォルトでクロールおよびインデックス化されます。同期モードオプションとしてフル同期を選択しなくても、最初の同期が失敗した場合は、データのフル同期を実行する必要があります。
-
フル同期: すべてのコンテンツを新しくインデックス化し、データソースがインデックスと同期するたびに既存のコンテンツを置き換えます。
-
新規、変更、削除された同期: データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのみをインデックス化します。 Amazon Kendra は、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツの変更を追跡し、コンテンツのインデックスを作成できます。
-
同期実行スケジュール で、頻度 — データソースコンテンツを同期してインデックスを更新する頻度を選択します。
-
[Next (次へ)] を選択します。
-
[フィールドマッピングを設定] ページで、次の情報を入力します。
-
から を選択します。 Amazon Kendra は、インデックスにマッピングするデフォルトのデータソースフィールドを生成しました。カスタムデータソースフィールドを追加するには、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。
-
[Next (次へ)] を選択します。
-
[確認と作成] ページで、入力した情報が正しいことを確認し、[データソースを追加] を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが [データソース] ページに表示されます。
- API
-
接続するには Amazon Kendra Confluence への
を使用して、データソーススキーマJSONの TemplateConfiguration を指定する必要がありますAPI。これには、以下の情報を入力する必要があります。
-
データソース — CONFLUENCEV2を使用する場合、データソースタイプを として指定します。 TemplateConfiguration JSON スキーマ。また、 を呼び出すTEMPLATEときにデータソースを として指定します。 CreateDataSource
API.
-
ホスト 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） - の Amazon リソースネーム (ARN) を指定します。 Secrets Manager Confluence で設定した認証情報を含む シークレット。基本認証を使用する場合、シークレットは次のキーを持つ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 サーバーのみ) 基本認証を使用する場合、シークレットは次のキーを持つ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て を提供するRoleArnタイミングを指定します。 IAM へのアクセス許可を持つ ロール Secrets Manager シークレットと は、Confluence コネクタと APIsに必要なパブリックを呼び出すことができます。 Amazon Kendra。 詳細については、「」を参照してください。 IAM Confluence データソース の ロール。
オプションで、次の機能を追加することもできます。
-
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 クローラーがオフになっている場合は、 を使用してユーザーコンテキストフィルタリング用のユーザーおよびグループのアクセス情報PutPrincipalMappingAPIをアップロードすることもできます。
-
フィールドマッピング — 選択すると、Confluence データソースフィールドを にマッピングします。 Amazon Kendra インデックスフィールド。詳細については、データソースフィールドのマッピングを参照してください。
ドキュメント本文フィールド、またはドキュメントと同等のドキュメント本文は、 のために必要です。 Amazon Kendra ドキュメントを検索するには、 を使用します。データソースのドキュメント本文フィールド名をインデックスフィールド名 にマッピングする必要があります_document_body。その他のすべてのフィールドはオプションです。
設定するその他の重要なJSONキーのリストについては、「Confluence テンプレートスキーマ」を参照してください。
メモ
