CNE Azure Ready: 初期環境のブートストラップ
CNE Azure Ready: 前提条件を完了したら、Cloud Native Experience (CNE) ブートストラップ プロセスを実行して、Azure サブスクリプション内に Azure Kubernetes Service (AKS) クラスター、Liferay プラットフォーム、および Liferay DXP 環境を作成します。
ブートストラップは1つのコマンドで実行できます。 config.jsonファイルを読み込み、ファイル名で指定されたブートストラップ リリースをダウンロードし、Terraform を使用して AKS クラスターとプラットフォームを作成し、Liferay プラットフォームのルート アプリケーションをインストールします。 Argo CD はそのアプリケーションを使用して、GitOps リポジトリ内のすべてをデプロイします。
Bootstrapディレクトリの準備
ブートストラップ処理用の作業ディレクトリを作成します。このスクリプトは、現在のディレクトリにあるconfig.jsonを読み込み、ブートストラップリリースをその中に抽出します。
mkdir cne-bootstrap
cd cne-bootstrap
touch config.json
実行後もこのディレクトリを保持してください。リモート Terraform ステートがない場合、再実行とティアダウンで使用されるステートを保持します。
Bootstrapの設定
config.jsonファイルはデプロイメントを定義します。この例では、PostgreSQLを使用し、Terraformの状態をAzureストレージアカウントに保存するclarityという名前のデプロイメントを作成します。
{
"deployment_name": "clarity",
"options": {
"auto_approve": false,
"parallelism": 10,
"provider": "azure",
"version": "0.3.0"
},
"platformComponents": {
"values": {
"gitops": {
"repository": {
"url": "https://github.com/clarity-vision-solutions/liferay-gitops.git"
}
}
}
},
"region": "eastus2",
"setup": {
"database": {
"engine": "postgresql"
}
},
"subscription_id": "your-azure-subscription-id",
"tenant_id": "your-azure-tenant-id",
"terraform": {
"platform": {
"cluster_secret_store": {
"key_vault": {
"name": "your-key-vault-name",
"resource_group_name": "your-key-vault-resource-group"
}
},
"keda_config": {
"enabled": true
},
"observability_config": {
"enabled": true
}
}
},
"tfstate": {
"container_name": "tfstate",
"resource_group_name": "clarity-tfstate",
"storage_account_name": "claritytfstate"
}
}
subscription_id 、 tenant_id 、 deployment_name 、Key Vault のnameとresource_group_name 、および GitOps リポジトリのurl 、前提条件の値に置き換えてください。次に、 regionとtfstate名を自由に選択してください。セットアップでは、 tfstateリソース グループ、ストレージ アカウント、およびコンテナーが存在しない場合は作成されます。ストレージ アカウント名は Azure 全体で一意である必要があります。
この例では、KEDA ( keda_config) とオブザーバビリティ ( observability_config) も有効にするため、ブートストラップによって、オートスケーリングと Grafana モニタリングで使用される KEDA および Azure Monitor リソースがセットアップされます。ブートストラップ後にこれらの機能を使用するには、 「CNE Azure Ready: 自動スケーリングの構成」および「CNE Azure Ready: Grafana を使用した監視」を参照してください。 config.jsonが受け入れるすべてのキーについては、 CNE Azure Ready: Bootstrap Configuration Reference を参照してください。
初回デプロイの際は、他のTerraformやHelmの値を変更する前に、この記事に記載されている設定を使用してブートストラップを実行してください。デプロイメントの評価が完了したら、 CNE Azure Ready: 環境のクリーンアップの説明に従って環境をクリーンアップし、独自の構成で再度デプロイしてください。
必須キー
すべてのconfig.jsonファイルでこれらのキーを設定する必要がありますが、 tfstateキーはtfstateオブジェクトのみに必要なので除きます。この例では、それらすべてを設定します。
| 鍵 | 説明 |
|---|---|
deployment_name | 展開状況を特定します。リソース グループと AKS クラスター ( <deployment_name>-aks) を指定します。 |
region | すべてのリソースの Azure リージョンを設定します (例: eastus2 )。 |
subscription_id | リソースが作成される Azure サブスクリプションの名前を指定します。 |
tenant_id | サブスクリプションが属する Microsoft Entra ID テナントの名前を指定します。 |
options.provider | インフラストラクチャプロバイダーを選択します。それをazureに設定してください。 |
setup.database.engine | デプロイメントに使用するデータベースエンジンを設定します。それをpostgresqlに設定してください。 |
terraform.platform.cluster_secret_store.key_vault | プラットフォームがシークレットを読み取るキー ボールトを、 nameとresource_group_name名で指定します。 |
platformComponents.values.gitops.repository.url | Argo CDがデプロイを行うGitOpsリポジトリの名前を指定します。 |
tfstate.container_name 、 tfstate.resource_group_name 、 tfstate.storage_account_name | Terraformの状態を保持するブロブコンテナ、リソースグループ、およびストレージアカウントの名前を指定します。これらは、 tfstateオブジェクトが存在する場合に必要です。 |
実行が停止する場所は、どのキーが欠落しているかによって異なります。
deployment_name、region、subscription_id、tenant_id、またはtfstateキーが欠落している場合、実行はThe configuration JSON file must contain a key named "<key>".options.providerが存在しない場合、ランチャーはNo provider is specified in <file>.setup.database.engineが見つからない場合、セットアップはインフラストラクチャ プロバイダー チャートからの Helm 値スキーマ エラーで停止し、teardown_azure.shsetup.database.engine is missingエラーで停止します。terraform.platform.cluster_secret_storeが存在しない場合、この変数にはデフォルト値が設定されていないため、プラットフォームスタックの Terraform apply が停止します。
Bootstrapのオプション
config.jsonのoptionsオブジェクトは、ブートストラップの実行方法を制御します。
| オプション | 説明 |
|---|---|
provider | インフラストラクチャプロバイダーを選択します。それをazureに設定してください。 |
version | ダウンロードするブートストラップリリースを選択します(例: 0.3.0 )。省略した場合、スクリプトは最新の公開リリースでlatestを使用します。 |
auto_approve | `-auto-approve` がtrueの場合、すべての Terraform apply および destroy に-auto-approveを追加します。デフォルトはfalseです。 |
parallelism | Terraformの-parallelismフラグを設定し、同時に実行できるTerraform操作の最大数を指定します。 |
version特定のリリースに設定します。スクリプトは各リリースを独自のliferay-azure-bootstrap-<version>ディレクトリに展開します。 tfstateがない場合、 latestを使用してより新しいリリースをダウンロードする後続の実行は、以前の実行のTerraformの状態を保持しない新しいディレクトリで動作します。
テラフォーム州の場所を選択する
tfstateオブジェクトは、Terraformの状態がどこに保存されるかを決定します。
-
tfstateを使用すると、スクリプトはリソース グループ、ストレージ アカウント、およびコンテナが存在しない場合、それらを作成します。 Azure ユーザーがコンテナを一覧表示できない場合、スクリプトはユーザーにコンテナに対するStorage Blob Data Contributorロールを付与し、ロールが有効になるまで最大 5 分待機します。各スタックの状態は、Microsoft Entra ID 認証で読み取られるブロブ<deployment_name>/<region>/<aks|platform>/terraform.tfstateです。 -
tfstateがない場合、状態はマシン上のliferay-azure-bootstrap-<version>/cloud/terraform/azure/aksおよびliferay-azure-bootstrap-<version>/cloud/terraform/azure/platformのブートストラップ ディレクトリに残ります。そのディレクトリは再実行と削除のために保管しておいてください。
Bootstrapスクリプトを実行する
bootstrapディレクトリから、bootstrapプロセスを実行します。
bash <(curl -sL https://raw.githubusercontent.com/liferay/liferay-portal/master/cloud/scripts/bootstrap.sh)
このスクリプトは、現在のディレクトリにあるconfig.jsonを読み込みます。ファイルを別の場所で使用するには、そのファイルのパスを引数として渡します。このスクリプトは、 https://cdn.liferay.cloud/bootstrap/からliferay-azure-bootstrap-<version>.tar.gzをダウンロードし、 .sha256チェックサムと照合して検証し、現在のディレクトリにliferay-azure-bootstrap-<version>として展開し、構成を使用して Azure セットアップを実行します。
tfstate使用すると、最初の実行時に403 AuthorizationPermissionMismatchで失敗する可能性があります。修正方法については、 「ブートストラッププロセスの再実行」を参照してください。
スクリプトは実行時に、以下の段階を順に経ていきます。
-
このスクリプトは、Terraformスタックごとに
config.auto.tfvars.jsonファイルを生成します。 -
このスクリプトはAzureにサインインします。アクティブな Azure CLI ログインが既にサブスクリプションをカバーしている場合は、
Reusing the active Azure login for the subscription <subscription_id>.そうでない場合は、Attempting to login to your Azure account.そして、config.jsonのテナントに対してaz login実行します。スクリプトで求められたら、サインインしてください。 -
tfstateでは、[Tfstate storage configuration]で始まる行は、状態ストレージが作成されたか、既に存在することを報告します。 -
Setting up the Kubernetes cluster.AKSスタックのTerraform適用が開始され、Kubernetes cluster setup complete.完了したとの報告があった。 -
Connecting to the Kubernetes cluster.az aks get-credentials --overwrite-existingを実行すると、~/.kube/config内のクラスターのエントリが置き換えられます。 -
Setting up the Liferay platform.プラットフォームスタックのTerraform適用が開始され、Argo CDがインストールされ、Liferay platform setup complete.完了したとの報告があった。 -
Applying the Liferay platform root application.liferay-platformHelm リリースをargocd-system名前空間にインストールします。
このスクリプトはTF_INPUT=0をエクスポートし、保存されたプランなしでAKSスタック、次にプラットフォームスタックに対してterraform applyを実行します。
options.auto_approveをデフォルト値のfalseに設定すると、Terraform は各スタックのプランを表示し、まず AKS スタック、次にプラットフォーム スタックの承認を求めます。各プロンプトにyesと入力してください。 TF_INPUT=0 、Terraform の変数値入力プロンプトのみを無効にします。プロンプトなしで実行するには、 auto_approve trueに設定してください。
Argo CD は、スクリプトが終了した後も、GitOps リポジトリからプラットフォーム コンポーネントと環境のデプロイを継続します。 Argo CD のユーザーインターフェースで、それらの進捗状況を確認してください。詳細は「Argo CD へのアクセス」を参照してください。
ブートストラッププロセスを再実行する
プロビジョニングが失敗した場合は、原因を修正し、同じディレクトリから同じconfig.jsonを使用してブートストラップを再度実行してください。再実行では Terraform の状態と既存の状態ストレージが再利用され、 ストレージ アカウント <name> が既に存在します、のような行で存在する各ストレージ リソースが報告されます。作成プロセスをスキップします。
0.3.0 では、 tfstate初めて実行すると、Terraform が状態をロックしている間に403 AuthorizationPermissionMismatchエラーが発生して失敗することがあります。これは、スクリプトが一度正常に読み取った後、新しいロールの割り当てを待つのを停止するためです。次の実行では、 state blob is already lockedで失敗します。ステートブロブのリースを解除してから、ブートストラップを再度実行します。
az storage blob lease break \
--account-name <storage_account_name> \
--auth-mode login \
--blob-name <deployment_name>/<region>/aks/terraform.tfstate \
--container-name <container_name> \
--lease-break-period 0
引き続きエラーが発生する場合は、 「CNE Azure Ready: トラブルシューティング」を参照するか、 「CNE Azure Ready: 環境のクリーンアップ」で説明されている手順に従って環境をクリーンアップしてから再試行してください。
Argo CDへのアクセス
プラットフォームスタックはargocd-system名前空間にargocdリリースとしてArgo CDをインストールします。次に、ブートストラップによってliferay-platformルートアプリケーションがインストールされ、 liferay-platform-components (外部シークレット、Crossplane、Envoy Gateway、Argoワークフロー、ECKオペレーター、Liferay DXPオペレーター、KEDA、有効になっている場合はオブザーバビリティ、およびGitOpsリポジトリ内の各環境フォルダーに対応するアプリケーションセット)がデプロイされます。
このスクリプトは、Argo CDの認証情報を出力したり、ポートフォワーディングを開始したりしません。 Argo CDのユーザーインターフェースを開くには、以下の手順に従ってください。
-
Argo CDサーバーにローカルポートを転送する:
kubectl -n argocd-system port-forward svc/argocd-server 8080:80Argo CDサーバーはTLSなしで動作するため、転送先はポート
80なります。このコマンドは停止するまで実行され続けるので、Argo CDのユーザーインターフェースを使用している間は開いたままにしておいてください。 -
別のターミナルで、
argocd-initial-admin-secretシークレットからadminパスワードを取得します。kubectl -n argocd-system get secret argocd-initial-admin-secret \ -o jsonpath="{.data.password}" | base64 --decode -
ブラウザで
http://localhost:8080を開き、そのパスワードを使用してadminとしてログインしてください。 -
各アプリケーションが「正常」かつ「同期済み」と表示されていることを確認してください。
アプリケーションは、リソースがステータスを報告するまで「進行中」と表示されます。 LiferayInfrastructureリソースにThe system is initializing.、次にStill <reason>: <message> 、そしてThe LiferayInfrastructure is healthy. Synced状態がFalse場合、 LiferayInfrastructureは劣化状態となり、その状態のメッセージが表示されます。
デプロイメントの検証
GitOpsリポジトリ内の各環境フォルダは、名前空間liferay- <project>-<environment>-infra内に、 <project>-<environment>-app -infra およびliferay-<project>-<environment> -app という2つのArgo CDアプリケーションを生成します。ボイラープレートから作成され、まだ変更されていない GitOps リポジトリでは、これらは名前空間liferay-default-dev内のdefault-dev-infraとdefault-dev-appです。
Argo CD は、 LiferayInfrastructureのReady状態がTrueあり、かつ管理対象サービスが準備完了状態(データベースのブートストラップが完了し、ドキュメントライブラリへの接続が準備完了状態)である場合にのみ、LiferayInfrastructure が正常であると報告します。
環境の名前空間にある Liferay ポッドを確認してください。
kubectl get pods --namespace liferay-default-dev
Liferayポッドが準備完了になると、そのSTATUSはRunningとなり、 READY列にはすべてのコンテナが準備完了としてカウントされます。その初期化コンテナが実行されている間、そのSTATUS Init:で始まります。
Liferay DXP が起動する前に、Liferay ポッドは、とりわけ以下の依存関係が満たされるまで待機します。
-
wait-for-elasticsearch待ちコンテナは、Elasticsearchが緑色または黄色の正常状態を報告するまで実行されます。 -
database-server-detailsConfigMapが表示されます。
データベースのプロビジョニング中に、 database-server-details ConfigMapがまだ存在しないため、LiferayポッドにCreateContainerConfigErrorが表示されます。 ConfigMapが見つからないためにPodがCreateContainerConfigErrorのままになっている場合、データベースがプロビジョニングされていません。 CNE Azure Ready: トラブルシューティングを参照してください。
Azure 上の Liferay DXP は、トライアル ライセンスが無効になっている状態で起動するため、ライセンスを追加する必要があります。 CNE Azure Ready: シークレットとライセンスの管理を参照してください。ドメインで Liferay DXP にアクセスするには、 「CNE Azure Ready: Liferay ドメインと TLS の構成」を参照してください。
CNE Azure Ready: Cloud Native Experience の構成に進み、環境とプラットフォーム コンポーネントをカスタマイズしてください。