This page details how to create custom constraints for Cloud Run services and jobs and enforce them at the project level. For information about custom organization policies, see Creating and managing custom organization policies.
If you've created or deployed Cloud Run functions using gcloud functions
commands or the Cloud Functions v2 APIs, see Manage function resources using custom constraints.
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.
BenefitsCloud Run lets you write any number of custom constraints using most user-configured fields in the Cloud Run Admin API. For example, you can create a custom constraint specifying that a service be set to internal or that prevents non-GA launch stages.
Once applied, requests that violate a policy that enforces a custom constraint show an error message in the gcloud CLI and in Cloud Run logs. The error message contains the constraint ID and description of the violated custom constraint.
Tip: Use the policy simulator to check whether existing services or jobs in your organization are in violation of a new custom organization policy. Policy inheritanceBy default, organization policies are inherited by the descendants of the resources that you enforce the policy on. 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.
PricingThe Organization Policy Service, including predefined and custom organization policies, is offered at no charge.
LimitationsTo get the permissions that you need to manage 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.
This predefined role contains the permissions required to manage organization policies. To see the exact permissions that are required, expand the Required permissions section:
Required permissionsThe following permissions are required to manage organization policies:
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.
Create a custom constraintA custom constraint is defined in a YAML file by the resources, methods, conditions, and actions that are supported by the service that you are enforcing the organization policy on. 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 YAML file for a Cloud Run custom constraint, refer to the following example:
name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
resourceTypes:
- run.googleapis.com/Service
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.ingressInternal. The maximum length of this field is 70 characters, not counting the prefix, for example, organizations/123456789/customConstraints/custom
.
CONDITION
: a CEL condition that is written against a representation of a supported service resource. This field has a maximum length of 1000 characters. For example, condition: "'run.googleapis.com/ingress' in resource.metadata.annotations && resource.metadata.annotations['run.googleapis.com/ingress'] == 'internal'".
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, for example, "Require ingress to be set to internal." 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 constraintAfter 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 constraintYou can enforce a constraint by creating an organization policy that references it, and then applying that organization policy to a Google Cloud resource.
ConsoleTo 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.ingressInternal
.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.
To test the example that restricts ingress settings, try to deploy a Cloud Run service in the project with ingress set to all
:
gcloud run deploy org-policy-test \
--project=PROJECT_ID \
--region=REGION_ID \
--ingress=all
The output is the following:
Operation denied by custom org policies: ["customConstraints/custom.ingressConstraint": "Require ingress to be set to internal."]
Example custom organization policies for common use cases
The following table provides examples of custom constraints that you might find useful with Cloud Run services and jobs:
Description Constraint syntax Require that a Cloud Run service be set to internal.name: organizations/ORGANIZATION_ID/customConstraints/custom.ingressInternal resourceTypes: - run.googleapis.com/Service methodTypes: - CREATE - UPDATE condition: "'run.googleapis.com/ingress' in resource.metadata.annotations && resource.metadata.annotations['run.googleapis.com/ingress'] == 'internal'" actionType: ALLOW displayName: IngressInternal description: Require ingress to be set to internal.Description Constraint syntax Require a custom memory limit for all containers of a Cloud Run service.
name: organizations/ORGANIZATION_ID/customConstraints/custom.memoryLimit resourceTypes: - run.googleapis.com/Service methodTypes: - CREATE - UPDATE condition: "resource.spec.template.spec.containers.all(container, 'memory' in container.resources.limits && container.resources.limits['memory'] <= 'MEMORY_LIMIT')" actionType: ALLOW displayName: memoryLimitCap description: Require the container memory limit to be set to <= MEMORY_LIMIT.Description Constraint syntax Prevent the Cloud Run launch stage from being changed from default GA to a non-GA launch stage.
name: organizations/ORGANIZATION_ID/customConstraints/custom.launchStage resourceTypes: - run.googleapis.com/Service methodTypes: - CREATE - UPDATE condition: "!('run.googleapis.com/launch-stage' in resource.metadata.annotations) || resource.metadata.annotations['run.googleapis.com/launch-stage'] == 'GA'" actionType: ALLOW displayName: launchStage description: Only allow users to create and update Cloud Run services with either an unset launch stage (default is GA) or a launch stage explicitly set to GA.Description Constraint syntax Require Binary Authorization to be set to default.
name: organizations/ORGANIZATION_ID/customConstraints/custom.binaryAuthorization resourceTypes: - run.googleapis.com/Service methodTypes: - CREATE - UPDATE condition: "'run.googleapis.com/binary-authorization' in resource.metadata.annotations && resource.metadata.annotations['run.googleapis.com/binary-authorization'] == 'default'" actionType: ALLOW displayName: binaryAuthorization description: Require binaryAuthorization to be set to default.Description Constraint syntax Require that services have a liveness probe for every container.
name: organizations/ORGANIZATION_ID/customConstraints/custom.livenessProbe resourceTypes: - run.googleapis.com/Service methodTypes: - CREATE - UPDATE condition: "resource.spec.template.spec.containers.all(container, has(container.livenessProbe.initialDelaySeconds))" actionType: ALLOW displayName: livenessProbe description: Require all containers to have a liveness probe configured with initialDelaySeconds.Description Constraint syntax Require that a service has at least one sidecar container that uses an image beginning with a specified prefix and a port equal to a specified number.
name: organizations/ORGANIZATION_ID/customConstraints/custom.requireSidecar resourceTypes: - run.googleapis.com/Service methodTypes: - CREATE - UPDATE condition: "resource.spec.template.spec.containers.exists(container, container.image.startsWith('us-docker.pkg.dev/cloud-ops-agents-artifacts/cloud-run-gmp-sidecar/') && container.ports.exists(port, port.containerPort == 8081))" actionType: ALLOW displayName: requireSidecar description: Require at least one container with an image that starts with "us-docker.pkg.dev/cloud-ops-agents-artifacts/cloud-run-gmp-sidecar/" and uses port 8081.Description Constraint syntax Only allows the creation and editing of functions.
name: organizations/ORGANIZATION_ID/customConstraints/custom.allowcrf resource_types: run.googleapis.com/Service method_types: - CREATE - UPDATE condition: "resource.spec.template.spec.containers.exists(container, container.image.startsWith('gcr.io/cloudrun/placeholder')) || (has(resource.metadata.annotations) && 'run.googleapis.com/build-function-target' in resource.metadata.annotations)" action_type: ALLOW display_name: runFunctionsOnly description: Only allows the creation and editing of Cloud Run functionsWhat's next
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4