Use custom organization policies

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

• compute.googleapis.com/Router

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

Some subfields of resource.bgpPeers and resource.interfaces fields are not yet supported.

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.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the 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.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the 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.restrictPeerAsn. 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, compute.googleapis.com/Router.

• 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.bgpPeers.all(b, b.peerAsn == 61234)".

• 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

After you have created the YAML file for a new custom constraint, you must set it up to make it available for organization policies in your organization. To set up a custom constraint, use the gcloud org-policies set-custom-constraint command:

gcloud org-policies set-custom-constraint CONSTRAINT_PATH

Replace CONSTRAINT_PATH with the full path to your custom constraint file. For example, /home/user/customconstraint.yaml. Once completed, your custom constraints are available as organization policies in your list of Google Cloud organization policies. To verify that the custom constraint exists, use the gcloud org-policies list-custom-constraints command:

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

Replace ORGANIZATION_ID with the ID of your organization resource. For more information, see Viewing organization policies.

Enforce a custom organization policy

You can enforce a boolean constraint by creating an organization policy that references it, and then applying that organization policy to a Google Cloud resource.

Console

1. In the Google Cloud console, go to the Organization policies page.

   Go to Organization policies

2. From the project picker, select the project for which you want to set the organization policy.
3. From the list on the Organization policies page, select your constraint to view the Policy details page for that constraint.
4. To configure the organization policy for this resource, click Manage policy.
5. On the Edit policy page, select Override parent's policy.
6. Click Add a rule.
7. In the Enforcement section, select whether enforcement of this organization policy is on or off.
8. Optional: To make the organization policy conditional on a tag, click Add condition. Note that if you add a conditional rule to an organization policy, you must add at least one unconditional rule or the policy cannot be saved. For more information, see Setting an organization policy with tags.
9. If this is a custom constraint, you can click Test changes to simulate the effect of this organization policy. For more information, see Test organization policy changes with Policy Simulator.
10. To finish and apply the organization policy, click Set policy. The policy requires up to 15 minutes to take effect.

gcloud

To create an organization policy that enforces a boolean constraint, create a policy YAML file that references the constraint:

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

Replace the following:

• PROJECT_ID: the project on which you want to enforce your constraint.
• CONSTRAINT_NAME: the name you defined for your custom constraint. For example, custom.restrictPeerAsn.

To enforce the organization policy containing the constraint, run the following command:

    gcloud org-policies set-policy POLICY_PATH
    

Replace POLICY_PATH with the full path to your organization policy YAML file. The policy requires up to 15 minutes to take effect.

Test the custom organization policy

The following example creates a custom constraint and policy that requires all new Cloud Routers in a specific project to support only IPv6.

Before you begin, you should know the following:

• Your organization ID
• A project ID

Create the constraint

1. Save the following file as constraint-restrict-peer-asn.yaml:

   name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictPeerAsn
   resourceTypes:
   - compute.googleapis.com/Router
   methodTypes:
   - CREATE
   - UPDATE
   condition: "resource.bgpPeers.all(b, b.peerAsn == 61234)"
   actionType: ALLOW
   displayName: Restrict BGP peer ASNs.
   description: All BGP Peers must connect with peer ASN 61234.
   

   This defines a constraint where every BGO peer ASN in every Cloud Router must be the specified number.

2. Apply the constraint:

   gcloud org-policies set-custom-constraint ~/constraint-restrict-peer-asn.yaml
   

3. Verify that the constraint exists:

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

   The output is similar to the following:

   CUSTOM_CONSTRAINT                       ACTION_TYPE  METHOD_TYPES   RESOURCE_TYPES                      DISPLAY_NAME
   custom.restrictPeerAsn                  ALLOW        CREATE,UPDATE  compute.googleapis.com/Router       Restrict BGP peer ASNs.
   ...
   

Create the policy

1. Save the following file as policy-restrict-peer-asn.yaml:

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

   Replace PROJECT_ID with your project ID.

2. Apply the policy:

   gcloud org-policies set-policy ~/policy-restrict-peer-asn.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.restrictPeerAsn                 -              SET               COCsm5QGENiXi2E=
   

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

Test the policy

Create a Cloud Router with a single interface in the project:

 gcloud compute routers create r1 --region=us-central1
 gcloud compute routers add-interface r1 --region=us-central1 \
   --interface-name=i1 --vpn-tunnel=vpn-tunnel1

Try adding a BGP Peer:

 gcloud compute routers add-bgp-peer r1 --region=us-central1 \
   --peer-name=p1 --interface=i1 --peer-asn=61235 

The output is similar to the following:

Operation denied by custom org policies: ["customConstraints/custom.restrictPeerAsn": "BGP Peer ASN must be 61234."]

Example custom organization policies for common use cases

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

Description	Constraint syntax
Restrict BGP peer ASNs	name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictBgpPeerAsn resourceTypes: - compute.googleapis.com/Router methodTypes: - CREATE - UPDATE condition: "resource.bgpPeers.all(b, b.peerAsn == 61234)" actionType: ALLOW displayName: Restrict BGP peer ASNs. description: All BGP Peers must connect with peer ASN 61234.

Cloud Router supported resources

The following table lists the Cloud Router resources that you can reference in custom constraints.

Resource	Field
compute.googleapis.com/Router	resource.bgp.advertisedGroups
	resource.bgp.advertisedIpRanges.description
	resource.bgp.advertisedIpRanges.range
	resource.bgp.advertiseMode
	resource.bgp.asn
	resource.bgp.keepaliveInterval
	resource.bgpPeers.advertisedGroups
	resource.bgpPeers.advertisedIpRanges.description
	resource.bgpPeers.advertisedIpRanges.range
	resource.bgpPeers.advertisedRoutePriority
	resource.bgpPeers.advertiseMode
	resource.bgpPeers.customLearnedIpRanges.range
	resource.bgpPeers.customLearnedRoutePriority
	resource.bgpPeers.md5AuthenticationKeyName
	resource.bgpPeers.peerAsn
	resource.bgpPeers.routerApplianceInstance
	resource.description
	resource.encryptedInterconnectRouter
	resource.interfaces.linkedVpnTunnel
	resource.interfaces.subnetwork
	resource.md5AuthenticationKeys.name
	resource.name
	resource.nats.autoNetworkTier
	resource.nats.drainNatIps
	resource.nats.enableDynamicPortAllocation
	resource.nats.enableEndpointIndependentMapping
	resource.nats.endpointTypes
	resource.nats.icmpIdleTimeoutSec
	resource.nats.logConfig.enable
	resource.nats.logConfig.filter
	resource.nats.maxPortsPerVm
	resource.nats.minPortsPerVm
	resource.nats.name
	resource.nats.natIpAllocateOption
	resource.nats.natIps
	resource.nats.rules.action.sourceNatActiveIps
	resource.nats.rules.action.sourceNatActiveRanges
	resource.nats.rules.action.sourceNatDrainIps
	resource.nats.rules.action.sourceNatDrainRanges
	resource.nats.rules.description
	resource.nats.rules.match
	resource.nats.rules.ruleNumber
	resource.nats.sourceSubnetworkIpRangesToNat
	resource.nats.subnetworks.name
	resource.nats.subnetworks.secondaryIpRangeNames
	resource.nats.subnetworks.sourceIpRangesToNat
	resource.nats.tcpEstablishedIdleTimeoutSec
	resource.nats.tcpTimeWaitTimeoutSec
	resource.nats.tcpTransitoryIdleTimeoutSec
	resource.nats.type
	resource.nats.udpIdleTimeoutSec
	resource.nccGateway
	resource.network

What's next

• To troubleshoot issues when using Cloud Router, see Troubleshooting.
• 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.