Use 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 organization policies.

By implementing a custom organization policy you enforce consistent configurations and restrictions. This verifies that your AlloyDB for PostgreSQL clusters, instances, and backups adhere to security best practices and regulatory requirements.

If you attempt to create or update a cluster, instance, or backup while the custom constraint is enforced and noncompliant with the constraint, then the operation fails. Any project added to the organization or folder that uses a custom organization policy inherits the constraints of that 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.

Pricing

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

Limitations

Like all organization policy constraints, policy changes don't apply retroactively to existing AlloyDB for PostgreSQL clusters, instances, and backups.

A new policy doesn't impact an existing cluster, instance, and backup configurations.
An existing cluster, instance, and backup configuration remains valid, unless you change the cluster, instance, or backup configuration from a compliance to non-compliance state using the Google Cloud console, Google Cloud CLI, or RPC.
A scheduled maintenance update doesn't cause a policy enforcement, because maintenance doesn't change the configuration of the cluster, instance, or backup.
Backups created using the Continuous Backup and Recovery, and the Automated Backups features won't be constrained by the policies themselves.

Before you begin

Set up your project.
1. Verify that you know your organization ID.

Required roles

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

Organization policy administrator (roles/orgpolicy.policyAdmin) on the organization resource
To create or update an AlloyDB cluster: AlloyDB Admin (roles/alloydb.admin) on the project 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.

Organization policies are defined by the values set for each constraint. An organization policy administrator can create custom constraints to restrict public IP configurations of AlloyDB at the project, folder, or organization level.

You can create a custom constraint—for example, customConstraints/custom.restrictPublicIP, to limit public IP access on AlloyDB instances. This boolean constraint restricts configuring public IP on AlloyDB instances where this constraint is set. This constraint isn't retroactive. AlloyDB instances with existing public IP access still work even after this constraint is enforced.

By default, public IP access to AlloyDB instances is allowed.

Create a YAML file for a custom constraint as follows:

name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
resourceTypes:
- alloydb.googleapis.com/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.restrictPublicIP. 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 AlloyDB REST resource containing the object and field you want to restrict. For example, Instance.
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 custom constraint for more information about the resources available to write conditions against. For example, "resource.networkConfig.enablePublicIp == true".
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 2000 characters.

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

Set up a custom constraint

Console

To create a custom constraint, do the following:

In the Google Cloud console, go to the Organization policies page.
Go to Organization policies
From the project picker, select the project that you want to set the organization policy for.
Click Custom constraint.
In the Display name box, enter a human-readable name for the constraint. This name is used in error messages and can be used for identification and debugging. Don't use PII or sensitive data in display names because this name could be exposed in error messages. This field can contain up to 200 characters.
In the Constraint ID box, enter the name that you want for your new custom constraint. A custom constraint can only contain letters (including upper and lowercase) or numbers, for example custom.disableGkeAutoUpgrade. This field can contain up to 70 characters, not counting the prefix (custom.), for example, organizations/123456789/customConstraints/custom. Don't include PII or sensitive data in your constraint ID, because it could be exposed in error messages.
In the Description box, enter a human-readable description of the constraint. This description is used as an error message when the policy is violated. Include details about why the policy violation occurred and how to resolve the policy violation. Don't include PII or sensitive data in your description, because it could be exposed in error messages. This field can contain up to 2000 characters.
In the Resource type box, select the name of the Google Cloud REST resource containing the object and field that you want to restrict—for example, container.googleapis.com/NodePool. Most resource types support up to 20 custom constraints. If you attempt to create more custom constraints, the operation fails.
Under Enforcement method, select whether to enforce the constraint on a REST CREATE method or on both CREATE and UPDATE methods. If you enforce the constraint with the UPDATE method on a resource that violates the constraint, changes to that resource are blocked by the organization policy unless the change resolves the violation.

Not all Google Cloud services support both methods. To see supported methods for each service, find the service in Supported services.

To define a condition, click Edit condition.

In the Add condition panel, create a CEL condition that refers to a supported service resource, for example, resource.management.autoUpgrade == false. This field can contain up to 1000 characters. For details about CEL usage, see Common Expression Language. For more information about the service resources you can use in your custom constraints, see Custom constraint supported services.
Click Save.

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

The deny action means that the operation to create or update the resource is blocked if the condition evaluates to true.

The allow action means that the operation to create or update the resource is permitted only if the condition evaluates to true. Every other case except ones explicitly listed in the condition is blocked.

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, create a YAML file using the following format:

      name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
      resourceTypes:
      - 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 that you want for your new custom constraint. A custom constraint can only contain letters (including upper and lowercase) or numbers, for example, custom.restrictPublicIP. This field can contain up to 70 characters.
RESOURCE_NAME: the fully qualified name of the Google Cloud resource containing the object and field that you want to restrict. For example, Instance.
CONDITION: a CEL condition that is written against a representation of a supported service resource. This field can contain up to 1000 characters. For example, "resource.networkConfig.enablePublicIp == true".

For more information about the resources available to write conditions against, see Supported resources.

ACTION: the action to take if the condition is met. Can only be ALLOW.

The allow action means that if the condition evaluates to true, the operation to create or update the resource is permitted. This also means that every other case except the one explicitly listed in the condition is blocked.

DISPLAY_NAME: a human-friendly name for the constraint. This field can contain up to 200 characters.
DESCRIPTION: a human-friendly description of the constraint to display as an error message when the policy is violated. This field can contain up to 2000 characters.

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.

After this operation is complete, 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 constraint by creating an organization policy that references it, and then applying that organization policy to a Google Cloud resource.

Console

In the Google Cloud console, go to the Organization policies page.
Go to Organization policies
From the project picker, select the project that you want to set the organization policy for.
From the list on the Organization policies page, select your constraint to view the Policy details page for that constraint.
To configure the organization policy for this resource, click Manage policy.
On the Edit policy page, select Override parent's policy.
Click Add a rule.
In the Enforcement section, select whether this organization policy is enforced or not.
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.
Click Test changes to simulate the effect of the organization policy. For more information, see Test organization policy changes with Policy Simulator.
To enforce the organization policy in dry-run mode, click Set dry run policy. For more information, see Create an organization policy in dry-run mode.
After you verify that the organization policy in dry-run mode works as intended, set the live policy by clicking Set policy.

gcloud

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

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

Replace the following:

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

To enforce the organization policy in dry-run mode, run the following command with the dryRunSpec flag:

        gcloud org-policies set-policy POLICY_PATH \
          --update-mask=dryRunSpec

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

After you verify that the organization policy in dry-run mode works as intended, set the live policy with the org-policies set-policy command and the spec flag:

        gcloud org-policies set-policy POLICY_PATH \
          --update-mask=spec

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

Supported custom constraints and operations

You can enforce custom constraints on AlloyDB instance, cluster, and backup resources. All v1 fields on the AlloyDB instance, cluster, and backup resources are supported for the custom constraint. You can enforce custom constraints during the following AlloyDB operations:

Instance creation
Instance update
Cluster creation
Cluster update
Backup creation

This section provides examples of the following common custom constraints:

Restrict public IP access using organization policies
Limit the CIDR range of Authorized Networks
Limit the number of Authorized Networks
Enforce mandatory tags using organization policies
Enforce continuous backups for all clusters
Restrict on-demand backup for specific clusters

Restrict public IP access using organization policies

    name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictPublicIP
    resourceTypes:
    - alloydb.googleapis.com/Instance
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.networkConfig.enablePublicIp == true"
    actionType: DENY
    displayName: Restrict public IP access on AlloyDB instances
    description: Prevent users from enabling public IP on instance creation and update.

Supported operations:

Instance creation
Instance update

Limit the CIDR range of authorized networks

    name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictCidrRange
    resourceTypes:
      - alloydb.googleapis.com/Instance
    methodTypes:
      - CREATE
      - UPDATE
    condition: "resource.networkConfig.authorizedExternalNetworks.exists(net, ['/0', '/1', '/2', '/n'].exists(ending, net.cidrRange.endsWith(ending)))"
    actionType: DENY
    displayName: "Restrict large CIDR ranges for AlloyDB Authorized Networks"
    description: "Prevents AlloyDB instances from being created or updated with an authorized network CIDR range larger than /n (i.e., a prefix length less than n, e.g., 16)."

Replace ORGANIZATION_ID with the organization ID.

Supported operations:

Instance creation
Instance update

Limit the number of authorized networks

    name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictAuthorizedNetworksCount
    resourceTypes:
      - alloydb.googleapis.com/Instance
    methodTypes:
      - CREATE
      - UPDATE
    condition: "resource.networkConfig.authorizedExternalNetworks.size() > 1"
    actionType: DENY
    displayName: "Limit the number of AlloyDB Authorized Networks"
    description: "Prevents AlloyDB instances from being created or updated with more than a specified number of Authorized Networks."

Replace ORGANIZATION_ID with the organization ID.

Supported operations:

Instance creation
Instance update

Enforce mandatory tags using organization policies

    name: organizations/ORGANIZATION_ID/customConstraints/custom.enforceMandatoryTags
    resourceTypes:
    - alloydb.googleapis.com/Cluster
    methodTypes:
    actionType: ALLOW
    displayName: Enforce mandatory tags on AlloyDB cluster resource.
    description: Prevent users from cluster creation if mandatory tags are not provided.

Replace TAG_NAME with the tag name.

Supported operations: Supported operations:

Cluster creation
Backup creation

Enforce continuous backups for all clusters

    name: organizations/ORGANIZATION_ID/customConstraints/custom.enforceContBackupConfig
    resourceTypes:
    - alloydb.googleapis.com/Cluster
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.continuousBackupConfig.enabled == false"
    actionType: DENY
    displayName: Enforce continuous backup configuration on AlloyDB clusters
    description: Prevent users from disabling continuous backup configuration on cluster creation and update.

Supported operations:

Cluster creation
Cluster update

Restrict on-demand backup for specific clusters

    name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictOnDemandBackup
    resourceTypes:
    - alloydb.googleapis.com/Backup
    methodTypes:
    - CREATE
    condition: "resource.type == 'ON_DEMAND' && resource.clusterName.contains('CLUSTER_NAME')"
    actionType: DENY
    displayName: Restrict taking on-demand backup of certain clusters
    description: Prevent users from taking on-demand backups for certain clusters.

Replace CLUSTER_NAME with the cluster name.

Supported operation:

Backup creation

What's next

See Introduction to the Organization Policy Service to learn more about organization policies.
Learn more about how to create and manage organization policies.
See the full list of predefined Organization policy constraints.
Connect using a public IP.
Create a primary instance.

Use custom organization policies Stay organized with collections Save and categorize content based on your preferences.

Policy inheritance

Pricing

Limitations

Before you begin

Required roles

Create a custom constraint

Set up a custom constraint

Console

gcloud

Enforce a custom organization policy

Console

gcloud

Supported custom constraints and operations

Restrict public IP access using organization policies

Limit the CIDR range of authorized networks

Limit the number of authorized networks

Enforce mandatory tags using organization policies

Enforce continuous backups for all clusters

Restrict on-demand backup for specific clusters

What's next

Use custom organization policies