此页面由 Cloud Translation API 翻译。

创建自定义组织政策限制条件

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

dataform.googleapis.com/Repository

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

组织政策和限制条件简介

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

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

政策继承

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

优势

您可以使用自定义组织政策来允许或拒绝 Dataform 资源的特定值。例如，如果创建或更新 dataform.googleapis.com/Repository 资源的请求未通过组织政策设置的自定义限制条件验证，则请求会失败，并且会向调用方返回错误。

使用自定义组织政策可增加一层额外的安全性、合规性和治理。例如，您可以定义仅允许在特定区域创建资源或禁止使用组织外部的 Git 远程代码库的政策。

限制

与所有组织政策限制条件一样，政策更改不会以追溯方式应用于现有资源：

新政策不会影响现有资源。
如果您更改政策，现有资源仍然有效，除非您使用Google Cloud 控制台或 RPC 将资源从合规值更改为不合规值。

建议您先使所有现有资源符合某项政策，然后再强制执行新政策。如需检查在强制执行政策后哪些现有资源将不合规，请使用组织政策的 Policy Simulator。

准备工作

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.

Roles required to select or create a project

Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
Create a project: To create a project, you need the Project Creator (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Install the Google Cloud CLI.

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

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

gcloud init

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

Roles required to select or create a project

Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
Create a project: To create a project, you need the Project Creator (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Install the Google Cloud CLI.

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

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

gcloud init

请确保您知道您的组织 ID。

所需的角色

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

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

创建自定义限制条件

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

如需创建自定义限制条件，请使用以下格式创建 YAML 文件：

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. 开头，只能包含大写字母、小写字母或数字。例如 custom.restrictRepositoryLocation。该字段的最大长度为 70 个字符。
RESOURCE_NAME：包含要限制的对象和字段的Google Cloud 资源的完全限定名称。例如 dataform.googleapis.com/Repository。
CONDITION：针对受支持的服务资源的表示法编写的 CEL 条件。此字段的长度上限为 1,000 个字符。如需详细了解可用于针对其编写条件的资源，请参阅支持的资源。例如 "resource.name.contains('/locations/us-central1/')"。
ACTION：满足 condition 时要执行的操作。可能的值包括 ALLOW 和 DENY。
DISPLAY_NAME：限制条件的直观易记名称。此字段的最大长度为 200 个字符。
DESCRIPTION：直观易懂的限制条件说明，在违反政策时显示为错误消息。此字段的长度上限为 2,000 个字符。

如需详细了解如何创建自定义限制条件，请参阅定义自定义限制条件。

设置自定义限制条件

gcloud org-policies set-custom-constraint

gcloud org-policies set-custom-constraint CONSTRAINT_PATH

CONSTRAINT_PATH

/home/user/customconstraint.yaml

gcloud org-policies list-custom-constraints

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

ORGANIZATION_ID

查看组织政策

强制执行自定义组织政策

控制台

在 Google Cloud 控制台中，前往组织政策页面。
转到组织政策
在项目选择器中，选择要设置组织政策的项目。
从组织政策页面上的列表中选择您的限制条件，以查看该限制条件的政策详情页面。
如需为该资源配置组织政策，请点击管理政策。
在修改政策页面，选择覆盖父级政策。
点击添加规则。
在强制执行部分中，选择开启还是关闭此组织政策的强制执行。
（可选）如需使组织政策成为基于某个标记的条件性政策，请点击添加条件。请注意，如果您向组织政策添加条件规则，则必须至少添加一个无条件规则，否则无法保存政策。如需了解详情，请参阅设置带有标记的组织政策。
点击测试更改以模拟组织政策的效果。政策模拟不适用于旧版托管式限制。如需了解详情，请参阅使用 Policy Simulator 测试组织政策更改。
若要完成并应用组织政策，请点击设置政策。该政策最长需要 15 分钟才能生效。

gcloud

如需创建包含布尔值规则的组织政策，请创建引用该限制条件的 YAML 政策文件：

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

请替换以下内容：

PROJECT_ID：要对其实施限制条件的项目。
CONSTRAINT_NAME：您为自定义限制条件定义的名称。例如，custom.restrictRepositoryLocation。

如需强制执行包含限制条件的组织政策，请运行以下命令：

    gcloud org-policies set-policy POLICY_PATH

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

测试自定义组织政策

以下示例创建自定义限制条件和政策，要求所有 dataform.googleapis.com/Repository 资源都在特定区域中创建。

在开始之前，您必须满足以下条件：

您的组织 ID
项目 ID

创建限制条件

如需创建自定义限制条件，请按照以下步骤操作：

将以下文件保存为 constraint-restrict-repository-location.yaml：

name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictRepositoryLocation
resourceTypes:
- dataform.googleapis.com/Repository
methodTypes:
- CREATE
- UPDATE
condition: "resource.name.contains('/locations/us-central1/')"
actionType: ALLOW
displayName: Only us-central1 region is allowed.
description: All resources must be created in the us-central1 region.

将 ORGANIZATION_ID 替换为您的组织 ID。

此文件定义了一个限制条件，即对于 dataform.googleapis.com/Repository 资源的每次创建或更新操作，只有当所选资源区域为 us-central1 时，该操作才会被允许。

应用限制条件：

gcloud org-policies set-custom-constraint ~/constraint-restrict-repository-location.yaml

验证限制条件存在：

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

输出类似于以下内容：

CUSTOM_CONSTRAINT                       ACTION_TYPE  METHOD_TYPES   RESOURCE_TYPES                     DISPLAY_NAME
custom.restrictRepositoryLocation       ALLOW        CREATE,UPDATE  dataform.googleapis.com/Repository Only us-central1 region is allowed.
...

创建政策

现在，创建一个政策并将其应用于您创建的自定义限制条件。

将以下文件保存为 policy-restrict-repository-location.yaml：

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

将 PROJECT_ID 替换为您的项目 ID。

应用政策：

gcloud org-policies set-policy ~/policy-restrict-repository-location.yaml

验证政策存在：

gcloud org-policies list --project=PROJECT_ID

输出类似于以下内容：

CONSTRAINT                           LIST_POLICY    BOOLEAN_POLICY    ETAG
custom.restrictRepositoryLocation    -              SET               ETAG

应用政策后，请等待大约两分钟，以便 Google Cloud 开始强制执行政策。

测试政策

按照创建代码库中的步骤在项目中创建 dataform.googleapis.com/Repository 资源。选择与您在自定义限制中指定的区域不同的区域。

输出如下所示：

Operation denied by custom org policies: ["customConstraints/custom.restrictRepositoryLocation": "All resources must be created in the us-central1 region."]

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

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

说明	限制条件语法
所有资源都必须在 us-central1 区域中创建。	name: organizations/`ORGANIZATION_ID`/customConstraints/custom.restrictRepositoryLocation resourceTypes: - dataform.googleapis.com/Repository methodTypes: - CREATE - UPDATE condition: "resource.name.contains('/locations/us-central1/')" actionType: ALLOW displayName: Only us-central1 region is allowed. description: All resources must be created in the us-central1 region.
仅允许配置 Git 远程代码库，以使用 HTTPS 连接到 GitHub 上 Google 组织中的代码库。	name: organizations/`ORGANIZATION_ID`/customConstraints/custom.restrictGitRemote resourceTypes: - dataform.googleapis.com/Repository methodTypes: - CREATE - UPDATE condition: \|- resource.gitRemoteSettings.url == "" \|\| resource.gitRemoteSettings.url.startsWith('https://github.com/google/') actionType: ALLOW displayName: Only allow the https://github.com/google/ Git remote. description: Only allow configuration of a Git remote to connect using HTTPS to repositories in the Google organization on GitHub.

说明

限制条件语法

所有资源都必须在 us-central1 区域中创建。

    name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictRepositoryLocation
    resourceTypes:
    - dataform.googleapis.com/Repository
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.name.contains('/locations/us-central1/')"
    actionType: ALLOW
    displayName: Only us-central1 region is allowed.
    description: All resources must be created in the us-central1 region.

仅允许配置 Git 远程代码库，以使用 HTTPS 连接到 GitHub 上 Google 组织中的代码库。

    name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictGitRemote
    resourceTypes:
    - dataform.googleapis.com/Repository
    methodTypes:
    - CREATE
    - UPDATE
    condition: |-
      resource.gitRemoteSettings.url == ""
      || resource.gitRemoteSettings.url.startsWith('https://github.com/google/')
    actionType: ALLOW
    displayName:  Only allow the https://github.com/google/ Git remote.
    description: Only allow configuration of a Git remote to connect using HTTPS to repositories in the Google organization on GitHub.

Dataform 支持的资源

资源	字段
dataform.googleapis.com/Repository	`resource.displayName`
	`resource.gitRemoteSettings.authenticationTokenSecretVersion`
	`resource.gitRemoteSettings.defaultBranch`
	`resource.gitRemoteSettings.sshAuthenticationConfig.hostPublicKey`
	`resource.gitRemoteSettings.sshAuthenticationConfig.userPrivateKeySecretVersion`
	`resource.gitRemoteSettings.url`
	`resource.kmsKeyName`
	`resource.name`
	`resource.npmrcEnvironmentVariablesSecretVersion`
	`resource.serviceAccount`
	`resource.setAuthenticatedUserAdmin`
	`resource.workspaceCompilationOverrides.defaultDatabase`
	`resource.workspaceCompilationOverrides.schemaSuffix`
	`resource.workspaceCompilationOverrides.tablePrefix`

后续步骤

详细了解自定义限制条件。
详细了解组织政策服务。
详细了解如何创建和管理组织政策。
查看托管式组织政策限制条件的完整列表。

创建自定义组织政策限制条件 使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

组织政策和限制条件简介

政策继承

优势

限制

准备工作

所需的角色

创建自定义限制条件

设置自定义限制条件

强制执行自定义组织政策

控制台

gcloud

测试自定义组织政策

创建限制条件

创建政策

测试政策

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

Dataform 支持的资源

后续步骤

创建自定义组织政策限制条件