ガイド付きセットアップを使用した Kong Gateway の API サービスグラフコネクタの構成

  • リリースバージョン: Zurich
  • 更新日 2025年07月31日
  • 所要時間：14分

    • Kong Gateway データを 構成管理データベース (CMDB) にプルするようにスケジュール済みインポートジョブを設定します。

    始める前に

    重要:
    ガイド付きセットアップ方法は廃止されるため、構成の問題がない限り、CMDB ワークスペースSGC セントラルビューを使用してコネクタの接続を構成します。
    依存関係と要件：
    • 自動的にインストールされる CMDB 共通統合ストアアプリ。「Integration Commons for CMDB」を参照してください。
    • 自動的にインストールされる CMDB CI クラスモデルストアアプリ。「CMDB CI クラスモデル」を参照してください。
    • ITOM ディスカバリーライセンスプラグイン (com.snc.itom.discovery.license)。このプラグインを有効にする必要があります。
    • ITOM Licensing プラグイン (com.snc.itom.license)。「Request Discovery」を参照してください。

    ベーシック認証の場合は、 Kong Gateway Admin API への要求を認証するために必要なユーザー名とパスワードを取得します。

    トークンベースの認証の場合は、 Kong Gateway サービスに接続するための API キーを取得します。

    必要なロール：admin

    手順

    1. アプリケーションピッカーを使用して、アプリケーションスコープを Kong Gateway の API サービスグラフコネクタ アプリケーションに設定します。
      詳細については、「アプリケーションピッカー」を参照してください。
    2. 移動先 すべて > サービスグラフコネクタ > Kong ゲートウェイ > セットアップ.
    3. 認証タイプ、認証情報、および HTTP 接続の詳細を構成します。
      1. [Kong Gateway Integration with CMDB] ページの [接続と資格情報の構成] セクションで、[開始] を選択します。
      2. 認証タイプを構成します。
        1. [ 認証の種類を設定する ] タスクで、[ 構成] を選択します。
        2. Auth Typeプロパティを次のいずれかの値に設定します。
          • Basic:ユーザー名とパスワードを使用するベーシック認証。
          • トークン:ユーザー名とパスワードを使用してトークンを取得するトークンベースの認証。
        3. [Update (更新)] を選択します。
        4. [完了としてマーク] を選択して、[認証タイプを設定] タスクを完了に設定します。
      3. Kong Gateway 管理 API に要求を送信するために使用する認証情報を構成します。
        1. [ 接続の構成] タスクで、[ 構成] を選択します。
        2. 認証タイプに基づいて、接続タイプを選択します。
          • ベーシック認証の場合は、[接続] ページで [Kong ベーシック認証 ] を検索して選択し、[ 詳細の表示] を選択します。
          • トークンベースの認証の場合は、[接続] ページで [Kong RBAC 認証 ] を検索して選択し、[ 詳細の表示] を選択します。
        3. デフォルトで利用可能なベーシック認証の詳細を編集します。
          注:
          トークンベースの認証を使用する場合は、この手順をスキップします。
          1. [接続を編集 (Edit Connection)] ウィンドウの [接続情報 (Connection Information)] セクションで、フィールドに入力します。
            表 : 1. 接続情報
            フィールド 説明
            接続名 Kong Gateway接続レコードを識別する名前です。

            Kong ベーシック認証 がデフォルトの接続名です。複数の Kong Gateway インスタンスを追加できます。ただし、デフォルトの接続名は変更しないようにしてください。
            ホスト名 Kong Gateway インスタンスへのアクセスに使用されるターゲットドメイン名または IP アドレス。
            プロトコル クライアントと Kong サーバー間の安全な通信を確保する接続に使用されるプロトコル。このフィールドは自動的に https に設定されます。有効な値は次のとおりです。
            • http
            • https
            デフォルトポートを上書き Kong Admin API によって使用されるポート。
          2. [接続を編集 (Edit Connection)] ウィンドウの [認証情報 (Credential Information)] セクションで、フィールドに入力します。
            表 : 2. 認証情報
            フィールド 説明
            ユーザー名 「事前準備」セクションに記載されている、Kong ゲートウェイ管理 API への要求を認証するために必要なユーザー名。
            パスワード 「事前準備」セクションに記載されている、要求の認証に必要なユーザー名に関連付けられたパスワード。
          3. [接続を編集] を選択します。
        4. デフォルトで利用可能なトークンベースの認証の詳細を編集します。
          注:
          ベーシック認証を使用する場合は、この手順をスキップします。
          1. [接続を編集 (Edit Connection)] ウィンドウの [接続情報 (Connection Information)] セクションで、フィールドに入力します。
            表 : 3. 接続情報
            フィールド 説明
            接続名 Kong Gateway接続レコードを識別する名前です。

            Kong RBAC 認証 がデフォルトの接続名です。複数の Kong Gateway インスタンスを追加できます。ただし、デフォルトの接続名は変更しないようにしてください。
            ホスト名 Kong Gateway インスタンスへのアクセスに使用されるターゲットドメイン名または IP アドレス。
            プロトコル クライアントと Kong サーバー間の安全な通信を確保する接続に使用されるプロトコル。このフィールドは自動的に https に設定されます。有効な値は次のとおりです。
            • http
            • https
            デフォルトポートを上書き Kong Admin API によって使用されるポート。
          2. [接続を編集] ウィンドウの [認証情報] セクションの [API キー] フィールドに、[事前準備] セクションの説明に従って、Kong Gateway サービスに接続するための認証シークレットを入力します。
          3. [接続を編集] を選択します。
        5. [完了としてマーク] を選択して、[接続の構成] タスクを完了に設定します。
      4. データ取得のスコープを制御するプロパティを構成します。
        1. [ 構成プロパティを設定 ] タスクで、[ 構成] を選択します。
        2. [サービスグラフ接続のプロパティ] 関連リストで、プロパティを設定します。
          表 : 4. プロパティ
          プロパティ 説明
          ワークスペースを除外 除外するワークスペースの名前。このワークスペースのエンティティは、 Kong Gateway サービスに入力されません。

          ワークスペースが複数ある場合は、カンマで区切ります。たとえば、workspace1,workspace2 のようにします。

          このフィールドを空のままにすると、コネクタ内のデータソースはすべてのワークスペースからデータをインポートします。
          タグのインポート Kong Gateway サービスから取り込むタグ。

          タグが複数ある場合は、カンマで区切ります。

          指定する場合は、 Tags Value Separator プロパティにタグのキーと値のペアの区切り文字を入力します。指定しない場合、タグはフェッチされません。
          タグ値セパレーター タグのキーと値のセパレーター。

          たとえば、タグ値の区切り文字が = に設定されている場合、タグ env=prod は、 env をキーとして、 prod を値として保存されます。

          空のままにすると、タグは取り込まれません。
          注:
          Auth Type、Workspaces、およびLoad Balancersのプロパティは自動的に入力されます。
        3. [完了としてマーク] を選択して、[構成プロパティを設定 (Set configuration properties)] タスクを完了に設定します。
      5. 接続をテストします。
        1. [ テスト接続 ] タスクで、[ 構成] を選択します。
        2. [テスト接続] 関連リンクを選択して、接続をテストします。

          接続のテストには少し時間がかかる場合があります。ページが更新され、テスト結果が表示されます。

        3. [ステータス] フィールドが [成功] に設定されている場合は、[更新] を選択します。

          いずれかのテストでエラーが発生した場合は、修正の提案に従ってください。

        4. [完了としてマーク] を選択して、テスト接続タスクを完了に設定します。
    4. オプション: 複数のインスタンスを追加します。
      注:
      複数のインスタンスを追加する必要がない場合は、この手順をスキップできます。
      1. [CMDB との Kong Gateway 統合] ページの [複数のインスタンスを追加] セクションで、[開始] を選択します。
      2. 新しい Kong Gateway 接続のデータソースの作成を有効にします。
        1. データソース [sys_data_source] テーブルの編集権限があることを確認してください。
        2. [ データソースアクセスを更新 ] タスクで、[ 構成] を選択します。
        3. レコードを編集するには、アプリケーションピッカーから [グローバル] アプリケーションスコープを選択します。
        4. [データソースアクセスを更新] フォームの [アプリケーションのアクセス] 関連リストで、[ 作成可能]、[ 更新可能]、および [削除可能 ] チェックボックスをオンにします。
        5. [Update (更新)] を選択します。
        6. アプリケーションピッカーを使用して、 Kong Gateway の API サービスグラフコネクタ アプリケーションを選択します。
        7. [完了としてマーク] を選択して、[データソースアクセスの更新] タスクを完了に設定します。
      3. 新しい接続のデータソースを作成できるようにするには、データソース [sys_data_source] テーブルとテーブル [sys_db_object] テーブルのキャッシュをクリアします。
        キャッシュをクリアするには：
        1. [キャッシュをクリア] タスクで、[構成] を選択します。
        2. バックグラウンドスクリプトページの [ スクリプトを実行 ] テキストボックスに、次のスクリプトを入力します。
          GlideTableManager.invalidateTable("sys_data_source");
      GlideCacheManager.flushTable("sys_data_source");
      GlideTableManager.invalidateTable("sys_db_object");
      GlideCacheManager.flushTable("sys_db_object");
        3. グローバルスコープでバックグラウンドスクリプトを実行するには、[スクリプトを実行] を選択します。

          スクリプトの実行には数分かかる場合があります。

        4. スクリプトが実行されたら、[ 閉じる] を選択します。
        5. アプリケーションピッカーを使用して、 Kong Gateway の API サービスグラフコネクタ アプリケーションを選択します。
        6. [完了としてマーク] を選択して、[キャッシュのクリア] タスクを完了に設定します。
      4. 新しい接続を追加します。
        1. [ 別の接続を追加 ] タスクで、[ 構成] を選択します。
        2. 認証タイプに基づいて、接続タイプを選択します。
          • 基本認証の場合は、[接続] ページで [Kong 基本認証 ] を検索して選択し、[ 接続の追加] を選択します。
          • トークンベースの認証の場合は、[接続] ページで [Kong RBAC 認証 ] を検索して選択し、[ 接続の追加] を選択します。
        3. ベーシック認証の詳細を入力します。
          注:
          トークンベースの認証を使用する場合は、この手順をスキップします。
          1. [接続を作成] ウィンドウの [接続情報] セクションで、フィールドに入力します。
            表 : 5. 接続情報
            フィールド 説明
            接続名 Kong Gateway接続レコードを識別する名前です。
            ホスト名 Kong Gateway インスタンスへのアクセスに使用されるターゲットドメイン名または IP アドレス。
            プロトコル クライアントと Kong サーバー間の安全な通信を確保する接続に使用されるプロトコル。このフィールドは自動的に https に設定されます。有効な値は次のとおりです。
            • http
            • https
            デフォルトポートを上書き Kong Admin API によって使用されるポート。
          2. [接続を作成] ウィンドウの [認証情報] セクションで、フィールドに入力します。
            表 : 6. 認証情報
            フィールド 説明
            ユーザー名 「事前準備」セクションに記載されている、Kong ゲートウェイ管理 API への要求を認証するために必要なユーザー名。
            パスワード 「事前準備」セクションに記載されている、要求の認証に必要なユーザー名に関連付けられたパスワード。
          3. [接続を作成] を選択します。
        4. トークンベースの認証の詳細を入力します。
          注:
          ベーシック認証を使用する場合は、この手順をスキップします。
          1. [接続を作成] ウィンドウの [接続情報] セクションで、フィールドに入力します。
            表 : 7. 接続情報
            フィールド 説明
            接続名 Kong Gateway接続レコードを識別する名前です。
            ホスト名 Kong Gateway インスタンスへのアクセスに使用されるターゲットドメイン名または IP アドレス。
            プロトコル クライアントと Kong サーバー間の安全な通信を確保する接続に使用されるプロトコル。このフィールドは自動的に https に設定されます。有効な値は次のとおりです。
            • http
            • https
            デフォルトポートを上書き Kong Admin API によって使用されるポート。
          2. [接続を作成] ウィンドウの [認証情報] セクションの [API キー] フィールドに、「事前準備」セクションの説明に従って、Kong Gateway サービスに接続するための認証シークレットを入力します。
          3. [接続を作成] を選択します。
        5. [完了としてマーク] を選択して、[別の接続を追加] タスクを完了に設定します。
      5. 新しい接続のプロパティを設定します。
        1. [ 新しい接続の構成プロパティを設定 ] タスクで、[ 構成] を選択します。
        2. [名前] 列から、新しい接続の接続レコードを選択します。
        3. [サービスグラフ接続のプロパティ] 関連リストで、プロパティを設定します。
          表 : 8. プロパティ
          プロパティ 説明
          ワークスペースを除外 除外するワークスペースの名前。このワークスペースのエンティティは、 Kong Gateway サービスに入力されません。

          ワークスペースが複数ある場合は、カンマで区切ります。たとえば、workspace1,workspace2 のようにします。このフィールドを空のままにすると、コネクタ内のデータソースはすべてのワークスペースからデータをインポートします。
          タグのインポート Kong Gateway サービスから取り込むタグ。

          タグが複数ある場合は、カンマで区切ります。

          指定する場合は、 Tags Value Separator プロパティにタグのキーと値のペアの区切り文字を入力します。指定しない場合、タグはフェッチされません。
          タグ値セパレーター タグのキーと値のセパレーター。

          たとえば、タグ値の区切り文字が = に設定されている場合、タグ env=prod は、 env をキーとして、 prod を値として保存されます。

          空のままにすると、タグは取り込まれません。
          注:
          Auth Type、Workspaces、およびLoad Balancersのプロパティは自動的に入力されます。
        4. [Update (更新)] を選択します。
        5. [完了としてマーク] を選択して、[新しい接続の構成プロパティを設定 (Set configuration properties for new connection)] タスクを完了に設定します。
      6. 新しい接続をテストします。
        1. [ 新しい接続のテスト ] タスクで、[ 構成] を選択します。
        2. [名前] 列から、新しい接続の接続レコードを選択します。
        3. [テスト接続] 関連リンクを選択して、接続をテストします。

          接続のテストには少し時間がかかる場合があります。ページが更新され、テスト結果が表示されます。

        4. [ステータス] フィールドが [成功] に設定されている場合は、[更新] を選択します。

          いずれかのテストでエラーが発生した場合は、修正の提案に従ってください。

        5. [完了としてマーク] を選択して、[新しい接続のテスト] タスクを完了に設定します。
      7. 別のインスタンスを追加するには、 4.a から 4.f までの手順を繰り返します。
    5. スケジュール済みインポートジョブを設定します。
      1. [CMDB との Kong Gateway 統合] ページの [スケジュール済みインポートジョブを設定 (Set up scheduled import jobs)] セクションで、[開始] を選択します。
      2. [ スケジュール済みインポートの構成 ] タスクで、[ 構成] を選択します。
      3. [名前] 列から、親のスケジュール済みジョブ SG-Kong Gateway を選択します。
      4. [スケジュール設定済みデータインポート(Scheduled Data Import)] フォームで、スケジュール済みジョブのフィールド値を確認します。

        詳細については、「Schedule a data import」を参照してください。

      5. [ アクティブ ] チェックボックスをオンにして、SG-Kong Gateway スケジュール済みインポートをアクティブにします。
      6. [実行] フィールドで、[定期的] を選択して、ジョブの実行頻度を指定します。
      7. [Update (更新)] を選択します。
      8. [完了としてマーク] を選択して、[スケジュール済みインポートの構成] タスクを完了に設定します。