Creating custom constraints for Backup for GKE

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

gkebackup.googleapis.com/BackupPlan
gkebackup.googleapis.com/Backup
gkebackup.googleapis.com/RestorePlan
gkebackup.googleapis.com/Restore

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 built-in managed 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.

Before you begin

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.

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

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Install the Google Cloud CLI.

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

To initialize the gcloud CLI, run the following command:

gcloud init

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

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Install the Google Cloud CLI.

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

To initialize the gcloud CLI, run the following command:

gcloud init

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.retentionPolicyEnforced. 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, gkebackup.googleapis.com/Backup.
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.retainDays > 30".
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 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 for which you want to set the organization policy.
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 enforcement of this organization policy is on or off.
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. Policy simulation isn't available for legacy managed constraints. For more information, see Test organization policy changes with Policy Simulator.
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 with boolean rules, 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.retentionPolicyEnforced.

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 steps show you how to create a custom constraint and policy that lets the users create a Backup for GKE backup if the retainDays field is set to a value greater than 30.

Before you begin, prepare the following:

Your organization ID
Your project ID

Create the constraint

Save the following file as CONSTRAINT_FILE_NAME.yaml:

name: organizations/ORGANIZATION_ID/customConstraints/custom.retentionPolicyEnforced
resourceTypes:
- gkebackup.googleapis.com/Backup
methodTypes:
- CREATE
condition: "resource.retainDays > 30"
actionType: ALLOW
displayName: Enforce retention policy
description: Enforce backup creation with a retention policy greater than 30 days.

Replace ORGANIZATION_ID with your organization ID.

This file defines a constraint where the retainDays field must be greater than 30 in the CREATE method.

Apply the constraint by using the gcloud org-policies set-custom-constraint command:
```
gcloud org-policies set-custom-constraint CONSTRAINT_FILE_NAME.yaml
```

Verify that the constraint exists using the gcloud org-policies list-custom-constraints command:

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.retentionPolicyEnforced   DENY         CREATE,UPDATE  gkebackup.googleapis.com/Backup   Enforce retention policy
...

Create the policy

Save the following file as POLICY_FILE_NAME.yaml:

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

Replace PROJECT_ID with your project ID.

Apply the policy using the gcloud org-policies set-policy command:
```
gcloud org-policies set-policy POLICY_FILE_NAME.yaml
```

Verify that the policy exists using the gcloud org-policies list command:

gcloud org-policies list --project=PROJECT_ID

The output is similar to the following:

CONSTRAINT                         LIST_POLICY  BOOLEAN_POLICY  ETAG
custom.retentionPolicyEnforced     -            SET             CPiLkMMGEKDFq6IB-

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

Test the policy

Create a backup without setting the retainDays field to a value greater than 30:

gcloud beta container backup-restore backups create test-backup --backup-plan=test-backup-plan --location=us-central1

The output is similar to the following:

ERROR: (gcloud.beta.container.backup-restore.backups.create) FAILED_PRECONDITION: Operation denied by org policy on resource 'pprojects/test-project/locations/us-central1/backupPlans/autopilot-cluster-1-backup-1/backups/test-backup-1': ["customConstraints/custom.retentionPolicyEnforced": "Enforce backup creation with a retention policy greater than 30 days."].
- '@type': type.googleapis.com/google.rpc.DebugInfo
  detail: "generic::failed_precondition: Operation denied by org policy on resource\
    \ 'projects/test-project/locations/us-central1/backupPlans/autopilot-cluster-1-backup-1/backups/test-backup-1':\
    \ [\"customConstraints/custom.retentionPolicyEnforced\": \"Enforce backup creation with a retention \
    \ policy greater than 30 days.\"]."
  .
  .
  .
- '@type': type.googleapis.com/google.rpc.DebugInfo
- '@type': type.googleapis.com/google.rpc.ErrorInfo
  domain: gkebackup.googleapis.com
  metadata:
    customConstraints: customConstraints/custom.backupRetainDays
    resource: projects/test-project/locations/us-central1/backupPlans/autopilot-cluster-1-backup-1/backups/test-backup-1
  reason: CUSTOM_ORG_POLICY_VIOLATION

Example custom organization policies for common use cases

The following table lists custom organization policies that you might find useful:

Description	Constraint syntax
Allow creating backups only if they have a retention period greater than 20 days	name: organizations/`ORGANIZATION_ID`/customConstraints/custom.retainDaysLimit resourceTypes: - gkebackup.googleapis.com/Backup methodTypes: - CREATE - UPDATE condition: resource.retainDays > 20 actionType: ALLOW displayName: Minimum Backup Retention period description: Minimum Backup Retention period of 20 days is required
Disable creating backup plans with different than intended cronSchedule	name: organizations/`ORGANIZATION_ID`/customConstraints/custom.disableInvalidScheduleBackupPlan resourceTypes: - gkebackup.googleapis.com/BackupPlan methodTypes: - CREATE - UPDATE condition: resource.backupSchedule.cronSchedule != "5 20 * * " actionType: DENY displayName: Backup plan cron schedule constraint description: Deny Backup plan creation or update if cron schedule is not set to 5 20 * *.

Description

Constraint syntax

Allow creating backups only if they have a retention period greater than 20 days

    name: organizations/ORGANIZATION_ID/customConstraints/custom.retainDaysLimit
    resourceTypes:
    - gkebackup.googleapis.com/Backup
    methodTypes:
    - CREATE
    - UPDATE
    condition: resource.retainDays > 20
    actionType: ALLOW
    displayName: Minimum Backup Retention period
    description: Minimum Backup Retention period of 20 days is required

Disable creating backup plans with different than intended cronSchedule

    name: organizations/ORGANIZATION_ID/customConstraints/custom.disableInvalidScheduleBackupPlan
    resourceTypes:
    - gkebackup.googleapis.com/BackupPlan
    methodTypes:
    - CREATE
    - UPDATE
    condition: resource.backupSchedule.cronSchedule != "5 20 * * *"
    actionType: DENY
    displayName: Backup plan cron schedule constraint
    description: Deny Backup plan creation or update if cron schedule is not set to 5 20 * * *.

Backup for GKE supported resources

The following table lists the Backup for GKE resources that you can reference in custom constraints.

Resource	Field
gkebackup.googleapis.com/Backup	`resource.deleteLockDays`
	`resource.description`
	`resource.retainDays`
gkebackup.googleapis.com/BackupPlan	`resource.backupConfig.allNamespaces`
	`resource.backupConfig.encryptionKey.gcpKmsEncryptionKey`
	`resource.backupConfig.includeSecrets`
	`resource.backupConfig.includeVolumeData`
	`resource.backupConfig.permissiveMode`
	`resource.backupConfig.selectedApplications.namespacedNames.name`
	`resource.backupConfig.selectedApplications.namespacedNames.namespace`
	`resource.backupConfig.selectedNamespaces.namespaces`
	`resource.backupSchedule.cronSchedule`
	`resource.backupSchedule.paused`
	`resource.backupSchedule.rpoConfig.exclusionWindows.daily`
	`resource.backupSchedule.rpoConfig.exclusionWindows.daysOfWeek.daysOfWeek`
	`resource.backupSchedule.rpoConfig.exclusionWindows.duration`
	`resource.backupSchedule.rpoConfig.targetRpoMinutes`
	`resource.cluster`
	`resource.deactivated`
	`resource.description`
	`resource.retentionPolicy.backupDeleteLockDays`
	`resource.retentionPolicy.backupRetainDays`
	`resource.retentionPolicy.locked`
gkebackup.googleapis.com/Restore	`resource.backup`
	`resource.description`
	`resource.filter.exclusionFilters.groupKind.resourceGroup`
	`resource.filter.exclusionFilters.groupKind.resourceKind`
	`resource.filter.exclusionFilters.name`
	`resource.filter.exclusionFilters.namespace`
	`resource.filter.inclusionFilters.groupKind.resourceGroup`
	`resource.filter.inclusionFilters.groupKind.resourceKind`
	`resource.filter.inclusionFilters.name`
	`resource.filter.inclusionFilters.namespace`
	`resource.volumeDataRestorePolicyOverrides.policy`
	`resource.volumeDataRestorePolicyOverrides.selectedPvcs.namespacedNames.name`
	`resource.volumeDataRestorePolicyOverrides.selectedPvcs.namespacedNames.namespace`
gkebackup.googleapis.com/RestorePlan	`resource.backupPlan`
	`resource.cluster`
	`resource.description`
	`resource.restoreConfig.allNamespaces`
	`resource.restoreConfig.clusterResourceConflictPolicy`
	`resource.restoreConfig.clusterResourceRestoreScope.allGroupKinds`
	`resource.restoreConfig.clusterResourceRestoreScope.excludedGroupKinds.resourceGroup`
	`resource.restoreConfig.clusterResourceRestoreScope.excludedGroupKinds.resourceKind`
	`resource.restoreConfig.clusterResourceRestoreScope.noGroupKinds`
	`resource.restoreConfig.clusterResourceRestoreScope.selectedGroupKinds.resourceGroup`
	`resource.restoreConfig.clusterResourceRestoreScope.selectedGroupKinds.resourceKind`
	`resource.restoreConfig.excludedNamespaces.namespaces`
	`resource.restoreConfig.namespacedResourceRestoreMode`
	`resource.restoreConfig.noNamespaces`
	`resource.restoreConfig.restoreOrder.groupKindDependencies.requiring.resourceGroup`
	`resource.restoreConfig.restoreOrder.groupKindDependencies.requiring.resourceKind`
	`resource.restoreConfig.restoreOrder.groupKindDependencies.satisfying.resourceGroup`
	`resource.restoreConfig.restoreOrder.groupKindDependencies.satisfying.resourceKind`
	`resource.restoreConfig.selectedApplications.namespacedNames.name`
	`resource.restoreConfig.selectedApplications.namespacedNames.namespace`
	`resource.restoreConfig.selectedNamespaces.namespaces`
	`resource.restoreConfig.substitutionRules.newValue`
	`resource.restoreConfig.substitutionRules.originalValuePattern`
	`resource.restoreConfig.substitutionRules.targetGroupKinds.resourceGroup`
	`resource.restoreConfig.substitutionRules.targetGroupKinds.resourceKind`
	`resource.restoreConfig.substitutionRules.targetJsonPath`
	`resource.restoreConfig.substitutionRules.targetNamespaces`
	`resource.restoreConfig.transformationRules.description`
	`resource.restoreConfig.transformationRules.fieldActions.fromPath`
	`resource.restoreConfig.transformationRules.fieldActions.op`
	`resource.restoreConfig.transformationRules.fieldActions.path`
	`resource.restoreConfig.transformationRules.fieldActions.value`
	`resource.restoreConfig.transformationRules.resourceFilter.groupKinds.resourceGroup`
	`resource.restoreConfig.transformationRules.resourceFilter.groupKinds.resourceKind`
	`resource.restoreConfig.transformationRules.resourceFilter.jsonPath`
	`resource.restoreConfig.transformationRules.resourceFilter.namespaces`
	`resource.restoreConfig.volumeDataRestorePolicy`
	`resource.restoreConfig.volumeDataRestorePolicyBindings.policy`
	`resource.restoreConfig.volumeDataRestorePolicyBindings.volumeType`

What's next

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

Creating custom constraints for Backup for GKE Stay organized with collections Save and categorize content based on your preferences.

About organization policies and constraints

Policy inheritance

Before you begin

Required roles

Create a custom constraint

Set up a custom constraint

Enforce a custom organization policy

Console

gcloud

Test the custom organization policy

Create the constraint

Create the policy

Test the policy

Example custom organization policies for common use cases

Backup for GKE supported resources

What's next

Creating custom constraints for Backup for GKE