アップグレードガイド

このガイドでは、Terraform を使用して既存の Manufacturing Data Engine（MDE）インストールをアップグレードする方法について一般的なガイダンスを提供します。

Terraform スクリプトを変更した場合は、追加の手順が必要になることがあります。これは一般的なアップグレードガイドであるため、デプロイする特定のバージョンの完全なリリースノートも必ずお読みください。考慮すべき情報が含まれている可能性があります。

始める前に

アップグレードする前に、一部の Dataflow ジョブを手動で停止する必要があります。リリースノートには、アップグレード先の特定のバージョンで手動で停止する必要があるジョブが記載されています。

このガイドには、次の前提条件があります。

デフォルトのデプロイパッケージを使用している。
クライアント環境に、必要な CLI ツールが最新バージョンでインストールされている。
- 次の追加コンポーネントがインストールされた Google Cloud CLI:
  - kubectl
  - cbt
  - Terraform CLI (1.9.x 以降)
  - Helm CLI（3.9.x 以降）
MDE のデプロイには任意のクライアント環境を使用できますが、Cloud Shell からデプロイすると、必要なツールのほとんどがすでにインストールされているため、時間を節約できます。
Cloud Shell をアクティブにする
MDE Google Cloud プロジェクトに対する完全なアクセス権と、元のデプロイに使用された構成ファイルに対するアクセス権がある。
- サービスアカウントの JSON キーファイル: mde-imgs-service-account-key.json。
- Terraform: input.tfvars。
- Terraform: backend.conf。
注: MDE v1.5 では、サービスアカウントの JSON キーファイルは必要ありません。
このガイドのすべての gcloud コマンドは、デフォルトのプロジェクトが MDE デプロイプロジェクトに設定されていることを前提としています。デフォルトプロジェクトは、次のコマンドで設定できます。
```
gcloud config set project PROJECT_ID
```
PROJECT_ID は、MDE デプロイプロジェクト ID に置き換えます。

MDE GKE クラスタの認証情報を取得している。まだ実行していない場合は、次のコマンドを使用します。

export CLUSTER_NAME="mde-gke"
export CLUSTER_LOCATION=$(gcloud container clusters list --filter="name:$CLUSTER_NAME" --format="value(LOCATION)" )

# when upgrading to 1.5.2 we need to enable DNS endpoint on GKE cluster to allow Terraform connect to it
gcloud container clusters update $CLUSTER_NAME --region $CLUSTER_LOCATION --enable-dns-access

export KUBE_CONFIG_PATH=~/.kube/config
gcloud container clusters get-credentials $CLUSTER_NAME --region $CLUSTER_LOCATION --dns-endpoint

デフォルト名（mde-gke）を変更した場合は、CLUSTER_NAME をクラスタの名前に置き換えます。kubeconfig がデフォルトのパスにない場合は、KUBE_CONFIG_PATH を変更します。

アップグレード

このセクションでは、Terraform を使用してアップグレードを行う方法について説明します。

Terraform サービスアカウントの権限を更新して、MDE 1.4.0 以降で新たに必要となる権限を追加します。次のコマンドを使用して追加できます。

export PROJECT_ID=$(gcloud config get-value project)
export SA_TERRAFORM="mde-tf"

gcloud projects add-iam-policy-binding $PROJECT_ID \
--member="serviceAccount:$SA_TERRAFORM@$PROJECT_ID.iam.gserviceaccount.com" \
--role='roles/file.editor'

次のコマンドを使用して、古いデプロイフォルダをバックアップします。
```
cp -r MDE_FOLDER MDE_FOLDER_BACKUP
```
MDE_FOLDER と MDE_FOLDER_BACKUP は、MDE フォルダとバックアップフォルダの名前に置き換えます。
最新の MDE ソリューションリリースパッケージをダウンロードして解凍します。

注: MDE デプロイアセットにアクセスするには、 Google Cloud チームの承認が必要です。MDE のテストまたはデプロイに関心がある場合は、できるだけ早くお問い合わせになることをおすすめします。 Google Cloud アカウントチームがわからない場合は、画面右上の Contact Us ボタンをご利用ください。担当者から折り返しご連絡いたします。
1. ソリューションパッケージをダウンロードします。
2. パッケージをクライアント環境に抽出します。
3. cd コマンドを使用して、新しいリリースフォルダに移動します。
v1.4.x にアップグレードする場合は、次のコマンドを使用して、バックアップから新しいフォルダに次のファイルをコピーします（ファイルパスは異なる場合があります）。
```
cp ../MDE_FOLDER_BACKUP/mde-imgs-service-account-key.json .
cd deployment/terraform
cp ../../../MDE_FOLDER_BACKUP/deployment/terraform/input.tfvars .
cp ../../../MDE_FOLDER_BACKUP/deployment/terraform/backend.conf .
```
v1.5.1 にアップグレードする場合は、次のファイルのみをコピーします。
```
cd deployment/terraform
cp ../../../MDE_FOLDER_BACKUP/deployment/terraform/input.tfvars .
cp ../../../MDE_FOLDER_BACKUP/deployment/terraform/backend.conf .
```
MDE_FOLDER_BACKUP は、MDE バックアップフォルダの名前に置き換えます。
v1.4.x から v1.5.x にアップグレードする場合、または v1.5.0 から v1.5.1 にアップグレードする場合は、リリースパッケージに含まれているアップグレード前スクリプトを実行します。

注: このスクリプトは、すべての Pub/Sub サブスクリプションがドレインされた後に実行してください。'/configuration/v1/processing:stop' API を使用するか、MDE UI の Messages processing スイッチを切り替えて処理を停止し、システムをドレインしてからこのスクリプトを実行します。
```
# Execute script from the upgrade/1.5 directory and return to the terraform directory
cd ../../upgrade/1.5
export BQ_PROJECT_ID=$(gcloud config get-value project)
export PUBSUB_PROJECT_ID=$(gcloud config get-value project)
sh migrate-metadata-instance-bq-table.sh "$BQ_PROJECT_ID" "$PUBSUB_PROJECT_ID"
cd ../../deployment/terraform
```

1.5.2 にアップグレードする場合は、次のコマンドを使用して、providers.tf ファイル内のローカル kubeconfig を使用するように Kubernetes プロバイダを切り替える必要があります。

provider "kubernetes" {
config_path            = "~/.kube/config"
# host                   = "https://${local.gke_host}"
# token                  = data...
# cluster_ca_certificate = local.gke_ca_cert
}

provider "helm" {
kubernetes {
    config_path            = "~/.kube/config"
    # host                   = "https://${local.gke_host}"
    # token                  = data...
    # cluster_ca_certificate = local.gke_ca_cert
}
}

次のコマンドを使用して Terraform 状態を再読み込みします。
```
terraform init -backend-config=backend.conf -reconfigure
```
Terraform プランを作成します。

入力パラメータの準備ができたら、次のコマンドを使用して Terraform プランを作成する必要があります。このプランを使用して、プロジェクトで作成されるアーティファクトと構成を確認できます。

注: v1.5.x 以降ではサービスアカウントキーが不要になったため、mde_artifact_registry_sa_path に関する Terraform 警告が表示されることがあります。この警告は無視してかまいません。この変数を input.tfvars ファイルからコメントアウトまたは削除してください。
```
terraform plan -var-file=./input.tfvars -out=./tfplan
```
このコマンドを使用して、計画された変更を閲覧できます。
```
terraform show -no-color ./tfplan > tfplan.txt
more tfplan.txt
```
重要: 計画フェーズで、-materialization 接尾辞が付いた特定の Pub/Sub サブスクリプションに lifecycle.prevent_destroy フラグがあるため削除できないというエラーが Terraform に表示された場合は、-materialization 接尾辞が付いたすべての Pub/Sub トピックと、それに接続されているサブスクリプションを手動で削除する必要があります。この手順は、デプロイを開始する前に実行する必要があります。これにより、デプロイ後に MDE によってトピックが自動的に作成されます。
次のコマンドを使用して Terraform プランを適用します。
```
terraform apply ./tfplan
```
デプロイが成功したことを確認します。

terraform apply コマンドの実行が完了すると、次のような成功メッセージが表示されます（実際の数は、特定のデプロイオプションとバージョンによって異なります）。
```
Apply complete! Resources: 1 added, 34 changed, 0 destroyed.
```

アップグレード後

アップグレードが完了したら、以前の MDE デプロイのステータスに応じて、次の手順を 1 つ以上実行する必要があります。

既存のタイプの BigQuery ビュー

1.4.x より前のリリースからアップグレードする場合、この機能は 1.4.0 で導入されたため、作成されたタイプに分析ビューは作成されません。アナリティクスビューの再作成をトリガーするには、既存のタイプを再度有効にする必要があります。/activate エンドポイントは、リリースに付属している Postman キットで確認できます。

GKE クラスタの Filestore ドライバ

GKE クラスタ Pod が起動しない、または ContainerCreating 状態のままになるという問題が発生した場合は、Filestore ドライバが有効になっていない可能性があります。有効にするには、デプロイガイドの手順に沿って操作します。