CNE Azure Ready: 前提条件
Microsoft Azure 上で Cloud Native Experience (CNE) のブートストラップ スクリプトを実行する前に、必要なコマンドライン ツールをインストールし、Azure サブスクリプションを準備し、Azure Key Vault と GitOps リポジトリを作成してください。 Argo CDはGitOpsリポジトリからLiferay DXP環境をデプロイするため、リポジトリの内容によってクラスタ上で実行されるものが定義されます。
ブートストラップはローカルマシン上で実行され、Terraform、Helm、Argo CD、およびAzure Kubernetes Service(AKS)を使用してGitOpsベースのプラットフォームをプロビジョニングします。
コマンドラインツールのインストール
ブートストラップスクリプトは、他の処理を実行する前にこれらのツールが存在するかどうかを確認します。それらをインストールし、システムのPATHで利用可能になっていることを確認してください。
| 道具 | 必須 | 目的 |
|---|---|---|
Azure CLI ( az) | setup_azure.shとteardown_azure.sh | Azureにサインインし、Terraformの状態ストレージ、ロールの割り当て、およびクラスタの認証情報を作成します。 |
| テラフォーム | ランチャー、 setup_azure.sh 、およびteardown_azure.sh | AKSクラスターとプラットフォームをプロビジョニングします。 |
| Helm CLI | setup_azure.shとteardown_azure.sh | setup_azure.shでconfig.jsonインフラストラクチャ プロバイダー チャートに対して検証し、 liferay-platformチャートをインストールし、 teardown_azure.shでそれをアンインストールします。 |
| jq | ランチャー、 setup_azure.sh 、およびteardown_azure.sh | ブートストラップスクリプト内のconfig.json読み込んでください。 |
| カール | ランチャー | Bootstrapリリースをダウンロードしてください。 |
tar | ランチャー | ブートストラップリリースを抽出します。 |
sha256sumまたはshasum | ランチャー | ブートストラップリリースのチェックサムを検証してください。 |
| kubectl CLI | teardown_azure.sh | Terraformがインフラストラクチャを破壊する前に、プラットフォームのKubernetesリソースを削除してください。 |
ツールが見つからない場合、実行はThe utility <name> is not installed. どちらのチェックサムツールもインストールされていない場合、ランチャーはNeither sha256sum nor shasum is installed.
Terraformのバージョンは1.10.0以降である必要があります。 Azure Terraform スタックはどちらも、Terraform の初期化時にこのバージョンを強制的に適用します。 OpenTofuはサポートされていません。
セットアップでは、 oci://us-central1-docker.pkg.dev/external-assets-prd/liferay-helm-chartからliferay-azure-infrastructure-providerおよびliferay-platformチャートを取得するため、お使いのマシンからそのレジストリにアクセスできる必要があります。実行中、お使いのマシンは以下のエンドポイントにも到達します。
https://storage.googleapis.comでは、ランチャーに公開されているブートストラップのリリース一覧が表示されます。https://cdn.liferay.cloudアクセスすると、ランチャーがブートストラップリリースとそのチェックサムをダウンロードします。https://argoproj.github.io/argo-helmでは、プラットフォームスタックが Argo CD チャートを取得します。
Azure サブスクリプションの準備
ブートストラップはconfig.jsonからサブスクリプションとテナントを読み込み、Key Vaultを除くプラットフォームで使用されるすべてのAzureリソースを作成します。
Azure アカウントの設定
サブスクリプションIDとテナントIDを確認し、役割を確認し、デプロイメント名を選択し、ブートストラップを実行するアカウントでサインインしてください。
-
デプロイ先のサブスクリプションとそのテナントのIDを見つけてください。
az loginでサインインし、アカウントで使用できるサブスクリプションの一覧を表示してください。az account list --query "[].{name: name, subscription_id: id, tenant_id: tenantId}" --output tableconfig.jsonで、subscription_idとtenant_idという 2 つの ID を設定します。 -
ブートストラップを実行するアカウントが、サブスクリプションの所有者権限、またはロールベースアクセス制御管理者権限を持つ共同作成者権限を保持していることを確認してください。ブートストラップは、Key Vaultや構成したコンテナレジストリなどを含むリソースを作成し、ロールを割り当てます。そのため、これらのロールはそれらのスコープもカバーする必要があります。不足しているロールを付与するには、 「Azure CLI を使用して Azure ロールを割り当てる」を参照してください。
ブートストラップでは、
deployment_nameという名前のリソースグループ、仮想ネットワーク、サブネット、NAT ゲートウェイ、パブリック IP アドレス、ネットワークセキュリティグループ、AKS クラスター、およびユーザーに割り当てられた管理対象 ID が作成されます。また、これらのアイデンティティに以下の役割を割り当てます。役割 範囲 Network Contributor仮想ネットワーク AcrPull各コンテナレジストリ Contributorリソースグループ Managed Identity Contributorリソースグループ Role Based Access Control Administrator、条件付きリソースグループ Key Vault Secrets User鍵保管庫 監視ロール(可観測性が有効になっている場合) 監視リソースとリソースグループ -
deployment_name名を選択してください。これはリソース グループ名、AKS DNS プレフィックス、およびすべてのリソース名のプレフィックスとなり、AKS クラスターは<deployment_name>-aksという名前になります。小文字、数字、ハイフンのみを使用してください。名前はアルファベットで始め、アルファベットか数字で終わり、29文字以内に収めてください。 -
デプロイ先のテナントにサインインしてください。
az login --tenant <tenant-id>ブラウザでのサインインがうまくいかない場合は、代わりにデバイスコードを使用してサインインしてください。
az login --tenant <tenant-id> --use-device-codeアカウントで複数のサブスクリプションを使用できる場合は、
config.jsonで設定したサブスクリプションを選択してください。そうすることで、この記事のチェックがそのサブスクリプションに対して実行されます。az account set --subscription <subscription-id>セットアップがサブスクリプションのトークンを取得できるアクティブなログインを見つけると、それを再利用して
Reusing the active Azure login for the subscription <id>.そうでない場合は、Attempting to login to your Azure account.そして、az login --tenant <tenant_id>を自身で実行します。いずれにしても、その後、az account setサブスクリプションが選択されます。サービスプリンシパルではなくユーザーアカウントでサインインしてください。アカウントで Terraform ステートコンテナを一覧表示できない場合、セットアップはサインインしたユーザーにそのコンテナに対するロールを付与し、そのロールをユーザーに割り当てます。
十分なコンピューティングクォータを確保する
AKSシステムノードプールは、 machine_type VMサイズ(デフォルトはStandard_D8s_v3 )のsystem_node_countノード(デフォルトは2 )を実行します。 general-purposeノード自動プロビジョニングプールは、同じサイズのワークロードノードをオンデマンドでプロビジョニングします。初回実行前に、そのリージョンにそのVMサイズに対応するvCPUクォータがあり、かつそれが提供されていることを確認してください。
az vm list-usage --location <region> --output table
az vm list-skus --location <region> --size Standard_D8s_v3
az vm list-usageコマンドは、リージョン内の各 vCPU クォータを、現在の使用量と制限値とともに一覧表示します。 VMサイズのファミリーに対する割り当て量は、システムノードと、環境が追加するワークロードノードのための余裕を残しておく必要があります。そうならない場合は、割り当て量の増加を要求してください。 az vm list-skusは、リージョンで利用可能な場合、VM サイズと、そのサイズに対するゾーン制限を一覧表示します。
別の VM サイズを使用するには、 config.jsonでterraform.aks.machine_typeを設定します。 CNE Azure Ready: Bootstrap構成リファレンスを参照してください。
データベースサービスが利用可能であることを確認する
このプラットフォームは、お客様のregionにAzure Database for PostgreSQL Flexible Serverをプロビジョニングします。そのサブスクリプションを作成するには、そのサブスクリプションの承認が必要です。実行前にこれをチェックするものは何もありません。クラスターとプラットフォームのインストール後、データベースが失敗し、Liferay DXPは起動しません。
ご契約の地域でそのサービスが提供されているかどうかをご確認ください。
az postgres flexible-server list-skus --location <region> --query "[0].reason" --output tsv
検索結果が空の場合は、その地域でサービスが利用可能であることを意味します。
デフォルトのPostgreSQLサーバーサイズはGP_Standard_D2s_v3です。そのリージョンでそれが利用可能かどうかを確認するか、環境ごとにdatabase.instanceTypeを設定してください。 CNE Azure Ready: Helm 値リファレンスを参照してください。
リモート Terraform ステートの設定 (オプション)
デフォルトでは、Terraformは状態をローカルマシンに保持します。 Azure Storage に保存するには、 config.jsonにresource_group_name 、 storage_account_name 、 container_nameを含むtfstateオブジェクトを追加します。 tfstateオブジェクトが存在する場合、3つのキーすべてが必要になります。セットアップでは、まだ存在しない名前付きリソース(リソースグループ、 Standard_LRS冗長性を備えたStorageV2ストレージアカウント、およびコンテナ)をそれぞれ作成します。
tfstate実行するたびに、セットアップによってストレージ アカウントも構成されます。具体的には、パブリック ブロブ アクセスを無効にし、TLS 1.2 を必須とし、ブロブ バージョン管理と 90 日間のブロブ削除保持を有効にします。
ストレージアカウント名は、小文字の英字と数字を組み合わせた3~24文字で、Azure全体で一意である必要があります。
アカウントで状態コンテナを一覧表示できない場合、セットアップはサインインしているユーザーにコンテナ上のStorage Blob Data Contributorロールを割り当て、割り当てが有効になるまで最大5分間待機します。
Azure Key Vault の作成
このプラットフォームは、GitOpsリポジトリの認証情報を含む機密情報を、ユーザーが作成したAzure Key Vaultから読み取ります。
-
Azure ロールベース アクセス制御 (RBAC) アクセス許可モデルを使用するAzure Key Vault を作成します。ブートストラップはボールトを読み込むだけで、ボールトを作成することはなく、アクセス ポリシーの権限モデルを使用するボールトは実行を停止します。
subscription_idストラップは、subscription_id で指定されたサブスクリプションを通じてボルトを読み取るため、そのサブスクリプション内にボルトを作成してください。 -
保管庫の名前とリソースグループをメモしておいてください。それらを
config.jsonでterraform.platform.cluster_secret_store.key_vault.nameおよびterraform.platform.cluster_secret_store.key_vault.resource_group_nameとして設定します。 -
保管庫に秘密情報を保存するアカウントが、保管庫上でキー保管庫秘密情報責任者またはキー保管庫管理者の役割を担っていることを確認してください。
GitOpsリポジトリの作成
Liferayのテンプレートからリポジトリを作成し、Argo CDに読み取り用のトークンを付与します。
-
LiferayCloud/cloud-native-gitops-boilerplateテンプレートを使用してリポジトリを作成します。その
liferay/projects/default/environments/dev/フォルダは、プラットフォームが想定するレイアウトと一致しています。 -
GitOpsリポジトリの内容への読み取り専用アクセス権限を持つ個人用アクセストークンを生成します。プラットフォームはリポジトリを読み取るだけです。
-
この JSON ドキュメントを、
gitops-credentials.jsonなどのファイルに、ご自身の値とともに保存してください。{ "git_machine_user_id": "your-github-username", "git_access_token": "ghp_abc...WxYZ" }分野 説明 git_machine_user_idトークンを所有するGitHubユーザー名(または組織のマシンアカウントのログイン情報) git_access_tokenあなたが生成した個人アクセストークン -
そのファイルから、Key Vaultに
liferay-credentials-gitopsという名前のシークレットを作成します。az keyvault secret set \ --file gitops-credentials.json \ --name liferay-credentials-gitops \ --vault-name <vault-name>
設定の確認
続行する前に、各コマンドを実行し、その出力が期待される出力と一致することを確認してください。
| 指示 | 期待される出力 |
|---|---|
az version | "azure-cli": "2.90.0"以降のバージョン |
az account show --query "{subscription_id: id, tenant_id: tenantId}" --output table | config.jsonで設定したサブスクリプションIDとテナントID |
az keyvault show --name <vault-name> --query properties.enableRbacAuthorization | true |
az keyvault secret show --name liferay-credentials-gitops --output tsv --query name --vault-name <vault-name> | liferay-credentials-gitops |
terraform -version | Terraform v1.10.0以降のバージョン |
helm version 、 kubectl version --client 、 jq --version 、 curl --version 、 tar --version | 各バージョン番号 |
sha256sum --versionまたはshasum --version | どちらのバージョン番号でも |
結果が一致しない場合は、続行する前に、その前提条件を扱っているセクションに戻ってください。
次のステップ
これらの前提条件を満たしたら、 「CNE Azure Ready: 初期環境のブートストラップ」に進んでください。