継続的インテグレーション

Liferay CloudはJenkinsを使用して、継続的なインテグレーションインフラストラクチャサービスを強化しています。プルリクエストを送信するか、事前設定されたGitHubブランチの1つにコミットをプッシュすると、自動で設定可能なビルドがトリガーされます。

デフォルトでは、この自動ビルドはコードをコンパイルし、テストを実行するように設定できます。 Liferay Cloudはサービスをビルドし、そのステータスを環境のビルドページに表示します。テストが失敗した場合は、Jenkinsダッシュボードとhttps://ci-companyname-infra.lfr.cloudログを確認できます。

詳細については、 CI サービスの制限事項 を参照してください。

JDKバージョンの設定

CI サービスは、環境変数 LCP_CI_GRADLE_JDK で構成された JDK を使用します。デフォルトでは、この変数は jdk8 に設定されます。

Jenkinsは、ビルド中にタスクを実行したりコードをコンパイルしたりするために、設定されたJDKバージョンを使用します。

LCP_CI_GRADLE_JDK でサポートされている値は次のとおりです。

• jdk8
• jdk11
• jdk17
• jdk21

グローバルJDKの設定

CI バージョン 6.0.0+では、環境変数 LCP_CI_GRADLE_JDK によって、独自の JDK 構成を指定しないブランチで使用されるデフォルトの JDK が定義されます。

1. Liferay Cloud Consoleを開きます。

2. ci サービスに移動します。

3. LCP_CI_GRADLE_JDK 環境変数を追加または変更します。

4. 変数の値を目的のJDKに設定します。

   	jdk21
   

環境変数の変更は、 ci サービスが再起動された後に有効になります。

ブランチごとのJDKの設定

CI バージョン 6.1.1+では、個々のブランチに対してデフォルトの CI JDK を上書きできます。

1. 対象のソースコードブランチで、 liferay ディレクトリに移動します。

2. lcp-ci-liferay.properties ファイルを作成します。

3. lcp.ci.liferay.gradle.jdk プロパティを追加します。

   	lcp.ci.liferay.gradle.jdk=jdk21
   

このJDK構成は、現在のブランチにのみ適用されます。

異なるJDKバージョンを必要とする各ブランチごとに、この設定を繰り返してください。

変更内容は次回のビルドから適用されます。

CIサービスビルドの自動デプロイ

自動デプロイは、グローバル設定またはブランチごとに設定できます。

ブランチごとのデプロイメント構成を推奨します。これは、より予測可能なデプロイメント動作を実現し、グローバルなブランチマッチングルールによって引き起こされる意図しないデプロイメントを回避できるためです。

ブランチごとの自動デプロイの設定

CI バージョン 6.1.2+では、個々のブランチを特定のターゲット環境に自動的にデプロイするように構成できます。

1. 対象のソースコードブランチで、リポジトリのルートディレクトリに移動します。

2. lcp-ci.properties ファイルを作成します。

3. lcp.ci.deploy.target プロパティを追加します。

   	lcp.ci.deploy.target=uat
   

このブランチは、指定されたターゲット環境にのみ自動的にデプロイされます。

自動デプロイが必要な各ブランチに対して、この設定を繰り返してください。

変更内容は次回のビルドから適用されます。

グローバル自動デプロイの設定

従来の環境変数を使用して、自動デプロイメントをグローバルに設定できます。

1. Liferay Cloud Consoleを開きます。

2. ci サービスに移動します。

3. 以下の環境変数を設定します：

   • LCP_CI_DEPLOY_BRANCH
   • LCP_CI_DEPLOY_TARGET

LCP_CI_DEPLOY_BRANCH は、自動デプロイ用のソースブランチ名に一致する正規表現を受け入れます。

デフォルト値は以下のとおりです。

環境変数の変更は、 ci サービスが再起動された後に有効になります。

従来の自動デプロイ変数の無効化

従来のグローバル展開変数を無効にして、ブランチレベルで明示的に構成された展開のみを許可することができます。

1. Liferay Cloud Consoleを開きます。

2. ci サービスに移動します。

3. 以下の環境変数を追加してください。

   	LCP_CI_AUTO_DEPLOY_LEGACY_ENV_VARS_DISABLE=true
   

ci サービスを再起動した後、明示的に lcp.ci.deploy.target プロパティが設定されたブランチのみが自動デプロイを実行します。

自動デプロイの無効化

ブランチ構成に関係なく、すべての自動デプロイを無効にすることができます。

1. Liferay Cloud Consoleを開きます。

2. ci サービスに移動します。

3. 以下の環境変数を追加してください。

   	LCP_CI_AUTO_DEPLOY_DISABLE=true
   

ci サービスを再起動した後、自動デプロイは実行されません。

デフォルトのJenkinsfileを使用する

CIサービスには、プロジェクトのビルドに使用されるデフォルトのJenkinsfileが含まれています。デフォルトのJenkinsfileは、これまでJenkinsfileに格納されていたすべてのロジックをカプセル化し、Jenkinsプラグインに移動します。これは、CI構成の変更を必要とせずに、バグ修正、セキュリティ修正、および改善を適用できることを意味します。

さらに、CIパイプラインのあらゆるステップをカスタマイズするための拡張ポイントも用意されています。

デフォルトのJenkinsfileを拡張する

デフォルトの Jenkinsfile を拡張するには、プロジェクトリポジトリの ci フォルダーに次のファイルを追加します。

• Jenkinsfile-before-all
• Jenkinsfile-before-cloud-build
• Jenkinsfile-before-cloud-deploy
• Jenkinsfile-after-all
• Jenkinsfile-post-always

CIビルドプロセスの基本的な手順の概要は以下のとおりです。

1. ci/Jenkinsfile-before-allが存在する場合はロードします。

2. Liferayワークスペースを構築します。

3. ci/Jenkinsfile-before-cloud-buildが存在する場合はロードします。

4. コンソールに表示されるLiferay Cloudビルドを作成します。

5. ci/Jenkinsfile-before-cloud-deployが存在する場合はロードします。

6. 現在のブランチがデプロイブランチであれば、ビルドをクラウド環境にデプロイできます。 LCP_CI_DEPLOY_BRANCH 環境変数はデプロイブランチを設定し、 LCP_CI_DEPLOY_TARGET はデプロイ環境を指定します。

7. ci/Jenkinsfile-after-allが存在する場合はロードします。これは、すべてのビルド手順が完了したときに実行されます。

8. ci/Jenkinsfile-post-alwaysが存在する場合はロードします。これは、ビルドが成功した場合でも失敗した場合でも実行されます。

デフォルトのパイプラインでどのように使用されているかを確認するには、Jenkinsサービスの起動ログを監視してください。起動ログには、デフォルトのJenkinsfileの全文が出力されます。

パイプラインの追加カスタマイズと外部呼び出し

パイプラインに追加の手順を設けることで、外部サービスを呼び出すことができます。例えば、REST API を介してサードパーティの監視サービスを呼び出したり、ビルドプロセス中に実行するスクリプトを呼び出したりすることができます。

また、リポジトリのci/フォルダ内に独自のJenkinsfile を定義することで、独自のパイプラインを作成することもできます。詳細については、 Jenkins Web サイト を参照してください。

異なる拡張ポイント間でのコードの再利用

これらの拡張ポイント間でコードを共有することで、構造を簡素化できる。一つの方法は、Groovyスクリプトを読み込むことです。

例えば、 ci/ フォルダに util.groovy という名前の Groovy ファイルを作成し、以下の内容を記述することができます。

def sendSlackMessage(message) {
	println(message)
}

return this

次に、 ci/Jenkinsfile-before-cloud-build に以下を挿入します。

def util = load("ci/util.groovy")

util.sendSlackMessage("About to create Liferay Cloud build...")

プロジェクトのJenkinsへのアクセスをIPアドレスで制限する

CIサービスバージョン6.8.1以降

プロジェクトのJenkinsインスタンスにアクセスできるIPアドレスを制限することで、パブリックインターネットへの露出を減らすことができます。その情報漏洩は、ログインページ、ジョブページ、ビルドログ、JSON APIなど、Jenkinsのあらゆる部分に及ぶ。プロジェクトのCIサービスで許可リストを有効にしてください。

許可リストを有効にすると、リスト外の IP からのリクエストは、Jenkins UI または API に到達する代わりに HTTP 403 アクセス拒否 を受け取ります。

一部のIPアドレスは常に許可されており、追加する必要はありません。

• クラスタ内トラフィックおよびループバックトラフィック
• Liferayサポートスタッフ
• ロードバランサーの健全性チェック
• ソースコード管理（SCM）プロバイダーのWebhook送信元IPアドレス

ご自身の組織のIPアドレスのみを追加してください。 SCMプロバイダーのWebhook IPアドレスは自動的に許可されているため、ビルドは引き続き正常に実行されます。

許可リストを有効にする

1. CI サービス上の LCP_CI_ALLOWED_IPS 環境変数 を、コンソールまたは CI サービスの LCP.json ファイルで、カンマ区切りの CIDR 範囲のリスト ( 203.0.113.0/24 のような IP アドレス ブロック) に設定します。

   単一のIPアドレスは /32 の範囲を使用します。

   LCP_CI_ALLOWED_IPS=203.0.113.42/32
   

   複数の範囲を指定する場合は、カンマで区切ってください。 IPv4とIPv6の両方のCIDRがサポートされています。カンマの前後の空白と空のエントリは無視されます。

   LCP_CI_ALLOWED_IPS=203.0.113.0/24, 198.51.100.42/32, 2001:db8::/48
   

1. お釣りを保存してください。 LCP.jsonで変数を設定した場合は、代わりにコミットしてデプロイしてください。

   CIサービスが再起動され、数分間リクエストの受信が停止する場合があります。環境の サービス ページでサービスのステータスを確認してください。サービスが復旧すると、許可リストが有効になります。

2. 許可リストに登録されているネットワークからJenkinsのURLを開き、ログインページが正しく読み込まれることを確認してください。

   リストにないネットワークから同じ URL にアクセスすると、 HTTP 403 アクセス拒否 が返されます。

許可リストを無効にするには、 LCP_CI_ALLOWED_IPS を削除するか、空の文字列に設定してから保存します。 CIサービスが再起動され、サービスが復旧するとアクセスが復元されます。

許可リストに載せるべきもの

組織のセキュリティ境界内にあるIPアドレスを許可リストに追加します。これは、あなた（または信頼できるセキュリティチーム）が管理、監査、パッチ適用を行うネットワークおよびシステムを指します。

オフィスネットワーク、VPN、および構築システムがインターネットに接続するために使用するパブリックIPアドレスを、ネットワークチームに問い合わせてください。現在アクセスしているアドレスを確認するには、そのネットワーク上の「自分のIPアドレスは？」といったサービスにアクセスしてください。プロバイダが動的アドレスを割り当てる場合は、それに依存する前に静的アドレスまたはアドレス範囲を要求し、ネットワークが変更されるたびにその値を再確認してください。

以下のカテゴリのIPアドレスを追加してください。

• 運用しているCI/CDシステムとバスティオンホスト
• 本社オフィスの外部IPアドレス
• 企業VPNの出口IPアドレス
• セキュリティ運用ツール

以下のIPアドレスタイプは、許可リストによる保護を弱めるため、使用を避けてください。

• 0.0.0.0/0 または ::/0 (これらはインターネット全体に一致し、保護を無効にします)
• 幅広いパブリッククラウドプロバイダーの選択肢
• 個々の開発者のホームIP

SCM IPの更新周波数を調整する

SCMプロバイダーが新しいWebhook IPアドレス範囲を公開すると、CIサービスは次回の更新時にそれらを反映するため、それまでは新しい範囲からトリガーされるビルドは開始されない可能性があります。環境変数 LCP_CI_ALLOWLIST_REFRESH_HOURS を 1 から 24 までの数値に設定して、更新が実行される頻度（時間単位）を制御します。デフォルト値は 24 時間です。この範囲外の値や数値以外の値は無視され、間隔はデフォルト値に戻ります。

環境変数リファレンス

これらの環境変数をCIサービス上で、コンソールまたはサービスの LCP.json ファイルで設定します。

関連トピック

• Liferay Cloud Servicesにログインする
• GitLabリポジトリの設定
• Bitbucketリポジトリの設定