5.2. Jenkins エージェント
OpenShift Container Platform は、Jenkins エージェントとして使用するための Base、Maven、および Node.js イメージを提供します。
Jenkins エージェントのベースイメージは次のことを行います。
-
必須のツール (ヘッドレス Java、Jenkins JNLP クライアント) と有用なツール (
git、tar、zip、nssなど) の両方を取り入れます。 - JNLP エージェントをエントリーポイントとして確立します。
-
Jenkins ジョブ内からコマンドラインの操作を呼び出す
ocクライアントツールが含まれます。 -
Red Hat Enterprise Linux (RHEL) および
localdevイメージの両方の Dockerfile を提供します。
Maven v3.5、Node.js v10、および Node.js v12 イメージは、ベースイメージを拡張します。これらは、新しいエージェントイメージを構築するときに参照できる Universal Base Image (UBI) の Dockerfile を提供します。また、contrib および contrib/bin サブディレクトリーにも注意してください。これらのサブディレクトリーを使用すると、イメージの設定ファイルと実行可能スクリプトを挿入できます。
OpenShift Container Platform リリースバージョンに適したバージョンのエージェントイメージを使用してください。OpenShift Container Platform バージョンと互換性のない oc クライアントバージョンを埋め込むと、予期しない動作が発生する可能性があります。
OpenShift Container Platform Jenkins イメージは、Jenkins Kubernetes プラグインでこれらのエージェントイメージを使用する方法を示すために次のサンプル Pod テンプレートも定義します。
-
OpenShift Container Platform Maven Jenkins エージェントイメージを使用する単一のコンテナーを使用する
MavenPod テンプレート。 -
nodejsPod テンプレート。OpenShift Container PlatformNode.js Jenkins エージェントイメージを使用する単一のコンテナーを使用します。 -
2 つのコンテナーを使用する
java-builderPod テンプレート。1 つはjnlpコンテナーで、OpenShift Container Platform Base エージェントイメージを使用し、Jenkins エージェントを開始および停止するための JNLP コントラクトを処理します。2 つ目は、javaOpenShift Container Platform サンプル ImageStream を使用するjavaコンテナーです。これには、コードをビルドするために、Maven バイナリーmvnを含むさまざまな Java バイナリーが含まれています。 -
2 つのコンテナーを使用する
nodejs-builderPod テンプレート。1 つはjnlpコンテナーで、OpenShift Container Platform Base エージェントイメージを使用し、Jenkins エージェントを開始および停止するための JNLP コントラクトを処理します。2 つ目は、nodejsOpenShift Container Platform サンプル ImageStream を使用するnodejsコンテナーです。これには、コードをビルドするために、npmバイナリーを含むさまざまな Node.js バイナリーが含まれています。
5.2.1. Jenkins エージェントイメージ
OpenShift Container Platform Jenkins エージェントイメージは Quay.io または registry.redhat.io で利用できます。
Jenkins イメージは、Red Hat レジストリーから入手できます。
$ docker pull registry.redhat.io/ocp-tools-4/jenkins-rhel8:<image_tag>
$ docker pull registry.redhat.io/ocp-tools-4/jenkins-agent-base-rhel8:<image_tag>
これらのイメージを使用するには、Quay.io または registry.redhat.io から直接アクセスするか、これらを OpenShift Container Platform コンテナーイメージレジストリーにプッシュします。
5.2.2. Jenkins エージェントの環境変数
各 Jenkins エージェントコンテナーは、以下の環境変数で設定できます。
| 変数 | 定義 | 値と設定の例 |
|---|---|---|
|
|
これらの値は Jenkins JVM の最大ヒープサイズを制御します。 デフォルトでは Jenkins JVM の最大ヒープサイズは、上限なしでコンテナーメモリー制限の 50% に設定されます。 |
|
|
|
これらの値は Jenkins JVM の初期ヒープサイズを制御します。 デフォルトでは、JVM は初期のヒープサイズを設定します。 |
|
|
| 設定されている場合には、内部の JVM スレッドのサイジング数に使用するコアの数を整数で指定します。 |
設定例: |
|
| このコンテナーで実行中のすべての JVM に適用するオプションを指定します。この値の上書きは推奨していません。 |
デフォルト: |
|
| Jenkins JVM ガーベッジコレクションのパラメーターを指定します。この値の上書きは推奨していません。 |
デフォルト: |
|
| Jenkins JVM の追加オプションを指定します。これらのオプションは、上記の Java オプションを含む、その他すべてのオプションに追加され、必要に応じてそれらのいずれかを上書きするために使用できます。追加オプションがある場合には、スペースで区切ります。オプションにスペース文字が含まれる場合には、バックスラッシュでエスケープしてください。 |
設定例: |
|
|
コンテナーでエージェントを実行するために使用する Java バージョンのバージョンを指定します。コンテナーの基本イメージには、 |
デフォルト値は
設定例: |
5.2.3. Jenkins エージェントのメモリー要件
JVM はすべての Jenkins エージェントで使用され、Jenkins JNLP エージェントをホストし、javac、Maven、または Gradle などの Java アプリケーションを実行します。
デフォルトで、Jenkins JNLP エージェントの JVM はヒープにコンテナーメモリー制限の 50% を使用します。この値は、CONTAINER_HEAP_PERCENT の環境変数で変更可能です。上限を指定することも、すべて上書きすることも可能です。
デフォルトでは、シェルスクリプトや oc コマンドをパイプラインから実行するなど、Jenkins エージェントコンテナーで実行される他のプロセスはすべて、OOM kill を呼び出さずに残りの 50% メモリー制限を超えるメモリーを使用することはできません。
デフォルトでは、Jenkins エージェントコンテナーで実行される他の各 JVM プロセスは、最大でコンテナーメモリー制限の 25% をヒープに使用します。多くのビルドワークロードにおいて、この制限の調整が必要になる場合があります。
5.2.4. Jenkins エージェントの Gradle ビルド
OpenShift Container Platform の Jenkins エージェントで Gradle ビルドをホストすると、Jenkins JNLP エージェントおよび Gradle JVM に加え、テストが指定されている場合に Gradle が 3 番目の JVM を起動してテストを実行するので、さらに複雑になります。
以下の設定は、OpenShift Container Platform でメモリーに制約がある Jenkins エージェントの Gradle ビルドを実行する場合の開始点として推奨されます。必要に応じて、これらの設定を変更することができます。
-
gradle.propertiesファイルにorg.gradle.daemon=falseを追加して、有効期間の長い (long-lived) Gradle デーモンを無効にするようにします。 -
gradle.propertiesファイルでorg.gradle.parallel=trueが設定されていないこと、また、コマンドラインの引数として--parallelが設定されていないことを確認して、並行ビルドの実行を無効にします。 -
java { options.fork = false }をbuild.gradleファイルに設定して、プロセス以外で Java がコンパイルされないようにします. -
build.gradleファイルでtest { maxParallelForks = 1 }が設定されていることを確認して、複数の追加テストプロセスを無効にします。 -
GRADLE_OPTS、JAVA_OPTS、またはJAVA_TOOL_OPTIONS環境変数で、Gradle JVM メモリーパラメーターを上書きします。 -
build.gradleのmaxHeapSizeおよびjvmArgs設定を定義するか、-Dorg.gradle.jvmargsコマンドライン引数を使用して、Gradle テスト JVM に最大ヒープサイズと JVM の引数を設定します。
5.2.5. Jenkins エージェント Pod の保持
Jenkins エージェント Pod は、ビルドが完了するか、停止された後にデフォルトで削除されます。この動作は、Kubernetes プラグイン Pod の保持設定で変更できます。Pod の保持は、すべての Jenkins ビルドについて各 Pod テンプレートの上書きで設定できます。以下の動作がサポートされます。
-
Alwaysは、ビルドの結果に関係なくビルド Pod を維持します。 -
Defaultはプラグイン値を使用します (Pod テンプレートのみ)。 -
Neverは常に Pod を削除します。 -
On Failureは Pod がビルド時に失敗した場合に Pod を維持します。
Pod の保持はパイプライン Jenkinsfile で上書きできます。
podTemplate(label: "mypod",
cloud: "openshift",
inheritFrom: "maven",
podRetention: onFailure(), 1
containers: [
...
]) {
node("mypod") {
...
}
}- 1
podRetentionに許可される値は、never()、onFailure()、always()、およびdefault()です。
保持される Pod は実行し続け、リソースクォータに対してカウントされる可能性があります。
