デプロイメントの更新

このページでは、Infrastructure Manager を使用してデプロイメントを更新する方法について説明します。Deployment を更新する必要があるケースには、次のものがあります。

  • インフラストラクチャを選択した状態に戻す。

    デプロイを作成した後、しばらくするとリソースが変更される場合があります。たとえば、一部のリソースがコンソールで作業しているユーザーによって変更されている可能性があります。元の Terraform 構成を使用してデプロイメントを更新し、選択した状態に戻すことができます。

  • インフラストラクチャの変更を実装する。

    デプロイを作成した後、インフラストラクチャを変更する場合があります。たとえば、新しいリソースの追加や一部の構成の変更などです。新しいインフラストラクチャを記述する Terraform 構成を使用して、デプロイを更新できます。

このページは、Terraform に精通していることを前提としています。詳細については、Terraform と Infra Manager をご覧ください。

始める前に

  1. Infra Manager が有効になっていることを確認します。
  2. デプロイメントの作成に必要な IAM 権限があることを確認します。roles/config.admin
  3. 必要な権限を持つサービス アカウントがあることを確認します。詳細については、サービス アカウントを構成するをご覧ください。
  4. 更新する Infra Manager デプロイメントを特定します。

  5. 更新用にデプロイする Terraform 構成を特定します。リビジョンには任意の構成を使用できます。多くの場合、この構成は、すでにデプロイされている構成の同一バージョンまたは更新バージョンです。

    この Terraform 構成が、構成に機密データが含まれていないことなど、制約に準拠していることを確認します。

  6. 目的のインフラストラクチャに関連付けられているプロダクトの組織の割り当てを確認します。対象のインフラストラクチャが、デプロイで使用するプロダクトに対する組織の割り当てを超えている場合、デプロイ エラーが発生する可能性があります。詳細については、割り当てと上限をご覧ください。

  7. 変更するリソースのデータ移行またはサービスの継続性を確保するために必要な手順を実施します。

  8. リソースを構成する前に更新をプレビューする場合は、デプロイの更新をプレビューするをご覧ください。

構成に固有の権限を付与する

Google Cloud Terraform 構成で指定されたリソースをデプロイするには、Infra Manager の呼び出しに使用するサービス アカウントに、次のものに固有の権限が必要です。

  • リビジョンに使用している構成で定義されたGoogle Cloud リソース。

  • リビジョンに使用している構成で、デプロイに使用されている構成とは異なるリソースが定義されている場合は、両方の構成で定義されているリソースに対する権限が必要です。

構成で定義されたリソースに固有の権限は、サービス アカウントが Infra Manager サービスを使用するために必要な権限に加えて付与されます。

Google Cloud リソースの権限を付与し、必要なプロジェクトにアクセスできるようにする方法については、サービス アカウントを構成するをご覧ください。

非公開の Git リポジトリとホストを Cloud Build に接続する

プライベート Git リポジトリから Terraform 構成をデプロイする場合は、Git ホストとリポジトリを Cloud Build に接続する必要があります。

デプロイメントの更新

デプロイメントを更新するには、同じデプロイ名を使用して構成をデプロイします。これにより、リビジョンが作成されます。詳細については、デプロイとリビジョンの概要をご覧ください。

既存のデプロイがない場合は、Infra Manager を使用してインフラストラクチャをデプロイするをご覧ください。

リソースをプロビジョニングせずに更新をプレビューするには、デプロイをプレビューするをご覧ください。

デプロイを更新する方法の詳細については、選択したワークフローのタブを選択してください。

Consolegcloud CLIgcloud CLIgcloud CLI

このセクションでは、Google Cloud コンソールの Infra Manager を使用して Terraform 構成を更新する方法について説明します。

構成をデプロイしてリビジョンを作成します。

  1. Google Cloud コンソールで、[Infra Manager] ページに移動します。

    Infrastructure Manager に移動

  2. [Deployments] ページの [ID] 列で、更新するデプロイメントをクリックします。
  3. デプロイ ID がタイトルに表示されているページで、[編集] をクリックします。
  4. [デプロイの詳細] ページで、[Terraform バージョン]、[サービス アカウント]、 [Terraform 構成のソース] フィールドを変更できます。プライベート Git リポジトリを指定する場合は、ホストとリポジトリを Cloud Build に接続していることを確認します。

    [続行] をクリックします。

  5. [Terraform の詳細] ページで、Terraform 構成の入力値を変更できます。[続行] をクリックします。
  6. [詳細] ページで、[ラベルとアノテーション]、[ワーカープール]、[アーティファクトの Cloud Storage バケット] フィールドを変更できます。
  7. デプロイメントに加えた変更に問題がなければ、[更新] をクリックして更新プロセスを開始します。

デプロイ パラメータとその形式の詳細については、リソースのデプロイのドキュメントをご覧ください。

このセクションでは、Cloud Storage バケットに保存されている Terraform 構成のデプロイについて説明します。ストレージ バケットを使用すると、構成へのアクセスを制御できます。

  1. Terraform 構成が Cloud Storage バケットにあることを確認します。詳細については、構成をストレージ バケットにアップロードするをご覧ください。

  2. ストレージ バケットが Infra Manager を実行しているプロジェクトとは異なるプロジェクトにある場合は、Infra Manager のサービス アカウントにバケットに対する読み取り権限があることを確認する必要があります。詳細については、サービス アカウントを構成するをご覧ください。

    ストレージ バケットが Infra Manager と同じプロジェクトにある場合、バケットへの読み取り権限はすでに有効になっています。

  3. 構成をデプロイしてリビジョンを作成します。

    gcloud infra-manager deployments apply projects/PROJECT_ID/locations/LOCATION/deployments/DEPLOYMENT_ID \
        --service-account projects/SERVICE_ACCOUNT_PROJECT_ID/serviceAccounts/SERVICE_ACCOUNT \
        --gcs-source gs://BUCKET_NAME/OBJECT_NAME \
        --quota-validation=QUOTA_VALIDATION \
        --input-values=INPUT_1_NAME=VALUE,INPUT_2_NAME=VALUE \
        --tf-version-constraint=TERRAFORM_VERSION \
        --annotation="ANNOTATION_KEY=ANNOTATION_VALUE"
次のように置き換えます。
  • PROJECT_ID: Infra Manager が実行されるプロジェクト ID。
  • LOCATION: Infra Manager が実行されるロケーション。有効なロケーションの一覧については、Infra Manager のロケーションをご覧ください。
  • DEPLOYMENT_ID: 指定したデプロイ ID。デプロイ ID の制約について詳しくは、デプロイ名をご覧ください。
  • SERVICE_ACCOUNT_PROJECT_ID は、サービス アカウントのプロジェクト ID です。通常、これは Infra Manager が実行されているプロジェクトと同じです。
  • SERVICE_ACCOUNT: Infra Manager の呼び出しに使用するサービス アカウントの名前。
  • BUCKET_NAME: 構成が保存されているストレージ バケットの名前。
  • OBJECT_NAME: 構成ファイルのオブジェクト名。このオブジェクトはディレクトリまたは ZIP ファイルにできますが、Terraform ファイルにはできません。オブジェクトのバージョニングを使用している場合は、オブジェクトの世代番号を指定することもできます。詳細については、バージョニングされたオブジェクトを使用するをご覧ください。

    ストレージ バケットが Terraform 構成のルートパスである場合、OBJECT_NAME は省略可能です。

  • 省略可: QUOTA_VALIDATION: デプロイの作成時に、Terraform 構成ファイル内のリソースの割り当て検証が有効か適用されるかを決定する値。有効な値は次のとおりです。
    • ENABLED: Terraform 構成ファイルのリソースに対して計算割り当て検証を有効にします。割り当てが不十分なリソースを可視化します。
    • ENFORCED: 割り当て検証を適用して、Terraform 構成ファイルで定義されたインフラストラクチャに使用できる十分な割り当てがない場合にデプロイが失敗するようにします。

    QUOTA_VALIDATION が定義されていない場合、Terraform 構成ファイルの割り当て検証は無効になります。これはデフォルト値です。割り当て検証は、制限付きリソースに適用されます。 Google Cloud 詳細については、割り当てと上限をご覧ください。

  • INPUT_1_NAME と INPUT_2_NAME: Terraform 構成の入力値（デフォルトで定義されていない値を含む）。たとえば、リソースをデプロイするプロジェクトを project_id=my-project として指定できます。

    すべての入力値が構成でデフォルトで定義されている場合、このフラグは省略可能です。

  • 省略可:TERRAFORM_VERSION: Infra Manager がデプロイメントの作成に使用する Terraform のバージョン。サポートされているバージョンの一覧については、サポートされている Terraform バージョンをご覧ください。このオプションのフラグを削除すると、サポートされている最新バージョンの Terraform が使用されます。
  • 省略可: ANNOTATION_KEY と ANNOTATION_VALUE は、Infra Manager デプロイメントに関連付けることができる自由形式のテキストの Key-Value ペアを表します。アノテーションとラベルの使用と制約について詳しくは、アノテーションとラベルをご覧ください。

このセクションでは、Git リポジトリに保存されている Terraform 構成を操作する方法について説明します。

  1. Git がインストールされていることを確認します。
  2. Terraform 構成が非公開の Git リポジトリに保存されている場合は、Git ホストとリポジトリが Cloud Build に接続されていることを確認します。

  3. 構成をデプロイしてリビジョンを作成します。

    gcloud infra-manager deployments apply projects/PROJECT_ID/locations/LOCATION/deployments/DEPLOYMENT_ID \
        --service-account projects/SERVICE_ACCOUNT_PROJECT_ID/serviceAccounts/SERVICE_ACCOUNT \
        --git-source-repo="GIT_REPO" \
        --git-source-directory="DIRECTORY" \
        --git-source-ref="REF" \
        --quota-validation=QUOTA_VALIDATION \
        --input-values=INPUT_1_NAME=VALUE,INPUT_2_NAME=VALUE \
        --tf-version-constraint=TERRAFORM_VERSION \
        --annotation="ANNOTATION_KEY=ANNOTATION_VALUE"
次のように置き換えます。
  • PROJECT_ID: Infra Manager が実行されるプロジェクト ID。
  • LOCATION: Infra Manager が実行されるロケーション。有効なロケーションの一覧については、Infra Manager のロケーションをご覧ください。
  • DEPLOYMENT_ID: 指定したデプロイ ID。デプロイ ID の制約について詳しくは、デプロイ名をご覧ください。
  • SERVICE_ACCOUNT_PROJECT_ID は、サービス アカウントのプロジェクト ID です。通常、これは Infra Manager が実行されているプロジェクトと同じです。
  • SERVICE_ACCOUNT: Infra Manager の呼び出しに使用するサービス アカウントの名前。
  • GIT_REPO: Git リポジトリ。
  • DIRECTORY: Terraform 構成があるディレクトリ。
  • 省略可: REF: 構成の Git 参照。参照は省略可能です。参照を指定しない場合、Git リポジトリのデフォルトで構成されたブランチが使用されます。
  • 省略可: QUOTA_VALIDATION: デプロイの作成時に、Terraform 構成ファイル内のリソースの割り当て検証が有効か適用されるかを決定する値。有効な値は次のとおりです。
    • ENABLED: Terraform 構成ファイルのリソースに対して計算割り当て検証を有効にします。割り当てが不十分なリソースを可視化します。
    • ENFORCED: 割り当て検証を適用して、Terraform 構成ファイルで定義されたインフラストラクチャに使用できる十分な割り当てがない場合にデプロイが失敗するようにします。

    QUOTA_VALIDATION が定義されていない場合、Terraform 構成ファイルの割り当て検証は無効になります。これはデフォルト値です。割り当て検証は、制限付きリソースに適用されます。 Google Cloud 詳細については、割り当てと上限をご覧ください。

  • INPUT_1_NAME と INPUT_2_NAME: Terraform 構成の入力値（デフォルトで定義されていない値を含む）。たとえば、リソースをデプロイするプロジェクトを project_id=my-project として指定できます。

    すべての入力値が構成でデフォルトで定義されている場合、このフラグは省略可能です。

  • 省略可:TERRAFORM_VERSION: Infra Manager がデプロイメントの作成に使用する Terraform のバージョン。サポートされているバージョンの一覧については、サポートされている Terraform バージョンをご覧ください。このオプションのフラグを削除すると、サポートされている最新バージョンの Terraform が使用されます。
  • 省略可: ANNOTATION_KEY と ANNOTATION_VALUE は、Infra Manager デプロイメントに関連付けることができる自由形式のテキストの Key-Value ペアを表します。アノテーションとラベルの使用と制約について詳しくは、アノテーションとラベルをご覧ください。

このセクションでは、ローカルマシンに保存されている Terraform 構成を操作する方法について説明します。

  1. Cloud Shell を使用している場合は、構成を Cloud Shell にアップロードする必要があります。詳細については、Cloud Shell を使用してファイルを管理するをご覧ください。

  2. 構成をデプロイしてリビジョンを作成します。

    gcloud infra-manager deployments apply projects/PROJECT_ID/locations/LOCATION/deployments/DEPLOYMENT_ID \
        --service-account projects/SERVICE_ACCOUNT_PROJECT_ID/serviceAccounts/SERVICE_ACCOUNT \
        --local-source="LOCAL_DIRECTORY" \
        --quota-validation=QUOTA_VALIDATION \
        --input-values=INPUT_1_NAME=VALUE,INPUT_2_NAME=VALUE \
        --tf-version-constraint=TERRAFORM_VERSION \
        --annotation="ANNOTATION_KEY=ANNOTATION_VALUE"
次のように置き換えます。
  • PROJECT_ID: Infra Manager が実行されるプロジェクト ID。
  • LOCATION: Infra Manager が実行されるロケーション。有効なロケーションの一覧については、Infra Manager のロケーションをご覧ください。
  • DEPLOYMENT_ID: 指定したデプロイ ID。デプロイ ID の制約について詳しくは、デプロイ名をご覧ください。
  • SERVICE_ACCOUNT_PROJECT_ID は、サービス アカウントのプロジェクト ID です。通常、これは Infra Manager が実行されているプロジェクトと同じです。
  • SERVICE_ACCOUNT: Infra Manager の呼び出しに使用するサービス アカウントの名前。
  • LOCAL_DIRECTORY: Terraform 構成を保存するローカル ディレクトリ。Cloud Shell を使用している場合、これは構成が保存される Cloud Shell のディレクトリです。
  • 省略可: QUOTA_VALIDATION: デプロイの作成時に、Terraform 構成ファイル内のリソースの割り当て検証が有効か適用されるかを決定する値。有効な値は次のとおりです。
    • ENABLED: Terraform 構成ファイルのリソースに対して計算割り当て検証を有効にします。割り当てが不十分なリソースを可視化します。
    • ENFORCED: 割り当て検証を適用して、Terraform 構成ファイルで定義されたインフラストラクチャに使用できる十分な割り当てがない場合にデプロイが失敗するようにします。

    QUOTA_VALIDATION が定義されていない場合、Terraform 構成ファイルの割り当て検証は無効になります。これはデフォルト値です。割り当て検証は、制限付きリソースに適用されます。 Google Cloud 詳細については、割り当てと上限をご覧ください。

  • INPUT_1_NAME と INPUT_2_NAME: Terraform 構成の入力値（デフォルトで定義されていない値を含む）。たとえば、リソースをデプロイするプロジェクトを project_id=my-project として指定できます。

    すべての入力値が構成でデフォルトで定義されている場合、このフラグは省略可能です。

  • 省略可:TERRAFORM_VERSION: Infra Manager がデプロイメントの作成に使用する Terraform のバージョン。サポートされているバージョンの一覧については、サポートされている Terraform バージョンをご覧ください。このオプションのフラグを削除すると、サポートされている最新バージョンの Terraform が使用されます。
  • 省略可: ANNOTATION_KEY と ANNOTATION_VALUE は、Infra Manager デプロイメントに関連付けることができる自由形式のテキストの Key-Value ペアを表します。アノテーションとラベルの使用と制約について詳しくは、アノテーションとラベルをご覧ください。

次のステップ