Jenkinsプラグインを構成

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間：6分

    • パイプライン実行のリアルタイム通知をDevOps チェンジベロシティに送信するようにJenkinsを構成します。

    始める前に

    必要なロール:Jenkins admin

    手順

    1. Jenkins インスタンスの [Manage Jenkins > System configuration > Plugins (Jenkins インスタンスの Jenkins 管理)] に移動して、Jenkins Marketplace から ServiceNow DevOps プラグインをインストールします。
    2. ServiceNow DevOps プラグインを検索して選択し、[インストール] を選択します。

    Jenkins の Webhook を手動で構成

    同期通知を DevOps チェンジベロシティ アプリケーションに送信するように Jenkins で Webhook を構成します。

    始める前に

    必要なロール:sn_devops.admin または sn_devops.tool_owner ( DevOps チェンジベロシティ、Jenkins アドミン)

    このタスクについて

    合計 10 個の ServiceNow DevOps 構成を追加できます。たとえば、開発、テスト、本番インスタンスなどの Jenkins 接続を構成できます。

    アップグレードのお客様は、最新の Jenkins プラグインをダウンロードしてインストールし、複数の ServiceNow 構成を有効にする必要があります。インストール後、既存の構成は保持され、デフォルト構成になります。

    Jenkins の [ServiceNow DevOps 構成] セクションで、[名前] フィールドの値と、[インスタンス URL] フィールドと [オーケストレーションツール ID] フィールドの組み合わせは一意である必要があります。

    ServiceNow からツールを自動的に構成することを選択した場合、DevOps 構成の既存の設定はServiceNowJenkinsで上書きされます。

    DevOps コンフィグがインストールされている場合は、Jenkins を手動で構成することしかできません。

    手順

    1. DevOps チェンジベロシティ で、データを送信するようにツールインスタンスを設定するときに [手動で構成] を選択します。
      Webhook を自動的に構成します。
    2. 適切なフィールドで [ コピー ] を選択して、値をクリップボードにコピーします。

      フィールドラベルが [ コピー済み] に変わりますが、何度でもコピーできます。

      Webhook を手動で構成します。
    3. Jenkins で、 Jenkins の管理 > システム構成 > プラグインの管理 > システムの構成.
    4. [ServiceNow DevOps 構成] セクションで、[ 追加] を選択します。
      注:
      新しい構成ごとに [追加 ] を選択することで、複数の接続を追加できます。
    5. フィールドに入力してプラグインを構成します。

      有効にすると、 Jenkins 受信イベントとして DevOps へのイベントの送信を開始します。

      注:
      値の大文字と小文字は区別されます。

      Jenkins で構成するフィールド。

      フィールド 説明
      アクティブ 接続をアクティブにするには、このオプションを選択します。デフォルトでは、このオプションは、新しい接続に対して [追加 ] を選択すると選択されます。
      注:
      アクティブが有効になっているすべての接続から、パイプライン実行の Webhook 通知が送信されますが、変更ステップでは指定された接続のみが考慮されます。
      デフォルト 接続名がパイプラインの既存のステップで渡されないときに接続をデフォルトの接続にするには、このオプションを選択します。
      注:
      使用可能な接続が 1 つしかない場合にこのオプションを選択しないと、エラーが発生します。
      [Name (名前)] 接続の一意の名前。
      注:
      ServiceNow から接続を自動構成すると、名前の値が自動生成されます。
      インスタンス URL

      ステップ 2 でコピーした ServiceNow インスタンス URL を入力します。例: https://<your-instance>.service-now.com。
      オーケストレーションツール ID

      ステップ 2 でコピーしたオーケストレーションツールのsys_id。

      または、この値を Webhook URL (toolid 値) からコピーするか、オーケストレーションツールレコードの Copy sys_id コマンドを使用して直接取得することもできます。

      注:
      インスタンス URL とオーケストレーションツール ID の値の組み合わせは、接続ごとに一意である必要があります。
      アーティファクトツール ID

      アーティファクトツールのsys_id。
      認証情報

      Jenkins への接続に使用するベーシック認証情報を選択します。

      1. 資格情報を追加するには、 [追加] を選択します。
      2. [ユーザー名] フィールドに、DevOps Integration ユーザーの詳細を入力します。デフォルトでは、devops.integration.user です。
      3. [パスワード] フィールドに、DevOps Integration ユーザーのパスワードを入力します。
      シークレット認証情報

      ステップ 2 でコピーしたシークレットトークンを選択します。または、次の手順を実行して、ツールレコードからシークレットトークンを取得することもできます。

      1. DevOps 変更 でJenkinsツールのシークレットトークンをコピーします。
        • ワークスペース:ツールレコードに移動し、[ シークレットトークンの構成 ] を選択してコピーします。
        • クラシック UI:ツールレコードに移動し、[ トークンのコピー] を選択します。
      2. トークンを追加するには、 [追加] を選択します。
      3. [ 種類 ] リストから [ シークレットテキスト] を選択します。
      4. [シークレット] フィールドに、[DevOps] で Jenkins ツール接続の作成時に生成されたシークレットトークンを入力します。
      5. [ID] フィールドにトークンの名前を入力します。
      ログレベル Jenkinsログ/ServiceNowログレコーダーに保存するログメッセージのレベル。
      次のオプションのいずれかを選択します。
      • 継承
      • off
      • severe
      • 警告
      • 情報
      • 構成
      • いい
      • 細かい
      • 最高
      • すべて

      ログレベルとログレコーダーの詳細については、次を参照してください。 Jenkins ログレベルとログレコーダー
      トラッキングチェックを強制

      チェックボックスをオンにすると、パイプライン実行ごとに Jenkins に対して REST (POST) API 呼び出しを行い、パイプラインが追跡されているかどうかが判断されます。

      snPipelineInfo.jsonファイルに詳細を保存し、すべてのパイプライン実行に対して API 呼び出しを停止するには、チェックボックスをオフにします。

      注:
      パイプラインが追跡されると、すべてのアクティブな Jenkins 構成がジョブ通知を受信します。
      プル要求パイプライン追跡チェック

      プル要求パイプラインの追跡を有効にするには、チェックボックスをオンにします。

      注:
      パイプラインが追跡されると、すべてのアクティブな Jenkins 構成がジョブ通知を受信します。
    6. [テスト接続] を選択します。
      「接続に成功しました」というメッセージが表示されることを確認します。
      • ベーシック認証情報を追加した場合、接続に成功すると、「 「認証情報」を使用した接続に成功しました」というメッセージが表示されます。
      • シークレットトークンを追加した場合、接続が成功すると、「 「シークレット認証情報」を使用した接続に成功しました」というメッセージが表示されます。
    7. [適用] を選択して変更を適用し、[保存] を選択します。