使用自定义限制条件管理资源

本页面介绍了如何使用组织政策服务自定义限制条件来限制 对以下 Google Cloud 资源执行的特定操作：

  • cloudresourcemanager.googleapis.com/Project
  • cloudresourcemanager.googleapis.com/Folder

如需详细了解组织政策，请参阅自定义组织政策。

组织政策和限制条件简介

借助 Google Cloud 组织政策服务，您可以对组织的资源进行程序化集中控制。作为组织政策管理员，您可以定义组织政策，这是一组称为限制条件的限制，会应用于 Google Cloud 资源层次结构中的Google Cloud 资源及其后代。您可以在组织、文件夹或项目级强制执行组织政策。

组织政策为各种 Google Cloud 服务提供内置的托管式限制。但是，如果您想要更精细地控制和自定义组织政策中受限的特定字段，还可以创建自定义限制条件并在组织政策中使用这些自定义限制条件。

政策继承

如果您对资源强制执行政策，默认情况下，该资源的后代会继承组织政策。例如，如果您对某个文件夹强制执行一项政策， Google Cloud 会对该文件夹中的所有项目强制执行该政策。如需详细了解此行为及其更改方式，请参阅层次结构评估规则。

福利

为了确保安全、合规性和治理，您可以通过以下方式使用自定义组织政策：

  • 控制项目命名模式：您可以针对项目 ID 创建自定义限制条件。例如，在暂存资源文件夹中，仅当项目 ID 以 staging- 开头时，才允许对项目执行创建和更新操作。
  • 限制对安全项目和文件夹的更改：您可以创建自定义限制条件，以在父级是安全文件夹或组织时拒绝项目和文件夹更新。

限制

  • 如果已针对文件夹或项目设置自定义限制条件，则对 App Script、Firebase 或 Contact Center Solution 资源执行的创建或更新操作可能会失败。在这种情况下，请检查导致失败的自定义限制条件中的条件。确保更新这些限制，然后重试失败的操作。
  • 与所有组织政策限制条件一样，政策更改不会以追溯方式应用于现有实例。
  • 在 Google Cloud 控制台中创建项目和文件夹时，可能不会提供 PERMISSION_DENIED错误消息的具体原因。 如需确认导致失败的具体限制条件的详细信息，您可以查看审核日志。

准备工作

  • 请确保您知道您的组织 ID。
  • 安装并初始化 Google Cloud CLI。

    1. 安装 Google Cloud CLI。

    2. 如果您使用的是外部身份提供方 (IdP)，则必须先使用联合身份登录 gcloud CLI。

    3. 如需初始化 gcloud CLI，请运行以下命令： 

      gcloud init

    • 所需的角色

    如需获得管理自定义组织政策所需的权限，请让您的管理员为您授予组织资源的 Organization Policy Administrator (roles/orgpolicy.policyAdmin) IAM 角色。 如需详细了解如何授予角色，请参阅管理对项目、文件夹和组织的访问权限。

    您也可以通过自定义角色或其他预定义角色来获取所需的权限。

    设置自定义限制条件

    自定义限制条件是在 YAML 文件中，由实施组织政策的服务所支持的资源、方法、条件和操作定义的。自定义限制条件的条件使用通用表达式语言 (CEL) 进行定义。如需详细了解如何使用 CEL 构建自定义限制条件中的条件，请参阅创建和管理自定义限制条件的 CEL 部分。

    控制台

    如需创建自定义限制条件，请执行以下操作：

    1. 在 Google Cloud 控制台中，转到组织政策页面。

      转到组织政策

    2. 在项目选择器中，选择要为其设置组织政策的项目。
    3. 点击 自定义限制条件。
    4. 在显示名称框中，为限制条件输入一个人类可读名称。此名称会在错误消息中使用，并可用于识别和调试用途。 请勿在显示名称中使用 个人身份信息 (PII) 或敏感数据，因为此 名称可能会在错误消息中公开。此字段最多可包含 200 个字符。
    5. 在限制条件 ID 框中，为新的自定义 限制条件输入所需的 ID。自定义限制条件只能包含字母（包括大写和小写）或 数字，例如 custom.allowProjectForXDepartmentNameOnly。此字段最多可包含 70 个字符，不计算前缀 (custom.)，例如 organizations/123456789/customConstraints/custom。请勿在限制条件 ID 中包含个人身份信息或敏感数据，因为该 ID 可能会在错误消息中公开。
    6. 在说明框中，输入人类可读的限制条件说明。当违反政策时，此说明将用作错误消息。请包含有关发生违规的原因以及如何解决违规问题的详细信息。请勿在说明中包含个人身份信息或敏感数据，因为该说明可能会在错误消息中公开。 此字段最多可包含 2000 个字符。
    7. 在资源类型框中，选择包含要限制的对象和字段的 Google Cloud REST 资源的名称，例如 container.googleapis.com/NodePool。大多数资源类型最多支持 20 个自定义限制条件。如果您尝试创建更多自定义限制条件，操作将会失败。
    8. 在强制执行方法下，选择是对 REST CREATE 方法强制执行限制条件，还是同时对 CREATE 和 UPDATE 方法强制执行限制条件。如果您对违反限制条件的资源使用 UPDATE 方法强制执行限制条件，除非更改解决了违规问题，否则组织政策会阻止对该资源的更改。

      9. 如需查看每种服务支持的方法，请在 支持自定义限制条件的服务中找到相应服务。

    9. 如需定义条件，请点击 修改条件。
      1. 在添加条件面板中，创建一个引用受支持服务资源的 CEL 条件，例如 resource.management.autoUpgrade == false。此字段最多可包含 1,000 个字符。如需详细了解 CEL 用法，请参阅通用表达式语言。 如需详细了解可在自定义限制条件中使用的服务资源，请参阅自定义限制条件支持的服务。
      2. 点击保存。
    10. 在操作下，选择在满足条件时是允许还是拒绝评估的方法。

      11. 拒绝操作意味着，如果条件计算结果为 true，则创建或更新资源的操作会被阻止。

      允许操作意味着，仅当条件计算结果为 true 时，才允许执行创建或更新资源的操作。除了条件中明确列出的情况之外，其他所有情况都会被阻止。

    11. 点击创建限制条件 。

      12. 在每个字段中输入值后，右侧将显示此自定义限制条件的等效 YAML 配置。

    gcloud

    1. 如需创建自定义限制条件，请使用以下格式创建 YAML 文件： 
      2. name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
resourceTypes: RESOURCE_NAME
methodTypes:
  - CREATE
        - UPDATE       
condition: "CONDITION"
actionType: ACTION
displayName: DISPLAY_NAME
description: DESCRIPTION

      请替换以下内容：

      • ORGANIZATION_ID：您的组织 ID，例如 123456789。
      • CONSTRAINT_NAME：新的自定义限制条件的名称。自定义限制条件只能包含字母（包括大写和小写） 或数字，例如 custom.allowProjectForXDepartmentNameOnly。此字段最多可包含 70 个字符，不计算前缀 (custom.)，例如 organizations/123456789/customConstraints/custom。请勿在限制条件 ID 中包含个人身份信息或 敏感数据，因为该 ID 可能会在错误消息中公开。
      • RESOURCE_NAME：包含要限制的对象和字段的资源的完全限定名称。 Google Cloud例如， cloudresourcemanager.googleapis.com/Project。大多数资源类型最多支持 20 个自定义 限制条件。如果您尝试创建更多自定义限制条件，操作将会失败。
      • methodTypes：强制执行限制条件的 REST 方法。 可以是 CREATE，也可以是 CREATE 和 UPDATE。如果您对违反限制条件的资源使用 UPDATE 方法强制执行限制条件，除非更改解决了违规问题，否则组织政策会阻止对该资源的更改。

        • 如需查看每种服务支持的方法，请在 支持自定义限制条件的服务中找到相应服务。

      • CONDITION：针对受支持服务资源的表示形式编写的 CEL 条件。此字段最多可包含 1,000 个字符。例如 "resource.projectId.startsWith(\"XDepartment\")"。

        • 如需详细了解可针对其编写条件的资源，请参阅支持的资源。

      • ACTION：满足 condition 时要执行的操作。 可能的值包括 ALLOW 和 DENY。

        • 允许操作意味着，如果条件计算结果为 true，则允许执行创建或更新资源的操作。这也意味着，除了条件中明确列出的情况之外，其他所有情况都会被阻止。

        拒绝操作意味着，如果条件计算结果为 true，则创建或 更新资源的操作会被阻止。

      • DISPLAY_NAME：限制条件的直观易记名称。此名称 会在错误消息中使用，并可用于识别和调试用途。请勿在显示名称中使用 PII 或敏感数据，因为此名称可能会在错误消息中公开。 此字段最多可包含 200 个字符。
      • DESCRIPTION：直观易懂的限制条件说明，当违反政策时会作为错误消息显示。此字段最多可包含 2000 个字符。
    2. 为新的自定义限制条件创建 YAML 文件后，您必须对其进行设置，以使其可用于组织中的组织政策。如需设置自定义限制条件，请使用 gcloud org-policies set-custom-constraint 命令： 
      3. gcloud org-policies set-custom-constraint CONSTRAINT_PATH

      将 CONSTRAINT_PATH 替换为自定义限制条件文件的完整路径。例如 /home/user/customconstraint.yaml。

      此操作完成后，您的自定义限制条件将作为组织政策显示在您的 Google Cloud 组织政策列表中。

    3. 如需验证自定义限制条件是否存在，请使用 gcloud org-policies list-custom-constraints 命令： 
      4. gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID

      将 ORGANIZATION_ID 替换为您的组织资源的 ID。

      如需了解详情，请参阅查看组织政策。

    强制执行自定义组织政策

    如需强制执行限制条件，您可以创建引用该限制条件的组织政策，并将该组织政策应用于 Google Cloud 资源。

    控制台

    1. 在 Google Cloud 控制台中，前往组织政策页面。

      转到组织政策

    2. 在项目选择器中，选择要为其设置组织政策的项目。
    3. 从组织政策页面上的列表中选择您的限制条件，以查看该限制条件的政策详情页面。
    4. 如需为该资源配置组织政策，请点击管理政策。
    5. 在修改政策页面，选择覆盖父级政策。
    6. 点击添加规则。
    7. 在强制执行部分中，选择是否强制执行此组织政策。
    8. （可选）如需使组织政策成为基于某个标记的条件性政策，请点击添加条件。请注意，如果您向组织 政策添加条件规则，则必须至少添加一个无条件规则，否则无法保存政策。如需了解详情，请参阅 使用标记限定组织政策的范围。
    9. 点击测试更改 以模拟组织政策的效果。如需了解详情，请参阅使用 Policy Simulator 测试组织政策更改。
    10. 如需在试运行模式下强制执行组织政策，请点击设置试运行政策 。如需了解详情，请参阅 测试组织政策。
    11. 验证试运行模式下的组织政策按预期运行后，点击设置政策来设置现行政策。

    gcloud

    1. 如需创建包含布尔值规则的组织政策，请创建引用该限制条件的 YAML 政策文件： 
      2. name: projects/PROJECT_ID/policies/CONSTRAINT_NAME
spec:
  rules:
  - enforce: true

dryRunSpec:
  rules:
  - enforce: true

      请替换以下内容：

      • PROJECT_ID：要对其强制执行您的限制条件的项目。
      • CONSTRAINT_NAME：您为自定义限制条件定义的名称。例如，custom.allowProjectForXDepartmentNameOnly。
    2. 如需在试运行模式下强制执行组织政策，请运行以下带有 dryRunSpec 标志的命令： 
      3. gcloud org-policies set-policy POLICY_PATH --update-mask=dryRunSpec

      将 POLICY_PATH 替换为组织政策 YAML 文件的完整路径。该政策最长需要 15 分钟才能生效。

    3. 验证试运行模式下的组织政策按预期运行后，使用 org-policies set-policy 命令和 spec 标志设置现行政策： 
      4. gcloud org-policies set-policy POLICY_PATH --update-mask=spec

      将 POLICY_PATH 替换为组织政策 YAML 文件的完整路径。该政策最长需要 15 分钟才能生效。

    测试自定义组织政策

    以下示例创建了一个自定义限制条件和政策，要求组织中的所有项目 ID 都以 dev_ 开头。

    在开始之前，请先确定您的组织 ID。

    创建限制条件

    1. 如需定义一个限制条件，以在项目 ID 不以 dev_ 开头时拒绝所有项目创建和更新，请创建包含以下内容的 constraint-allow-dev-projects.yaml：

      name: organizations/ORGANIZATION_ID/customConstraints/custom.allowProjectForDevIdOnly
resourceTypes:
- cloudresourcemanager.googleapis.com/Project
methodTypes:
- CREATE
- UPDATE
condition: "resource.projectId.startsWith(\"dev_\")"
actionType: ALLOW
displayName: Allow dev_ projects
description: All projects in the org should start with dev_.

      将 ORGANIZATION_ID 替换为您的组织 ID。

    2. 应用限制条件：

      gcloud org-policies set-custom-constraint ~/constraint-allow-dev-projects.yaml

    3. 验证限制条件存在：

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

      输出类似于以下内容：

      CUSTOM_CONSTRAINT                ACTION_TYPE  METHOD_TYPES   RESOURCE_TYPES                                      DISPLAY_NAME
custom.allowProjectForDevIdOnly  ALLOW        CREATE,UPDATE  cloudresourcemanager.googleapis.com/Project   Allow dev_ projects
...

    创建政策

    1. 创建包含以下政策的 policy-enable-dev-projects.yaml 文件：

      Name: organizations/ORGANIZATION_ID/policies/custom.allowProjectForDevIdOnly
spec:
  rules:
  - enforce: true

      将 ORGANIZATION_ID 替换为您的组织 ID。

    2. 应用政策：

      gcloud org-policies set-policy ~/policy-enable-dev-projects.yaml

    3. 验证政策存在：

      gcloud org-policies list --organization=ORGANIZATION_ID

      输出类似于以下内容：

      CONSTRAINT                        LIST_POLICY    BOOLEAN_POLICY    ETAG
custom.allowProjectForDevIdOnly   -              SET               COCsm5QGENiXi2E=

    应用政策后， Google Cloud 大约需要两分钟才能 开始强制执行政策。

    测试政策

    在组织中创建一个项目，项目 ID 为 sampleDemoProject：

    gcloud projects create sampleDemoProject \
    --organization=ORGANIZATION_ID

    输出如下所示：

    PERMISSION_DENIED: The caller does not have permission

    常见用例的自定义组织政策示例

    下表提供了一些常见自定义限制条件的语法示例。

    说明 限制条件语法
    拒绝在文件夹 1234 (secure_admin_folder) 中创建新项目。 
          name: organizations/ORGANIZATION_ID/customConstraints/custom.disableNewProjectInSecureAdminFolder
      resourceTypes:
      - cloudresourcemanager.googleapis.com/Project
      methodTypes:
      - CREATE
      condition: "resource.parent == "organizations/1234""
      actionType: DENY
      displayName: Disable new project creation in the secure admin folder
      description: Do not allow creation of new projects in the secure folders.
    禁止在另一个文件夹中创建文件夹，以控制 资源层次结构树的深度。 
          name: organizations/ORGANIZATION_ID/customConstraints/custom.disableFolderCreation
      resourceTypes:
      - cloudresourcemanager.googleapis.com/Folder
      methodTypes:
      - CREATE
      condition: "resource.parent.startsWith("folders")"
      actionType: DENY
      displayName: Disable creation of a folder inside another folder
      description: Do not allow creation of a folder within another folder when
                   the resource hierarchy is set to a maximum value of 1.

    Resource Manager 支持的资源

    下表列出了您可以在自定义限制条件中引用的 Resource Manager 资源。

    资源 字段
    cloudresourcemanager.googleapis.com/Folder resource.displayName
    resource.parent
    cloudresourcemanager.googleapis.com/Project resource.parent
    resource.projectId

    后续步骤