Jenkins プラグインのインストールおよびユーザ ガイド

EOL 通知: Jenkins 用 CA Agile Central のプラグインは拡張または修正されなくなります。テクニカル サポートは 2018 年 6 月で終了します。 既存のお客様は引き続き統合を使用できますが、新しい Build Connector for Jenkins を使用することをお勧めします。新しいコネクタは、パイプライン ジョブをサポートし、ログ ファイルを提供します。新しいコネクタにはプレビュー モードがあります。新しいコネクタのバージョンは継続的に拡張される予定です。

概要

Jenkins の CA Agile Central プラグインを使用することで、チームは作業中のプロジェクトのビルド ステータスを確認したり、ビルドのヘルスに関するグラフを表示したり、ビルドへのコード コミットを追跡したりすることができます。これは、プラグインが CA Agile Central にビルド データを入力することによって達成されます。

VCS (Version Control System、バージョン コントロール システム)および CA Agile Central VCS コネクタと併用されている Jenkins プラグインは、変更セットにもビルドをリンクします。CA Agile Central VCS コネクタは、commit メッセージを解析します。CA Agile Central のアーティファクト(DE27 など)が記述されている場合、VCS コネクタは SCM システムにコミットされた変更セットにそのアーティファクトをリンクします。次の Jenkins ビルドが発生すると、Jenkins プラグインは CA Agile Central のビルドに変更セットをリンクします。[ストーリー]/[ディフェクト]-[変更セット]-[ビルド]から結果を追跡できます。

全社で継続的なビルド/テスト パイプラインのヘルスを管理するために、ビルドのヘルス アプリケーションとビルドのトレーサビリティ アプリケーションを表示するカスタム ダッシュボードを作成することもできます。

このインストール ガイドの構成は次のとおりです。

ソフトウェア要件

Jenkins サポート

  • 現在では Jenkins 2.7.1 がサポートされます。(Jenkins バージョン 1.598 ~ 1.609 はディフェクトのため、以下のプラットフォームでこのプラグインと併用することができません。)
  • Ubuntu、CentOS、Mac OS X、および Windows Server 2012 でテストが実施されました。これらのオペレーティング システムが推奨されています。

SCM システムのサポート

  • CA Agile central のビルド オブジェクトに変更セットをリンクするには、SCM システムが必要です。これにより、ビルドへのストーリー/ディフェクトを追跡することができます。
  • Git、Subversion、および Mercurial のサポートが認定されています。
  • SCM システムの Jenkins プラグインが Jenkins にインストールされる必要があります。Jenkins には Subversion プラグインが組み込まれています。Git および Mercurial のオプション プラグインは Jenkins CI サイトで提供されています。
  • 変更セットが CA Agile Central (GitSubversionMercurial)に入力されるには、適切な SCM の CA Agile Central VCS コネクタがインストールされる必要があります。
  • 注*** Jenkins プラグインは現在のところ SSO をサポートしていません。

コネクタのダウンロード

コネクタをダウンロードするには、ここの手順に従います。

インストール

プラグインのインストールの基本的な手順は次のとおりです。

  1. Jenkins に Ruby ランタイム プラグインをインストールします(1 回)。
  2. Jenkins に CA Agile Central ビルド ノティファイア プラグインをインストールします(1 回)。
  3. プラグインのグローバル設定を行います(1 回)。
  4. CA Agile Central にビルドの結果を発行する Jenkins ジョブを設定します(ジョブごと)。

CA Agile Central のセットアップ

ターゲット WorkspaceConfiguration オブジェクトに対して BuildandChangsetEnabled が true に設定されていることを確認します。

CA Agile Central ワークスペースの管理者は、ターゲット ワークスペースに対してこれを有効にする必要があります。これが有効でない場合は、コネクタは機能しますが、Rally 作業アイテム(ストーリー、ディフェクト、タスク)に関連付けられている変更セット/変更情報は表示されません。

ワークスペースの管理者は、ワークスペースを編集して、以下のことを実行する必要があります。

  1. [セットアップ]アイコン を選択します。
  2. [ワークスペースとプロジェクト]タブを選択します。
  3. [ワークスペースとプロジェクト]サマリ ページで、ワークスペースを選択します。
  4. [アクション]ドロップダウンから[編集]を選択します。
  5. ワークスペース エディタで、[ビルドと変更セットを有効化]というラベルが付いたチェック ボックスをオンにします。
  6. 保存して終了]を選択します。

 

Jenkins セットアップ

Jenkins プラグインを理解していない場合は、プラグインの Jenkins ドキュメントを読んで、その概念と Jenkins にプラグインをインストールする方法を理解してください。

プラグインの以前のバージョンから 4.0.1 バージョンへのアップグレード

CA Agile Central v4.0.0 以前の Jenkins プラグインを使用していた場合は、以下の手順を実行してから、Jenkins プラグインの v4.0.1 をインストールする必要があります。

  1. グローバル レベルとジョブ レベルの両方で、Jenkins の設定をすべて書き留めておきます。新しいプラグインをインストールした後には、これらを再入力する必要があります。
  2. Jenkins から Jenkins の CA Agile Central プラグイン(または Rally プラグイン)をアンインストールします。
  3. 以下の手順に従って、Jenkins にプラグインをインストールします。

Linux、Mac OS X、および Windows Server 2012 での Jenkins へのプラグインのインストール

これは、プラグインに付属する README にもあります。

Jenkins の再起動が必要になる可能性があります。

  1. Jenkins インターフェースで、[Manage Jenkins]-[Manage Plugins]に移動します。
  2. [Advanced]タブを選択します。
  3. [Upload Plugin]セクションで、[Choose File]を選択し、[ruby-runtime-plugin-0.14.hpi]を選択します。
  4. [Upload]を選択します。Jenkins のステータス画面に、プラグインがインストール中であることが表示されます。
  5. 上記と同じ手順に従って、Jenkins に CA Agile Central Publisher プラグインをインストールします。
  6. [Manage Plugins]画面に移動して、[Advanced]タブを選択します。
  7. [Upload Plugin]セクションで、[Choose File]を選択し、[agile-central-build-publisher-1.0.1.hpi]を選択します。Jenkins のステータス画面に、プラグインがインストール中であることが表示されます。

 

注: 手順の順序は重要です。ruby-runtime-plugin より前に agile-central-build-publisher がアップロードされると、Jenkins は ruby-runtime plugin の、必要な 0.14 バージョンではなく、0.12 バージョンを自動的にインストールします。一般的に提供されている 0.12 バージョン(ruby-runtime-plugin-0.12.hpi)または CA Technologies が以前にパッケージ化した 0.13 では、当社のプラグインは動作しません。

 

設定

プラグインがインストールされたら、プラグインをグローバル レベルで設定して、Jenkins ジョブごとに 1 回ずつ設定する必要があります。

グローバル設定の構成

  1. Jenkins の Web インターフェースで、[Manage Jenkins]-[System Configuration]に移動します。
  2. [CA Agile Central Build Publisher]セクションで、以下のフィールドに入力します。
    • CA Agile Central Server: テキスト ボックスに「rally1.rallydev.com」と入力します。CA Agile Central を評価している場合は、「trial.rallydev.com」と入力します。オンプレミス インスタンスを実行している場合は、CA Agile Central サーバの名前を入力します。
    • CA Agile Central Username and CA Agile Central Password: Jenkins ビルドの結果を発行するワークスペースへのアクセス権を持つ CA Agile Central ユーザのユーザ名およびパスワード。
  3. プロキシ サーバ経由で CA Agile Central にアクセスする場合は、[CA Agile Central Build Publisher Proxy Settings]セクションで[Advanced]を選択すると、プロキシの指定に使用される以下のフィールドが表示されます。
    • Proxy Server: プロキシ サーバの名前または IP アドレス
    • Proxy Port: プロキシ サーバを使用するポート番号
    • Proxy Username (オプション): 認証が必要である場合のプロキシ サーバの有効なユーザ名
    • Proxy Password (オプション): 認証が必要である場合のプロキシ サーバの有効なパスワード

ビルドの結果を発行する Jenkins ジョブの設定

CA Agile Central で BuildDefinition とビルドを発行するように、Jenkins で自由形式または maven2 ジョブを設定できます。CA Agile Central のそれぞれのプロジェクトに 1 つまたは複数ある BuildDefinitions を使用して、ビルド ステータス インジケータを発行することができます。

Jenkins で以下の手順に従います。

  1. CA Agile Central にビルドの結果に発行するように設定する Jenkins ジョブに移動して、左上にある[Configure]を選択します。
  2. ページの[Post-build Actions]セクションで、[Add post-build action]ドロップダウンを選択して、[CA Agile Central Build Publisher]オプションを選択します。
  3. ページの[CA Agile Central Build Publisher]セクションで、CA Agile Central ワークスペース名と、ビルドの結果を公開するプロジェクトを入力します(グローバル設定に入力したユーザには、指定するワークスペースに対する権限が必要であることに注意してください)。既知の問題: サブ プロジェクトに公開すると、プロジェクトの最上位レベル プロジェクトが入力されます。サブ プロジェクトが参照されている場合は、プラグインは次のエラーを表示します: ERROR: [Rally Publisher] Unable to post Build info to Rally for Test1 build #35, unable to find default project SubProj1
  4. 設定ページで[Save]を選択します。

次回のジョブ実行では、プラグインは CA Agile Central で Jenkins ジョブと同じ名前の BuildDefinition を検索します。それが見つからない場合は作成されます。ジョブが実行されるたびに、CA Agile Central でビルド オブジェクトが作成されて、この BuildDefinition にリンクされます。

必要に応じて以下の手順を繰り返して、ほかの CA Agile Central プロジェクトに結果を発行する追加の Jenkins ジョブを設定します。

CA Agile Central でのビルド情報の表示

レポートでのビルドのヘルスの表示

ビルドのヘルス レポートは、Rally の[Reports]-[Reports]に表示されます。具体的には、ビルドのヘルス、およびイテレーションごとのビルド ヘルスが表示されます。

カスタム ビルド ダッシュボードの作成

カスタム ダッシュボードを作成するときには、[ビルドのヘルス]および[イテレーションごとのビルド ヘルス]という異なるビルド ダッシュボード アプリケーションから選択できます。

トラブルシューティング

以下のコマンドを使用して、Jenkins をデバッグ モードで起動して、メッセージを表示します。

java  -Drally.debug="true"  -jar  jenkins.war  --httpPort=9000

コンソール出力

プラグインの問題が発生した場合は、Jenkins を実行しているアプリケーション サーバのログまたはジョブからコンソール出力を表示します。ジョブからコンソール出力を表示するには、Jenkins の Web インターフェースでビルド番号を選択して、表示された Jenkins ページで[Console Output]を選択します。

Tomcat サーバ ログ

Tomcat を使用している場合は、[TOMCAT_INSTALL_DIR]/logs/catalina.out に移動してアプリケーション サーバ ログを表示します。

パスワードの変更

プラグインのグローバル設定に入力した CA Agile Central のユーザ名とパスワードが適切であり変更されていないことを確認します。

オブジェクト モデル

CA Agile Central の Jenkins プラグインが実行されると、CA Agile Central 内のデータ オブジェクト間の関係は次のようになります。

履歴バージョンのハイライト

  • コンテキスト識別パラメータが追加されました。
  • Hudson の再起動時にグローバル設定が保持されて利用できます。
  • Rally でBuildDefinition とビルド オブジェクトがサポートされます。
  • Hudson バージョンは 1.381 までサポートされます。
  • Hudson で Maven2 プロジェクト タイプがサポートされます。
  • SCM オプションとして Git および Perforce がサポートされます。
  • Rally のプロキシ設定が保持されます。
  • ビルド オブジェクトの[期間]フィールドには、Jenkins から提供された値が入力されます。
  • デバッグ フラグが追加されました。

サポートされているバージョン

バージョン サポートの終了
Jenkins 2.x 以降 N/A
Jenkins 1.642.4 ~ 1.651.2 2016 年 12 月 1 日
Jenkins 1.42 ~ 1.642.3 2016 年 12 月 1 日
Jenkins 1.41 以前、Hudson の任意のバージョン 2013 年 4 月 1 日

リビジョン履歴

  • 4.0.1 (2016 年 5 月 18 日)
    • 修正:
      • 古い ruby-runtime-plugin に起因する Agile Central への SSL 接続エラー。
  • 4.0.0 (2015 年 11 月 16 日)
    • 機能強化:
      • ブランドの再設計。
  • 3.0.6 (2015 年 2 月 25 日)
    • 既知の問題:
      • [Build Configuration]にサブ プロジェクトを入力すると、以下のエラーが表示されます。

        ERROR: [Rally Publisher] Unable to post Build info to Rally for Test1 build #35, unable to find default project SubProj1

      • プラグインがプロジェクト名の漢字を正しく変換しません。

バージョン履歴

バージョン ファイル 日付
4.0.1
  • SSL エラーのための修正中止
Jenkins プラグイン 4.0.1 2016 年 5 月 18 日
4.0.0
  • ブランドの再設計
Jenkins プラグイン 4.0.0 2015 年 11 月 16 日
3.0.6
  • 新しいアーキテクチャでの再構築
  • ディフェクトの修正: プロジェクト名の特殊文字および末尾のスペース
Jenkins プラグイン 3.0.6 2015 年 1 月 28 日
1.0 - 2.4.1 サポートされていません  

フィードバック

ヘルプをお求めですか?CA Agile Central コミュニティは、セルフサービスとサポートのワンストップ ショップです。CA Agile Central サポートにフィードバックを送信したり、答を見つけたり、他のユーザとのコラボレーションには CA Agile Central コミュニティ にご参加ください。