CNE: AWS Ready - ブートストラップ設定リファレンス

以下の構成では、Cloud Native Experience (CNE) デプロイメントのクラウドインフラストラクチャ、GitOps 同期設定、およびブートストラップ実行オプションを定義します。 必須変数は デフォルト 列にマークされています。 複数のフェーズで必要となる変数は、簡潔にするため一度だけ表示されます。

EKSインフラストラクチャ変数

これらの変数は、AWSネットワークの中核となる環境とKubernetesクラスタ環境を定義します。

名前	種類	デフォルト	説明
arn_partition	文字列	"aws"	AWS ARN パーティション識別子 (例: "aws"、 "aws-cn"、または "aws-us-gov")。
deployment_name	文字列	(必須)	デプロイメントの一意の識別子。リソース名の命名に使用されます（小文字、数字、ハイフンのみ）。
gateway_namespace	文字列	"envoy-gateway-system"	Envoy API Gatewayリソースが作成される名前空間。 小文字、数字、ハイフンのみを使用してください。
max_availability_zones	整数	1	当該地域で使用されているアベイラビリティゾーンの数。
private_subnets	リスト（文字列）	null	内部リソース（例えば、インターネットに直接アクセスできないワーカーノード）が使用するプライベートサブネット用の追加のCIDRブロック。
public_subnets	リスト（文字列）	null	インターネットに接続されたリソース（例えば、ロードバランサー）が使用するパブリックサブネット用の追加のCIDRブロック。
region	文字列	(必須)	クラスターがデプロイされているリージョン。
vpc_cidr	文字列	"10.0.0.0/16"	VPCネットワーク全体に対するCIDRブロック。

観測可能性変数

これらの変数は、クラスターと共にデプロイされる可観測性スタックを制御します。

名前	種類	デフォルト	説明
observability_config	オブジェクト	{}	可観測性コンポーネントの設定。

observability_config プロパティ

名前	種類	デフォルト	説明
enabled	ブール値	true	可観測性コンポーネントを導入するかどうか。
alloy_namespace	文字列	"alloy"	Grafana Alloyがデプロイされている名前空間。

GitOps - プラットフォーム変数

これらの変数は、コアとなるGitOpsコンポーネントとオペレーターコンポーネントの名前空間を定義します。

名前	種類	デフォルト	説明
argo_workflows_namespace	文字列	"argo-workflows-system"	ArgoCDワークフローエンジンのコンポーネントがインストールされている名前空間。
argocd_namespace	文字列	"argocd-system"	ArgoCDコンポーネントがインストールされている名前空間。
crossplane_namespace	文字列	"crossplane-system"	Crossplaneのインストール用の名前空間。
external_secrets_namespace	文字列	"external-secrets-system"	外部シークレット演算子の名前空間。

GitOps - リソース変数

これらの変数は、Liferayとそのインフラストラクチャの依存関係がGitOpsを介してどのように管理されるかを設定します。

名前	種類	デフォルト	説明
argocd_domain_config	オブジェクト	{}	ArgoCD のドメイン構成（ホスト名およびtls_external_secret_name を含む）。
external_secret_store_provider_hcl	オブジェクト	null	外部シークレットストア用のHashiCorp構成言語（HCL）構成。 設定されていない場合、システムはデフォルトでAWS Secrets Managerを使用します。
gateway_class_name	文字列	"liferay-gateway-class"	プロバイダが使用するゲートウェイクラス名。
infrastructure_git_repo_config	オブジェクト	（Gitリポジトリ設定を参照）	インフラストラクチャGitリポジトリの設定オプション。
infrastructure_helm_chart_config	オブジェクト	( インフラストラクチャHelmチャート構成を参照)	インフラストラクチャHelmチャートの設定オプション。
infrastructure_provider_helm_chart_config	オブジェクト	( インフラストラクチャHelmチャート構成を参照)	インフラストラクチャプロバイダーのHelmチャートの設定オプション。
liferay_git_repo_url	文字列	(必須)	Liferay設定リポジトリのGitリポジトリURL。
liferay_helm_chart_name	文字列	"liferay-aws"	チャートの名前 (例: "liferay-default"、 "liferay-aws"、または "liferay-aws-marketplace")。
liferay_helm_chart_version	文字列	(必須)	デプロイするLiferay Helmチャートのバージョン。

Gitリポジトリの設定

infrastructure_git_repo_config 変数は、リポジトリへのアクセス、ソースパス、および Argo CD ターゲット設定を定義します。

認証オプション (認証)

プロパティ	種類	デフォルト	説明
credentials_secret_name	文字列	"liferay/credentials/gitops"	Git認証情報を保存する外部保管庫内の秘密の名前。
internal_secret_name	文字列	"gitops-credentials"	Argo CDで使用されるKubernetesのシークレット名。
method	文字列	"https"	認証方法: https または ssh。
ssh_private_key_property	文字列	"git_ssh_private_key"	SSH秘密鍵のVaultプロパティ名。
token_property	文字列	"git_access_token"	GitアクセストークンのVaultプロパティ名。
username_property	文字列	"git_machine_user_id"	GitユーザーIDに対応するVaultプロパティ名。

改訂履歴

プロパティ	種類	デフォルト	説明
revision	文字列	"HEAD"	追跡対象のGitリビジョンまたはブランチ。

ソースパス (source_paths)

プロパティ	種類	デフォルト	説明
base	文字列	"liferay/projects/{{path[2]}}/base"	プロジェクト構成の基本パスパターン。
environment	文字列	"liferay/projects/*/environments/*"	環境ディレクトリ用のグロブパターン。
infrastructure_provider_values_filename	文字列	"infrastructure-provider.yaml"	インフラストラクチャプロバイダーの値を格納するファイル名。
system	文字列	"liferay/system"	システムレベルの設定を行うためのパス。
values_filename	文字列	"infrastructure.yaml"	インフラストラクチャHelmの値を格納するファイル名。

ターゲットオプション (ターゲット)

プロパティ	種類	デフォルト	説明
name	文字列	"{{path[2]}}-{{path[4]}}-infra"	Argo CDアプリケーションの命名パターン。
namespaceSuffix	文字列	"{{path[2]}}-{{path[4]}}"	名前空間の接尾辞パターン。
slugEnvironmentId	文字列	"{{path[4]}}"	パスから取得した環境識別子。
slugProjectId	文字列	"{{path[2]}}"	パスから取得したプロジェクト識別子。

URLの上書き

プロパティ	種類	デフォルト	説明
url	文字列	null	オプションのGitリポジトリURLの上書き。 infrastructure_git_repo_config にのみ適用されます。

例

infrastructure_git_repo_config のデフォルト構造:

{
   "infrastructure_git_repo_config": {
      "auth": {
         "credentials_secret_name": "liferay/credentials/gitops",
         "internal_secret_name": "gitops-credentials",
         "method": "https",
         "ssh_private_key_property": "git_ssh_private_key",
         "token_property": "git_access_token",
         "username_property": "git_machine_user_id"
      },
      "revision": "HEAD",
      "source_paths": {
         "base": "liferay/projects/{{path[2]}}/base",
         "environment": "liferay/projects/*/environments/*",
         "infrastructure_provider_values_filename": "infrastructure-provider.yaml",
         "system": "liferay/system",
         "values_filename": "infrastructure.yaml"
      },
      "target": {
         "name": "{{path[2]}}-{{path[4]}}-infra",
         "namespaceSuffix": "{{path[2]}}-{{path[4]}}",
         "slugEnvironmentId": "{{path[4]}}",
         "slugProjectId": "{{path[2]}}"
      },
      "url": null
   }
}

Bootstrapのオプション

ブートストラップスクリプトは、ブートストラップ処理中にTerraformがどのように実行されるかを制御する追加オプションをサポートしています。 これらのオプションは、config.json 内のルートレベルのオプションオブジェクトで定義してください。

名前	種類	デフォルト	説明
auto_approve	ブール値	false	確認を求めることなく terraform apply を実行します。
parallelism	整数	10	Terraformが同時に作成または更新できるリソースの最大数。 Kubernetes API呼び出しが過負荷状態になった場合は、この値を小さくしてください。

例

{
   "options": {
      "auto_approve": true,
      "parallelism": 5
   },
   "provider": "aws",
   "variables": {...}
}

インフラストラクチャ Helm チャート構成

infrastructure_helm_chart_config

プロパティ	種類	デフォルト	説明
chart_name	文字列	"liferay-aws-infrastructure"	インフラストラクチャ Helm チャート名。
chart_url	文字列	"oci://us-central1-docker.pkg.dev/external-assets-prd/liferay-helm-chart/liferay-aws-infrastructure"	チャートのOCIレジストリURL。
path	文字列	null	チャートへのローカルパス（OCIを使用していない場合）。
version	文字列	"0.3.1"	Helmチャート版。

infrastructure_provider_helm_chart_config

プロパティ	種類	デフォルト	説明
chart_name	文字列	"liferay-aws-infrastructure-provider"	インフラストラクチャプロバイダーのHelmチャート名。
chart_url	文字列	"oci://us-central1-docker.pkg.dev/external-assets-prd/liferay-helm-chart/liferay-aws-infrastructure-provider"	チャートのOCIレジストリURL。
path	文字列	null	チャートへのローカルパス（OCIを使用していない場合）。
version	文字列	"0.2.2"	Helmチャート版。