Go 1.16 が一般提供になりました。

共有 VPC ホスト プロジェクトでコネクタを構成する

組織で共有 VPC を使用している場合は、サーバーレス VPC アクセス コネクタをサービス プロジェクトかホスト プロジェクトのいずれかで設定できます。このガイドでは、ホスト プロジェクトでコネクタを設定する方法について説明します。

サービス プロジェクトでコネクタを設定する必要がある場合は、サービス プロジェクトでコネクタを構成するをご覧ください。各方法の利点については、共有 VPC ネットワークへの接続をご覧ください。

始める前に

  1. 現在使用しているアカウントの Identity and Access Management(IAM)ロールを確認します。アクティブ アカウントには、ホスト プロジェクトで次のロールが必要です。

  2. 目的の環境でホスト プロジェクトを選択します。

Console

  1. Cloud Console のダッシュボードに移動します。

    Cloud Console のダッシュボードに移動

  2. ダッシュボードの上部にあるメニューバーで、プロジェクトのプルダウン メニューをクリックし、ホスト プロジェクトを選択します。

gcloud

ターミナルで次のコマンドを実行して、gcloud CLI のデフォルト プロジェクトをホスト プロジェクトに設定します。

gcloud config set project HOST_PROJECT_ID

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

  • HOST_PROJECT_ID: 共有 VPC ホスト プロジェクトの ID。

サーバーレス VPC アクセス コネクタを作成する

VPC ネットワークにリクエストを送信して対応するレスポンスを受信するには、サーバーレス VPC アクセス コネクタを作成する必要があります。コネクタは、Google Cloud Console、Google Cloud CLI、または Terraform を使用して作成できます。

Console

  1. プロジェクトでサーバーレス VPC アクセスの API を有効にします。

    API を有効にする

  2. サーバーレス VPC アクセスの概要ページに移動します。

    サーバーレス VPC アクセスに移動

  3. [コネクタを作成] をクリックします。

  4. [名前] フィールドに、コネクタの名前を入力します。名前は Compute Engine の命名規則に従い、21 文字未満にする必要があります。ハイフン(-)は 2 文字としてカウントされます。

  5. [リージョン] フィールドで、コネクタのリージョンを選択します。これは、サーバーレス サービスのリージョンと一致する必要があります。

    サービスが us-central または europe-west リージョンにある場合は、us-central1 または europe-west1 を使用します。

  6. [ネットワーク] フィールドで、コネクタを接続する VPC ネットワークを選択します。

  7. [サブネットワーク] プルダウン メニューをクリックします。

    /28 の未使用のサブネットを選択します。

    • サブネットはコネクタ専用にする必要があります。VM、Private Service Connect、内部 HTTP(S) ロード バランシングなどの他のリソースでは使用できません。
    • サブネットが Private Service Connect や内部 HTTP(S) ロード バランシングに使用されていないことを確認するには、gcloud CLI で次のコマンドを実行して、サブネット purposePRIVATE であることを確認します。
      gcloud compute networks subnets describe SUBNET_NAME
      
      SUBNET_NAME は、使用するサブネットの名前に置き換えます。
  8. (省略可)コネクタを詳細に制御するためのスケーリング オプションを設定するには、[スケーリング設定を表示] をクリックしてスケーリング フォームを表示します。

    1. コネクタのインスタンスの最小数と最大数を設定するか、デフォルト値(最小 2、最大 10)を使用します。コネクタは、トラフィックが増加すると、指定された最大値までスケールアウトしますが、トラフィックが減少してもスケールインしません。210 の値を使用し、MINMAX よりも小さい値にする必要があります。
    2. [インスタンスのタイプ] プルダウン メニューで、コネクタに使用するマシンタイプを選択するか、デフォルトの e2-micro を使用します。インスタンス タイプを選択すると、右側にコスト サイドバーが表示され、帯域幅とコストの見積もりが表示されます。
  9. [作成] をクリックします。

  10. コネクタの使用準備が整うと、コネクタ名の横に緑色のチェックマークが表示されます。

gcloud

  1. gcloud コンポーネントを最新バージョンに更新します。

    gcloud components update
    
  2. プロジェクトでサーバーレス VPC アクセス API を有効にします。

    gcloud services enable vpcaccess.googleapis.com
    
  3. サーバーレス VPC アクセス コネクタを作成します。

    gcloud compute networks vpc-access connectors create CONNECTOR_NAME \
    --region=REGION \
    --subnet=SUBNET \
    --subnet-project=HOST_PROJECT_ID \
    # Optional: specify minimum and maximum instance values between 2 and 10, default is 2 min, 10 max.
    --min-instances=MIN \
    --max-instances=MAX \
    # Optional: specify machine type, default is e2-micro
    --machine-type=MACHINE_TYPE
    

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

    • CONNECTOR_NAME: コネクタの名前。名前は Compute Engine の命名規則に従い、21 文字未満にする必要があります。ハイフン(-)は 2 文字としてカウントされます。
    • REGION: コネクタのリージョン。これは、サーバーレス サービスのリージョンと一致する必要があります。サービスが us-central または europe-west リージョンにある場合は、us-central1 または europe-west1 を使用します。
    • SUBNET: 未使用の /28 サブネットの名前。
      • サブネットはコネクタ専用にする必要があります。VM、Private Service Connect、内部 HTTP(S) ロード バランシングなどの他のリソースでは使用できません。
      • サブネットが Private Service Connect や内部 HTTP(S) ロード バランシングに使用されていないことを確認するには、gcloud CLI で次のコマンドを実行して、サブネット purposePRIVATE であることを確認します。
        gcloud compute networks subnets describe SUBNET_NAME
        
        次のように置き換えます。
        • SUBNET_NAME: サブネットの名前
    • HOST_PROJECT_ID: ホスト プロジェクトの ID
    • MIN: コネクタに使用するインスタンスの最小数。29 の整数を使用してください。デフォルトは 2 です。
    • MAX: コネクタに使用するインスタンスの最大数。310 の整数を使用してください。デフォルトは 10 です。コネクタは、トラフィックが増加すると最大インスタンス数までスケールアウトしますが、スケールインしません。
    • MACHINE_TYPE: f1-microe2-micro、または e2-standard-4

      マシンタイプ 推定スループット範囲(Mbps) 料金
      コネクタ インスタンスとネットワーク下り(外向き)のコスト
      f1-micro 100~500 f1-micro の料金
      e2-micro 200~1,000 e2-micro の料金
      e2-standard-4 3,200~16,000 e2 標準料金

      たとえば、MACHINE_TYPEf1-micro に設定した場合、コネクタの推定スループットは 100 Mbps(デフォルトが MIN の場合)か 500 Mbps(デフォルトが MAX の場合)になります。

    より詳しい情報とオプションの引数については、gcloud のリファレンスをご覧ください。

  4. 使用する前に、コネクタが READY 状態になっていることを確認します。

    gcloud compute networks vpc-access connectors describe CONNECTOR_NAME \
    --region=REGION
    

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

    • CONNECTOR_NAME: コネクタの名前。これは、前のステップで指定した名前です。
    • REGION: コネクタのリージョン。これは、前の手順で指定したリージョンです。

    出力には、state: READY という行が含まれます。

Terraform

Terraform リソースを使用して、vpcaccess.googleapis.com API を有効にできます。

resource "google_project_service" "vpcaccess-api" {
  project = var.project_id # Replace this with your project ID in quotes
  service = "vpcaccess.googleapis.com"
}

Terraform モジュールを使用して VPC ネットワークとサブネットを作成し、コネクタを作成できます。

module "test-vpc-module" {
  source       = "terraform-google-modules/network/google"
  version      = "~> 3.3.0"
  project_id   = var.project_id # Replace this with your project ID in quotes
  network_name = "my-serverless-network"
  mtu          = 1460

  subnets = [
    {
      subnet_name   = "serverless-subnet"
      subnet_ip     = "10.10.10.0/28"
      subnet_region = "us-central1"
    }
  ]
}

module "serverless-connector" {
  source     = "terraform-google-modules/network/google//modules/vpc-serverless-connector-beta"
  project_id = var.project_id
  vpc_connectors = [{
    name        = "central-serverless"
    region      = "us-central1"
    subnet_name = module.test-vpc-module.subnets["us-central1/serverless-subnet"].name
    # host_project_id = var.host_project_id # Specify a host_project_id for shared VPC
    machine_type  = "e2-standard-4"
    min_instances = 2
    max_instances = 7
    }
    # Uncomment to specify an ip_cidr_range
    #   , {
    #     name          = "central-serverless2"
    #     region        = "us-central1"
    #     network       = module.test-vpc-module.network_name
    #     ip_cidr_range = "10.10.11.0/28"
    #     subnet_name   = null
    #     machine_type  = "e2-standard-4"
    #     min_instances = 2
    #   max_instances = 7 }
  ]
  depends_on = [
    google_project_service.vpcaccess-api
  ]
}

コネクタへのアクセス権を設定する

コネクタへのアクセス権は、App Engine サービスをデプロイするプリンシパルに、ホスト プロジェクトのサーバーレス VPC アクセス ユーザーの IAM ロールを付与することで設定します。

Console

  1. [IAM] ページを開きます。

    IAM に移動

  2. プロジェクトのプルダウン メニューをクリックし、ホスト プロジェクトを選択します。

  3. [Add] をクリックします。

  4. [新しいプリンシパル] フィールドに、App Engine サービスをデプロイするプリンシパルを追加します。

  5. [ロール] フィールドで、[サーバーレス VPC アクセス ユーザー] を選択します。

  6. [保存] をクリックします。

gcloud

ターミナルで次のコマンドを実行します。

gcloud projects add-iam-policy-binding HOST_PROJECT_ID \
--member=PRINCIPAL \
--role=roles/vpcaccess.user

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

  • HOST_PROJECT_ID: 共有 VPC ホスト プロジェクトの ID。
  • PRINCIPAL: App Engine サービスをデプロイするプリンシパル。詳細は、--member フラグをご覧ください。

コネクタを検出可能にする

コネクタを表示するには、ホスト プロジェクトとサービス プロジェクトの両方で、プリンシパルに特定の表示ロールが必要です。プリンシパルが Cloud Console またはターミナルで使用可能なコネクタを表示するときにご利用のコネクタが表示されるようにするには、App Engine サービスをデプロイするプリンシパルの IAM ロールを追加します。

ホスト プロジェクトで IAM ロールを付与する

ホスト プロジェクトで、App Engine サービスをデプロイするプリンシパルにサーバーレス VPC アクセス閲覧者(vpcaccess.viewerのロールを付与します。

Console

  1. [IAM] ページを開きます。

    IAM に移動

  2. プロジェクトのプルダウン メニューをクリックし、ホスト プロジェクトを選択します。

  3. [Add] をクリックします。

  4. [新しいプリンシパル] フィールドに、サービス プロジェクトでコネクタを表示する必要があるプリンシパルのメールアドレスを入力します。このフィールドには複数のメールアドレスを入力できます。

  5. [ロール] フィールドで、[サーバーレス VPC アクセス閲覧者] を選択します。

  6. [保存] をクリックします。

gcloud

ターミナルで次のコマンドを実行します。

gcloud projects add-iam-policy-binding HOST_PROJECT_ID \
--member=PRINCIPAL \
--role=roles/vpcaccess.viewer

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

  • HOST_PROJECT_ID: 共有 VPC ホスト プロジェクトの ID。
  • PRINCIPAL: App Engine サービスをデプロイするプリンシパル。詳細は、--member フラグをご覧ください。

サービス プロジェクトで IAM ロールを付与する

サービス プロジェクトで、App Engine サービスをデプロイするプリンシパルに Compute ネットワーク閲覧者(compute.networkViewerロールを付与します。

Console

  1. [IAM] ページを開きます。

    IAM に移動

  2. プロジェクトのプルダウン メニューをクリックし、サービス プロジェクトを選択します。

  3. [Add] をクリックします。

  4. [新しいプリンシパル] フィールドに、サービス プロジェクトでコネクタを表示する必要があるプリンシパルのメールアドレスを入力します。このフィールドには複数のメールアドレスを入力できます。

  5. [ロール] フィールドで、[Compute ネットワーク閲覧者] を選択します。

  6. [保存] をクリックします。

gcloud

ターミナルで次のコマンドを実行します。

gcloud projects add-iam-policy-binding SERVICE_PROJECT_ID \
--member=PRINCIPAL \
--role=roles/compute.networkViewer

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

  • SERVICE_PROJECT_ID: サービス プロジェクトの ID。
  • PRINCIPAL: App Engine サービスをデプロイするプリンシパル。詳細は、--member フラグをご覧ください。

コネクタを使用するサービスを構成する

共有 VPC にアクセスする必要がある App Engine サービスごとに、サービス用のコネクタを指定する必要があります。次の手順では、コネクタを使用するようにサービスを構成する方法について説明します。

  1. vpc_access_connector をサービスの app.yaml ファイルに追加します。

    vpc_access_connector:
    name: projects/HOST_PROJECT_ID/locations/REGION/connectors/CONNECTOR_NAME
    

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

    • HOST_PROJECT_ID: 共有 VPC ホスト プロジェクトの ID。
    • REGION: コネクタのリージョン。
    • CONNECTOR_NAME: コネクタの名前。
  2. サービスをデプロイします。

    gcloud app deploy

デプロイ後、サービスでは共有 VPC ネットワークにリクエストを送信して、対応するレスポンスを受信できます。

次のステップ