Manage VPC resources by using custom organization policies

Google Cloud Organization Policy 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 a custom 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.

Virtual Private Cloud supported resources

For VPC, you can set custom constraints on the following resources and fields.

  • Network: compute.googleapis.com/Network
    • Name: resource.name
    • Description: resource.description
    • Mode: resource.autoCreateSubnetworks
    • MTU setting: resource.mtu
    • Firewall enforcement order: resource.networkFirewallPolicyEnforcementOrder
    • Internal IPv6 setting: resource.enableUlaInternalIpv6
    • Internal IPv6 range: resource.internalIpv6Range
    • Routing mode: resource.routingConfig.routingMode
  • Subnetwork: compute.googleapis.com/Subnetwork
    • Name: resource.name
    • Description: resource.description
    • Network: resource.network
    • IP CIDR range: resource.ipCidrRange
    • Secondary IP address ranges: resource.secondaryIpRanges[]
      • Range name:resource.secondaryIpRanges[].rangeName
      • IP CIDR range: resource.secondaryIpRanges[].ipCidrRange
    • Stack type: resource.stackType
    • IPv6 access type: resource.ipv6AccessType
    • Private Google Access setting: resource.privateIpGoogleAccess
    • Subnet purpose: resource.purpose
    • Role: resource.role
    • VPC Flow Logs:
      • Logging configuration: resource.logConfig.enable
      • Aggregation interval: resource.logConfig.aggregationInterval
      • Sampling rate: resource.logConfig.flowSampling
      • Metadata: resource.logConfig.metadata
      • Metadata fields: resource.logConfig.metadataFields[]
      • Filter expression: resource.logConfig.filterExpr
  • Route: compute.googleapis.com/Route
    • Name: resource.name
    • Description: resource.description
    • Network: resource.network
    • Tags: resource.tags
    • Destination range: resource.destRange
    • Priority: resource.priority
    • Next hop instance: resource.nextHopInstance
    • Next hop IP address: resource.nextHopIp
    • Next hop gateway: resource.nextHopGateway
    • Next hop internal passthrough Network Load Balancer: resource.nextHopIlb
    • Next hop VPN tunnel: resource.nextHopVpnTunnel
  • Packet Mirroring: compute.googleapis.com/PacketMirroring
    • Name: resource.name
    • Description: resource.description
    • Network URL: resource.network.url
    • Priority: resource.priority
    • Collector ILB URL: resource.collectorIlb.url
    • Mirrored resources:
      • Subnetworks URL: resource.mirroredResources.subnetworks[].url
      • Instances URL: resource.mirroredResources.instances[].url
      • Tags: resource.mirroredResources.tags[]
    • Filter:
      • CIDR ranges: resource.filter.cidrRanges[]
      • IP Protocols: resource.filter.IPProtocols[]
      • Direction: resource.filter.direction
    • Enable: resource.enable

Before you begin

  • If you haven't already, then set up authentication. Authentication is the process by which your identity is verified for access to Google Cloud services and APIs. To run code or samples from a local development environment, you can authenticate to Compute Engine by selecting one of the following options:

    Select the tab for how you plan to use the samples on this page:

    Console

    When you use the Google Cloud console to access Google Cloud services and APIs, you don't need to set up authentication.

    gcloud

    1. Install the Google Cloud CLI, then initialize it by running the following command: 

      gcloud init
    2. Set a default region and zone.

    REST

    To use the REST API samples on this page in a local development environment, you use the credentials you provide to the gcloud CLI.

      Install the Google Cloud CLI, then initialize it by running the following command: 

      gcloud init

    For more information, see Authenticate for using REST in the Google Cloud authentication documentation.

Required roles

To get the permissions that you need to manage organization policies for VPC resources, ask your administrator to grant you the following IAM roles:

For more information about granting roles, see Manage access to projects, folders, and organizations.

These predefined roles contain the permissions required to manage organization policies for VPC resources. To see the exact permissions that are required, expand the Required permissions section:

Required permissions

The following permissions are required to manage organization policies for VPC resources:

  • orgpolicy.constraints.list
  • orgpolicy.policies.create
  • orgpolicy.policies.delete
  • orgpolicy.policies.list
  • orgpolicy.policies.update
  • orgpolicy.policy.get
  • orgpolicy.policy.set

You might also be able to get these permissions with custom roles or other predefined roles.

Set up a custom constraint

A custom constraint is defined 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 by 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.

You can create a custom constraint and set it up for use in organization policies using the Google Cloud console or Google Cloud CLI.

Console

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

    Go to Organization policies

  2. Select the Project picker at the top of the page.

  3. From the Project picker, select the resource for which you want to set the organization policy.

  4. Click Custom constraint.

  5. In the Display name box, enter a human-friendly name for the constraint. This field has a maximum length of 200 characters. Don't use PII or sensitive data in constraint names, because they could be exposed in error messages.

  6. In the Constraint ID box, enter 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.createCustomNetworks. The maximum length of this field is 70 characters, not counting the prefix, for example, organizations/123456789/customConstraints/custom..

  7. In the Description box, enter 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 2,000 characters.

  8. In the Resource type box, select the name of the Google Cloud REST resource containing the object and field you want to restrict. For example, compute.googleapis.com/Network.

  9. Under Enforcement method, select whether to enforce the constraint on the REST CREATE method.

  10. To define a condition, click Edit condition.

    1. In the Add condition panel, create a CEL condition that refers to a supported service resource. This field has a maximum length of 1,000 characters.

    2. Click Save.

  11. Under Action, select whether to allow or deny the evaluated method if the above condition is met.

  12. Click Create constraint.

When you have entered a value into each field, the equivalent YAML configuration for this custom constraint appears on the right.

gcloud

To create a custom constraint using the Google Cloud CLI, create a YAML file for the custom constraint:

name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
resourceTypes: compute.googleapis.com/RESOURCE_NAME
methodTypes:
- CREATE
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.createCustomNetworks. The maximum length of this field is 70 characters, not counting the prefix, for example, organizations/123456789/customConstraints/custom..

  • RESOURCE_NAME: the name (not the URI) of the Compute Engine API REST resource containing the object and field you want to restrict. For example, Network.

  • 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.

  • ACTION: the action to take if the condition is met. This can be either ALLOW or 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 2,000 characters.

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

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 constraint

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.createCustomNetworks.

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.

Example: Create a constraint that restricts networks to custom mode

gcloud

  1. Create a onlyCustomNetwork.yaml constraint file with the following information. Replace ORGANIZATION_ID with your organization ID.

    name: organizations/ORGANIZATION_ID/customConstraints/custom.createOnlyCustomNetwork
resourceTypes: compute.googleapis.com/Network
condition: "resource.autoCreateSubnetworks == false"
actionType: ALLOW
methodTypes: CREATE
displayName: Restrict creation of networks to custom mode networks
description: Only custom mode networks allowed.

  2. Set the custom constraint.

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

  3. Create a onlyCustomNetwork-policy.yaml policy file with the following information. In this example we enforce this constraint at the project level but you might also set this at the organization or folder level. Replace PROJECT_ID with your project ID.

          name: projects/PROJECT_ID/policies/custom.onlyCustomNetwork
      spec:
        rules:
        – enforce: true

  4. Enforce the policy.

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

  5. Test the constraint by trying to create an auto mode VPC network.

    gcloud compute networks create vpc1
    --project=PROJECT_ID \
    --subnet-mode=auto

    The output is similar to the following:

    ERROR: (gcloud.compute.networks.create) Could not fetch resource:
- Operation denied by custom org policy: [customConstraints/custom.createOnlyCustomNetwork] : Only custom mode networks allowed.

Example custom constraints for common use cases

The following sections provide the syntax of some custom constraints that you might find useful.

Require networks to have an internal IPv6 range

name: organizations/ORGANIZATION_ID/customConstraints/custom.networkInternalIpv6Range
resourceTypes: compute.googleapis.com/Network
condition: "resource.enableUlaInternalIpv6 == true"
actionType: ALLOW
methodTypes: CREATE
displayName: Require networks to have an internal IPv6 range
description: Networks must have a ULA internal IPv6 range configured

Require subnets to use ranges in 10.0.0.0/8

name: organizations/ORGANIZATION_ID/customConstraints/custom.subnetRangeUse10Slash8
resourceTypes: compute.googleapis.com/Subnetwork
condition: "resource.ipCidrRange.startsWith('10.')"
actionType: ALLOW
methodTypes: CREATE
displayName: Require subnets to use ranges in 10.0.0.0/8
description: Subnetwork's primary IPv4 range must come from 10.0.0.0/8

Require next-hop-ilb routes to be specified by IP address

Require that routes that use next-hop-ilb be specified by using the IP address instead of the forwarding rule resource name.

name: organizations/ORGANIZATION_ID/customConstraints/custom.routeNextHopIlbByIpAddress
resourceTypes: compute.googleapis.com/Route
condition: "!resource.nextHopIlb.contains('forwardingRules')"
actionType: ALLOW
methodTypes: CREATE
displayName: Require defining next-hop-ilb by IP address
description: Next hops that are an internal load balancer must be specified by IP address instead of resource name.

Require Packet Mirroring to mirror TCP traffic only

name: organizations/ORGANIZATION_ID/customConstraints/custom.packetMirroringTcpFilter
resourceTypes: compute.googleapis.com/PacketMirroring
condition: "resource.filter.IPProtocols.size() == 1 && resource.filter.IPProtocols[0] == 'tcp'"
actionType: ALLOW
methodTypes:
  - CREATE
  - UPDATE
displayName: Require policies to mirror TCP protocol only.
description: Packet mirroring must mirror all TCP traffic and no other protocols.

Pricing

The Organization Policy Service, including predefined and custom organization policies, is offered at no charge.

Limitations

  • Custom constraints are only enforced on the CREATE method for route resources.

What's next