コンテンツにスキップ

ビルドとデプロイプロセス#

この文書では、Lagoonのビルドとデプロイメント中に実際に何が起こるかを説明します。実際のプロセスから大幅に単純化されていますが、Lagoonが新しいコードをデプロイするたびに何が行われているかを理解するのに役立ちます。

以下のビデオを見て、デプロイメントプロセスの詳細を確認してください。

1. 環境のためのOpenShiftプロジェクト/Kubernetesネームスペースの設定#

まず、Lagoonは指定された環境のOpenShiftプロジェクト/Kubernetesネームスペースが存在して正しく設定されているかどうかを確認します。必要なサービスアカウントがあることを確認し、シークレットを作成し、環境変数をlagoon-envというConfigMapに設定します。これは、環境のタイプや名前、Lagoonプロジェクトの名前などの情報で満たされます。

2. Gitのチェックアウトとマージ#

次に、LagoonはGitからコードをチェックアウトします。.lagoon.yml、docker-compose.yml、および.envを読み取るためだけでなく、Dockerイメージをビルドするためにもこれが必要です。

注意点として、Lagoonはブランチ/PRがLagoonで設定されたブランチの正規表現と一致する場合にのみ、これらのアクションを処理します。デプロイメントがどのようにトリガーされたかに基づいて、異なることが起こります。

ブランチWebhookプッシュ#

デプロイがGit webhook経由で自動的にトリガーされ、単一のブランチ向けである場合、Lagoonはwebhookペイロードに含まれるGit SHAをチェックアウトします。これにより、プッシュされた各Git SHAごとにデプロイがトリガーされます。

ブランチRESTトリガー#

REST API経由(UIまたはGraphQL経由)で手動でブランチデプロイをトリガーし、POSTペイロードでSHAを定義しない場合、Lagoonはそのブランチの最新のコミットを単にチェックアウトし、それをデプロイします。

プルリクエスト#

デプロイがプルリクエスト(PR)デプロイである場合、LagoonはプルリクエストのベースとHEADブランチおよびSHAをロードし、次のことを行います:

  • PRが指しているブランチ(ベースブランチ)をチェックアウトします。
  • PRが起源となるブランチ(HEADブランチ)をベースブランチの上にマージします。
  • より具体的には:
    • Lagoonは、Webhookで送信された特定のSHAをチェックアウトしてマージします。これらのSHAはブランチヘッドを指している場合もあれば、 そうでない場合 もあります。例えば、GitHubプルリクエストに新しいプッシュを行うと、ベースブランチのSHAが現在のベースブランチHEADを指していない場合があります。

マージが失敗した場合、Lagoonも停止し、そのことをお知らせします。

3. イメージのビルド#

docker-compose.ymlで定義された各サービスについて、Lagoonはイメージをビルドする必要があるかどうかを確認します。ビルドする必要がある場合、この時点でビルドが行われます。ビルドの順序は、docker-compose.ymlでの設定順に基づいています。いくつかのビルド引数が注入されます。

  • LAGOON_GIT_SHA
  • LAGOON_GIT_BRANCH
  • LAGOON_PROJECT
  • LAGOON_BUILD_TYPE ( pullrequest、branch、または promote のいずれか)
  • LAGOON_SSH_PRIVATE_KEY - ソースリポジトリをクローンするために使用されるSSHの秘密鍵です。ビルド引数を実際の鍵に変換するには、RUN /lagoon/entrypoints/05-ssh-key.shを使用します。この鍵は/home/.ssh/keyにあり、SSHとGitが自動的に使用します。安全のため、RUN rm /home/.ssh/keyを使用して鍵を再度削除します。
  • LAGOON_GIT_SOURCE_REPOSITORY - ソースリポジトリの完全なGit URLです

また、これがプルリクエストのビルドである場合は以下となります。

  • LAGOON_PR_HEAD_BRANCH
  • LAGOON_PR_HEAD_SHA
  • LAGOON_PR_BASE_BRANCH
  • LAGOON_PR_BASE_SHA
  • LAGOON_PR_TITLE

また、すでに構築された各イメージの名前も注入されます。あなたのdocker-compose.ymlが最初にcliイメージを構築し、次にnginxイメージを構築するように設定されている場合、nginxイメージの名前はNGINX_IMAGEとして注入されます。

4. KubernetesまたはOpenShiftのサービスとルートを設定する#

次に、Lagoonは、サービスタイプから定義されるすべてのサービスとルート、および.lagoon.ymlで定義した追加可能なのカスタムルートをKubernetesまたはOpenShiftに設定します。

このステップでは、LAGOON_ROUTESで定義されたすべてのルートをカンマ区切りのURLとして公開します。また、以下の順序で1つのルートを"main"ルートとして定義します:

  1. カスタムルートが定義されている場合:.lagoon.ymlで最初に定義されたカスタムルート
  2. docker-compose.ymlで定義されたサービスから自動生成された最初のルート
  3. なし

"main"ルートはLAGOON_ROUTE環境変数を介して注入されます。

5. イメージのプッシュとタグ付け#

これで、以前にビルドしたDockerイメージを内部のDockerイメージレジストリにプッシュすることができます。

docker-compose.ymlでビルドするDockerfileを指定せずにイメージのみを指定したサービスについても、タグ付けが行われ、内部Dockerイメージレジストリに認識されるため、これらのイメージをコンテナで使用できるようになります。

6. 永続的なストレージ#

Lagoonは、永続的なストレージ（PVC）を必要として要求した各サービスのために永続的なストレージを作成します。

7. Cronジョブ#

MariaDBのようにcronジョブを要求する各サービス、および.lagoon.ymlに定義されたカスタムcronジョブごとに、Lagoonはcronジョブ環境変数を生成し、それらは後でデプロイメントに注入されます。

8. 定義済みのプレロールアウトタスクの実行#

次にLagoonは.lagoon.ymlファイルで定義されたpre-rolloutのタスクを確認し、それらを定義されたサービスごとに1つずつ実行します。これらのタスクは現在実行中のポッドで実行されるため、最新のコミットにのみ存在する機能やスクリプトを利用することはできません。また、最初のデプロイメントでは実行されません。

これらのタスクのいずれかが失敗した場合、Lagoonは直ちに停止し通知します。そのため、ロールアウトは進行しません。

9. DeploymentConfigs、Statefulsets、Daemonsets#

これがおそらく最も重要なステップです。定義されたサービスタイプに基づいて、Lagoonは[ Deployment、Statefulset または Daemonsets をサービス用に使用します。 (DeploymentはOpenShiftの DeploymentConfigs と同等です)

これには、以前に収集した情報、cronジョブ、永続的ストレージの位置、プッシュされたイメージなど全てが含まれます。

これらのオブジェクトの作成は、環境変数が変更されたり、イメージが変更されたりした場合など、必要に応じてKubernetesやOpenShiftがポッドの新しいデプロイメントを自動的にトリガーすることも引き起こします。しかし、変更がない場合はデプロイメントは行われません。これは、アプリケーションのPHPコードのみを更新した場合、Varnish、Solr、MariaDB、Redisなどの定義されているがあなたのコードを含まない他のサービスはデプロイされないということを意味します。これにより、全てが非常に高速になります。

10. すべてのロールアウトが完了するのを待つ#

ここでLagoonは待機します！新しいポッドのデプロイメントがすべて完了し、ヘルスチェックが成功するのを待ちます。

デプロイメントやヘルスチェックのいずれかが失敗した場合、デプロイメントはここで停止され、Slackなどの定義済みの通知システムを通じてデプロイメントが失敗したことが通知されます。

11. 定義されたポストロールアウトタスクの実行#

次に、Lagoonは.lagoon.ymlファイルをチェックしてpost-rolloutで定義されたタスクを探し、定義されたサービスでそれらを一つずつ実行します。

これらのいずれかが失敗した場合、Lagoonは直ちに停止し、あなたに通知します。

12. 成功#

全てが順調に進み、何もエラーが発生しなかった場合、Lagoonはこのビルドを成功とマークし、定義された通知を介してあなたに通知します。✅