Documentation

DXP Cloud デプロイメントワークフローの概要

DXP Cloudは、高効率なCI/CD戦略を実現するための強固なフレームワークを提供します。 GitとJenkinsの統合により、CIビルドを自動的にトリガーして、プロジェクト環境にデプロイすることができます。 また、CIサービスのビルドプロセスを完全に省略し、 Command Line Interface (CLI)ツールを使用して、プロジェクト環境にローカルの変更を直接デプロイすることもできます。

デプロイメントには複数のパスがありますが、ワークフローは一般的に以下の3つのステージに沿って行われます:

開発・構成

すべてのワークフローは、プロジェクトのGitリポジトリ(つまり、GitHubBitbucket、またはGitLab)に変更を加えることから始まります。 このリポジトリは、Liferay DXPサービスインスタンスを含む、お客様のプロジェクトへのカスタム追加の基礎となります。 このGitリポジトリは、プロジェクトサービスの構成とカスタマイゼーションのための共有バージョンコントロール、プロジェクトのデプロイのための信頼できる唯一のソース、DXPモジュール、テーマ、拡張機能を構築するための共有ワークスペースを提供します。

サービスの LCP.json fileを構成、 またはconfigs/ フォルダを介してサービスへの環境固有およびプロジェクト全体の変更を行います。 各サービスの構成オプションの詳細については、それぞれのドキュメンテーションを参照してください:

ビルドとテスト

プロジェクトのGitリポジトリの構成にもよりますが、プロジェクトの中央リポジトリにコミットをマージしたり、変更内容を記載した新しいプルリクエストを公開したりすることで、自動CIビルドをトリガーすることができます。 このプロセスは自動的に行われますが、infra環境のCIサービスを変更して、テストを含む追加のパイプラインステップを含めることができます。 詳しくは 継続的インテグレーション を参照してください。

すべてのプロジェクト環境のビルドの履歴にアクセスするには、DXP Cloudコンソールの Builds ページに移動します。 ここでは、CIサービスまたはCLIツールのいずれかによって開始されたすべてのビルドを、その一般的な情報やステータス(保留、通過、失敗など)とともに表示することができます。

ビルドページからプロジェクトのビルドにアクセスできます。

デプロイ

Liferay DXP Cloudでは、サービスをデプロイする方法として、CLIツールを介したデプロイ(手動)、DXP Cloud管理コンソールを介したデプロイ(手動)、または特定のCIビルドを構成して自動的にデプロイする3つの方法があります。

オプション1:コマンドラインインターフェースを介したデプロイ

CLIツールを使用するのが、ローカル変更をサービスにデプロイする最も早い方法です。 これを使えば、ターミナルからデプロイすることができ、変更内容をリモートリポジトリにプッシュしたり、Jenkinsのビルドをトリガーしたりする必要がありません。 他のデプロイ方法とは異なり、CLIツールでは一度に1つのサービスのローカル変更をデプロイすることもできます。

これを行うには、ターミナルのCLIツールにログインし、デプロイしたいサービスのフォルダーに移動します(フォルダーにはサービスのLCP.jsonファイルが含まれている必要があります)。 次に、lcp deployを実行してデプロイを開始し、デプロイするプロジェクトと環境を選択します(例: devuatprd)。 本番環境にデプロイする前に、必ず dev または uat 環境にデプロイして、変更点を検証してください。

デプロイを成功させるには、選択した環境にデプロイする権限が必要です。 このデプロイのワークフローについては、 Deploying Changes via CLI Toolを参照してください。

重要

バックアップ、CI、データベース、検索機能、Webサーバの各サービスを直接デプロイすることはできますが、 lcp deploy コマンドを実行する前に、まずLiferayサービスのgradleビルドを作成する必要があります。 詳細については、 Deploying to the Liferay Service を参照してください。

CLIツールでデプロイする場合、すべてのサービスを一度にデプロイする(プロジェクトのルートディレクトリからコマンドを実行する)か、単一のサービスのみをデプロイする(サービスの LCP.jsonファイルを含むディレクトリからコマンドを実行する)ことができます。 liferay サービスではデプロイするために 追加のステップ を必要とするため、プロジェクトワークスペースからファイルをビルドおよび準備できます。

オプション2:Liferay DXP Cloudコンソールからのデプロイ

Liferay DXP Cloudコンソールは、プロジェクトの変更をデプロイするための主要な方法です。 これを使用すると、成功したビルドを表示して選択し、選択した環境にデプロイできます。 これらには、CIサービスとCLIツールの両方で生成されたビルドが含まれており、DXP Cloudコンソールの Builds ページからアクセスできます。 本番環境にデプロイする前に、必ず dev または uat の環境を選び、変更点を検証してください。

デプロイメントのワークフローについては、 DXP Cloud Consoleによる変更のデプロイメント を参照してください。

DXP Cloudコンソールからビルドをデプロイします。

オプション3:自動的にビルドを dev環境にデプロイ

必要に応じて、CIサービスを設定して、プロジェクトの dev環境にビルドを自動的にデプロイすることもできます。 CIサービスに環境変数を追加することで、指定したブランチで作成されたビルドの自動デプロイを開始します。 詳細については、 Setting Up Automatic Deployment を参照してください。