Use custom organization policies

Stay organized with collections Save and categorize content based on your preferences.

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

• cloudquotas.googleapis.com/QuotaPreference

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.

Limitations

Custom organization policy enforcement restricts operations that create or update QuotaPreference resources. The following limitations apply because some quota change scenarios don't create or update QuotaPreference resources:

• When using the Service Usage API: Quota value changes initiated through the Service Usage API aren't subject to custom organization policy enforcement because they don't change QuotaPreference resources. To restrict quota value changes initiated through the Service Usage API, implement an IAM deny policy on the serviceusage.quota.update permission.

• When initiating quota changes in the Google Cloud console: Quota value changes initiated using the Google Cloud console aren't subject to custom organization policy enforcement because the Google Cloud console does not create QuotaPreference resources.

• When using the quota adjuster: When quota adjuster is enabled, it can adjust quota values on your behalf. These adjustments aren't subject to custom organization policy enforcement because they don't create QuotaPreference resources.

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. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

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

   gcloud init

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

   Go to project selector

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

9. Install the Google Cloud CLI.

10. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

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

    gcloud init

12. 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.restrictQuotaChangeCpusPerProjectPerRegion. 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, cloudquotas.googleapis.com/cloudquotas.googleapis.com/QuotaPreference.

• 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.service == compute.googleapis.com && resource.quotaId == CPUS-per-project-region".

• 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

The following examples create a custom constraint and policy that deny all QuotaPreference settings in a specific project for the compute.googleapis.com service, which has a CPUS-per-project-region quota ID.

Before you begin, you need to know the following:

• Your organization ID
• Your project ID

In the examples that follow, replace ORGANIZATION_ID and PROJECT_ID with the strings for your configuration.

Create an example constraint

The following code snippet shows an example of creating a quota preference constraint. When creating your own quota preference constraints, update these fields as needed for your configuration.

1. Save the following file as quota-constraint.yaml:

   name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictCPUsPerProjectRegion
   resourceTypes:
     - cloudquotas.googleapis.com/QuotaPreference
   methodTypes:
     - CREATE
     - UPDATE
   condition: "resource.service == 'compute.googleapis.com' && resource.quotaId == 'CPUS-per-project-region'"
   actionType: DENY
   displayName: Restrict quota update for compute CPUS-per-project-region
   description: Deny quota change for the 'CPUS-per-project-region' quota ID of 'compute.googleapis.com' service.
   

   Replace the following:

   • ORGANIZATION_ID: your organization ID. For help finding your organization ID, see Getting your organization resource ID.

   This defines a constraint where quota cannot be changed for the CPUS-per-project-region quota ID of compute.googleapis.com service.

2. Apply the constraint:

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

3. Verify that the constraint exists:

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

4. The output is similar to the following:

   CUSTOM_CONSTRAINT                    ACTION_TYPE  METHOD_TYPES   RESOURCE_TYPES                              DISPLAY_NAME
   custom.restrictCPUsPerProjectRegion  DENY         CREATE,UPDATE  cloudquotas.googleapis.com/QuotaPreference  Restrict quota update for compute CPUS-per-project-region
   

Create the policy

1. Save the following file as quota-policy.yaml:

   name: projects/PROJECT_ID/policies/custom.restrictCPUsPerProjectRegion
   spec:
     rules:
     - enforce: true
   

   Replace PROJECT_ID with your project ID.

2. Apply the policy:

   gcloud org-policies set-policy quota-policy.yaml
   

3. Verify that the policy exists:

   gcloud org-policies list --project=PROJECT_ID
   

   The output is similar to the following:

   CONSTRAINT                           LIST_POLICY  BOOLEAN_POLICY  ETAG
   custom.restrictCPUsPerProjectRegion  -            SET             CNXIq78GEODKiK4D-
   
   

After you apply the policy, wait for about two minutes for Google Cloud to start enforcing the policy.

Test the policy

To test the policy, create a quota preference request:

• For example, run the following gcloud CLI command to create a quota preference for Compute Engine:

  gcloud beta quotas preferences create \
      --service=compute.googleapis.com \
      --quota-id=CPUS-per-project-region \
      --preferred-value=30 \
      --project=PROJECT_ID
  

• The output is similar to the following:

  Operation denied by org policy on resource 'projects/PROJECT_ID/locations/global': ["customConstraints/custom.restrictCPUsPerProjectRegion": "Deny quota change for the 'CPUS-per-project-region' quota ID of 'compute.googleapis.com' service."]
  

Delete the example policy and constraint

After you have tested the policy, you can delete it:

1. Delete the policy:

   gcloud org-policies delete custom.restrictCPUsPerProjectRegion --project=PROJECT_ID
   

2. Delete the constraint:

   gcloud org-policies delete-custom-constraint custom.restrictCPUsPerProjectRegion \
     --organization=ORGANIZATION_ID
   

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.restrictCPUsPerProjectRegionQuota
  resourceTypes:
    - cloudquotas.googleapis.com/QuotaPreference
  methodTypes:
    - CREATE
    - UPDATE
  condition: |-
    resource.service == 'compute.googleapis.com'
     && resource.quotaId == 'CPUS-per-project-region'
  actionType: DENY
  displayName: Deny quota update for compute CPUS-per-project-region
  description: Deny quota change for the 'CPUS-per-project-region' quota ID of 'compute.googleapis.com' service.
  

  name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictCPUsPerProjectRegionQuotaLimit
  resourceTypes:
    - cloudquotas.googleapis.com/QuotaPreference
  methodTypes:
    - CREATE
    - UPDATE
  condition: |-
    resource.service == 'compute.googleapis.com'
     && resource.quotaId == 'CPUS-per-project-region'
     && resource.quotaConfig.preferredValue <= 25
  actionType: ALLOW
  displayName: Restrict quota update for compute CPUS-per-project-region
  description: Restrict quota change for the 'CPUS-per-project-region' quota ID of 'compute.googleapis.com' service.

Cloud Quotas 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.