Confluence コネクタ V2.0 - Amazon Kendra
サポートされている機能前提条件接続手順

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

Confluence コネクタ V2.0

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

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

サポートされている機能

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

  • フィールドマッピング

  • ユーザーアクセスコントロール

  • 包含/除外パターン

  • 完全および増分コンテンツ同期

  • Virtual Private Cloud (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 Cloud を使用している場合、ホスト URL は atlassian.net/ で終わる必要があります。

    注記

    以下の URL の形式はサポートされていません。

    • https://example.confluence.com/xyz

    • https://www.example.confluence.com//wiki/spacekey/xxx

    • https://atlassian.net/xyz

    注記

    (オンプレミス/サーバー) Amazon KendraAWS Secrets Managerは、 に含まれるエンドポイント情報が、データソース設定の詳細で指定されたエンドポイント情報と同じかどうかを確認します。混乱する代理問題は、ユーザーがアクションを実行するアクセス許可がないにもかかわらず、Amazon Kendra をプロキシとして使用して設定された秘密にアクセスし、アクションを実行するセキュリティの問題です。後でエンドポイント情報を変更する場合は、新しいシークレットを作成してこの情報を同期する必要があります。

  • ユーザー名 (Confluence へのログインに使用する電子メール ID) とパスワード (Confluence API トークンをパスワードとして) を含む基本認証情報を設定済みであること。「Manage API tokens for your Atlassian account」を参照してください。

    注記

    認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨しません。

  • オプション: Amazon Kendra を Confluence インスタンスに接続できるように、Confluence アプリキー、Confluence アプリシークレット、Confluence アクセストークン、および Confluence リフレッシュトークンを含む OAuth 2.0 認証情報を設定しました。アクセストークンの有効期限が切れた場合は、更新トークンを使用してアクセストークンと更新トークンのペアを再生成できます。または、認可プロセスを繰り返すこともできます。アクセストークンの詳細については、「OAuth アクセストークンの管理」を参照してください。

  • (Confluence Server/Data Center のみ) オプション: Confluence で個人用アクセストークン (PAT) を設定済みであること。「Using Personal Access Tokens」を参照してください。

でAWS アカウント、以下があることを確認します。

  • Amazon Kendraインデックスを作成し、 API を使用している場合はインデックス ID を記録しました。

  • データソースの IAMロールを作成し、 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 を指定する必要があります。

接続手順

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

Console

Confluence Amazon Kendraに接続するには

  1. にサインインAWS マネジメントコンソールし、 Amazon Kendraコンソールを開きます。

  2. 左側のナビゲーションペインで、[インデックス] を選択し、インデックスのリストから使用するインデックスを選択します。

    注記

    [インデックスの設定] で、[ユーザーアクセスコントロール] 設定を設定または編集できます。

  3. [使用開始] ページで、[データソースを追加] を選択します。

  4. [データソースを追加] ページで [Confluence コネクタ] を選択し、[コネクタを追加] を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた [Confluence コネクタ] を選択します。

  5. [データソースの詳細を指定] ページで、次の情報を入力します。

    1. [名前と説明] の [データソース名] に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。

    2. (オプション) [説明] - オプションで、データソースの説明を入力します。

    3. [デフォルト言語] - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。

    4. タグで、新しいタグを追加する - リソースを検索してフィルタリングしたり、AWSコストを追跡したりするためのオプションのタグを含めます。

    5. [次へ] を選択します。

  6. [アクセスとセキュリティの定義] ページで、次の情報を入力します。

    1. [ソース] で、[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 Server/Data Center のみ) [ウェブプロキシ - オプション] - ウェブプロキシのホスト名 (http:// プロトコルまたは https:// プロトコルは含めません) とポート番号 (ホスト URL トランスポートプロトコルが使用するポート) を入力します。ポート番号は 0～65535 の数字である必要があります。

    5. [承認] - アクセスコントロールリスト (ACL) があり、それをアクセスコントロールに使用する場合に、ドキュメントの ACL 情報を有効にするか無効にするかを選択します。ACL では、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「User context filtering」を参照してください。

    6. [認証] — 基本認証、Oauth 2.0 認証、または (Confluence Server/Data Center のみ) 個人用アクセストークン認証のいずれかを選択します。

    7. [AWS Secrets Manager シークレット] - Confluence の認証情報を保存する既存のシークレットを選択するか、新しい Secrets Manager シークレットを作成します。新しいシークレットの作成を選択すると、AWS Secrets Manager シークレットウィンドウが開きます。ウィンドウで、以下の情報を入力します。

      1. [シークレット名] - シークレットの名前。シークレット名に、プレフィックス「AmazonKendra-Confluence-」が自動的に追加されます。

      2. 基本認証を使用する場合 - Confluence で設定したシークレット名、ユーザー名、パスワード (Confluence API トークンをパスワードとして使用) を入力します。

        OAuth2.0 認証を使用する場合 - Confluence で設定したシークレット名、アプリキー、アプリシークレット、アクセストークン、更新トークンを入力します。

        (Confluence Server/Data Center のみ) 個人用アクセストークン認証を使用する場合 - Confluence で設定したシークレット名と Confluence トークンを入力します。

      3. シークレットを保存して追加します。

    8. [仮想プライベートクラウド (VPC)] - VPC の使用を選択できます。選択する場合は、[サブネット] と [VPC セキュリティグループ] を追加する必要があります。

    9. [ID クローラー] - Amazon Kendra の ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセス権に基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、Amazon KendraID クローラをオンにして検索結果のユーザーコンテキストフィルタリングを設定することもできます。それ以外の場合は、ID クローラーがオフになっている場合、すべてのドキュメントは公開され検索可能になります。ID クローラーがオフになっているときにドキュメントのアクセスコントロールを使用する場合は、代わりに PutPrincipalMapping API を使用して、ユーザーコンテキストフィルタリング用にユーザーとグループのアクセス情報をアップロードすることができます。

    10. IAMrole — 既存のIAMロールを選択するか、新しいIAMロールを作成してリポジトリの認証情報とインデックスコンテンツにアクセスします。

      注記

      IAMインデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、[新しいロールを作成] を選択してください。

    11. [次へ] を選択します。

  7. [同期設定の構成] ページで、次の情報を入力します。

    1. [同期スコープ] の [コンテンツを同期] - 次のコンテンツタイプから同期するものを選択します。ページ、ページのコメント、ページの添付ファイル、ブログ、ブログのコメント、ブログの添付ファイル、個人用スペース、アーカイブ済みスペース。

      注記

      ページのコメントとページの添付ファイルは、ページを同期することを選択した場合にのみ選択できます。ブログのコメントとブログの添付ファイルは、ブログを同期することを選択した場合にのみ削除できます。

      重要

      [追加設定] でスペースキーの正規表現パターンを指定しない場合、すべてのページとブログがデフォルトでクロールされます。

    2. 追加設定で、ファイルの最大サイズ - クロールAmazon Kendraするファイルサイズの制限を MBs 単位で指定します。 Amazon Kendraは、定義したサイズ制限内のファイルのみをクロールします。デフォルトのファイルサイズは 50 MB です。最大ファイルサイズは 0 MB より大きくし、50 MB 以下にする必要があります。

      [スペースの正規表現パターン] - 特定のスペースをインデックスに含めるか除外するかを次のように指定します。

      • スペースキー (例: my-space-123)

        注記

        スペースキーの正規表現パターンを指定しない場合、すべてのページとブログがデフォルトでクロールされます。

      • URL (例: .*/MySite/MyDocuments/)

      • ファイルタイプ (例: .*\.pdf, .*\.txt)

      [エンティティタイトル正規表現パターン] - 特定のブログ、ページ、コメント、添付ファイルをタイトル別に含めたり除外したりするための正規表現パターンを指定します。

      注記

      特定のページまたは子ページのクローリングを含める、または除外する場合には、ページタイトルの正規表現パターンを使用できます。

    3. [同期モード] - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。Amazon Kendra でデータソースを初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。

      • 完全同期: データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。

      • 新規、変更、削除された同期: データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendraは、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツの変更とインデックスコンテンツを追跡できます。

    4. [同期実行スケジュール] の [頻度] - データソースコンテンツを同期してインデックスを更新する頻度を選択します。

    5. [次へ] を選択します。

  8. [フィールドマッピングを設定] ページで、次の情報を入力します。

    1. インデックスにマッピングするAmazon Kendra、生成されたデフォルトのデータソースフィールドから選択します。カスタムデータソースフィールドを追加するには、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。

    2. [次へ] を選択します。

  9. [確認と作成] ページで、入力した情報が正しいことを確認し、[データソースを追加] を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが [データソース] ページに表示されます。

API

Confluence Amazon Kendraに接続するには

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

  • [データソース] — TemplateConfiguration JSON スキーマを使用する場合は、データソースタイプを CONFLUENCEV2 と指定します。また、CreateDataSource API を呼び出す場合は、データソースを TEMPLATE と指定します。

  • [ホスト URL] - Confluence のホスト URL インスタンスを指定します。例: https://example.confluence.com

  • [同期モード] - データソースのコンテンツが変更されたときに、Amazon Kendra がインデックスを更新する方法を指定します。データソースを Amazon Kendraと初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。以下のいずれかから選択できます。

    • FORCED_FULL_CRAWL は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。

    • FULL_CRAWL は、データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendraは、データソースのメカニズムを使用して、コンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。

  • [認証タイプ] — 認証のタイプを指定します。Basic、OAuth2、Personal-token (Confluence Server のみ) のいずれかを指定します。

  • (オプション - Confluence サーバーのみ) SSL 証明書の場所 - SSL 証明書の保存に使用した S3bucketName および s3certificateName を指定します。

  • Secret Amazon Resource Name (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 サーバーのみ) 基本認証を使用する場合、シークレットは以下のキーを含む 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"
}

  • IAMrole — を呼び出しCreateDataSourceて IAMロールにSecrets Managerシークレットへのアクセス許可を付与し、Confluence コネクタと に必要なパブリック APIs を呼び出すRoleArnタイミングを指定しますAmazon Kendra。詳細については、「IAM roles for Confluence data sources」を参照してください。

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

  • [仮想プライベートクラウド (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 KendraID クローラをオンにして検索結果のユーザーコンテキストフィルタリングを設定することもできます。それ以外の場合は、ID クローラーがオフになっている場合、すべてのドキュメントは公開され検索可能になります。ID クローラーがオフになっているときにドキュメントのアクセスコントロールを使用する場合は、代わりに PutPrincipalMapping API を使用して、ユーザーコンテキストフィルタリング用にユーザーとグループのアクセス情報をアップロードすることができます。

  • フィールドマッピング - 選択すると、Confluence データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「データソースフィールドのマッピング」を参照してください。

    注記

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

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

注意事項

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