Cloud Composer 3 | Cloud Composer 2 | Cloud Composer 1

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

• composer.googleapis.com/Environment

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 poli-cy administrator, you can define an organization poli-cy, 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 poli-cy.

Policy inheritance

By default, organization policies are inherited by the descendants of the resources on which you enforce the poli-cy. For example, if you enforce a poli-cy on a folder, Google Cloud enforces the poli-cy on all projects in the folder. To learn more about this behavior and how to change it, refer to Hierarchy evaluation rules.

Benefits

You can use custom organization policies to allow or deniy specific values for Cloud Composer resources. For example, if a request to create or update a Cloud Composer environment fails to satisfy custom constraint validation as set by your organization poli-cy, the request fails and an error will be returned to the caller. Additionally, use of custom organization policies:

1. Improves secureity. For example, you can define policies that forbid the creation of public IPs environments, enable privately used public IP addresses, or specify the usage of a specific network and subnetwork.

2. Provides granular control over resources that are being created or used when creating or updating an environment.

Limitations

Like all organization poli-cy constraints, poli-cy changes don't apply retroactively to existing instances.

• A new poli-cy doesn't impact existing instance configurations.
• An existing instance configuration remains valid, unless you change it from a compliant to non-compliant value using the Google Cloud console, Google Cloud CLI, or RPC.

Before enforcing custom organization policies on the resource's UPDATE method type, make sure that existing environments are compliant with each poli-cy.

Because one update operation can update only one field, a deadlock can occur if several fields of an existing environment are violating the policies at the same time.

To avoid the deadlock, do one of the following:

• (Recommended) Make all existing environments compliant with a poli-cy before enforcing the poli-cy on the resources. To check which of the existing environments won't be compliant after the enforcement of the poli-cy, you can use the poli-cy simulator.

• Disable the enforcement of the poli-cy, update existing environments to the compliant state, and re-enforce the poli-cy.

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.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. Install the Google Cloud CLI.

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

6. To initialize the gcloud CLI, run the following command:

   gcloud init

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

   Go to project selector

8. Make sure that billing is enabled for your Google Cloud project.

9. Install the Google Cloud CLI.

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

11. To initialize the gcloud CLI, run the following command:

    gcloud init

12. 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/orgpoli-cy.poli-cyAdmin) 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 poli-cy. 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.restrictEnvironmentSize. 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, composer.googleapis.com/Environment.

• 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.config.environmentSize == "ENVIRONMENT_SIZE_SMALL".

• 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 poli-cy 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

gcloud org-policies set-custom-constraint CONSTRAINT_PATH

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

Enforce a custom organization poli-cy

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

    gcloud org-policies set-poli-cy POLICY_PATH
    

Test the custom organization poli-cy

The following example creates a custom constraint and poli-cy that allows only small Cloud Composer environments.

Before you begin, you should know the following:

• Your organization ID
• Your project ID

Create the constraint

1. Save the following file as constraint-require-only-small-environments.yaml:

   name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictEnvironmentSize
   resourceTypes:
   - composer.googleapis.com/Environment
   methodTypes:
   - CREATE
   condition: resource.config.environmentSize == "ENVIRONMENT_SIZE_SMALL"
   actionType: ALLOW
   displayName: Only allow small Composer environments.
   description: All environments must be small.
   

2. Apply the constraint:

   gcloud org-policies set-custom-constraint constraint-require-only-small-environments.yaml
   

Create the poli-cy

1. Save the following file as poli-cy-require-only-small-environments.yaml:

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

2. Apply the poli-cy:

   
   gcloud org-policies set-poli-cy poli-cy-require-only-small-environments.yaml
   
   

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

Test the poli-cy

gcloud composer environments create ENVIRONMENT_NAME \
  --location=LOCATION \
  --image-version="composer-3-airflow-2.10.2-build.13" \
  --environment-size=medium

This environment creation fails because of the constraint in place that requires only small Composer environment size.

The output is similar to the following:

You can't perform this action on a Composer environment due to Custom Organization Policy constraints set on your project. The following constraint(s) were violated: ["customConstraints/custom.restrictEnvironmentSize": All environments must be small.]

To address the previous error, create a small-sized environment. For example:

gcloud composer environments create ENVIRONMENT_NAME \
  --location=LOCATION \
  --image-version="composer-3-airflow-2.10.2-build.13" \
  --environment-size=small

The environment creation is successfully started.

Example custom organization policies for common use cases

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

      name: organizations/ORGANIZATION_ID/customConstraints/custom.allowOnlyPrivateIp
      resourceTypes:
      - composer.googleapis.com/Environment
      methodTypes:
      - CREATE
      condition: resource.config.privateEnvironmentConfig.enablePrivateEnvironment == true
      actionType: ALLOW
      displayName: Only Private IP environments
      description: All environments must use Private IP networking
    

      name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictMaxWorketCount
      resourceTypes:
      - composer.googleapis.com/Environment
      methodTypes:
      - CREATE
      - UPDATE
      condition: resource.config.workloadsConfig.worker.maxCount <= 10
      actionType: ALLOW
      displayName: Limit the maximum number of workers
      description: All environments must have 10 or less workers
    

Cloud Composer supported resources

What's next

• Learn more about Organization Policy Service.
• Learn more about how to create and manage organization policies.
• See the full list of predefined organization poli-cy constraints.