شروع به کار با Terraform و Firebase

Firebase درحال شروع پشتیبانی از Terraform است. اگر در تیمی هستید که می‌خواهد ایجاد پروژه‌های Firebase را با منابع خاص ارائه‌شده و سرویس‌های فعال‌شده خودکار و استاندارد کند، استفاده از Terraform با Firebase می‌تواند برای شما مناسب باشد.

گردش کار اصلی برای استفاده از Terraform با Firebase شامل موارد زیر است:

  • ایجاد و سفارشی‌سازی فایل پیکربندی Terraform (فایل .tf) که زیرساختی را که می‌خواهید تأمین کنید مشخص می‌کند (یعنی منابعی که می‌خواهید تأمین کنید و سرویس‌هایی که می‌خواهید فعال کنید).

  • بااستفاده از فرمان‌های gcloud CLI که با Terraform تعامل دارند، زیرساخت مشخص‌شده در فایل .tf را فراهم می‌کند.

با Terraform و Firebase چه کارهایی می‌توانید انجام دهید؟

نمونه گردش کار تعمیم‌یافته در این راهنما یک پروژه Firebase جدید با برنامه Android ایجاد می‌کند. اما می‌توانید کارهای بسیار بیشتری با Terraform انجام دهید، ازجمله:

  • Delete and modify existing infrastructure using Terraform.

  • مدیریت کردن پیکربندی و تکالیف مختص محصول بااستفاده از Terraform، مثل:

    • درحال فعال کردن ارائه‌دهندگان ورود به سیستم Firebase Authentication.
    • درحال ایجاد کردن Cloud Storage سطل یا نمونه پایگاه داده و استقرار Firebase Security Rules برای آن‌ها.
    • درحال ایجاد Firebase App Hosting پس‌زمینه، ساخت، و دیگر منابع مرتبط.

می‌توانید از فایل‌ها و فرمان‌های پیکربندی استاندارد Terraform برای انجام همه این کارها استفاده کنید. و برای کمک به شما در این زمینه، نمونه فایل‌های پیکربندی Terraform را برای چند مورد استفاده رایج ارائه کرده‌ایم.



گردش کار تعمیم‌یافته برای استفاده از Terraform با Firebase

پیش‌نیازها

این راهنما مقدمه‌ای بر استفاده از Terraform با Firebase است، بنابراین فرض می‌کند که مهارت پایه‌ای در Terraform دارید. پیش‌از شروع این گردش کار، مطمئن شوید که پیش‌نیازهای زیر را تکمیل کرده‌اید.

  • Terraform را نصب کنید و بااستفاده از آموزش‌های رسمی Terraform با آن آشنا شوید.

  • Google Cloud CLI را نصب کنید (gcloud CLI). بااستفاده از حساب کاربری یا حساب سرویس به سیستم وارد شوید.


مرحله ۱: ایجاد و سفارشی‌سازی کردن فایل پیکربندی Terraform

فایل پیکربندی Terraform به دو بخش اصلی نیاز دارد (که در زیر به‌طور مفصل شرح داده شده است):

راه‌اندازی 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 = "~> 6.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 ایجاد شود

در فایل پیکربندی Terraform (برای این راهنما، فایل 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,
      ]
    }


مرحله ۲: اجرای فرمان‌های Terraform برای ایجاد زیرساخت مشخص‌شده

برای تأمین منابع و فعال کردن سرویس‌های مشخص‌شده در فایل main.tf، دستورات زیر را از همان دایرکتوری فایل main.tf اجرا کنید. برای اطلاعات دقیق درباره این فرمان‌ها، اسناد Terraform را ببینید.

  1. اگر این اولین‌باری است که فرمان‌های Terraform را در دایرکتوری اجرا می‌کنید، باید دایرکتوری پیکربندی را مقداردهی اولیه کنید و ارائه‌دهنده Google Terraform را نصب کنید. این کار را با اجرای فرمان زیر انجام دهید:

    terraform init
  2. با اجرای فرمان زیر، زیرساخت مشخص‌شده در فایل main.tf را ایجاد کنید:

    terraform apply
  3. تأیید کنید که همه موارد طبق انتظار آماده‌سازی یا فعال شده باشد:

    • گزینه ۱: با اجرای دستور زیر، پیکربندی چاپ‌شده در پایانه را ببینید:

      terraform show
    • گزینه ۲: پروژه 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 App Hosting

  • google_firebase_app_hosting_backend — ایجاد و مدیریت یک پس‌بک Firebase App Hosting، ازجمله اتصال مخزن GitHub آن و شاخه زنده برای استقرار مداوم.

  • google_firebase_app_hosting_build — ایجاد کردن ساخت برای پس‌زمینه، در برچسب مرجع پایگاه کد نقطه خاص و نقطه زمانی.

  • google_firebase_app_hosting_traffic — عرضه کردن ساخت یا پیکربندی کردن استقرار پیوسته GitHub.


Firebase SQL Connect


Firebase Realtime Database

هنوز پشتیبانی نمی‌شود:

  • درحال استقرار Firebase Realtime Database Security Rules ازطریق Terraform (با نحوه استقرار این Security Rules بااستفاده از ابزارهای دیگر، ازجمله گزینه‌های برنامه‌ای آشنا شوید)

Cloud Firestore

  • google_firestore_database — ایجاد نمونه Cloud Firestore

  • google_firestore_index — فعال کردن پُرسمان‌های کارآمد برای Cloud Firestore

  • google_firestore_document — seed a Cloud Firestore instance with a specific document in a collection

    مهم: از داده‌های واقعی کاربر نهایی یا داده‌های تولید در این سند بذر استفاده نکنید.


Cloud Storage for Firebase

  • google_firebase_storage_bucket — دسته Cloud Storage موجود را برای کیت‌های توسعه نرم‌افزار Firebase، اصالت‌سنجی، و Firebase Security Rules دردسترس قرار دهید

  • 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 bucket اعمال می‌شود تعریف کنید

  • google_firebaserules_release — مجموعه قوانین خاصی را در نمونه Cloud Firestore یا سبد Cloud Storage مستقر کنید


Firebase App Check


Firebase Extensions



نمونه فایل‌های پیکربندی Terraform برای موارد استفاده رایج



عیب‌یابی و پرسشگان