CIビルダー関連のMavenパラメーター - Cloud - 8.0

TalendSoftware Development Life Cycleベストプラクティスガイド

Version
Cloud
8.0
Language
日本語
Product
Talend Big Data
Talend Big Data Platform
Talend Cloud
Talend Data Fabric
Talend Data Integration
Talend Data Management Platform
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Real-Time Big Data Platform
Module
Talend Administration Center
Talend Artifact Repository
Talend CommandLine
Talend JobServer
Talend Management Console
Talend Remote Engine
Talend Studio
Content
ジョブデザインと開発
デプロイメント
管理と監視
Last publication date
2024-02-29

以下のパラメーターはプラグインに組み込まれているヘルプで説明されており(generate-mojo.htmlファイルを参照)、お使いのCIビルド定義のmavenOpts (Jenkins)/mavenOptions(Azure DevOps)コマンドとmvn (Jenkins)/options (Azure DevOps)コマンドのいずれかで使用できます。

ビルド時にMavenパラメーターのリストをインラインヘルプとして取得するためには、次のコマンドを実行します。
mvn org.talend.ci:builder-maven-plugin:<version>:help 
-Ddetail=true 
-s F:/<your_studio>/configuration\maven_user_settings.xml
ヒント: また、次のコマンドで特定の目標を設定すると、その目標に関連するパラメーターのみ返されるようにすることができます。
mvn org.talend.ci:builder-maven-plugin:<version>:help 
-Dgoal=generateAllPoms 
-Ddetail=true 
-s F:/<your_studio>/configuration\maven_user_settings.xml
Mavenパラメーター
Talend CommandLineパラメーター -Dlicense.path Talend製品のライセンスへのパスです。

ライセンスパスの値がURLで、アクセスに認証情報が必要な場合は、パラメーター-Dlicense.remote.user-Dlicense.remote.passwordを使います。

ビルド時にこのパラメーターを使えば、期限切れのライセンスをアップデートできます。ライセンスを変更する際、mvn org.talend.ci:builder-maven-plugin:8.0.4:installコマンドを使用していない場合はこのパラメーターを使って-Dinstaller.clean=trueパラメーターを追加します。

-Dtalend.studio.p2.base

Talend Studioフィーチャーパッケージ用リポジトリーの URL、またはTalend Studioフィーチャーパッケージ用のTalend_Full_Studio_p2_repository-YYYYMMDD_HHmm-VA.B.C.zipアーカイブの解凍済みフォルダーへのパスです。

Talend Studioフィーチャーパッケージ用公式TalendリポジトリーのURLの例:

-Dtalend.studio.p2.base=https://update.talend.com/Studio/8/base

Talend Studioフィーチャーパッケージ用アーカイブの解凍済みフォルダーへのパス例:

-Dtalend.studio.p2.base=D:/Talend/v80/StudioP2Base

詳細は、Talend Studioと継続的インテグレーションのアップデートリポジトリーを設定をご覧ください。

-Dtalend.studio.p2.update

Talend Studioアップデート用リポジトリーのURL、お客様に割り当てられたパッチZIPの解凍済みフォルダーへのパス、Talend Studioアップデート用アーカイブのいずれかです。

プロジェクトを新しいバージョンに移行したい場合は、ビルド時にこのパラメーターを使用してパッチ(Talend Studioマンスリーアップデート、マニュアルパッチおよびコンポーネントパッチ)をインストールする必要があります。このパラメーターの主な利点は、パッチをTalend Studioに適用する前に、CIを使って1つ(または複数)の既存プロジェクトでパッチをテストしたり、プロジェクトにパッチを適用したりできることです。

最新のTalend Studioマンスリーアップデート用公式TalendリポジトリーのURLの例

-Dtalend.studio.p2.update=https://update.talend.com/Studio/8/updates/latest

Talend Studioマンスリーアップデート用アーカイブの解凍済みフォルダーへのパス例:

-Dtalend.studio.p2.update=D:/Talend/v80/StudioR202201

詳細は、Talend Studioと継続的インテグレーションのアップデートリポジトリーを設定をご覧ください。

-Dhttp.proxy*パラメーターと-Dhttps.proxy*パラメーター

+ -Djdk.http.auth.tunneling.disabledSchemes

使用したいプロキシサーバーのURL。

この機能は8.0 R2023-12以降で利用できます。

例:

-Dhttp.proxyHost=<proxy_host> 
-Dhttp.proxyPort=<proxy_port> 
-Dhttp.proxyUser=<username> 
-Dhttp.proxyPassword=<password> 
-Dhttp.nonProxyHosts=localhost 
-Dhttps.proxyHost=<proxy_host> 
-Dhttps.proxyPort=<proxy_port> 
-Dhttps.proxyUser=<username> 
-Dhttps.proxyPassword=<password> 
-Dhttps.nonProxyHosts=localhost
-Djdk.http.auth.tunneling.disabledSchemes=

詳細は、Talend CommandLineのプロキシ設定をご覧ください。

(オプション)

-Declipse.keyring-Declipse.password

-Dtalend.studio.p2.base.user-Dtalend.studio.p2.base.pwd

-Dtalend.studio.p2.update.user-Dtalend.studio.p2.update.pwd

Talend Studioアップデートリポジトリーで基本認証が有効になっている場合は、これらのパラメーターを使い、Eclipseセキュアストレージで暗号化された認証情報を入力します。

この機能は8.0 R2022-09以降で利用できます。

例:

-Dtalend.studio.p2.base=http://localhost:8081/Studio/8/base
-Dtalend.studio.p2.update=http://nexus.company.com:8081/Studio/8/updates/R2022-07v2/ 
-Declipse.keyring=<keyring-file-path>/mykeyring
-Declipse.password=<master-password-file-path>/mymaster
-Dtalend.studio.p2.base.user=admin
-Dtalend.studio.p2.base.pwd=admin123 
-Dtalend.studio.p2.update.user=admin
-Dtalend.studio.p2.update.pwd=admin123

Talend Studio設定ファイルで認証情報を暗号化する方法は、Talend Studioでのアップデートリポジトリーの基本認証をご覧ください。

(オプション)

-Dproduct.path

Talend CommandLineインストールディレクトリーへのパス。

例:
-Dproduct.path=/opt/Talend/commandline8

Talend CI Builderのバージョン8.0.4(R2022-04から利用可能)以降、Talend CommandLine CommandLineはビルド時に自動的にダウンロードしてインストールできます。

(オプション)

-Dp2Installer.path

Installerファイルのパスです。

-Dprduct.pathが指定されている場合(非推奨)、Talend CommandLineはこのパラメーターで指定されている値でインストールされます。

例:
-Dproduct.path=/home/.installation/.commandline_8
-Dp2Installer.path=/home/.installation/.p2Installer_8
これにより、製品のバージョンごとに別々のパスを使用できるようになります。
(オプション)

-DexecuteRawScript-DscriptFile

mvn org.talend.ci:builder-maven-plugin:8.0.X:executeScriptコマンドと共に使用され、実行するCIパラメーターがすべて含まれるカスタムスクリプトを実行します。デフォルトでは、このパラメーターはfalseに設定されます。

例:
mvn org.talend.ci:builder-maven-plugin:8.0.X:executeScript 
-DexecuteRawScript=false 
-DscriptFile=<Path_to_script_file>/script.txt

-DexecuteRawScript=true-DexecuteRawScript=falseの違いについては、プロジェクトでカスタムスクリプトを実行をご覧ください。

(オプション)

-Dinstaller.clean

クリーンインストールを行い、CIワークスペースディレクトリーの下にある.metadataフォルダーを削除してからTalend CommandLineを再インストールします。

例: -Dinstaller.clean=true

(オプション)

-Dinstall.org.eclipse.ecf.provider.filetransfer.httpclient4.retrieve.connectTimeout

-Dinstall.org.eclipse.ecf.provider.filetransfer.httpclient4.retrieve.readTimeout

-Dinstall.org.eclipse.ecf.provider.filetransfer.httpclient4.browse.connectTimeout

-Dinstall.org.eclipse.equinox.p2.transport.ecf.retry

エラーが返されるまで接続が開くのを待つタイムアウト時間(ミリ秒)と接続試行の回数。これらのパラメーターは、CIサーバーがすぐに応答を受け取れない場合にブロックされるのを防ぐのに役立ちます。デフォルト値はすべて12000ミリ秒です。

例:

-Dinstall.org.eclipse.ecf.provider.filetransfer.httpclient4.retrieve.connectTimeout=12000
-Dinstall.org.eclipse.ecf.provider.filetransfer.httpclient4.retrieve.readTimeout=12000
-Dinstall.org.eclipse.ecf.provider.filetransfer.httpclient4.browse.connectTimeout=12000
-Dinstall.org.eclipse.equinox.p2.transport.ecf.retry=5
(オプション)

-Dgeneration.type

アーティファクトのソースを生成する値としてlocalと入力すると、ビルドの実行中にTalend CommandLineを実行していなくてもテストをローカルに行うことができます。
例:
-Dgeneration.type=local

server生成タイプはサポート対象ではなくなりました。

(オプション)

-DcveReportFilePath

修正済み脆弱性のリストが含まれているレポートをアーティファクトに保存するパスを定義できます。

このパラメーターは、org.talend.ci:builder-maven-plugin:<version>:detectCVEというMavenコマンドでのみ使用できます。

詳細は、ビルド中にアーティファクトの修正済み脆弱性 (CVE)を検出をご覧ください。

例:
-DcveReportFilePath=/home/talend/cvereport.csv
(オプション)

-Dcommandline.skip

アーティファクトのソースコード生成をスキップするための値として、trueと入力します。

このパラメーターは、以前にTalend CommandLineを使用してアーティファクトを生成したことがある場合のみ使用できます。

例:
-Dcommandline.skip=true
(オプション)

-Dtalend.profile.module

この値をtrueまたはfalseにすることで、POMファイルを生成する際にプロファイルを有効または無効にできます。

Talendが提供する8.0 R2022-06以降のTalend Studioマンスリーアップデートがインストールされておらず、メインプロジェクトに参照プロジェクトが重複している場合は、メインプロジェクトのPOMファイルを生成する際にこのパラメーターを追加して値をtrueに設定し、POMファイルでのプロジェクトのモジュール定義の重複を回避してから、Mavenパッケージコマンドでプロジェクトおよびアーティファクトをビルドする際に-Pパラメーターでプロファイルを指定する必要があります。詳細は、プロジェクトのPOMファイルを生成をご覧ください。

プロジェクトがバージョン7.1、7.2、7.3から移行された場合は、Talend Studio[Project Settings] (プロジェクト設定)ダイアログボックスの [Build] (ビルド) > Mavenビューの下にある[Set reference project modules in profile] (プロファイルで参照プロジェクトモジュールを設定)チェックボックスをオンにするか、選択を解除することによって、プロファイルが有効または無効にされます。CIでPOMファイルを生成する際に、-Dtalend.profile.moduleパラメーターを使ってTalend Studioでプロファイル設定を上書きできます。

プロファイルを有効化する例:

-Dtalend.profile.module=true
(オプション)

-Dtalend.exclude.deleted

プロジェクトのPOMファイルを生成する際に、この値をtrueに設定すると、削除された項目のモジュールをPOMファイルから除外できます。

例:

-Dtalend.exclude.deleted=true
(オプション)

-DprojectFilter

特定のプロジェクトをビルドできます。正規表現がサポートされています。

CIで始まる名前を持つすべてのプロジェクトに対するフィルタリングの例:

-DprojectFilter="CI.*"
projectAprojectBという2つの特定プロジェクトをフィルタリングする例:
-DprojectFilter="projectA|projectB"
(オプション)

-DitemFilter-Dfilter.include.dependencies=true

特定のプロジェクト項目をビルドできます。正規表現がサポートされています。

追加の-Dfilter.include.dependencies=trueパラメーターを使えば、フィルタリングされたプロジェクト項目の依存項目がすべて含まれ、POMがさらに速く生成できます。

-DitemFilter-DprojectFilterと共に使用した場合、-DitemFilter-DprojectFilterでフィルタリングされたプロジェクトにのみ適用されるのでご注意ください。フィルタリングされたプロジェクトに-DprojectFilterでフィルタリングされていない参照プロジェクトがある場合、これらの参照プロジェクトの全項目についてPOMファイルが生成されます。

このパラメーターの使用例は、プロジェクト項目をフィルタリングをご覧ください。

(オプション)

-Dstudio.forceMavenOnline=true

オフラインモードでジョブのビルドや実行のスケジューリングを行う際に依存項目のエラーが発生した場合は、Maven設定ファイルで定義されている内容に従って、Talend Studioが依存項目をダウンロードできるようになります。

次のエラーが表示されることがあります:

Plugin X.Y.Z or one of its dependencies could not be resolved: Cannot access central

POMファイルにはジョブの実行に必要な依存項目がすべて含まれているため、このエラーはビルド前にPOMファイルをすべて再生成することでも回避できます。

(オプション)

-Dworkspace

アーティファクトをビルドする現在のワークスペースプロジェクトを定義できます。

さまざまなMavenビルダーコマンド(org.talend.ci:builder-maven-plugin:8.0.X:detectCVEorg.talend.ci:builder-maven-plugin:8.0.X:generateAllPomsなど)で使用可能です。

例:
-Dworkspace=/home/talend/talend_studio/CI/workspace
-Dpatch.path インストールしたパッチ、またはインストールしたいパッチ(手動パッチ、カスタムコンポーネントパッチ、ホットフィックスなど)へのパス。

なお、このパラメーターは8.0 R2022-04以降に非推奨となっています。代わりに、-Dtalend.studio.p2.updateパラメーターを使用できます。

パッチをローカルにインストールした場合の例:
-Dpatch.path=D:/patches/Patch_TPS-2222.zip,D:/patches/Patch_TPS-3333.zip
ダウンロードするパッチの例:
-Dpatch.path=http://localhost:8085/nexus/content/repositories/releases/Patch_TPS-2222.zip,http://localhost:8085/nexus/content/repositories/releases/Patch_TPS-3333.zip 

Nexusアカウントをまだお持ちでない場合は、Talend Supportにお問い合わせください。リモートパッチがある場所へのアクセスで認証情報が必要となる場合は、-Dpatch.remote.userパラメーターと-Dpatch.remote.passwordパラメーターを使用します。patch.remote.passwordパラメーターによって、Mavenで暗号化されるパスワードを設定できます。

-DforceUpdate ローカルインストールが存在する場合も、このアップデートサイトからのTalend CommandLineのインストールを強制します。

なお、このパラメーターは8.0 R2022-04以降に非推奨となっています。代わりに、-Dinstaller.cleanパラメーターを使用できます。

例: -DforceUpdate=true

カスタムコンポーネントのパラメーター -Dcomponents.* カスタムコンポーネントを使用するジョブをアーティファクトリポジトリーにデプロイメントする時は、コンポーネントライブラリーが保存されているリポジトリーを指定します。

これは、Talend Component Kitを使って作成されたカスタムコンポーネントにのみ必要です。

詳細は、このドキュメンテーションをお読みください。

例:
-Dcomponents.nexus.user=<user>
-Dcomponents.nexus.password=<password>
-Dcomponents.nexus.url=http://localhost:8081/
-Dcomponents.nexus.repository=talend-custom-libs-release
-Dcomponents.nexus.repository.snapshot=talend-custom-libs-snapshot
注: 古いjavajetベースのコンポーネントについては、How to share a custom component in Talend Studioをご覧ください。
(オプション)

-Djvm.arguments

必要に応じて(Talend CommandLineで利用できるメモリを増加させる場合など)、JVMの引数を指定します。

Talendが提供する8.0 R2022-07以降のTalend Studioマンスリーアップデートをインストールしている場合、Talend CommandLineのインストールに使われるEclipse p2ディレ クターアプリケーションにもこのJVM引数が適用されます。詳細は、Installing software using the p2 director applicationをご覧ください。

例:
-Djvm.arguments=-Xms512m -Xmx4000m
(オプション)

-Dstudio.allow.java.internal.access

ビルド時にJavaクラスのアクセスエラーを防ぐためには、このパラメーターをtrueの値で追加します。

例:
-Dstudio.allow.java.internal.access=true
警告: この方法でビルドされたジョブをJava 8で実行することはできません。

このオプションの詳細、およびTalend Studioプロジェクト設定で有効にする方法は、Talend Studioのドキュメンテーションをお読みください。

(オプション)

-Dcodes.compile.failOnError

ビルドしているアーティファクトで使用されない、コンパイルエラーを持ったルーチンが発生する時にCIビルドが失敗することを防止するには、このパラメーターをfalse値で追加し、それらをスキップしてコンパイルを続行します。
-Dcodes.compile.failOnError=false