DevOps チェンジベロシティへのオンボードJenkinsワークスペース

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間:7分
  • DevOps 変更ワークスペースプレイブックを使用して Jenkins インスタンスに接続し、パイプラインを検出します。

    始める前に

    DevOps チェンジベロシティの開始トピックで指定されたタスクを完了します。

    Jenkins 用の ServiceNow DevOps プラグインをインストールして有効にします。すでにインストールしている場合は、最新バージョンに更新してください。手順については、「Jenkinsプラグインの構成」を参照してください。

    必要なロール:sn_devops.admin または sn_devops.tool_owner

    手順

    1. 移動先 ワークスペース > DevOps 変更ワークスペース をクリックし、次のいずれかのオプションを使用して、Jenkinsをオンボーディングするプレイブックを開きます。
      セットアップを簡素化するために、そのアプリケーションで関連付けて追跡する必要がある特定のパイプラインがわかっている場合は、アプリケーションからツールを接続できます。これにより、 Jenkins からデータを簡単に関連付けてインポートすることもできます。
      オプションステップ
      ホームページ
      1. [ ツールを接続] を選択します。
      2. [ツールに接続] モーダルで、適切なカテゴリからツールを選択します。たとえば、オーケストレーションツールとして Jenkins に接続する場合は、[オーケストレーション] カテゴリで [Jenkins] を選択します。
      アプリケーションモジュール
      1. プライマリナビゲーションから [アプリケーション ] (アプリケーションアイコン) を選択します。
      2. 既存のアプリケーションを選択するか、アプリケーションを作成します。アプリケーションを作成するには、「 アプリケーションの作成 - ワークスペース」を参照してください。
      3. [推奨アクション] ペインから、[ ツールの接続 ] カードを選択します。
      4. [ツールに接続] モーダルで、適切なカテゴリからツールを選択します。たとえば、オーケストレーションツールとして Jenkins に接続する場合は、[オーケストレーション] カテゴリで [Jenkins] を選択します。
      ツールモジュール
      1. プライマリナビゲーションから [ツール ] ([ツール] アイコン) を選択します。
      2. [機能] リストから、適切なカテゴリを選択します。たとえば、オーケストレーションツールとして Jenkins に接続する場合は、[ オーケストレーション ] カテゴリを選択します。
      3. [ ツールを接続] を選択します。
      4. [ツールに接続] モーダルで、 [ Jenkins] を選択します。
      重要:
      ツールへの接続中にパイプラインなどのツールオブジェクトを検出して追跡する場合は、アプリケーションモジュールからツールを接続する必要があります。
    2. [ツール名] フィールドに、ツールの名前を入力します。

      Jenkins ツール画面に接続

    3. Jenkins インスタンスの詳細プレイブックアクティビティで、次の操作を行います。
      1. Jenkins インスタンスの URL を入力します。
      2. Jenkinsインスタンスのログイン認証情報 (パスワード、アクセストークン、または API トークン) を入力します。
        API トークンを生成するには、「 API トークン認証を使用した Jenkins への接続」を参照してください。
      3. Jenkinsインスタンスが MID サーバーに接続されている場合は、[MID サーバー] オプションを選択し、その詳細を入力します。
        ツールインスタンスがオンプレミスでホストされている場合は、MID サーバーが必要です。MID サーバーの詳細については、「MID サーバーの選択」を参照してください。
    4. [接続] を選択します。

      Jenkins ツールへの接続 - [インスタンスの詳細を入力] 画面

    5. 入力した認証情報に対して権限チェックが実行されます。
      必要な権限と利用可能な権限が表示されます。より適切なアクセス許可を持つ資格情報を入力する場合は、 [ 資格情報の再入力] を選択します。必要なすべての権限の詳細については、「DevOpsツールに必要な権限Jenkins権限」を参照してください。

      必要なすべての権限がない場合でも、ツール接続を続行することを選択できます。

      Jenkins ツールに接続 - 権限確認画面

    6. [Next (次へ)] をクリックします。
    7. ツールのアクセス権を指定します。
      1. ツールへのアクセスを制御する場合は、ツールへのアクセス権を付与する必要があるグループを [保守担当者 ] フィールドに追加します。
        グループ内のこれらのユーザーが実行できるタスクは、割り当てられたロールによって異なります。
        • DevOps ツールオーナーロール:ツールを表示および編集できます。
        • DevOps アプリオーナーロール:ツールを表示し、ツールのオブジェクト (プラン、リポジトリ、パイプラインなど) の関連付け、検出、履歴データのインポート、パイプラインステップの変更 (該当する場合) を実行できます。
        • DevOps 管理者ロール:すべてのツールを編集できます。
        • その他の DevOps ロール:ツールを表示できます。
        注:
        グループを選択せずにこの手順をスキップすると、 DevOps ツールオーナーロールを持つすべてのユーザーがツールを編集できます。
      2. ツールへのアクセスを制御することを選択した場合は、[ すべてのアプリ所有者がツールオブジェクトを表示してアプリケーションに関連付けることができる ]オプションを選択できるようになります。

        このオプションを使用すると、 DevOps アプリオーナーロールを持つすべてのユーザーがツールにアクセスできます。選択すると、ツールのオブジェクトの表示、関連付け、検出、履歴データのインポート、およびパイプライン ステップの変更 (該当する場合) が可能になります。

      3. [アサイン] を選択します。

      ツールアクセスを指定

    8. Jenkins の ServiceNow DevOps プラグインをインストールします。

      拡張機能の詳細については、「 Jenkinsプラグインの構成」を参照してください。

      Jenkins プラグインをインストールします。

    9. [構成] を選択すると、Jenkinsインスタンスに ServiceNow DevOps 構成が自動的にセットアップされます。
      重要:
      • まず、Jenkins 用の ServiceNow DevOps プラグインをインストールして有効にする必要があります。すでにインストールしている場合は、最新バージョンに更新してください。手順については、「Jenkinsプラグインの構成」を参照してください。

      • Webhook を自動的に構成するには、 Jenkins アドミンアクセス権が必要です。
      • このツールを自動的に構成することを選択した場合、JenkinsServiceNow DevOps 構成の既存の設定が上書きされます。
      • 合計 10 個の ServiceNow 構成を追加できます。

      Webhook を自動的に構成します。

      図 : 1. での ServiceNow DevOps 構成の自動セットアップ Jenkins

      Jenkins で ServiceNow DevOps 構成を自動的にセットアップします

      Jenkins で Webhook を手動で構成するには、「 Jenkins の Webhook を手動で構成」を参照してください。

      また、管理モジュールの [ポーリングを有効にする] プロパティオプションを選択することで、夜間ポーリングを有効にして追跡対象のパイプラインのデータを取得することもできます。「DevOps チェンジベロシティ のプロパティ」を参照してください。

      重要:
      • ホームページまたはツールモジュールから接続している場合は、接続が完了し、[概要] ページに移動します。
      • アプリケーションモジュールから接続している場合は、インスタンスで利用可能なパイプラインが検出されます。それらから履歴データを追跡してインポートできます。
    10. [ パイプラインを選択 (Select pipelines playbook)] アクティビティから追跡するパイプラインを選択します。
      選択したパイプラインごとに、最後に成功した実行のすべてのステップがインポートされます。

      追跡するパイプラインを選択します。

    11. オプション: [パイプラインステップにサービスをアサイン] アクティビティで、各パイプラインステップの ステップタイプサービス を指定します。

      Jenkins のパイプラインにサービスをアサインします。

      このステップをツールオンボーディングの一環として完了すると、 DevOps インサイト ダッシュボードに意味のあるデータがより多く即座に表示されるようになります。

    12. パイプライン データをインポートする場合は、日付範囲を選択して [送信] を選択します。
    13. [概要] ページで [ツールレコードを表示] を選択して、接続されているJenkinsツールの詳細を確認します。

      サマリーページ。

      注:
      ツール認証情報が変更されている場合は、 ServiceNow インスタンスで認証情報を更新する必要があります。詳細については、「でのサードパーティツール認証情報の更新 DevOps チェンジベロシティ」を参照してください。

    タスクの結果

    Jenkins ツールが正常にオンボーディングされてDevOps チェンジベロシティされました。