diff --git a/.gcb/builds/README.md b/.gcb/builds/README.md new file mode 100644 index 0000000000..e1dddb33c1 --- /dev/null +++ b/.gcb/builds/README.md @@ -0,0 +1,63 @@ +# Terraform for Integration Test Resources + +This directory contains Terraform configurations to set up the resources needed +for integration tests (Firestore, KMS, Buckets, etc.). + +## Safe Usage for Personal Test Projects + +By default, this configuration uses a remote GCS backend which tracks the state +of the shared `rust-sdk-testing` project. **Do not run `terraform apply` +directly with the remote backend if you are targeting a personal test project, +as it may interfere with the shared state or disable services in the shared +project.** + +To safely use these Terraform scripts to set up resources in your personal test +project: + +1. **Set your project variable**: + + ```bash + PROJECT=$(gcloud config get project) + ``` + +1. **Override the backend to use local state**: Create a `backend_override.tf` + file. This tells Terraform to store the state locally on your machine instead + of the shared GCS bucket. + + ```bash + cat > backend_override.tf <