CIサーバーのセットアップ
このトピックでは、ALM OctaneとJenkinsやTeamCityなどのCIサーバーとの間の接続をセットアップする方法について説明します。これは、ALM Octaneでパイプラインを操作し、ALM OctaneをUFT Oneと統合するための基礎です。
- 注意:
-
ALM Octaneのアクセス許可メカニズムは、CIサーバーのアクセス許可メカニズムとは同期されません。そのため、ALM Octaneのユーザーは、アクセス許可メカニズムが同期されていればアクセスが許可されないようなログファイルやスタックトレースなどのCIサーバーからの情報にアクセスできる場合があります。
-
すべてのALM Octane統合、特にCIサーバー統合でSSLプロトコルを使用することをお勧めします。
前提条件
始める前に、以下を準備します。
-
APIアクセスの取得: スペース管理者に、APIアクセスのクライアントIDとクライアントシークレットの取得を依頼します。プラグインは、この情報を、ALM Octaneと通信する際の認証に使用します。
スペース管理者は、クライアントIDとクライアントシークレットをALM Octaneの設定で取得できます。アクセスキーは、関連するすべてのワークスペースで、CI/CD統合ロールに関連付ける必要があります。詳細については、APIアクセスのセットアップを参照してください。
-
必要な要件を満たしているCIサーバーへのアクセスの取得: ALM Octane CIプラグインでサポートされているCIサーバーについては、サポートマトリクスを参照してください。
ALM Octane CIプラグインのCIサーバーへのインストール
プラグインによっては、CIサーバーのビルドパイプラインを取得および表示し、テスト実行結果をCIサーバーと同期し、CIサーバー上のパイプライン実行をトリガーすることが可能になります。
ALM OctaneとCIサーバーの統合を可能にするプラグインのダウンロード、インストール、および設定を行います。詳細については、ALM Octane CIプラグインのCIサーバーへのインストールと設定を参照してください。
-
Jenkins、TeamCity、Bamboo、Azure DevOps Server (TFS)、およびGoCDのプラグインはオンラインで入手できます。
-
Jenkinsの場合、この機能はアプリケーション自動化ツールプラグインに含まれています。
ALM Octane統合を行うためにJenkinsサーバーにインストールする必要があるプラグイン、およびALM Octane統合でサポートされているが必須ではないプラグインの一覧については、アプリケーション自動化ツールwikiページまたはJenkins統合を参照してください。
-
Azure DevOpsサーバー2019年以降、およびAzure DevOpsサービスのために、ALM Octane統合拡張(技術プレビュー)はALM Octaneと統合することがあります。
-
GitLabの場合、ALM Octane GitLab CIサービスと呼ばれるスタンドアロンアプリケーションがあります。このアプリケーションはGitLab APIを使用してGitLabからイベントを取得し、それらをALM Octaneにプッシュします。
その他のCIサーバーについては、GitHubで入手可能なCI Plugin SDK for ALM Octaneを使用して、Javaで専用のプラグインを作成してください。
ALM OctaneにCIサーバーを追加
ALM OctaneをCIサーバーと統合するには、サーバーとそのURLをALM Octaneに追加する必要があります。
-
[設定] > スペースで、ワークスペースを選択します。
-
[DevOps] タブをクリックします。ペインの左側で、[CIサーバー] を選択します。
-
CIサーバーを追加するには [+] をクリックして、サーバーの名前を入力します。
-
CIサーバーのリストから、URLを選択します。
このリストには、次の条件を満たすすべてのサーバーが表示されます。
-
サーバーにALM Octane CIプラグインがインストールされ、ALM Octaneにアクセスするように設定されている。
-
現在のワークスペースで、プラグインが使用するAPIアクセスキーにCI/CD統合ロールが割り当てられている。
-
次に、CIサーバー上で実行するパイプラインを反映するパイプラインをALM Octaneで作成できます。
使用するCIサーバーの管理
CIサーバーのリストでは、CIサーバーの追加または削除、各サーバーに関する情報の表示、ALM OctaneとCIサーバー間の接続の中断または再開を行うことができます。
CIサーバーのリストを開く
このリストには、サーバーのステータス、タイプ、URLなどに関する情報が表示されます。
-
[設定] > スペースで、ワークスペースを選択します。
-
[DevOps] タブをクリックします。ペインの左側で、[CIサーバー] を選択します。
リストには、ALM Octane CIプラグインがALM Octaneにアクセスするようにセットアップされているすべてのサーバーが表示されます。
-
表示するカラムを選択します。たとえば、各サーバーごとに、次のような内容を表示できます。
-
サーバーが現在接続中かどうか。
-
CIサーバータイプ。
-
サーバーにインストールされているプラグインのバージョン、またはプラグインの開発に使用されたSDKバージョン。
お使いのプラグインは常に最新の状態にして、最新の機能強化や機能がすべて利用できるようにしてください。SDKのバージョンが古い場合は、赤いステータスアイコンが表示され、機能が損なわれます。
-
CIサーバーのURLへのリンク。
ヒント: このリンクが正しく機能するには、CIサーバーのサイトURLが適切に設定されている必要があります。
-
JenkinsからALM Octaneへのデータ転送の中断および再開
ALM Octaneへの情報の送信を停止するように選択したCIサーバーを設定します。これには、パイプライン実行、テスト実行、SCMコミット、およびコードカバレッジデータなどの情報が含まれます。
中断は、次のような場合に役立ちます。
-
CIサーバーがメンテナンス中なので、試験データをALM Octaneに送信されないようにする場合。
-
CIサーバーで予期しない動作の調査を行っていて、サーバーを隔離する必要がある場合。
-
CIサーバーとALM Octaneの間のネットワークがメンテナンスのために切断される予定で、その間にCIサーバーが過負荷になるのを抑制する場合。
次のステップ