SGC セントラル を使用して Kong Gateway の API サービスグラフコネクタを構成する

  • リリースバージョン: Australia
  • 更新日 2026年03月12日
  • 所要時間：9分

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

    始める前に

    ServiceNow Store からバージョン 2.0.0 以降Kong Gateway の API サービスグラフコネクタをインストールします。 インストール手順 ServiceNow Store については、「 ServiceNow Store アプリケーションのインストール」を参照してください。

    Prometheus 接続を設定する場合は、 Kong Gateway で Prometheus プラグインを有効にし、必要な認証情報が利用可能であることを確認します。Prometheus プラグインの詳細については、Kong 開発者ドキュメントサイトの「Prometheus」を参照してください。

    必要なロール:次の表は、プレイブックの各ステージに必要なロールを示しています。
    表 : 1. 各プレイブックステージに必要なロール
    ステージ ロール
    必須条件 アドミン
    セットアップ SGC-Admin (sn_cmdb_int_util.sgc_admin) または admin
    注:
    バックグラウンドスクリプトを実行し、SGC-Admin ユーザーにグローバルテーブルへのアクセス権を付与するには、admin ユーザーロールが必要です。サービスグラフコネクタのユーザーロールの詳細については、「サービスグラフコネクタ ユーザーロール」を参照してください。

    このタスクについて

    オンボーディングコネクタのプレイブックエクスペリエンスは、CMDB ワークスペースのSGC セントラルでアクティブ化されます。SGC セントラルアプリケーションを構成するには、「SGC セントラル の構成」を参照してください。プレイブックの操作方法の詳細については、「プレイブックとやり取りする」を参照してください。

    注:
    または、 SGC セントラル のインストール済み接続またはドラフト接続から既に利用可能なデフォルトの接続を構成することもできます。検索項目 すべて > サービスグラフコネクタをクリックし、メニューからコネクタの [セットアップ ] を選択します。インストール済み接続とドラフト接続の詳細については、「 SGC セントラル で サービスグラフコネクタ用に追加された接続の管理」を参照してください。

    手順

    1. 移動先 ワークスペース > CMDB ワークスペース.
    2. CMDB ワークスペースで SGC セントラル を選択します。
    3. [概要] ページで、[接続を作成] を選択します。
      ヒント:
      または、 [すべての接続] ページで [接続を作成] を選択することもできます。
    4. [接続を作成] ウィンドウで、Kong コネクタタイプを選択し、[接続を作成] を選択します。
    5. コネクタを使用して初めて接続を設定するための最初の前提条件を満たします。
      注:
      この手順は、初回セットアップ時にのみ必要です。「SGC セントラルで接続を作成するときの初期セットアップタスクの実行」を参照してください。
    6. 認証タイプのテンプレートを選択して、接続を作成します。
      1. プレイブックの [セットアップ (Setup)] ステージで、[エイリアステンプレートを選択 (Select alias template)] アクティビティを選択します。
      2. テンプレートタイプを選択します。
        • Kong RBAC 認証:トークンベースの認証を使用する場合に選択します。
        • Kong 基本認証:基本認証を使用する場合に選択します。
    7. 接続の詳細を入力し、Kong Gateway データをインポートするための API 接続をテストします。
      1. プレイブックの [セットアップ (Setup)] ステージで、[接続を作成してテスト (Create and test connection)] アクティビティを選択します。
      2. フォームのフィールドに入力します。
        表 : 2. [接続を作成してテスト (Create and test connection)] フォーム
        フィールド 説明
        接続名 Kong Gateway接続レコードを識別する名前です。
        ホスト名 Kong Admin API サーバーの管理 URL アドレス。
        プロトコル クライアントと Kong サーバー間の安全な通信を確保する接続に使用されるプロトコル。
        デフォルトポートを上書き Kong Admin API によって使用されるポート。
        API キー Kong Gatewayサービスに接続するための認証シークレット。このフィールドは、[エイリアステンプレートを選択] アクティビティで [Kong RBAC 認証] が選択されている場合にのみ表示されます。
        ユーザー名 Kong Gateway Admin API への要求を認証するために必要なユーザー名。このフィールドは、[エイリアステンプレートを選択] アクティビティで [Kong ベーシック認証] が選択されている場合にのみ表示されます。
        パスワード 要求の認証に必要なユーザー名に関連付けられたパスワード。このフィールドは、[エイリアステンプレートを選択] アクティビティで [Kong ベーシック認証] が選択されている場合にのみ表示されます。
      3. [接続の作成とテスト (Create and test connection)] を選択します。
      4. 接続テストが完了したら、[続行] を選択します。
    8. オプション: 接続の構成プロパティを設定します。
      1. プレイブックの [セットアップ (Setup)] ステージで、[構成プロパティを設定 (Set configuration properties)] アクティビティを選択します。
      2. [データ検索構成] セクションの [Expand HTTP Method Types] フィールドに、ルートとして考慮する GET、POST、PUT、PATCH、DELETE、OPTIONS、HEAD、CONNECT、TRACE などの HTTP メソッドを入力します。
        メソッドが複数ある場合は、カンマで区切ります。空白のままにすると、すべての標準 HTTP メソッドをサポートしていることを示す ALL メソッドで単一の API フロントエンドが作成されます。
      3. [プロパティ設定] セクションの利用可能な Exclude workspaces フィールドに、インポートから除外する必要があるワークスペースを入力します。

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

      4. タグ設定セクションの [ タグをインポート ] チェックボックスをオンにして、 Kong Gateway サービスからタグを取り込みます。
        選択されている場合、[ タグ値セパレーター] フィールドでタグのキーと値のペアのセパレーターを指定します。選択しない場合、タグはフェッチされません。
      5. [タグ設定] セクションの [ タグ値セパレーター ] フィールドに、タグのキーと値のセパレーターを入力します。
        たとえば、タグ値のセパレーターが = に設定されている場合、タグ env=prod は env をキーとして、 prod を値として保存します。

        空のままにすると、タグは取り込まれません。

      6. [メトリクス設定] セクションの [ 使用状況データを収集 ] チェックボックスをオンにして、使用状況データ収集を有効にして、指定した期間の API 使用状況データを取得できるようにします。
      7. [メトリクスの設定] セクションの [ 収集期間 (日数)] フィールドに、API 使用状況データを収集する期間を日数で入力します。
      8. [続行] を選択します。
    9. オプション: Prometheus 接続の詳細を入力し、Prometheus プラグインを使用してKong Gatewayメトリクスデータをインポートするための API 接続をテストします。
      注:
      Prometheus による API 使用状況の監視が不要な場合、または既存の Prometheus インスタンスを使用している場合は、この手順をスキップできます。この手順をスキップするには、[Prometheus 接続を作成してテスト] アクティビティで [スキップ] を選択します。
      1. プレイブックの [セットアップ ] ステージで、[ Prometheus 接続を作成してテスト ] アクティビティを選択します。
      2. フォームで、フィールドに入力します。
        表 : 3. Prometheus 接続の作成とテストフォーム
        フィールド 説明
        接続名 Prometheus 接続レコードを識別する名前。
        接続 URL メトリクスのフェッチに使用される Prometheus HTTP API のベース URL。
        ユーザー名 Prometheus サーバーへの要求の認証に必要なユーザー名。
        パスワード Prometheus サーバーへの要求を認証するために必要なユーザー名に関連付けられたパスワード。
      3. [接続の作成とテスト (Create and test connection)] を選択します。
      4. 接続テストが完了したら、[続行] を選択します。
    10. オプション: Prometheus 接続を Kong Gateway 接続に関連付けます。
      注:
      Prometheus による API 使用状況の監視が必要ない場合は、この手順をスキップできます。この手順をスキップするには、[Kong Prometheus マッピング] アクティビティで [スキップ] を選択します。
      1. プレイブックの [セットアップ ] ステージで、[ Kong Prometheus マッピング ] アクティビティを選択します。
      2. [ Prometheus 接続] フィールドで、関連付ける Prometheus 接続を検索して選択します。
        ステップ 9 で作成した Prometheus 接続を選択するか、このステップで既存の Prometheus 接続を選択できます。ステップ 9 をスキップする場合は、既存の Prometheus 接続を選択します。
      3. [送信] を選択します。
      Prometheus 接続は、複数の Kong Gateway 接続に関連付けることができます。SGC セントラルビューからいつでも Kong Gateway 接続の Prometheus マッピングを更新できます。「SGC セントラル での サービスグラフコネクタの接続の更新」を参照してください。
    11. 定期的にデータをインポートするようにインポートスケジュールを構成します。
      1. プレイブックの [セットアップ (Setup)] ステージで、[インポートスケジュールの構成 (Configure import schedule)] アクティビティを選択します。
      2. [インポートスケジュールの構成] を選択します。
      3. [スケジュール済みインポート] リスト内の [スケジュールされている親データインポート] を展開して、接続に関連付けられている SG-Kong ゲートウェイ インポートスケジュールを選択します。
        注:
        接続名には、スケジュール名のプリフィックスが付きます。
      4. [インポートスケジュールの構成] ダイアログボックスで、[アクティブ] チェックボックスをオンにして、実行スケジュールと時間の詳細を入力します。

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

      5. [保存] を選択します。
        あるいは、[今すぐ実行] を選択してインポートスケジュールをすぐに実行します。
      6. [続行] を選択します。
    12. プレイブックの [セットアップ (Setup)] ステージで、[接続の作成を確認 (Confirm connection creation)] アクティビティを選択して、接続が構成されているかどうかを確認します。

    次のタスク

    [すべての接続を表示 (View all connections)] を選択して、接続の詳細を確認します。Kong Gateway 接続と Prometheus 接続を含む構成済みの接続が作成されている場合は、[インストール済み接続] リストに表示されます。

    その後、CMDB ワークスペースのSGC セントラルビューから接続を管理できます。詳細については、「SGC セントラル で サービスグラフコネクタ用に追加された接続の管理」を参照してください。