Terraform Pub/Sub 教學課程

本教學課程示範如何將函式原始碼 ZIP 檔案上傳至 Cloud Storage 值區，並使用 Terraform 佈建資源，藉此部署 Pub/Sub 函式。Terraform 是一項開放原始碼工具，可讓您透過宣告式設定檔佈建資源 Google Cloud

本教學課程以 Node.js 函式為例，但 Python、Go 和 Java 函式也適用。無論使用哪種執行階段，操作說明都相同。如要瞭解如何搭配 Cloud Functions v2 API 使用 Terraform，請參閱 Hashicorp 的參考頁面。

正在設定環境

在本教學課程中，您將使用 Cloud Shell 執行指令。Cloud Shell 是已安裝 Google Cloud CLI 的殼層環境，並已針對您目前的專案設定好適用值。Cloud Shell 可能需要幾分鐘的時間才能初始化：

開啟 Cloud Shell

準備應用程式

在 Cloud Shell 中執行下列步驟：

  1. 將範例應用程式存放區複製到 Cloud Shell 執行個體：

    git clone https://github.com/terraform-google-modules/terraform-docs-samples.git

  2. 變更為包含 Cloud Run 函式程式碼範例的目錄：

    cd terraform-docs-samples/functions/pubsub

    本教學課程使用的 Node.js 範例是基本的「Hello World」Pub/Sub 函式。以下是 main.tf 檔案：

    terraform {
  required_providers {
    google = {
      source  = "hashicorp/google"
      version = ">= 4.34.0"
    }
  }
}

resource "random_id" "bucket_prefix" {
  byte_length = 8
}


resource "google_service_account" "default" {
  account_id   = "test-gcf-sa"
  display_name = "Test Service Account"
}

resource "google_pubsub_topic" "default" {
  name = "functions2-topic"
}

resource "google_storage_bucket" "default" {
  name                        = "${random_id.bucket_prefix.hex}-gcf-source" # Every bucket name must be globally unique
  location                    = "US"
  uniform_bucket_level_access = true
}

data "archive_file" "default" {
  type        = "zip"
  output_path = "/tmp/function-source.zip"
  source_dir  = "function-source/"
}

resource "google_storage_bucket_object" "default" {
  name   = "function-source.zip"
  bucket = google_storage_bucket.default.name
  source = data.archive_file.default.output_path # Path to the zipped function source code
}

resource "google_cloudfunctions2_function" "default" {
  name        = "function"
  location    = "us-central1"
  description = "a new function"

  build_config {
    runtime     = "nodejs22"
    entry_point = "helloPubSub" # Set the entry point
    environment_variables = {
      BUILD_CONFIG_TEST = "build_test"
    }
    source {
      storage_source {
        bucket = google_storage_bucket.default.name
        object = google_storage_bucket_object.default.name
      }
    }
  }

  service_config {
    max_instance_count = 3
    min_instance_count = 1
    available_memory   = "256M"
    timeout_seconds    = 60
    environment_variables = {
      SERVICE_CONFIG_TEST = "config_test"
    }
    ingress_settings               = "ALLOW_INTERNAL_ONLY"
    all_traffic_on_latest_revision = true
    service_account_email          = google_service_account.default.email
  }

  event_trigger {
    trigger_region = "us-central1"
    event_type     = "google.cloud.pubsub.topic.v1.messagePublished"
    pubsub_topic   = google_pubsub_topic.default.id
    retry_policy   = "RETRY_POLICY_RETRY"
  }
}

初始化 Terraform

在含有 main.tf 檔案的 terraform-docs-samples/functions/pubsub 目錄中，執行下列指令來新增必要的外掛程式，並建構 .terraform 目錄：

terraform init

驗證 Terraform 設定

預覽 Terraform 設定。這個步驟並非必要，但可讓您確認 main.tf 的語法是否正確。這個指令會顯示即將建立的資源預覽畫面：

terraform plan

套用 Terraform 設定

套用設定來部署函式。系統顯示提示訊息時，請輸入 yes：

terraform apply

觸發函式

如要測試 Pub/Sub 函式，請按照下列步驟操作：

  1. 將訊息發布到主題 (在本範例中，主題名稱為 functions2-topic)：

    gcloud pubsub topics publish TOPIC_NAME --message="Friend"

  2. 讀取函式記錄檔，查看結果，其中 FUNCTION_NAME 是函式的名稱 (在本範例中，函式名稱為 function)：

    gcloud functions logs read FUNCTION_NAME

    您應該會看到記錄輸出內容，其中包含新的「Friend」訊息。

清除所用資源

完成本教學課程後，您可以刪除所有建立的項目，以免產生任何額外費用。

您可以使用 Terraform 執行 terraform destroy 指令，移除設定檔中定義的所有資源：

terraform destroy

輸入 yes，允許 Terraform 刪除資源。