เริ่มต้นใช้งาน Terraform และ Firebase

Firebase กำลังเริ่มรองรับ Terraform หากคุณอยู่ในทีมที่ต้องการทำให้โครงการ Firebase เป็นแบบอัตโนมัติและมีมาตรฐานในการสร้างโครงการ Firebase ด้วยทรัพยากรที่มีการจัดสรรและเปิดใช้บริการที่เฉพาะเจาะจง การใช้ Terraform กับ Firebase อาจเหมาะกับคุณ

เวิร์กโฟลว์พื้นฐานสำหรับการใช้ Terraform กับ Firebase มีดังนี้

  • การสร้างและปรับแต่งไฟล์การกําหนดค่า Terraform (ไฟล์ .tf) ซึ่งระบุโครงสร้างพื้นฐานที่ต้องการจัดสรร (นั่นคือ ทรัพยากรที่ต้องการจัดสรรและบริการที่ต้องการเปิดใช้)

  • ใช้คำสั่ง gcloud CLI ที่อินเทอร์เฟซกับ Terraform เพื่อจัดสรรโครงสร้างพื้นฐานที่ระบุไว้ในไฟล์ .tf

คุณใช้ Terraform และ Firebase ทำอะไรได้บ้าง

เวิร์กโฟลว์ทั่วไปตัวอย่างในคู่มือนี้คือการสร้างโปรเจ็กต์ Firebase ใหม่ด้วยแอป Android แต่คุณทําสิ่งอื่นๆ ได้อีกมากมายด้วย Terraform เช่น

  • ลบและแก้ไขโครงสร้างพื้นฐานที่มีอยู่โดยใช้ Terraform

  • จัดการการกําหนดค่าและงานเฉพาะผลิตภัณฑ์โดยใช้ Terraform เช่น

    • กำลังเปิดใช้ผู้ให้บริการการลงชื่อเข้าใช้ Firebase Authentication ราย
    • การสร้างที่เก็บข้อมูล Cloud Storage หรืออินสแตนซ์ฐานข้อมูล และทำให้ Firebase Security Rules พร้อมใช้งาน

คุณสามารถใช้ไฟล์กำหนดค่าและคำสั่ง Terraform มาตรฐานเพื่อทำงานทั้งหมดนี้ และเพื่อเป็นการช่วยเหลือคุณในเรื่องนี้ เราจึงมีตัวอย่างไฟล์การกำหนดค่า Terraform สำหรับกรณีการใช้งานทั่วไปหลายรายการ



เวิร์กโฟลว์ทั่วไปสำหรับการใช้ Terraform กับ Firebase

ข้อกำหนดเบื้องต้น

คู่มือนี้เป็นข้อมูลเบื้องต้นเกี่ยวกับการใช้ Terraform กับ Firebase ดังนั้นจึงถือว่าผู้ใช้มีความเชี่ยวชาญพื้นฐานเกี่ยวกับ Terraform โปรดตรวจสอบว่าคุณได้ดำเนินการตามข้อกําหนดเบื้องต้นต่อไปนี้แล้วก่อนเริ่มเวิร์กโฟลว์นี้

  • ติดตั้ง Terraform และทำความคุ้นเคยกับ Terraform โดยใช้บทแนะนำอย่างเป็นทางการ

  • ติดตั้ง Google Cloud CLI (gcloud CLI) เข้าสู่ระบบโดยใช้บัญชีผู้ใช้หรือบัญชีบริการ


ขั้นตอนที่ 1: สร้างและปรับแต่งไฟล์การกำหนดค่า Terraform

ไฟล์การกําหนดค่า Terraform ต้องมี 2 ส่วนหลัก (ซึ่งอธิบายไว้อย่างละเอียดด้านล่าง)

ตั้งค่า provider

คุณต้องตั้งค่า provider ไม่ว่าผลิตภัณฑ์หรือบริการ Firebase ใดจะเกี่ยวข้อง

  1. สร้างไฟล์การกําหนดค่า Terraform (เช่น ไฟล์ main.tf) ในไดเรกทอรีในเครื่อง

    ในคู่มือนี้ คุณจะใช้ไฟล์การกำหนดค่านี้เพื่อระบุทั้งการตั้งค่า provider และโครงสร้างพื้นฐานทั้งหมดที่ต้องการให้ Terraform สร้าง อย่างไรก็ตาม โปรดทราบว่าคุณมีตัวเลือกในการรวมการตั้งค่าผู้ให้บริการ

  2. ใส่การตั้งค่า provider ต่อไปนี้ที่ด้านบนของไฟล์ main.tf

    คุณต้องใช้ผู้ให้บริการ google-beta เนื่องจากเป็นรุ่นเบต้าของการใช้ Firebase กับ Terraform โปรดใช้ความระมัดระวังเมื่อใช้ในเวอร์ชันที่ใช้งานจริง

    # Terraform configuration to set up providers by version.
    terraform {
      required_providers {
        google-beta = {
          source  = "hashicorp/google-beta"
          version = "~> 5.0"
        }
      }
    }
    
    # Configures the provider to use the resource block's specified project for quota checks.
    provider "google-beta" {
      user_project_override = true
    }
    
    # Configures the provider to not use the resource block's specified project for quota checks.
    # This provider should only be used during project creation and initializing services.
    provider "google-beta" {
      alias = "no_user_project_override"
      user_project_override = false
    }

    ดูข้อมูลเพิ่มเติมเกี่ยวกับแอตทริบิวต์ประเภทต่างๆ ที่เกี่ยวข้องกับโปรเจ็กต์ (รวมถึงสิ่งที่คู่มือนี้เรียกว่า "โปรเจ็กต์ตรวจสอบโควต้า") เมื่อใช้ Terraform กับ Firebase

  3. ไปที่ส่วนถัดไปเพื่อกรอกข้อมูลในไฟล์การกําหนดค่าให้เสร็จสมบูรณ์และระบุโครงสร้างพื้นฐานที่จะสร้าง

ระบุโครงสร้างพื้นฐานที่จะสร้างโดยใช้บล็อก resource

ในไฟล์การกำหนดค่า terform ของคุณ (สำหรับคู่มือนี้คือไฟล์ main.tf) คุณต้องระบุโครงสร้างพื้นฐานทั้งหมดที่ต้องการให้ Terraform สร้าง (หมายถึงทรัพยากรทั้งหมดที่คุณต้องการจัดสรรและบริการทั้งหมดที่คุณต้องการเปิดใช้) ดูรายการทรัพยากร Firebase ที่รองรับ Terraform ทั้งหมดได้ในคู่มือนี้

  1. เปิดไฟล์ main.tf

  2. ในการตั้งค่า provider ให้ใส่การกําหนดค่า resource ต่อไปนี้ บล็อก

    ตัวอย่างพื้นฐานนี้จะสร้างโปรเจ็กต์ Firebase ใหม่ จากนั้นสร้างแอป Firebase Android ภายในโปรเจ็กต์นั้น

    # Terraform configuration to set up providers by version.
    ...
    
    # Configures the provider to use the resource block's specified project for quota checks.
    ...
    
    # Configures the provider to not use the resource block's specified project for quota checks.
    ...
    
    # Creates a new Google Cloud project.
    resource "google_project" "default" {
      provider   = google-beta.no_user_project_override
    
      name       = "Project Display Name"
      project_id = "project-id-for-new-project"
      # Required for any service that requires the Blaze pricing plan
      # (like Firebase Authentication with GCIP)
      billing_account = "000000-000000-000000"
    
      # Required for the project to display in any list of Firebase projects.
      labels = {
        "firebase" = "enabled"
      }
    }
    
    # Enables required APIs.
    resource "google_project_service" "default" {
      provider = google-beta.no_user_project_override
      project  = google_project.default.project_id
      for_each = toset([
        "cloudbilling.googleapis.com",
        "cloudresourcemanager.googleapis.com",
        "firebase.googleapis.com",
        # Enabling the ServiceUsage API allows the new project to be quota checked from now on.
        "serviceusage.googleapis.com",
      ])
      service = each.key
    
      # Don't disable the service if the resource block is removed by accident.
      disable_on_destroy = false
    }
    
    # Enables Firebase services for the new project created above.
    resource "google_firebase_project" "default" {
      provider = google-beta
      project  = google_project.default.project_id
    
      # Waits for the required APIs to be enabled.
      depends_on = [
        google_project_service.default
      ]
    }
    
    # Creates a Firebase Android App in the new project created above.
    resource "google_firebase_android_app" "default" {
      provider = google-beta
    
      project      = google_project.default.project_id
      display_name = "My Awesome Android app"
      package_name = "awesome.package.name"
    
      # Wait for Firebase to be enabled in the Google Cloud project before creating this App.
      depends_on = [
        google_firebase_project.default,
      ]
    }


ขั้นตอนที่ 2: เรียกใช้คำสั่ง Terraform เพื่อสร้างโครงสร้างพื้นฐานที่ระบุ

หากต้องการจัดสรรทรัพยากรและเปิดใช้บริการที่ระบุในไฟล์ main.tf ให้เรียกใช้คำสั่งต่อไปนี้จากไดเรกทอรีเดียวกับไฟล์ main.tf ดูรายละเอียดเกี่ยวกับคําสั่งเหล่านี้ได้ที่เอกสารประกอบของ Terraform

  1. หากคุณเรียกใช้คำสั่ง Terraform ในไดเรกทอรีเป็นครั้งแรก คุณจะต้องเริ่มต้นไดเรกทอรีการกำหนดค่าและติดตั้งผู้ให้บริการ Google Terraform ด้วย ซึ่งทำได้โดยการเรียกใช้คำสั่งต่อไปนี้

    terraform init
  2. สร้างโครงสร้างพื้นฐานที่ระบุไว้ในไฟล์ main.tf โดยเรียกใช้คำสั่งต่อไปนี้

    terraform apply
  3. ตรวจสอบว่าทุกอย่างได้รับการจัดสรรหรือเปิดใช้ตามที่คาดไว้

    • ตัวเลือกที่ 1: ดูการกําหนดค่าที่พิมพ์ในเทอร์มินัลโดยเรียกใช้คําสั่งต่อไปนี้

      terraform show
    • ตัวเลือกที่ 2: ดูโปรเจ็กต์ Firebase ในคอนโซล Firebase



ทรัพยากร Firebase ที่รองรับ Terraform

ทรัพยากร Firebase และ Google ต่อไปนี้รองรับ Terraform และเราก็เพิ่มทรัพยากร อยู่ตลอดเวลา ดังนั้น หากคุณไม่เห็นทรัพยากรที่ต้องการจัดการด้วย Terraform โปรดกลับมาตรวจสอบในเร็วๆ นี้เพื่อดูว่าทรัพยากรพร้อมใช้งานหรือยัง หรือจะขอทรัพยากรดังกล่าวโดยส่งคำขอแจ้งปัญหาในรีโป GitHub ก็ได้


การจัดการโปรเจ็กต์และแอป Firebase

  • google_firebase_project — เปิดใช้บริการ Firebase ในโปรเจ็กต์ Google Cloud ที่มีอยู่

  • แอป Firebase


Firebase Authentication

  • google_identity_platform_config — เปิดใช้ Google Cloud Identity Platform (GCIP) (ซึ่งเป็นแบ็กเอนด์สำหรับ Firebase Authentication) และให้การตั้งค่าการตรวจสอบสิทธิ์ระดับโปรเจ็กต์

    • การกำหนดค่า Firebase Authentication ผ่าน Terraform จำเป็นต้องเปิดใช้ GCIP โปรดอ่านไฟล์ .tf ตัวอย่างเพื่อดูวิธีตั้งค่า Firebase Authentication

    • โปรเจ็กต์ที่ Terraform จะเปิดใช้ GCIP และ/หรือ Firebase Authentication ต้องอยู่ในแพ็กเกจราคา Blaze (กล่าวคือ โปรเจ็กต์ต้องมีบัญชี Cloud Billing ที่เชื่อมโยง) คุณทําแบบเป็นโปรแกรมได้โดยการตั้งค่าแอตทริบิวต์ billing_account ในทรัพยากร google_project

    • แหล่งข้อมูลนี้ยังเปิดใช้การกำหนดค่าเพิ่มเติม เช่น วิธีการลงชื่อเข้าใช้ในเครื่อง เช่น การตรวจสอบสิทธิ์แบบไม่ระบุตัวตน อีเมล/รหัสผ่าน และโทรศัพท์ ตลอดจนการบล็อกฟังก์ชันและโดเมนที่ได้รับอนุญาต

  • google_identity_platform_default_supported_idp_config — กำหนดค่าผู้ให้บริการข้อมูลประจำตัวแบบรวมศูนย์ทั่วไป เช่น Google, Facebook หรือ Apple

  • identity_platform_oauth_idp_config — กำหนดค่าแหล่งที่มาของผู้ให้บริการข้อมูลประจำตัว (IdP) OAuth ที่กำหนดเอง

  • google_identity_platform_inbound_saml_config — กำหนดค่าการผสานรวม SAML

ยังไม่รองรับ

  • การกำหนดค่าการตรวจสอบสิทธิ์แบบหลายปัจจัย (MFA) ผ่าน Terraform

Firebase Realtime Database

ยังไม่รองรับ

  • การติดตั้งใช้งาน Firebase Realtime Database Security Rules ผ่าน Terraform (ดูวิธีติดตั้งใช้งาน Rules เหล่านี้โดยใช้เครื่องมืออื่นๆ รวมถึงตัวเลือกแบบเป็นโปรแกรม)

Cloud Firestore

  • google_firestore_database — สร้างอินสแตนซ์ Cloud Firestore

  • google_firestore_index — เปิดใช้การค้นหาที่มีประสิทธิภาพสําหรับ Cloud Firestore

  • google_firestore_document — ตั้งต้นอินสแตนซ์ Cloud Firestore ที่มีเอกสารที่เฉพาะเจาะจงในคอลเล็กชัน

    สำคัญ: อย่าใช้ข้อมูลผู้ใช้ปลายทางหรือข้อมูลเวอร์ชันที่ใช้งานจริงในเอกสารข้อมูลเริ่มต้นนี้


Cloud Storage for Firebase

  • google_firebase_storage_bucket — ทำให้ที่เก็บข้อมูล Cloud Storage ที่มีอยู่เข้าถึงได้สำหรับ SDK, การตรวจสอบสิทธิ์ และ Firebase Security Rules ของ Firebase

  • google_storage_bucket_object — เพิ่มออบเจ็กต์ลงในที่เก็บข้อมูล Cloud Storage

    สำคัญ: อย่าใช้ข้อมูลผู้ใช้ปลายทางหรือข้อมูลเวอร์ชันที่ใช้งานจริงในไฟล์นี้


Firebase Security Rules (สำหรับ Cloud Firestore และ Cloud Storage)

โปรดทราบว่า Firebase Realtime Database ใช้ระบบการจัดสรรอื่นสำหรับ Firebase Security Rules

  • google_firebaserules_ruleset — กำหนด Firebase Security Rules ที่ใช้กับอินสแตนซ์ Cloud Firestore หรือที่เก็บข้อมูล Cloud Storage

  • google_firebaserules_release — ทำให้ชุดกฎที่เจาะจงใช้งานได้กับอินสแตนซ์ Cloud Firestore หรือที่เก็บข้อมูล Cloud Storage


Firebase App Check


Firebase Extensions



ตัวอย่างไฟล์การกําหนดค่า Terraform สําหรับกรณีการใช้งานทั่วไป



การแก้ปัญหาและคำถามที่พบบ่อย