Manage Firestore resources using custom constraints

This page shows you how to use Organization Policy Service custom constraints to restrict specific operations on the following Google Cloud resources:

• firestore.googleapis.com/Database

To learn more about Organization Policy, see Custom organization policies.

About organization policies and constraints

The Google Cloud Organization Policy Service gives you centralized, programmatic control over your organization's resources. As the organization policy administrator, you can define an organization policy, which is a set of restrictions called constraints that apply to Google Cloud resources and descendants of those resources in the Google Cloud resource hierarchy. You can enforce organization policies at the organization, folder, or project level.

Organization Policy provides predefined constraints for various Google Cloud services. However, if you want more granular, customizable control over the specific fields that are restricted in your organization policies, you can also create custom constraints and use those custom constraints in an organization policy.

Policy inheritance

By default, organization policies are inherited by the descendants of the resources on which you enforce the policy. For example, if you enforce a policy on a folder, Google Cloud enforces the policy on all projects in the folder. To learn more about this behavior and how to change it, refer to Hierarchy evaluation rules.

Benefits

• Security, compliance, and governance: you can use custom organization policies as follows:

  • To enforce disaster recovery requirements, you can require specific disaster recovery settings on databases like delete protection, and point in time recovery.

  • You can restrict database creation to only certain locations.

  • You can require CMEK (Customer Managed Encryption Key) for databases.

• Auditing: Custom org policy constraints are audit logged. Any operation including constraint modifications and constraint checks will generate corresponding Cloud Audit Logs.

Before you begin

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. Install the Google Cloud CLI.

5. To initialize the gcloud CLI, run the following command:

   gcloud init

6. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Go to project selector

7. Make sure that billing is enabled for your Google Cloud project.

8. Install the Google Cloud CLI.

9. To initialize the gcloud CLI, run the following command:

   gcloud init

10. Ensure that you know your organization ID.

Required roles

To get the permissions that you need to manage custom organization policies, ask your administrator to grant you the Organization Policy Administrator (roles/orgpolicy.policyAdmin) IAM role on the organization resource. For more information about granting roles, see Manage access to projects, folders, and organizations.

You might also be able to get the required permissions through custom roles or other predefined roles.

Create a custom constraint

A custom constraint is defined in a YAML file by the resources, methods, conditions, and actions that are supported by the service on which you are enforcing the organization policy. Conditions for your custom constraints are defined using Common Expression Language (CEL). For more information about how to build conditions in custom constraints using CEL, see the CEL section of Creating and managing custom constraints.

To create a custom constraint, create a YAML file using the following format:

name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
resourceTypes:
- RESOURCE_NAME
methodTypes:
- CREATE
- UPDATE
condition: "CONDITION"
actionType: ACTION
displayName: DISPLAY_NAME
description: DESCRIPTION

Replace the following:

• ORGANIZATION_ID: your organization ID, such as 123456789.

• CONSTRAINT_NAME: the name you want for your new custom constraint. A custom constraint must start with custom., and can only include uppercase letters, lowercase letters, or numbers. For example, custom.deleteProtectionRequired. The maximum length of this field is 70 characters.

• RESOURCE_NAME: the fully qualified name of the Google Cloud resource containing the object and field you want to restrict. For example, firestore.googleapis.com/Database.

• CONDITION: a CEL condition that is written against a representation of a supported service resource. This field has a maximum length of 1000 characters. See Supported resources for more information about the resources available to write conditions against. For example, "resource.deleteProtectionState == \"DELETE_PROTECTION_ENABLED\"".

• ACTION: the action to take if the condition is met. Possible values are ALLOW and DENY.

• DISPLAY_NAME: a human-friendly name for the constraint. This field has a maximum length of 200 characters.

• DESCRIPTION: a human-friendly description of the constraint to display as an error message when the policy is violated. This field has a maximum length of 2000 characters.

For more information about how to create a custom constraint, see Defining custom constraints.

Set up a custom constraint

gcloud org-policies set-custom-constraint CONSTRAINT_PATH

gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID

Enforce a custom organization policy

      name: projects/PROJECT_ID/policies/CONSTRAINT_NAME
      spec:
        rules:
        - enforce: true
    

    gcloud org-policies set-policy POLICY_PATH
    

Test the custom organization policy

Before you begin, you must know the following:

• Your organization ID

1. Create the deleteProtectionRequired.yaml file as follows:

    name: organizations/ORGANIZATION_ID/customConstraints/custom.deleteProtectionRequired
    resourceTypes:
    - firestore.googleapis.com/Database
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.deleteProtectionState == \"DELETE_PROTECTION_ENABLED\""
    actionType: ALLOW
    displayName: Firestore Delete Protection Required
    description: To ensure the data security, Delete Protection is required to be enabled for Firestore databases.
   

   This ensures that all CREATE and UPDATE methods on a Firestore database meet the constraint of deleteProtectionState being DELETE_PROTECTION_ENABLED. As a result, any databases create/update/restore/clone operations without explicitly enabling Delete Protection are rejected.

2. Set up the custom constraint at the organization level:

   gcloud org-policies set-custom-constraint deleteProtectionRequired.yaml
   

Test the policy

Try to create a database without setting the --delete-protection flag in a project in the organization:

gcloud firestore database create \
   --project=PROJECT_ID \
   --database=DATABASE_ID \

The output is the following:

Operation denied by custom org policies: ["customConstraints/custom.deleteProtectionRequired": "To ensure the data security, Delete Protection is required to be enabled for Firestore databases"]

Test and analyze organization policy changes

We recommend that you test and dry-run all changes to your organization policies, to better understand the state of your environment and how changes affect it.

Policy Simulator for Organization Policy helps you understand the effect of a constraint and organization policy on your current environment. Using this tool, you can review all resource configurations to see where violations occur, before it is enforced on your production environment. For detailed instructions, see Test organization policy changes with Policy Simulator.

When you understand the current effect, you can create an organization policy in dry-run mode to understand the impact and potential violations of a policy over the next 30 days. An organization policy in dry-run mode is a type of organization policy where violations of the policy are audit-logged, but the violating actions aren't denied. You can create an organization policy in dry-run mode from a custom constraint using the Google Cloud console or Google Cloud CLI. For detailed instructions, see Create an organization policy in dry-run mode.

Example custom organization policies for common use cases

The following table provides the syntax of some custom constraints for common use cases:

name: organizations/ORGANIZATION_ID/customConstraints/custom.nameSuffixMobile
resourceTypes:
- firestore.googleapis.com/Database
methodTypes:
- CREATE
condition: "resource.name.endsWith('-mobile')"
actionType: ALLOW
displayName: Firestore database names end with "-mobile"
description: Only allow the creation of database names ending with suffix "-mobile"

name: organizations/ORGANIZATION_ID/customConstraints/custom.locationUsCentral1
resourceTypes:
- firestore.googleapis.com/Database
methodTypes:
- CREATE
condition: "resource.locationId == 'us-central1'"
actionType: ALLOW
displayName: Firestore database location id us-central1
description: Only allow the creation of databases in region us-central1

name: organizations/ORGANIZATION_ID/customConstraints/custom.typeFirestore
resourceTypes:
- firestore.googleapis.com/Database
methodTypes:
- CREATE
- UPDATE
condition: "resource.type=="FIRESTORE_NATIVE""
actionType: ALLOW
displayName: Firestore database type Firestore_Native
description: Only allow creation and updating of databases if the type is Firestore in native mode.

name: organizations/ORGANIZATION_ID/customConstraints/custom.concurrencyNotPessimistic
resourceTypes:
- firestore.googleapis.com/Database
methodTypes:
- CREATE
- UPDATE
condition: "resource.concurrencyMode == 'PESSIMISTIC'"
actionType: DENY
displayName: Firestore database concurrencyMode not pessimistic
description: Disallow the creation and updating of databases with pessimistic concurrency mode.

name: organizations/ORGANIZATION_ID/customConstraints/custom.pitrEnforce
resourceTypes:
- firestore.googleapis.com/Database
methodTypes:
- CREATE
- UPDATE
condition: "resource.pointInTimeRecoveryEnablement == "POINT_IN_TIME_RECOVERY_ENABLED""
actionType: ALLOW
displayName: Firestore database enables PiTR
description: Only allow the creation and updating of a databases if PiTR is enabled.

name: organizations/ORGANIZATION_ID/customConstraints/custom.enableAppEngineIntegrationMode
resourceTypes:
- firestore.googleapis.com/Database
methodTypes:
- CREATE
- UPDATE
condition: "resource.appEngineIntegrationMode == 'ENABLED'"
actionType: ALLOW
displayName: Firestore Database App Engine integration mode enabled
description: Only allow the creation and updating of databases with App Engine Integration Mode enabled.

name: organizations/ORGANIZATION_ID/customConstraints/custom.deleteProtectionRequired
resourceTypes:
- firestore.googleapis.com/Database
methodTypes:
- CREATE
- UPDATE
condition: "resource.deleteProtectionState == "DELETE_PROTECTION_ENABLED""
actionType: ALLOW
displayName: Firestore Delete Protection Required
description: To ensure the data security, Delete Protection is required to be enabled for Firestore databases.
    

name: organizations/ORGANIZATION_ID/customConstraints/custom.cmekKeyNotDev
resourceTypes:
- firestore.googleapis.com/Database
methodTypes:
- CREATE
- UPDATE
condition: "resource.cmekConfig.kmsKeyName.matches('dev$')"
actionType: DENY
displayName: Firestore database CMEK key not dev
description: Disallow the creation and updating of databases with CMEK KMS keys ending with "dev".

Firestore supported resources

What's next

• Learn more about Organization Policy Service.
• Learn more about how to create and manage organization policies.
• See the full list of predefined organization policy constraints.