Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Firebase zaczyna obsługiwać Terraform.
Jeśli należysz do zespołu, który chce zautomatyzować i ustandaryzować tworzenie projektów Firebase z określonymi zasobami i włączonymi usługami, możesz skorzystać z Terraform w Firebase.
Podstawowy proces korzystania z Terraform w Firebase obejmuje te czynności:
Tworzenie i dostosowywanie pliku konfiguracji Terraform (pliku .tf), który określa infrastrukturę, którą chcesz zainicjować (czyli zasoby, które chcesz zainicjować, oraz usługi, które chcesz włączyć).
Używanie poleceń gcloud CLI, które współpracują z Terraform, do zaopatrywania infrastruktury określonej w pliku .tf.
tworzenie Cloud Storage lub instancji bazy danych i wdrażanie dla nich Firebase Security Rules.
Aby wykonać te zadania, możesz użyć standardowych plików konfiguracji i poleceń Terraform. Aby Ci w tym pomóc, udostępniliśmy przykładowe pliki konfiguracji Terraform na potrzeby kilku typowych zastosowań.
Uogólniony przepływ pracy dotyczący używania Terraform z Firebase
Wymagania wstępne
Ten przewodnik zawiera wprowadzenie do korzystania z Terraform z Firebase, więc zakłada
podstawową znajomość Terraform. Zanim rozpoczniesz ten przepływ pracy, sprawdź, czy spełniasz te wymagania wstępne.
Zainstaluj Terraform i zapoznaj się z tym narzędziem, korzystając z oficjalnych samouczków.
Wymagania dotyczące kont użytkowników i kont usługi
Jeśli używasz konta użytkownika, musisz zaakceptować Warunki korzystania z usługi Firebase. Warunki korzystania z usługi Firebase zostały przez Ciebie zaakceptowane, jeśli możesz wyświetlać projekt Firebase w konsoli Firebase.
Aby Terraform mógł wykonywać określone działania (na przykład tworzyć projekty), muszą być spełnione te warunki:
Użytkownik lub konto usługi musi mieć odpowiedni dostęp do uprawnień IAM do wykonywania tych działań.
Jeśli konto użytkownika lub usługi należy do organizacji Google Cloud, zasady organizacji muszą zezwalać na wykonywanie tych działań.
Krok 1. Utwórz i dostosuj plik konfiguracyjny Terraform
Plik konfiguracji Terraform wymaga dwóch głównych sekcji (opisane szczegółowo poniżej):
Konfiguracja provider jest wymagana niezależnie od tego, z których usług Firebase chcesz korzystać.
Utwórz plik konfiguracyjny Terraform (np. main.tf) w katalogu lokalnym.
W tym przewodniku użyjesz tego pliku konfiguracji, aby określić providerkonfigurację i całą infrastrukturę, którą ma utworzyć Terraform. Pamiętaj jednak, że możesz uwzględnić konfigurację dostawcy.
Konfigurację provider możesz dołączyć do pozostałej części konfiguracji Terraform za pomocą tych opcji:
Opcja 1: umieść ją na początku pojedynczego pliku konfiguracyjnego Terraform .tf (jak pokazano w tym przewodniku).
Użyj tej opcji, jeśli dopiero zaczynasz korzystać z Terraform lub jeśli dopiero zaczynasz korzystać z Terraform z Firebase.
Opcja 2: uwzględnij ją w osobnym pliku .tf (np. pliku provider.tf), z dala od pliku .tf, w którym określasz infrastrukturę do utworzenia (np. plik main.tf).
Użyj tej opcji, jeśli należysz do większego zespołu, który musi ujednolicić konfigurację.
Podczas wykonywania poleceń Terraform plik provider.tf i plik main.tf muszą znajdować się w tym samym katalogu.
U góry pliku main.tf umieść następującą konfigurację provider.
Musisz użyć dostawcy google-beta, ponieważ jest to wersja beta korzystania z Firebase z Terraform. Zachowaj ostrożność podczas korzystania z tego pakietu w produkcji.
# 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}
Dowiedz się więcej o różnych typach atrybutów związanych z projektem (w tym o tym, co w tym przewodniku nazywamy „projektem sprawdzającym limit”) podczas korzystania z Terraform w Firebase.
Przejdź do następnej sekcji, aby uzupełnić plik konfiguracyjny i określić infrastrukturę do utworzenia.
Określ, jaką infrastrukturę utworzyć za pomocą bloków resource
W pliku konfiguracji Terraform (w tym przypadku pliku main.tf) musisz określić całą infrastrukturę, którą ma utworzyć Terraform (czyli wszystkie zasoby, które chcesz udostępnić, i wszystkie usługi, które chcesz włączyć). W tym przewodniku znajdziesz pełną listę wszystkich zasobów Firebase, które obsługują Terraform.
Otwórz plik main.tf.
W ramach konfiguracji provider dodaj tę konfigurację bloków resource.
W tym podstawowym przykładzie utworzymy nowy projekt Firebase, a potem w jego ramach aplikację Firebase na Androida.
# 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_overridename="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_overrideproject=google_project.default.project_idfor_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-betaproject=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-betaproject=google_project.default.project_iddisplay_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 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"{ # Use the provider that enables the setup of quota checks for a new projectprovider=google-beta.no_user_project_overridename="Project Display Name" // learn more about the project nameproject_id="project-id-for-new-project" // learn more about the project ID # 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" // learn more about the Firebase-enabled label}}# Enables required APIs.resource"google_project_service""default"{ # Use the provider without quota checks for enabling APISprovider=google-beta.no_user_project_overrideproject=google_project.default.project_idfor_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.# This action essentially "creates a Firebase project" and allows the project to use# Firebase services (like Firebase Authentication) and# Firebase tooling (like the Firebase console).# Learn more about the relationship between Firebase projects and Google Cloud.resource"google_firebase_project""default"{ # Use the provider that performs quota checks from now onprovider=google-betaproject=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.# Learn more about the relationship between Firebase Apps and Firebase projects.resource"google_firebase_android_app""default"{provider=google-betaproject=google_project.default.project_iddisplay_name="My Awesome Android app" # learn more about an app's display namepackage_name="awesome.package.name" # learn more about an app's package name # Wait for Firebase to be enabled in the Google Cloud project before creating this App.depends_on=[google_firebase_project.default,]}
Krok 2. Uruchom polecenia Terraform, aby utworzyć określoną infrastrukturę
Aby zainicjować zasoby i włączyć usługi określone w pliku main.tf, uruchom podane niżej polecenia w tym samym katalogu co plik main.tf.
Szczegółowe informacje o tych poleceniach znajdziesz w dokumentacji Terraform.
Jeśli po raz pierwszy uruchamiasz w tym katalogu polecenia Terraform, musisz zainicjować katalog konfiguracji i zainstalować dostawcę Terraform Google. W tym celu uruchom następujące polecenie:
terraform init
Utwórz infrastrukturę określoną w pliku main.tf, uruchamiając to polecenie:
terraform apply
Sprawdź, czy wszystko zostało skonfigurowane lub włączone zgodnie z oczekiwaniami:
Opcja 1: aby wyświetlić konfigurację w terminalu, uruchom to polecenie:
Poniższe zasoby Firebase i Google obsługują Terraform. Stale dodajemy więcej zasobów. Jeśli nie widzisz zasobu, którym chcesz zarządzać za pomocą Terraform, wkrótce sprawdź, czy jest on dostępny, lub poproś o jego dodanie, zgłaszając problem w repozytorium GitHuba.
google_identity_platform_config – włącz Google Cloud Identity Platform (GCIP) (który jest backendem dla Firebase Authentication) i podaj ustawienia uwierzytelniania na poziomie projektu.
Projekt, w którym Terraform ma włączyć GCIP lub Firebase Authentication, musi być objęty planem cenowym Blaze (czyli musi mieć powiązane konto Cloud Billing). Możesz to zrobić automatycznie, ustawiając atrybut billing_account w zasobie google_project.
Ten zasób umożliwia też większą liczbę konfiguracji, takich jak lokalne metody logowania, na przykład anonimowe, e-mail/hasło i uwierzytelnianie przez telefon, a także funkcje blokowania i autoryzowane domeny.
Wdrażanie Firebase Realtime Database Security Rules za pomocą Terraform (dowiedz się, jak wdrażać te Rules za pomocą innych narzędzi, w tym opcji programowych).
Przykładowe pliki konfiguracji Terraform na potrzeby typowych zastosowań
Konfigurowanie usługi Firebase Authentication za pomocą interfejsu GCIP
Ta konfiguracja tworzy nowy projekt Google Cloud, łączy go z kontem Cloud Billing (abonament Blaze jest wymagany w przypadku usługi Firebase Authentication w GCP), włącza usługi Firebase w projekcie, konfiguruje Firebase Authentication w GCP i rejestruje w projekcie 3 różne typy aplikacji.
Pamiętaj, że aby skonfigurować Firebase Authentication za pomocą Terraform, musisz włączyć GCIP.
# Creates a new Google Cloud project.resource"google_project""auth"{provider=google-beta.no_user_project_overridefolder_id="folder-id-for-new-project"name="Project Display Name"project_id="project-id-for-new-project" # Associates the project with a Cloud Billing account # (required for Firebase Authentication with GCIP).billing_account="000000-000000-000000" # Required for the project to display in a list of Firebase projects.labels={"firebase"="enabled"}}# Enables required APIs.resource"google_project_service""auth"{provider=google-beta.no_user_project_overrideproject=google_project.auth.project_idfor_each=toset(["cloudbilling.googleapis.com","cloudresourcemanager.googleapis.com","serviceusage.googleapis.com","identitytoolkit.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""auth"{provider=google-betaproject=google_project.auth.project_iddepends_on=[google_project_service.auth,]}# Creates an Identity Platform config.# Also enables Firebase Authentication with Identity Platform in the project if not.resource"google_identity_platform_config""auth"{provider=google-betaproject=google_project.auth.project_id # Auto-deletes anonymous usersautodelete_anonymous_users=true # Configures local sign-in methods, like anonymous, email/password, and phone authentication.sign_in{allow_duplicate_emails=trueanonymous{enabled=true}email{enabled=truepassword_required=false}phone_number{enabled=truetest_phone_numbers={"+11231231234"="000000"}}} # Sets an SMS region policy.sms_region_config{allowlist_only{allowed_regions=["US","CA",]}} # Configures blocking functions.blocking_functions{triggers{event_type="beforeSignIn"function_uri="https://us-east1-${google_project.auth.project_id}.cloudfunctions.net/before-sign-in"}forward_inbound_credentials{refresh_token=trueaccess_token=trueid_token=true}} # Configures a temporary quota for new signups for anonymous, email/password, and phone number.quota{sign_up_quota_config{quota=1000start_time=""quota_duration="7200s"}} # Configures authorized domains.authorized_domains=["localhost","${google_project.auth.project_id}.firebaseapp.com","${google_project.auth.project_id}.web.app",] # Wait for identitytoolkit.googleapis.com to be enabled before initializing Authentication.depends_on=[google_project_service.auth,]}# Creates a Firebase Android App in the new project created above.resource"google_firebase_android_app""auth"{provider=google-betaproject=google_project.auth.project_iddisplay_name="My Android app"package_name="android.package.name" # Wait for Firebase to be enabled in the Google Cloud project before creating this App.depends_on=[google_firebase_project.auth,]}# Creates a Firebase Apple-platforms App in the new project created above.resource"google_firebase_apple_app""auth"{provider=google-betaproject=google_project.auth.project_iddisplay_name="My Apple app"bundle_id="apple.app.12345" # Wait for Firebase to be enabled in the Google Cloud project before creating this App.depends_on=[google_firebase_project.auth,]}# Creates a Firebase Web App in the new project created above.resource"google_firebase_web_app""auth"{provider=google-betaproject=google_project.auth.project_iddisplay_name="My Web app" # The other App types (Android and Apple) use "DELETE" by default. # Web apps don't use "DELETE" by default due to backward-compatibility.deletion_policy="DELETE" # Wait for Firebase to be enabled in the Google Cloud project before creating this App.depends_on=[google_firebase_project.auth,]}
Ta konfiguracja tworzy nowy projekt Google Cloud, włącza w nim usługi Firebase, udostępnia domyślny egzemplarz Realtime Database projektu i rejestruje w nim 3 różne typy aplikacji.
# Creates a new Google Cloud project.resource"google_project""rtdb"{provider=google-beta.no_user_project_overridefolder_id="folder-id-for-new-project"name="Project Display Name"project_id="project-id-for-new-project" # Required for the project to display in a list of Firebase projects.labels={"firebase"="enabled"}}# Enables required APIs.resource"google_project_service""rtdb"{provider=google-beta.no_user_project_overrideproject=google_project.rtdb.project_idfor_each=toset(["serviceusage.googleapis.com","cloudresourcemanager.googleapis.com","firebasedatabase.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""rtdb"{provider=google-betaproject=google_project.rtdb.project_id}# Provisions the default Realtime Database default instance.resource"google_firebase_database_instance""database"{provider=google-betaproject=google_project.rtdb.project_id # See available locations: https://firebase.google.com/docs/database/locationsregion="name-of-region" # This value will become the first segment of the database's URL.instance_id="${google_project.rtdb.project_id}-default-rtdb"type="DEFAULT_DATABASE" # Wait for Firebase to be enabled in the Google Cloud project before initializing Realtime Database.depends_on=[google_firebase_project.rtdb,]}# Creates a Firebase Android App in the new project created above.resource"google_firebase_android_app""rtdb"{provider=google-betaproject=google_project.rtdb.project_iddisplay_name="My Android app"package_name="android.package.name" # Wait for Firebase to be enabled in the Google Cloud project before creating this App.depends_on=[google_firebase_project.rtdb,]}# Creates a Firebase Apple-platforms App in the new project created above.resource"google_firebase_apple_app""rtdb"{provider=google-betaproject=google_project.rtdb.project_iddisplay_name="My Apple app"bundle_id="apple.app.12345" # Wait for Firebase to be enabled in the Google Cloud project before creating this App.depends_on=[google_firebase_project.rtdb,]}# Creates a Firebase Web App in the new project created above.resource"google_firebase_web_app""rtdb"{provider=google-betaproject=google_project.rtdb.project_iddisplay_name="My Web app" # The other App types (Android and Apple) use "DELETE" by default. # Web apps don't use "DELETE" by default due to backward-compatibility.deletion_policy="DELETE" # Wait for Firebase to be enabled in the Google Cloud project before creating this App.depends_on=[google_firebase_project.rtdb,]}
Tworzenie wielu instancji Firebase Realtime Database
Ta konfiguracja tworzy nowy projekt Google Cloud, łączy go z kontem Cloud Billing (abonament Blaze jest wymagany w przypadku wielu instancji Realtime Database), włącza usługi Firebase w projekcie, udostępnia wiele instancji Realtime Database (w tym domyślną instancję Realtime Database projektu) i rejestruje w projekcie 3 różne typy aplikacji.
# Creates a new Google Cloud project.resource"google_project""rtdb-multi"{provider=google-beta.no_user_project_overridefolder_id="folder-id-for-new-project"name="Project Display Name"project_id="project-id-for-new-project" # Associate the project with a Cloud Billing account # (required for multiple Realtime Database instances).billing_account="000000-000000-000000" # Required for the project to display in a list of Firebase projects.labels={"firebase"="enabled"}}# Enables required APIs.resource"google_project_service""rtdb-multi"{provider=google-beta.no_user_project_overrideproject=google_project.rtdb-multi.project_idfor_each=toset(["cloudbilling.googleapis.com","serviceusage.googleapis.com","cloudresourcemanager.googleapis.com","firebasedatabase.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""rtdb-multi"{provider=google-betaproject=google_project.rtdb-multi.project_id}# Provisions the default Realtime Database default instance.resource"google_firebase_database_instance""database-default"{provider=google-betaproject=google_project.rtdb-multi.project_id # See available locations: https://firebase.google.com/docs/database/locationsregion="name-of-region" # This value will become the first segment of the database's URL.instance_id="${google_project.rtdb-multi.project_id}-default-rtdb"type="DEFAULT_DATABASE" # Wait for Firebase to be enabled in the Google Cloud project before initializing Realtime Database.depends_on=[google_firebase_project.rtdb-multi,]}# Provisions an additional Realtime Database instance.resource"google_firebase_database_instance""database-additional"{provider=google-betaproject=google_project.rtdb-multi.project_id # See available locations: https://firebase.google.com/docs/projects/locations#rtdb-locations # This location doesn't need to be the same as the default database instance.region="name-of-region" # This value will become the first segment of the database's URL.instance_id="name-of-additional-database-instance"type="USER_DATABASE" # Wait for Firebase to be enabled in the Google Cloud project before initializing Realtime Database.depends_on=[google_firebase_project.rtdb-multi,]}# Creates a Firebase Android App in the new project created above.resource"google_firebase_android_app""rtdb-multi"{provider=google-betaproject=google_project.rtdb-multi.project_iddisplay_name="My Android app"package_name="android.package.name" # Wait for Firebase to be enabled in the Google Cloud project before creating this App.depends_on=[google_firebase_project.rtdb-multi,]}# Creates a Firebase Apple-platforms App in the new project created above.resource"google_firebase_apple_app""rtdb-multi"{provider=google-betaproject=google_project.rtdb-multi.project_iddisplay_name="My Apple app"bundle_id="apple.app.12345" # Wait for Firebase to be enabled in the Google Cloud project before creating this App.depends_on=[google_firebase_project.rtdb-multi,]}# Creates a Firebase Web App in the new project created above.resource"google_firebase_web_app""rtdb-multi"{provider=google-betaproject=google_project.rtdb-multi.project_iddisplay_name="My Web app" # The other App types (Android and Apple) use "DELETE" by default. # Web apps don't use "DELETE" by default due to backward-compatibility.deletion_policy="DELETE" # Wait for Firebase to be enabled in the Google Cloud project before creating this App.depends_on=[google_firebase_project.rtdb-multi,]}
Wprowadź domyślną instancję
Cloud Firestore
Ta konfiguracja tworzy nowy projekt Google Cloud, włącza w nim usługi Firebase, udostępnia domyślny egzemplarz Cloud Firestore projektu i rejestruje w nim 3 różne typy aplikacji.
Usługa ta tworzy też Firebase Security Rules dla domyślnego wystąpienia Cloud Firestore, indeks Cloud Firestore oraz dokument Cloud Firestore z danymi początkowymi.
# Creates a new Google Cloud project.resource"google_project""firestore"{provider=google-beta.no_user_project_overridefolder_id="folder-id-for-new-project"name="Project Display Name"project_id="project-id-for-new-project" # Required for the project to display in a list of Firebase projects.labels={"firebase"="enabled"}}# Enables required APIs.resource"google_project_service""firestore"{provider=google-beta.no_user_project_overrideproject=google_project.firestore.project_idfor_each=toset(["cloudresourcemanager.googleapis.com","serviceusage.googleapis.com","firestore.googleapis.com","firebaserules.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""firestore"{provider=google-betaproject=google_project.firestore.project_id}# Provisions the Firestore database instance.resource"google_firestore_database""firestore"{provider=google-betaproject=google_project.firestore.project_idname="(default)" # See available locations: https://firebase.google.com/docs/firestore/locationslocation_id="name-of-region" # "FIRESTORE_NATIVE" is required to use Firestore with Firebase SDKs, authentication, and Firebase Security Rules.type="FIRESTORE_NATIVE"concurrency_mode="OPTIMISTIC" # Wait for Firebase to be enabled in the Google Cloud project before initializing Firestore.depends_on=[google_firebase_project.firestore,]}# Creates a ruleset of Firestore Security Rules from a local file.resource"google_firebaserules_ruleset""firestore"{provider=google-betaproject=google_project.firestore.project_idsource{files{name="firestore.rules" # Write security rules in a local file named "firestore.rules". # Learn more: https://firebase.google.com/docs/firestore/security/get-startedcontent=file("firestore.rules")}} # Wait for Firestore to be provisioned before creating this ruleset.depends_on=[google_firestore_database.firestore,]}# Releases the ruleset for the Firestore instance.resource"google_firebaserules_release""firestore"{provider=google-betaname="cloud.firestore" # must be cloud.firestoreruleset_name=google_firebaserules_ruleset.firestore.nameproject=google_project.firestore.project_id # Wait for Firestore to be provisioned before releasing the ruleset.depends_on=[google_firestore_database.firestore,]}# Adds a new Firestore index.resource"google_firestore_index""indexes"{provider=google-betaproject=google_project.firestore.project_idcollection="quiz"query_scope="COLLECTION"fields{field_path="question"order="ASCENDING"}fields{field_path="answer"order="ASCENDING"} # Wait for Firestore to be provisioned before adding this index.depends_on=[google_firestore_database.firestore,]}# Adds a new Firestore document with seed data.# Don't use real end-user or production data in this seed document.resource"google_firestore_document""doc"{provider=google-betaproject=google_project.firestore.project_idcollection="quiz"document_id="question-1"fields="{\"question\":{\"stringValue\":\"Favorite Database\"},\"answer\":{\"stringValue\":\"Firestore\"}}" # Wait for Firestore to be provisioned before adding this document.depends_on=[google_firestore_database.firestore,]}# Creates a Firebase Android App in the new project created above.resource"google_firebase_android_app""firestore"{provider=google-betaproject=google_project.firestore.project_iddisplay_name="My Android app"package_name="android.package.name" # Wait for Firebase to be enabled in the Google Cloud project before creating this App.depends_on=[google_firebase_project.firestore,]}# Creates a Firebase Apple-platforms App in the new project created above.resource"google_firebase_apple_app""firestore"{provider=google-betaproject=google_project.firestore.project_iddisplay_name="My Apple app"bundle_id="apple.app.12345" # Wait for Firebase to be enabled in the Google Cloud project before creating this App.depends_on=[google_firebase_project.firestore,]}# Creates a Firebase Web App in the new project created above.resource"google_firebase_web_app""firestore"{provider=google-betaproject=google_project.firestore.project_iddisplay_name="My Web app" # The other App types (Android and Apple) use "DELETE" by default. # Web apps don't use "DELETE" by default due to backward-compatibility.deletion_policy="DELETE" # Wait for Firebase to be enabled in the Google Cloud project before creating this App.depends_on=[google_firebase_project.firestore,]}
To zbiór reguł Cloud Firestore Security Rules, który powinien znajdować się w pliku lokalnym o nazwie firestore.rules.
Ta konfiguracja tworzy nowy projekt Google Cloud, łączy go z kontem Cloud Billing (aby utworzyć dodatkowe zasobniki, wymagany jest plan cen Blaze), włącza usługi Firebase w projekcie, udostępnia dodatkowe, inne niż domyślne zasobniki Cloud Storage i rejestruje w projekcie 3 różne typy aplikacji.
Tworzy też Firebase Security Rules dla każdego zasobnika Cloud Storage i przesyła plik do jednego z zasobników Cloud Storage.
# Creates a new Google Cloud project.resource"google_project""storage-multi"{provider=google-beta.no_user_project_overridefolder_id="folder-id-for-new-project"name="Project Display Name"project_id="project-id-for-new-project" # Associates the project with a Cloud Billing account # (required for multiple Cloud Storage buckets).billing_account="000000-000000-000000" # Required for the project to display in a list of Firebase projects.labels={"firebase"="enabled"}}# Enables required APIs.resource"google_project_service""storage-multi"{provider=google-beta.no_user_project_overrideproject=google_project.storage-multi.project_idfor_each=toset(["cloudbilling.googleapis.com","serviceusage.googleapis.com","cloudresourcemanager.googleapis.com","firebaserules.googleapis.com","firebasestorage.googleapis.com","storage.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""storage-multi"{provider=google-betaproject=google_project.storage-multi.project_id}# Provisions a Cloud Storage bucket.resource"google_storage_bucket""bucket-1"{provider=google-betaproject=google_project.storage-multi.project_idname="name-of-storage-bucket" # See available locations: https://cloud.google.com/storage/docs/locations#available-locationslocation="name-of-region-for-bucket"}# Provisions an additional Cloud Storage bucket.resource"google_storage_bucket""bucket-2"{provider=google-betaproject=google_project.storage-multi.project_idname="name-of-additional-storage-bucket" # See available locations: https://cloud.google.com/storage/docs/locations#available-locations # This location does not need to be the same as the existing Storage bucket.location="name-of-region-for-additional-bucket"}# Makes the first Storage bucket accessible for Firebase SDKs, authentication, and Firebase Security Rules.resource"google_firebase_storage_bucket""bucket-1"{provider=google-betaproject=google_project.storage-multi.project_idbucket_id=google_storage_bucket.bucket-1.name}# Makes the additional Storage bucket accessible for Firebase SDKs, authentication, and Firebase Security Rules.resource"google_firebase_storage_bucket""bucket-2"{provider=google-betaproject=google_project.storage-multi.project_idbucket_id=google_storage_bucket.bucket-2.name}# Creates a ruleset of Firebase Security Rules from a local file.resource"google_firebaserules_ruleset""storage-multi"{provider=google-betaproject=google_project.storage-multi.project_idsource{files{ # Write security rules in a local file named "storage.rules" # Learn more: https://firebase.google.com/docs/storage/security/get-startedname="storage.rules"content=file("storage.rules")}} # Wait for the Storage buckets to be provisioned before creating this ruleset.depends_on=[google_firebase_project.storage-multi,]}# Releases the ruleset to the first Storage bucket.resource"google_firebaserules_release""bucket-1"{provider=google-betaname="firebase.storage/${google_storage_bucket.bucket-1.name}"ruleset_name="projects/${google_project.storage-multi.project_id}/rulesets/${google_firebaserules_ruleset.storage-multi.name}"project=google_project.storage-multi.project_id}# Releases the ruleset to the additional Storage bucket.resource"google_firebaserules_release""bucket-2"{provider=google-betaname="firebase.storage/${google_storage_bucket.bucket-2.name}"ruleset_name="projects/${google_project.storage-multi.project_id}/rulesets/${google_firebaserules_ruleset.storage-multi.name}"project=google_project.storage-multi.project_id}# Uploads a new file to the first Storage bucket.# Do not use real end-user or production data in this file.resource"google_storage_bucket_object""cat-picture-multi"{provider=google-betaname="cat.png"source="path/to/cat.png"bucket=google_storage_bucket.bucket-1.name}# Creates a Firebase Android App in the new project created above.resource"google_firebase_android_app""storage-multi"{provider=google-betaproject=google_project.storage-multi.project_iddisplay_name="My Android app"package_name="android.package.name" # Wait for Firebase to be enabled in the Google Cloud project before creating this App.depends_on=[google_firebase_project.storage-multi,]}# Creates a Firebase Apple-platforms App in the new project created above.resource"google_firebase_apple_app""storage-multi"{provider=google-betaproject=google_project.storage-multi.project_iddisplay_name="My Apple app"bundle_id="apple.app.12345" # Wait for Firebase to be enabled in the Google Cloud project before creating this App.depends_on=[google_firebase_project.storage-multi,]}# Creates a Firebase Web App in the new project created above.resource"google_firebase_web_app""storage-multi"{provider=google-betaproject=google_project.storage-multi.project_iddisplay_name="My Web app" # Wait for Firebase to be enabled in the Google Cloud project before creating this App.depends_on=[google_firebase_project.storage-multi,]}
To jest zbiór reguł Cloud Storage Security Rules, który powinien znajdować się w lokalnym pliku o nazwie storage.rules.
Chroń zasób interfejsu API za pomocą Firebase App Check
Ta konfiguracja tworzy nowy projekt Google Cloud, włącza usługi Firebase w tym projekcie oraz konfiguruje i włącza egzekwowanie Firebase App Check w przypadku Cloud Firestore, tak aby można było uzyskać do niego dostęp tylko z aplikacji na Androida.
# Creates a new Google Cloud project.resource"google_project""appcheck"{provider=google-beta.no_user_project_overridefolder_id="folder-id-for-new-project"name="Project Display Name"project_id="project-id-for-new-project" # Required for the project to display in a list of Firebase projects.labels={"firebase"="enabled"}}# Enables required APIs.resource"google_project_service""services"{provider=google-beta.no_user_project_overrideproject=google_project.appcheck.project_idfor_each=toset(["cloudresourcemanager.googleapis.com","firebase.googleapis.com","firebaseappcheck.googleapis.com","firestore.googleapis.com","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 earlier.resource"google_firebase_project""appcheck"{provider=google-betaproject=google_project.appcheck.project_iddepends_on=[google_project_service.services]}# Provisions the Firestore database instance.resource"google_firestore_database""database"{provider=google-betaproject=google_firebase_project.appcheck.projectname="(default)" # See available locations: https://firebase.google.com/docs/projects/locations#default-cloud-locationlocation_id="name-of-region" # "FIRESTORE_NATIVE" is required to use Firestore with Firebase SDKs, authentication, and Firebase Security Rules.type="FIRESTORE_NATIVE"concurrency_mode="OPTIMISTIC" # Wait for Firebase to be enabled in the Google Cloud project before initializing Firestore.depends_on=[google_firebase_project.appcheck,]}# Creates a Firebase Android App in the new project created earlier.resource"google_firebase_android_app""appcheck"{provider=google-betaproject=google_firebase_project.appcheck.projectdisplay_name="Play Integrity app"package_name="package.name.playintegrity"sha256_hashes=[ # TODO: insert your Android app's SHA256 certificate]}# It takes a while for App Check to recognize the new app# If your app already exists, you don't have to wait 30 seconds.resource"time_sleep""wait_30s"{depends_on=[google_firebase_android_app.appcheck]create_duration="30s"}# Register the Android app with the Play Integrity providerresource"google_firebase_app_check_play_integrity_config""appcheck"{provider=google-betaproject=google_firebase_project.appcheck.projectapp_id=google_firebase_android_app.appcheck.app_iddepends_on=[time_sleep.wait_30s,google_firestore_database.database]lifecycle{precondition{condition=length(google_firebase_android_app.appcheck.sha256_hashes)>0error_message="Provide a SHA-256 certificate on the Android App to use App Check"}}}# Enable enforcement of App Check for Firestoreresource"google_firebase_app_check_service_config""firestore"{provider=google-betaproject=google_firebase_project.appcheck.projectservice_id="firestore.googleapis.com"depends_on=[google_project_service.services]}
Instalowanie instancji Firebase Extension
Ta konfiguracja tworzy nowy projekt Google Cloud, włącza w nim usługi Firebase i instaluje w nim nowy egzemplarz usługi Firebase Extension. Jeśli instancja już istnieje, jej parametry zostaną zaktualizowane na podstawie wartości podanych w konfiguracji.
# Creates a new Google Cloud project.resource"google_project""extensions"{provider=google-beta.no_user_project_overridefolder_id="folder-id-for-new-project"name="Project Display Name"project_id="project-id-for-new-project" # Associates the project with a Cloud Billing account # (required to use Firebase Extensions).billing_account="000000-000000-000000" # Required for the project to display in a list of Firebase projects.labels={"firebase"="enabled"}}# Enables required APIs.resource"google_project_service""extensions"{provider=google-beta.no_user_project_overrideproject=google_project.extensions.project_idfor_each=toset(["cloudbilling.googleapis.com","cloudresourcemanager.googleapis.com","serviceusage.googleapis.com","firebase.googleapis.com","firebaseextensions.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""extensions"{provider=google-betaproject=google_project.extensions.project_iddepends_on=[google_project_service.extensions,]}# Installs an instance of the "Translate Text in Firestore" extension.# Or updates the extension if the specified instance already exists.resource"google_firebase_extensions_instance""translation"{provider=google-betaproject=google_project.extensions.project_idinstance_id="translate-text-in-firestore"config{extension_ref="firebase/firestore-translate-text"params={COLLECTION_PATH="posts/comments/translations"DO_BACKFILL=trueLANGUAGES="ar,en,es,de,fr"INPUT_FIELD_NAME="input"LANGUAGES_FIELD_NAME="languages"OUTPUT_FIELD_NAME="translated"}system_params={"firebaseextensions.v1beta.function/location"="us-central1""firebaseextensions.v1beta.function/memory"="256""firebaseextensions.v1beta.function/minInstances"="0""firebaseextensions.v1beta.function/vpcConnectorEgressSettings"="VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED"}}}
Rozwiązywanie problemów i najczęstsze pytania
Chcesz dowiedzieć się więcej o różnych atrybutach związanych z projektem (takich jak project i user_project_override).
W tym przewodniku podczas pracy z „projektami” używamy tych atrybutów Terraform.
project w resource bloku
Zalecane: jeśli to możliwe, dodaj atrybut project w każdym bloku resource
Dzięki uwzględnieniu atrybutu projektu Terraform utworzy infrastrukturę określoną w bloku zasobów w określonym projekcie. Opiera się to na tym przewodniku i w naszych przykładowych plikach konfiguracyjnych.
Zapoznaj się z oficjalną dokumentacją Terraform dotyczącą project.
user_project_override w bloku provider
Do alokowania większości zasobów należy użyć opcji user_project_override = true, co oznacza sprawdzenie limitu w Twoim projekcie Firebase. Aby jednak skonfigurować nowy projekt tak, aby mógł akceptować kontrole limitu, musisz najpierw użyć user_project_override = false.
Wyświetla się ten komunikat o błędzie:generic::permission_denied: Firebase Tos Not Accepted.
Upewnij się, że konto użytkownika, którego używasz do uruchamiania poleceń gcloud CLI, zaakceptowało Warunki korzystania z usługi Firebase.
Aby to sprawdzić, otwórz przeglądarkę, zaloguj się na konto użytkownika i spróbuj wyświetlić istniejący projekt Firebase w konsoli Firebase. Jeśli możesz wyświetlić istniejący projekt Firebase, oznacza to, że konto użytkownika zaakceptowało Warunki korzystania z usługi Firebase.
Jeśli nie możesz wyświetlić żadnego istniejącego projektu Firebase, konto użytkownika prawdopodobnie nie zaakceptowało Warunków korzystania z usługi Firebase. Aby rozwiązać ten problem, utwórz nowy projekt Firebase w konsoli Firebase i podczas tworzenia projektu zaakceptuj Warunki korzystania z usługi Firebase. Możesz natychmiast usunąć ten projekt w Ustawieniach projektu w konsoli.
Po uruchomieniu
terraform apply pojawia się ten błąd:
generic::permission_denied: IAM authority does not have the
permission.
Zaczekaj kilka minut i ponownie spróbuj uruchomić aplikację terraform apply.
Nie udało się utworzyć zasobu, ale po ponownym uruchomieniu polecenia terraform apply wyświetla się komunikat ALREADY_EXISTS.
Może to być spowodowane opóźnieniem rozpowszechniania w różnych systemach. Spróbuj rozwiązać ten problem, importując zasób do stanu Terraform, wykonując polecenie terraform import. Następnie spróbuj ponownie uruchomić terraform apply.
Podczas pracy z Cloud Firestore pojawia się ten błąd: Error creating Index: googleapi:
Error 409;...Concurrent access -- try again
Jak wskazuje błąd, Terraform może próbować udostępnić wiele indeksów lub utworzyć dokument w tym samym czasie i napotkać błąd równoczesności.
Spróbuj ponownie uruchomić terraform apply.
Występuje ten błąd: "you may need to specify 'X-Goog-User-Project' HTTP header for quota and
billing purposes".
Ten błąd oznacza, że Terraform nie wie, w którym projekcie ma sprawdzić limit. Aby rozwiązać problem, sprawdź w bloku resource te informacje:
Sprawdź, czy atrybut project ma określoną wartość.
Upewnij się, że używasz dostawcy z wartością user_project_override = true(bez aliasu), który w przypadku przykładów Firebase to google-beta.
Podczas tworzenia nowego projektu Google Cloud pojawia się błąd, że identyfikator projektu podany dla nowego projektu już istnieje.
Oto możliwe przyczyny, dla których identyfikator projektu już istnieje:
Projekt powiązany z tym identyfikatorem należy do innej osoby.
Aby rozwiązać problem: wybierz inny identyfikator projektu.
projekt powiązany z tym identyfikatorem został niedawno usunięty (w stanie miękkiego usunięcia);
Rozwiązanie problemu: jeśli uważasz, że projekt powiązany z identyfikatorem należy do Ciebie, sprawdź stan projektu za pomocą interfejsu API typu REST projects.get.
projekt powiązany z tym identyfikatorem istnieje prawidłowo w przypadku bieżącego użytkownika; Możliwą przyczyną błędu może być przerwanie poprzedniego terraform apply.
Rozwiązanie problemu: uruchom te polecenia: terraform import google_project.default PROJECT_ID
a potem terraform import google_firebase_project.default PROJECT_ID
Dlaczego trzeba udostępnić domyślną instancję Cloud Firestore przed domyślnym zasobnikiem Cloud Storage?
Jeśli domyślny folder Cloud Storage został udostępniony (za pomocą google_app_engine_application) przed próbą udostępnienia domyślnej instancji Cloud Firestore, domyślna instancja Cloud Firestore została już udostępniona. Pamiętaj, że instancja bazy danych utworzona przez pakiet SDK działa w trybie Datastore, co oznacza, że nie jest dostępna dla pakietów SDK Firebase, uwierzytelniania ani Firebase Security Rules. Jeśli chcesz używać usługi Cloud Firestore z tymi usługami Firebase, musisz opróżnić bazę danych, a potem zmienić jej typ w konsoli Google Cloud.
Podczas próby założenia instancji Cloud Storage (za pomocą interfejsu google_app_engine_application), a następnie domyślnej instancji Cloud Firestore, pojawia się ten błąd: Error: Error creating Database: googleapi: Error 409: Database already
exists. Please use another database_id.
Gdy zarezerwujesz domyślny kontener Cloud Storage projektu (za pomocą google_app_engine_application), a projekt nie ma jeszcze domyślnej instancji Cloud Firestore, google_app_engine_application automatycznie zarezerwuje domyślną instancję Cloud Firestore projektu.
Ponieważ domyślna instancja Cloud Firestore Twojego projektu jest już udostępniona, google_firestore_database wygeneruje błąd, jeśli spróbujesz ponownie udostępnić tę domyślną instancję.
Po wdrożenie domyślnej instancji usługi Cloud Firestore w projekcie nie można jej ponownie skonfigurować ani zmienić jej lokalizacji. Uwaga: udostępniona instancja bazy danych działa w trybie Datastore, co oznacza, że nie jest dostępna dla pakietów SDK Firebase, funkcji uwierzytelniania ani Firebase Security Rules. Jeśli z tymi usługami Firebase chcesz używać parametru Cloud Firestore, musisz opróżnić bazę danych, a następnie zmienić jej typ w konsoli Google Cloud.
[[["Łatwo zrozumieć","easyToUnderstand","thumb-up"],["Rozwiązało to mój problem","solvedMyProblem","thumb-up"],["Inne","otherUp","thumb-up"]],[["Brak potrzebnych mi informacji","missingTheInformationINeed","thumb-down"],["Zbyt skomplikowane / zbyt wiele czynności do wykonania","tooComplicatedTooManySteps","thumb-down"],["Nieaktualne treści","outOfDate","thumb-down"],["Problem z tłumaczeniem","translationIssue","thumb-down"],["Problem z przykładami/kodem","samplesCodeIssue","thumb-down"],["Inne","otherDown","thumb-down"]],["Ostatnia aktualizacja: 2024-11-07 UTC."],[],[]]