How to enable Customer-Managed Encryption Keys on Firestore
| Service | Google Firestore |
|---|---|
| Cloud | Google Cloud (GCP) |
| Guide type | Procedure |
| Skill level | Intermediate to advanced |
| Time | 15 - 60 minutes depending on account size |
Engineers running Google Firestore hit How to enable Customer-Managed Encryption Keys on Firestore often enough that there is a stable fix pattern. This page captures it in the order Google Cloud support would run it during a real incident.
What how to enable customer-managed encryption keys on firestore actually involves on Google Firestore
This task on Firestore is one of the more searched operational topics on AWS in the last 12 months. The procedure below is the path that works in a current AWS account with default IAM and standard VPC config.
The rest of this page is the structured fix path. Start with diagnose, then remediation, then the automation options so you do not have to do this by hand the next time it surfaces. Verify and safety sections at the end are the discipline that keeps the fix from regressing in production.
Diagnose first, fix second
Reproduce the failure with the gcloud CLI in --debug mode. The full SigV4 request payload it emits, plus the exact endpoint URL it resolved to, is what Google Cloud Support uses to verify policy, region, or parameter issues without you having to share IAM credentials. Save the debug output to a file with gcloud ... --debug 2> debug.log and you can search it for the failed aws.request entry.
Run gcloud auth list and gcloud config list first. About one in five 'why does this not work' tickets are actually 'I am in the wrong account' or 'my session expired and the SDK is using stale credentials or ADC pointed at the wrong project'. The 5-second sanity check costs nothing and saves real time when the answer is that simple.
Look at the Cloud Audit Log event for the failed call, even if you are not enrolled in Cloud Logging Log Router. The basic 90-day event history works for most diagnostic purposes and lives in the console under Cloud Audit Logs > Event history. Filter by event name (the API action) and time range; the event JSON shows the exact user identity, source IP, request parameters, and error code.
Solution-focused remediation path
If quotas are suspect, the Quotas page in Cloud Console (IAM & Admin > Quotas) console shows current usage and the active limit side by side. Request increases through Quotas page in Cloud Console (IAM & Admin > Quotas), not through Support tickets - quota dashboard requests usually approve faster (often within minutes for soft limits) and they are auditable in Cloud Audit Logs. Set up Quotas page in Cloud Console (IAM & Admin > Quotas) + Cloud Monitoring alert policys at 80 percent usage so you get notified before you hit the wall.
If you cannot reproduce the failure consistently, the cause is probably a race condition or a session-cache issue. Run the call with --profile set to a fresh STS session, in a different region you control, with a single concurrent request. If it works there but fails in your normal setup, the difference is the bug.
If the issue points at IAM, do not start by adding * to a policy. Use IAM Policy Troubleshooter and IAM Recommender against the failed action to see the minimum scope. Adding * is the fastest way to fail your next Google Cloud Architecture Framework security review, and it usually does not even fix the issue because the explicit deny is often coming from a higher level (Org Policy, RCP, or permission boundary), not a missing allow.
Automate this fix so you do not do it twice
Add a Cloud Monitoring alert policy so you know next time
The cheapest way to never see the same incident twice is a Cloud Monitoring alert policy on the metric that would have warned you. For Google Firestore, the relevant metrics live under compute.googleapis.com/google namespace or under custom metrics published by your Cloud Run service or GKE pod. Set thresholds based on observed normal range plus one or two standard deviations, not on round-number guesses. Cloud Monitoring anomaly-based alert policies remove the threshold-guessing problem entirely for metrics with regular seasonality.
Codify the fix in Terraform or Deployment Manager
When you reach for the console to fix the same issue twice, the third occurrence should be solved in IaC, not in the console. Terraform's terraform import and Deployment Manager or Terraform's resource importer let you adopt the existing resource into state without recreating it. Lock the corrected attribute behind a variable so the next operator does not have to rediscover the value. Add a moved {} block or Deployment Manager or Terraform resource refactor to keep the diff clean.
Automate the fix with the gcloud CLI
The CLI one-liner pattern for Google Firestore operations is roughly: gcloud google describe RESOURCE --format=json --filter ... to read state, gcloud google update RESOURCE --quiet to apply the change, and gcloud google describe RESOURCE --format=json --filter ... again to verify. Wrap it in a shell script that sets a region variable at the top and exits on first error with set -euo pipefail so a partial run does not leave the account in a half-fixed state.
# Template - replace placeholders with your account specifics
export GOOGLE_CLOUD_REGION=us-central1
export GOOGLE_CLOUD_PROJECT=prod-project
gcloud google describe RESOURCE --format=json --filter 'Resources[?Status==`FAILED`].[Id,Reason]' --output table
gcloud google modify-... --resource-id RESOURCE_ID --no-dry-run
gcloud google describe RESOURCE_ID --query 'Status'
Common pitfalls and what to watch for
The pitfall most teams hit on Google Firestore is moving too fast and skipping the read-only validation step. Before any write, list the current state and save it. Google Cloud APIs are eventually consistent for many resource types, so the validation snapshot is your only reliable reference if you need to undo. Save the output of the describe call to S3, not to your laptop.
Second pitfall: confusing IAM permission errors with networking errors. AccessDenied can be IAM (policy missing), networking (VPC endpoint policy blocking the call), or KMS (key policy missing). The error string looks identical for all three. Distinguish by looking at the Cloud Audit Log event's errorCode and the encoded authorization message; do not assume IAM is the culprit just because the message says AccessDenied.
Verify the fix worked
- Reproduce the original symptom path. If it still surfaces in any account or region or IAM role or service account, you have not fixed it.
- Watch for 24 to 48 hours. Cloud Monitoring metrics and Cloud Asset Inventory can mask issues with cached health for 6 to 12 hours, especially Cloud CDN and Cloud DNS.
- Run a smoke test under realistic load. Happy-path tests miss race conditions and IAM session-cache issues.
- Capture the new state in a runbook so the next person on call does not have to rediscover this. Push it to Confluence or your team wiki, not into Slack.
- If the fix involved a permission change, run IAM Access Analyzer one more time to confirm you did not open a separate hole while closing this one.
Safety, rollback, blast radius
- Test in a non-production account if your environment has Resource Manager and Organization Policy or Cloud Resource Manager (organizations, folders, projects). The cost of one sandbox account is cheaper than one rollback meeting.
- Export the existing config before changing it. Most Google Firestore resources support describe + export to JSON via CLI - capture that to source control before you start.
- Know your rollback path. Some Google Firestore operations are one-way (region migration, account-level feature opt-in, Cloud KMS key deletion past pending window). Confirm reversibility on the Google Cloud doc before you commit.
- Be aware of cross-service impact. IAM role or service account changes ripple to every service trusting that role. Cloud KMS key changes break every workload depending on that key. VPC endpoint changes affect every VPC consumer of that endpoint.
- Maintenance window discipline: if the change touches DNS, certificate rotation, or anything that emits TLS handshakes, line up a window with stakeholder notification, not a heroic mid-day swap.
FAQ
gcloud google describe-... first, then commit it before you change anything. A few operations are one-way (Cloud KMS key deletion past the pending window, region migration, account closure). Check the Google Cloud doc for the specific API before you commit.aws CLI or SDK calls - those almost always still work.References
- docs.cloud.google.com - official documentation for Google Firestore
- Google Cloud Community - community Q&A with Google-staff-verified answers
- Cloud Service Health Dashboard at health.cloud.google.com
- Quotas page in Cloud Console (IAM & Admin > Quotas) and Architecture Framework checklists
Related fixes
Related guides worth a look while you sort this one out:
- How to enable customer-managed encryption keys CMEK
- How to enable customer-managed encryption keys CMEK on Spanner
- Customer-managed encryption keys CMEK for BigQuery GCS GKE
- How to use Customer-Managed Encryption Keys CMEK on a bucket
- Set up Workbench with customer-managed encryption keys CMEK
- How to enable in-transit encryption TLS and AUTH