Blue/Green デプロイの切り替えを実行する

Green 環境をテストして検証したら、スイッチオーバーを開始して、Green 環境を新しい本番環境の読み取り / 書き込み環境に変換します。

始める前に

スイッチオーバーを開始する前に、必要な権限があり、デプロイがスイッチオーバーの準備ができていることを確認してください。

必要なロールと権限

スイッチオーバーの実行に必要な権限を取得するには、プロジェクトに対する次の IAM ロールを付与するよう管理者に依頼してください。

  • Cloud SQL 管理者(roles/cloudsql.admin)

カスタムロールの場合は、次の権限があることを確認してください。

  • cloudsql.blueGreenDeployments.switchover
  • cloudsql.blueGreenDeployments.get
  • cloudsql.instances.switchover
  • cloudsql.operations.get

Cloud SQL の IAM ロールと権限の詳細については、ロールと権限をご覧ください。

スイッチオーバー前の検証

スイッチオーバーを開始する前に、次の条件を確認します。

  1. デプロイの状態: デプロイは SWITCHOVER_READY 状態である必要があります。
  2. 構成設定: Google Cloud コンソールで設定の違いを確認するか、--show-config-diff フラグを指定して gcloud sql blue-green-deployments describe コマンドを実行するか、view=DETAILED パラメータを指定して blueGreenDeployments.get メソッドを呼び出して、グリーン インスタンスに想定される構成設定があることを確認します。詳細については、構成の違いを表示するをご覧ください。
  3. ワークロードの検証: グリーン ステージング インスタンスですべてのテストと検証を完了します。
  4. レプリケーション ラグが少ない: ブルーとグリーンの間のレプリケーション ラグを最小限に抑えて、スイッチオーバー時間を短縮します。

スイッチオーバーの仕組み

スイッチオーバーを開始すると、Cloud SQL は次の自動シーケンスを実行します。

  1. スイッチオーバー前の検証: スイッチオーバー オペレーションの前に、Cloud SQL はレプリケーションが破損していないことを検証し、一連の構成チェックを実行して、デプロイの準備が整っていることを確認します。
  2. スイッチオーバー ワークフローの実行: ワークフローの実行中に、Cloud SQL はスイッチオーバー用のインスタンスを準備します。レプリケーション ラグが大きすぎる場合や、アクティブなトランザクションがスイッチオーバーをブロックしている場合、スイッチオーバー オペレーションは失敗し、本番環境のブルー環境はオンラインのままになります。
  3. トラフィックのリダイレクト: Cloud SQL は、ブルー インスタンスとグリーン インスタンスの間で接続エンドポイントを入れ替えます。
  4. ロールの変換: グリーン インスタンスがアクティブな本番環境の読み取り / 書き込みインスタンスになり、ブルー インスタンスがスタンドアロンの読み取り / 書き込みインスタンスになります。

スイッチオーバー中、アプリケーション接続は一時的に中断されます(通常は数秒)。その後、アップグレードされた本番環境インスタンスに自動的に再接続されます。スイッチオーバーのダウンタイムは、Cloud SQL のエディションによって異なります。

  • Cloud SQL Enterprise Plus エディション: スイッチオーバーのダウンタイムは通常 1 秒未満です。
  • Cloud SQL Enterprise エディション: ワークロードとレプリケーション ラグに応じて、スイッチオーバーのダウンタイムは通常 60 秒未満です。アプリケーション構成や接続文字列の変更は必要ありません。

スイッチオーバーのライフサイクル状態

スイッチオーバーの前、最中、後に、デプロイは state レスポンス フィールドで次の状態に移行します。

  • SWITCHOVER_READY: ブルーからグリーンへの論理レプリケーションが正常で、デプロイメントの切り替えの準備ができています。SWITCHOVER_READY ステータスは、レプリケーションが正常である場合にのみ適用されます。Cloud SQL は、このステータスを設定するときにレプリケーション ラグを評価しません。
  • SWITCHOVER_NOT_READY: デプロイはプロビジョニングされていますが、スイッチオーバーを開始できません。これは、論理レプリケーションが破損、一時停止、停止した場合、または基盤となるノードエラーが発生した場合に発生します。Cloud SQL は、このステータスを設定するときにレプリケーション ラグを評価しません。errorDetail フィールドを調べて、スイッチオーバーを試みる前にエラーを解決します。
  • SWITCHOVER_IN_PROGRESS: switchover コマンドが実行中です。Cloud SQL が接続エンドポイントをスワップし、Green を本番環境の読み取り / 書き込みインスタンスに変換しています。
  • SWITCHOVER_COMPLETED: スイッチオーバーが正常に完了しました。緑色のインスタンスは、読み取りトラフィックと書き込みトラフィックを処理するアクティブな本番環境データベース インスタンスになり、青色のインスタンスは、デプロイを削除するまでスタンドアロン インスタンスとして保持されます。

スイッチオーバー前のベスト プラクティス

  • トラフィックの少ない時間帯にスケジュールを設定する: ダウンタイムは最小限(通常は数秒)ですが、書き込みアクティビティが少ない時間帯(たとえば、秒間クエリ数 [QPS] が最も少ないオフピーク時間帯やメンテナンスの時間枠)にスイッチオーバーを開始します。これにより、レプリケーション ラグが最小限に抑えられ、トランザクションがキャンセルされるリスクが軽減されます。
  • レプリケーション ラグを確認する: スイッチオーバーを開始する前に、レプリケーション ラグが最小限であることを確認します。Blue/Green デプロイの説明ではレプリケーション ラグは表示されません。また、Cloud SQL はスイッチオーバー オペレーションの前にレプリケーション ラグをチェックしません。ただし、ワークフローの実行中にレプリケーション ラグが大きすぎると、スイッチオーバーは失敗します。レプリケーション ラグをモニタリングするには、Cloud Monitoring の指標(replica_lag など)を確認するか、グリーン インスタンスでレプリケーション ステータスを直接確認します。詳細については、レプリケーション ラグをご覧ください。
  • アクティブなトランザクションを確認する: 切り替えを開始する前に、長時間実行される DDL オペレーションまたはバッチ書き込みが完了していることを確認します。

スイッチオーバーを開始する

Google Cloud コンソール、gcloud CLI、Terraform、または Cloud SQL Admin API を使用して、スイッチオーバー オペレーションを開始します。

コンソール

  1. Google Cloud コンソールで、Cloud SQL の [インスタンス] ページに移動します。

    Cloud SQL の [インスタンス] に移動

  2. インスタンスの [概要] ページを開くには、インスタンス名をクリックします。
  3. [Blue Green Deployment Status] カードで [Details] をクリックして、[Deployment overview] ページを開きます。
  4. [デプロイを切り替える] をクリックします。
  5. [インスタンス設定の違い] ダイアログで、[ソース] インスタンスと [ターゲット] インスタンスの設定の違いを確認し、[続行] をクリックしてスイッチオーバーを開始します。

gcloud

gcloud sql blue-green-deployments switchover コマンドを実行します。

gcloud sql blue-green-deployments switchover DEPLOYMENT_NAME \
  --region=REGION \
  --async

スイッチオーバー オペレーションが完了するまでに数分かかることがあります。オペレーションに予想より時間がかかっていることを示すメッセージが表示される場合があります。このメッセージは無視するか、gcloud sql operations wait コマンドを実行してメッセージを閉じ、オペレーションが完了するまで待機します。

gcloud sql operations wait OPERATION_ID

スイッチオーバー オペレーションのステータスを確認するには、gcloud sql operations describe コマンドを実行します。

gcloud sql operations describe OPERATION_ID

次のように置き換えます。

  • DEPLOYMENT_NAME: Blue/Green デプロイの名前。
  • REGION: デプロイが作成された Google Cloud リージョン。
  • OPERATION_ID: スイッチオーバー オペレーションの ID。

Terraform

Terraform を使用してスイッチオーバーを開始するには、プライマリ google_sql_database_instance リソース構成を更新し、1 回のオペレーションで変更を適用します。

  1. blue_green_deployment コードブロックで、active_environment フィールドを "SOURCE" から "TARGET" に変更します。
  2. ソース インスタンスとは異なる target_database_version フィールドを使用してデプロイを作成した場合は、同じ構成変更で target_database_version フィールドと一致するように、最上位の database_version フィールドを更新します。グリーン インスタンスで他の設定を変更した場合は、Terraform 構成がグリーン インスタンスと一致するように、google_sql_database_instance リソースのそれらのフィールドを同時に更新します。
  3. 省略可: クリーンアップ中に blue_green_deployment コードブロックを削除したときに、以前のブルー インスタンスを自動的に削除するには、blue_green_deployment コードブロックで delete_old_source_on_destroy フィールドを true に設定します。
resource "google_sql_database_instance" "primary" {
  name             = "SOURCE_INSTANCE_ID"
  region           = "REGION"
  database_version = "TARGET_DATABASE_VERSION"

  settings {
    tier              = "MACHINE_TIER"
    edition           = "EDITION"
    availability_type = "REGIONAL"

    backup_configuration {
      enabled            = true
      binary_log_enabled = true
    }
  }

  blue_green_deployment {
    deployment_name              = "DEPLOYMENT_NAME"
    target_database_version      = "TARGET_DATABASE_VERSION"
    active_environment           = "TARGET"
    delete_old_source_on_destroy = true
  }
}

次のように置き換えます。

  • SOURCE_INSTANCE_ID: プライマリ インスタンスの名前。
  • REGION: デプロイが作成された Google Cloud リージョン。
  • TARGET_DATABASE_VERSION: グリーン インスタンスのデータベース バージョン(例: MYSQL_8_4)。
  • MACHINE_TIER: グリーン インスタンスのマシンタイプ(例: db-custom-2-7680)。
  • EDITION: グリーン インスタンスの Cloud SQL エディション(ENTERPRISE または ENTERPRISE_PLUS)。
  • DEPLOYMENT_NAME: Blue/Green デプロイの名前。

Google Cloud プロジェクトで Terraform 構成を適用するには、次のセクションの手順を完了します。

Cloud Shell を準備する

  1. Cloud Shell を起動します。
  2. Terraform 構成を適用するデフォルトの Google Cloud プロジェクトを設定します。

    このコマンドは、プロジェクトごとに 1 回だけ実行する必要があります。これは任意のディレクトリで実行できます。

    export GOOGLE_CLOUD_PROJECT=PROJECT_ID

    Terraform 構成ファイルに明示的な値を設定すると、環境変数がオーバーライドされます。

ディレクトリを準備する

Terraform 構成ファイルには独自のディレクトリ(ルート モジュールとも呼ばれます)が必要です。

  1. Cloud Shell で、ディレクトリを作成し、そのディレクトリ内に新しいファイルを作成します。ファイル名の拡張子は .tf にする必要があります(例: main.tf)。このチュートリアルでは、このファイルを main.tf とします。
    mkdir DIRECTORY && cd DIRECTORY && touch main.tf
  2. チュートリアルを使用している場合は、各セクションまたはステップのサンプルコードをコピーできます。

    新しく作成した main.tf にサンプルコードをコピーします。

    必要に応じて、GitHub からコードをコピーします。Terraform スニペットがエンドツーエンドのソリューションの一部である場合は、この方法をおすすめします。

  3. 環境に適用するサンプル パラメータを確認し、変更します。
  4. 変更を保存します。
  5. Terraform を初期化します。これは、ディレクトリごとに 1 回だけ行います。
    terraform init

    最新バージョンの Google プロバイダを使用する場合は、-upgrade オプションを使用します。

    terraform init -upgrade

変更を適用する

  1. 構成を確認して、Terraform が作成または更新するリソースが想定どおりであることを確認します。
    terraform plan

    必要に応じて構成を修正します。

  2. 次のコマンドを実行します。プロンプトで「yes」と入力して、Terraform 構成を適用します。
    terraform apply

    Terraform に「Apply complete!」というメッセージが表示されるまで待ちます。

  3. Google Cloud プロジェクトを開いて結果を表示します。 Google Cloud コンソールの UI でリソースに移動して、Terraform によって作成または更新されたことを確認します。

REST v1

blueGreenDeployments.switchover メソッドに POST リクエストを送信します。

POST https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/
  locations/REGION/
  blueGreenDeployments/DEPLOYMENT_NAME:switchover

次のように置き換えます。

  • PROJECT_ID: 実際の Google Cloud プロジェクト ID。
  • REGION: デプロイが作成された Google Cloud リージョン。
  • DEPLOYMENT_NAME: Blue/Green デプロイの名前。

REST v1beta4

blueGreenDeployments.switchover メソッドに POST リクエストを送信します。

POST https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/
  locations/REGION/
  blueGreenDeployments/DEPLOYMENT_NAME:switchover

次のように置き換えます。

  • PROJECT_ID: 実際の Google Cloud プロジェクト ID。
  • REGION: デプロイが作成された Google Cloud リージョン。
  • DEPLOYMENT_NAME: Blue/Green デプロイの名前。

切り替え後のモニタリング

スイッチオーバーが完了すると、次のようになります。

  1. アプリケーションが正常に再接続され、本番環境データベースのオペレーションが再開されることを確認します。
  2. 新しい本番環境インスタンスで、クエリのスループット、エラーログ、レプリケーション ステータスをモニタリングします。
  3. アップグレード後の最初の検証期間中は、青色のスタンドアロン インスタンスをそのままにしておきます。安定性を確認したら、デプロイを削除します。詳細については、Blue/Green デプロイを削除するをご覧ください。

次のステップ