翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
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/。 Amazon Kendraに接続するには、Confluence インスタンス URL が必要です。
Confluence クラウドを使用している場合、ホスト 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 Amazon Kendra インスタンスへの接続を許可するユーザー名 (Confluence へのログインに使用される電子メール ID) とパスワード (Confluence サーバーのパスワード) を含む基本認証資格情報を設定しました。Confluence API トークンの作成方法については、「Atlassian アカウントの API トークンの管理」を参照してください。
-
オプション:Confluence インスタンスに接続できるように、Confluence アプリキー、Confluence アプリシークレット、Confluence アクセストークン、および Confluence リフレッシュトークンを含む OAuth 2.0 認証情報を設定しました。 Amazon Kendra アクセストークンの有効期限が切れた場合は、更新トークンを使用してアクセストークンと更新トークンのペアを再生成できます。または、認証プロセスを繰り返すこともできます。アクセストークンの詳細については、「OAuth アクセストークンの管理」を参照してください。
-
(Confluence サーバーのみ) オプション:Confluence インスタンスに接続できるように Amazon Kendra 、Confluence トークンを含む個人用アクセストークン (PAT) を設定しました。PAT トークンの作成方法については、「個人用アクセストークンの使用」を参照してください。
には、 AWS アカウント次のものが揃っていることを確認してください。
-
Amazon Kendra インデックスを作成し、API を使用している場合はインデックス ID を書き留めました。
-
IAM データソース用のロールを作成し、API IAM を使用している場合はロールの ARN を記録しました。
認証タイプと認証情報を変更した場合、 AWS Secrets Manager 正しいシークレット ID IAM にアクセスできるようにロールを更新する必要があります。
-
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 管理コンソールにサインインし、コンソールを開きます。Amazon Kendra
-
左側のナビゲーションペインで、[インデックス] を選択し、インデックスのリストから使用するインデックスを選択します。
[インデックスの設定] で、[ユーザーアクセスコントロール] 設定を設定または編集できます。
-
[使用開始] ページで、[データソースを追加] を選択します。
-
[データソースを追加する] ページで [Confluence コネクタ V2.0] を選択し、[コネクタを追加] を選択します。
-
[データソースの詳細を指定] ページで、次の情報を入力します。
-
[名前と説明] の [データソース名] に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。
-
(オプション) [説明] - オプションで、データソースの説明を入力します。
-
デフォルト言語 — 索引用のドキュメントをフィルタリングする言語を選択します。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。
-
[タグ] の [新しいタグの追加] — リソースの検索、絞り込み、コストの追跡を行うためのオプションタグを追加します。 AWS
-
[次へ] を選択します。
-
[アクセスとセキュリティの定義] ページで、次の情報を入力します。
-
[ソース] では、Confluence データソースのホスティング方法に基づいて [Confluence クラウド] と [Confluence サーバー] のいずれかを選択します。
-
Confluence の URL - Confluence のホスト URL を入力します。入力するホスト URL の形式は、https://example.confluence.com です。
-
(Confluence サーバーのみ) SSL 証明書の場所-オプション- Confluence サーバーの SSL Amazon S3 証明書ファイルへのパスを入力します。
-
(Confluence Server のみ) [Web プロキシ-オプション] - ウェブプロキシの[ホスト名] (http:// プロトコルまたは https:// プロトコルなし) と [ポート番号] (ホスト URL トランスポートプロトコルが使用するポート) を入力します。ポート番号は 0～65535 の数字である必要があります。
-
(Confluence サーバーのみ) [承認] - [アクセスコントロールリスト (ACL)] を有効にするかどうかを選択します。次に、[ユーザー名] と [E メール] を選択して、アクセスコントロールに使用するフィールドを選択します。
-
ユースケースに応じて、[基本認証]、[OAuth 2.0 認証]、および (Confluence サーバーのみ) [個人用アクセストークン認証] のいずれかを選択します。
-
[AWS
Secrets Manager シークレット] - Confluence の認証情報を保存する既存のシークレットを選択するか、新しい Secrets Manager シークレットを作成します。新しいシークレットの作成を選択すると、 AWS
Secrets Manager シークレットウィンドウが開きます。ウィンドウで、以下の情報を入力します。
-
[シークレット名] - シークレットの名前。プレフィックス 'AmazonKendra-Confluence-' がシークレット名に自動的に追加されます。
-
[基本認証] を使用している場合 - Confluence アカウントから生成してダウンロードした [シークレット名]、[ユーザー名]、[パスワード] (Confluence サーバーパスワード) を入力します。
[OAuth2.0 認証] を使用する場合 - Confluence アカウントで作成した [シークレット名]、[アプリキー]、[アプリシークレット]、[アクセストークン]、[更新トークン] を入力します。
(Confluence サーバーのみ) [個人用アクセストークン認証] を使用する場合 - Confluence アカウントで作成した [シークレット名]と [Confluence トークン] を入力します。
-
[シークレットを保存して追加する] を選択します。
-
[VPC とセキュリティグループの設定 - オプション] で、[仮想プライベートクラウド (VPC)] では VPC の使用を選択できます。選択する場合は、[サブネット] と [VPC セキュリティグループ] を追加する必要があります。
-
ID クローラー — の ID クローラーを有効にするかどうかを指定します。 Amazon Kendra ID クローラーは、ドキュメントのアクセス制御リスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて検索結果をフィルタリングします。ドキュメント用の ACL があり、その ACL を使用することを選択した場合は、 Amazon Kendraの ID クローラーを有効にして、検索結果のユーザーコンテキストフィルタリングを設定することもできます。それ以外の場合、ID クローラーがオフになっていると、すべてのドキュメントをパブリックに検索できます。ID クローラーがオフになっていて、ドキュメントのアクセス制御を使用したい場合は、PutPrincipalMappingAPI を使用してユーザーおよびグループのアクセス情報をアップロードし、ユーザーコンテキストフィルタリングを行うこともできます。
-
IAM ロール — 既存のロールを選択するか、 IAM IAM 新しいロールを作成して、リポジトリの認証情報とインデックスコンテンツにアクセスします。
IAM インデックスに使用されるロールはデータソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、[新しいロールを作成] を選択してください。
-
[次へ] を選択します。
-
[同期設定の構成] ページで、次の情報を入力します。
-
[同期スコープ] では、[コンテンツを同期] で、[ページ]、[ページコメント]、[ページ添付ファイル]、[ブログ]、[ブログコメント]、[ブログ添付ファイル]、[個人用スペース]、[アーカイブ済みスペース] のエンティティタイプから同期を選択します。
[ページコメント] と [ページ添付ファイル] は、[ページ] を同期することを選択した場合にのみ削除できます。[ブログコメント] と [ブログ添付ファイル] は、[ブログ] を同期することを選択した場合にのみ削除できます。
[追加設定] で [スペースキー] 正規表現パターンを指定しない場合、すべての [ページ] と [ブログ] がデフォルトでクロールされます。
-
[スペース正規表現パターン] の [追加設定] では、特定のスペースをインデックスに含めるか除外するかを次のように指定します。
-
[スペースキー] - 例えば、my-space-123 と入力します。
[追加設定] で [スペースキー] 正規表現パターンを指定しない場合、すべての [ページ] と [ブログ] がデフォルトでクロールされます。
-
URL — たとえば、. *//MySite/MyDocuments。
-
[ファイルタイプ] 例えば、.*\.pdf, .*\.txt です。
特定のページまたはサブページをクロールする場合は、ページタイトルの正規表現パターンを使用して、そのページを含めたり除外したりできます。
-
[同期モード] では、データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。 Amazon Kendra
でデータソースを初めて同期すると、デフォルトですべてのコンテンツが同期されます。
-
[同期実行スケジュール] で、[頻度]-[ Amazon Kendra データソースと同期する頻度] を選択します。
-
[次へ] を選択します。
-
[フィールドマッピングを設定] ページで、次の情報を入力します。
-
[スペース]、[ページ]、[ブログ]、[コメント]、[添付ファイル]- Amazon Kendra 生成されたデフォルトのデータソースフィールドから、インデックスにマッピングする項目を選択します。
-
[フィールドを追加] - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。
-
[次へ] を選択します。
-
[確認と作成] ページで、入力した情報が正しいことを確認し、[データソースを追加] を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが [データソース] ページに表示されます。
- API
-
Confluence Amazon Kendra に接続するには
API を使用してデータソーススキーマの JSON を指定する必要があります。TemplateConfigurationこれには、以下の情報を入力する必要があります。
-
データソース — TemplateConfigurationJSON CONFLUENCEV2 スキーマを使用する場合と同様に、データソースタイプを指定します。また、CreateDataSourceAPI TEMPLATE を呼び出すときと同じようにデータソースを指定します。
-
ホスト URL - Confluence ホストインスタンスのバージョンを指定します。例えば、https://example.confluence.com などです。
-
同期モード - Amazon Kendra
がすべてのドキュメントを同期してインデックスを更新するか、新しいドキュメント、変更されたドキュメント、削除されたドキュメントのみを同期するかどうかを指定します。以下のいずれかから選択できます。
-
認証タイプ - Confluence インスタンスの認証のタイプ (Basic、OAuth2、Personal-token) を指定します。
-
(オプション - Confluence サーバーのみ) SSL 証明書の場所 - SSL 証明書の保存に使用した S3bucketName および s3certificateName を指定します。
-
シークレットアマゾンリソースネーム (ARN) — Confluence Secrets Manager アカウントで作成した認証証明書を含むシークレットの Amazon リソースネーム (ARN) を指定します。基本アカウント認証を使用する場合、シークレットは以下のキーを含む JSON 構造に保存されます。
{
"username": "Confluence account user name",
"password": "Confluence API token"
}
OAuth 2.0 認証を使用する場合、シークレットは以下のキーを含む JSON 構造に保存されます。
{
"confluenceAppKey": "app key for your Confluence account",
"confluenceAppSecret": "app secret from your Confluence token",
"confluenceAccessToken": "access token created in Confluence",
"confluenceRefreshToken": "refresh token created in Confluence"
}
(Confluence サーバーのみ) 基本認証を使用する場合、シークレットは以下のキーを含む JSON 構造に保存されます。
{
"hostUrl": "Confluence Server host URL",
"username": "Confluence Server user name",
"password": "Confluence Server password"
}
(Confluence サーバーのみ) パーソナルアクセストークン認証を使用する場合、シークレットは以下のキーを含む JSON 構造に保存されます。
{
"hostUrl": "Confluence Server host URL",
"patToken": "Confluence token"
}
認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨しません。
-
IAM ロール — CreateDataSource IAM Secrets Manager シークレットにアクセスする権限をロールに提供し、Confluence コネクターとに必要なパブリック API RoleArn を呼び出すタイミングを指定します。 Amazon Kendra詳細については、「IAM roles for Confluence data sources」を参照してください。
オプションで、次の機能を追加することもできます。
-
[仮想プライベートクラウド (VPC)] - VpcConfiguration で CreateDataSource を呼び出すタイミングを指定します。詳細については、「を使用する Amazon Kendra ための の設定 Amazon VPC」を参照してください。
-
包含フィルターと除外フィルター - 特定のスペース、ページ、ブログ、およびそれらのコメントや添付ファイルを含めるか除外するかを指定できます。
ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。
-
ID クローラー — の ID クローラーを有効にするかどうかを指定します。 Amazon Kendra ID クローラーは、ドキュメントのアクセス制御リスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて検索結果をフィルタリングします。ドキュメント用の ACL があり、その ACL を使用することを選択した場合は、 Amazon Kendraの ID クローラーを有効にして、検索結果のユーザーコンテキストフィルタリングを設定することもできます。それ以外の場合、ID クローラーがオフになっていると、すべてのドキュメントをパブリックに検索できます。ID クローラーがオフになっていて、ドキュメントのアクセス制御を使用したい場合は、PutPrincipalMappingAPI を使用してユーザーおよびグループのアクセス情報をアップロードし、ユーザーコンテキストフィルタリングを行うこともできます。
-
フィールドマッピング - 選択すると、Confluence データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、データソースフィールドのマッピングを参照してください。
ドキュメントを検索するには、ドキュメント本文フィールドまたはドキュメントに対応するドキュメント本文が必要です。 Amazon Kendra データソース内の文書本文フィールド名をインデックスフィールド名にマップする必要があります_document_body。その他のすべてのフィールドはオプションです。
設定が必要なその他の重要な JSON キーのリストについての詳細は、「Confluence テンプレートスキーマ」を参照してください。
メモ
