使用自訂限制條件管理 Dataflow 資源

Google Cloud 組織政策可讓您透過程式輔助，集中控管組織的資源。組織政策管理員可以定義組織政策，也就是一組稱為「限制」的限制條件，適用於Google Cloud 資源和這些資源在Google Cloud 資源階層中的子系。您可以在組織、資料夾或專案層級強制執行組織政策。

機構政策提供各種Google Cloud 服務的預先定義限制。不過，如要更精細地自訂組織政策中受限的特定欄位，您也可以建立自訂組織政策。

優點

您可以根據支援的資源屬性 (例如作業名稱、類型和服務選項)，使用自訂機構政策，有條件地允許或拒絕建立 Dataflow 作業。

政策繼承

根據預設，您強制執行政策的資源子系會繼承組織政策。舉例來說，如果您對資料夾強制執行政策， Google Cloud 會對該資料夾中的所有專案強制執行政策。如要進一步瞭解這項行為以及如何變更，請參閱這篇文章。

定價

組織政策服務 (包括預先定義和自訂組織政策) 免費提供。

限制

您只能使用 Google Cloud 控制台或 Google Cloud CLI，為 Dataflow Job 資源設定自訂限制。
自訂限制只能針對 Dataflow Job 資源的 CREATE 方法強制執行。
新實施的自訂限制不會套用至現有資源。

事前準備

如要進一步瞭解機構政策和限制條件的定義和運作方式，請參閱「機構政策服務簡介」。

必要的角色

如要取得管理組織政策所需的權限，請要求管理員授予您組織的組織政策管理員 (roles/orgpolicy.policyAdmin) IAM 角色。如要進一步瞭解如何授予角色，請參閱「管理專案、資料夾和組織的存取權」。

這個預先定義的角色具備管理組織政策所需的權限。如要查看確切的必要權限，請展開「Required permissions」(必要權限) 部分：

所需權限

必須具備下列權限，才能管理組織政策：。

orgpolicy.constraints.list
orgpolicy.policies.create
orgpolicy.policies.delete
orgpolicy.policies.list
orgpolicy.policies.update
orgpolicy.policy.get
orgpolicy.policy.set

您或許還可透過自訂角色或其他預先定義的角色取得這些權限。

建立自訂限制

自訂限制是在 YAML 檔案中定義，其中包含您要強制執行組織政策的服務所支援的資源、方法、條件和動作。自訂限制的條件是使用一般運算語言 (CEL) 來定義。如要進一步瞭解如何使用 CEL 在自訂限制中建構條件，請參閱「建立及管理自訂限制」的 CEL 相關章節。

如要為自訂限制建立 YAML 檔案，請按照下列步驟操作：

name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
resourceTypes:
- dataflow.googleapis.com/RESOURCE_NAME
methodTypes:
- CREATE
condition: "CONDITION"
actionType: ACTION
displayName: DISPLAY_NAME
description: DESCRIPTION

更改下列內容：

ORGANIZATION_ID：組織 ID，例如 123456789。
CONSTRAINT_NAME：新自訂限制的名稱。自訂限制必須以 custom. 開頭，且只能包含大/小寫英文字母或數字，例如 custom.denyPrimeJobs。這個欄位的長度上限為 70 個字元，不含前置字元，例如 organizations/123456789/customConstraints/custom。
RESOURCE_NAME：內含要限制的物件和欄位的 Dataflow API REST 資源名稱 (而非 URI)，例如 dataflow.googleapis.com/Job。
CONDITION：針對支援服務資源表示法所撰寫的 CEL 條件。這個欄位的長度上限為 1,000 個字元。如要進一步瞭解可編寫條件的資源，請參閱「支援的資源」。例如：「resource.environment.serviceOptions.exists(value, value=='enable_prime')」。
ACTION：符合 condition 時採取動作。支援的值為 ALLOW 和 DENY。
DISPLAY_NAME：容易記得的限制名稱。這個欄位的長度上限為 200 個字元。
DESCRIPTION：違反政策時，會以錯誤訊息形式顯示且易於理解的限制說明。這個欄位的長度上限為 2,000 個字元。

如要進一步瞭解如何建立自訂限制，請參閱「定義自訂限制」。

設定自訂限制

控制台

如要建立自訂限制，請按照下列步驟操作：

前往 Google Cloud 控制台的「Organization policies」(組織政策) 頁面。
前往「Organization policies」(組織政策)
在專案選擇工具中，選取要設定組織政策的專案。
按一下「自訂限制」。
在「顯示名稱」方塊中，輸入容易理解的限制名稱。這個名稱會顯示在錯誤訊息中，可用於識別和偵錯。請勿在顯示名稱中使用 PII 或機密資料，因為錯誤訊息可能會顯示這類名稱。這個欄位最多可包含 200 個半形字元。
在「Constraint ID」(限制 ID) 方塊中，輸入新自訂限制的名稱。自訂限制只能包含字母 (包括大寫和小寫) 或數字，例如 custom.disableGkeAutoUpgrade。這個欄位最多可包含 70 個字元，不含前置字元 (custom.)，例如 organizations/123456789/customConstraints/custom。請勿在限制 ID 中輸入 PII 或機密資料，因為錯誤訊息可能會顯示上述資訊。
在「說明」方塊中，輸入使用者可理解的限制說明。違反政策時，系統會顯示這項說明做為錯誤訊息。請提供違反政策的詳細原因，以及如何解決問題。請勿在說明中輸入 PII 或機密資料，因為錯誤訊息可能會顯示上述資訊。這個欄位最多可輸入 2000 個字元。
在「Resource type」方塊中，選取包含要限制物件和欄位的 Google Cloud REST 資源名稱，例如 container.googleapis.com/NodePool。大多數資源類型最多支援 20 項自訂限制。如果您嘗試建立更多自訂限制，作業會失敗。
在「強制執行方法」下方，選取要對 REST 「CREATE」方法強制執行限制，還是對「CREATE」和「UPDATE」方法都強制執行限制。如果您使用 UPDATE 方法，對違反限制的資源強制執行限制，除非變更可解決違規問題，否則組織政策會封鎖對該資源的變更。

並非所有 Google Cloud 服務都支援這兩種方法。如要查看各項服務支援的方法，請在「支援的服務」中找出該服務。

如要定義條件，請按一下「編輯條件」。

在「Add condition」(新增條件) 面板中，建立參照支援服務資源的 CEL 條件，例如 resource.management.autoUpgrade == false。這個欄位最多可輸入 1000 個字元。如要進一步瞭解如何使用 CEL，請參閱「一般運算語言」。如要進一步瞭解自訂限制中可使用的服務資源，請參閱「自訂限制支援的服務」。
按一下 [儲存]。

在「動作」下方，選取符合條件時要允許或拒絕評估方法。

如果條件評估結果為 true，系統會禁止建立或更新資源。

允許動作表示只有在條件評估為 true 時，才能建立或更新資源。除了條件中明確列出的情況外，所有其他情況都會遭到封鎖。

按一下「建立限制」。

在每個欄位中輸入值後，右側會顯示這個自訂限制的對等 YAML 設定。

gcloud

如要建立自訂限制，請使用下列格式建立 YAML 檔案：

name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
resourceTypes: RESOURCE_NAME
methodTypes:
  - CREATE
condition: "CONDITION"
actionType: ACTION
displayName: DISPLAY_NAME
description: DESCRIPTION

請替換下列項目：

ORGANIZATION_ID：您的機構 ID，例如 123456789。
CONSTRAINT_NAME：新自訂限制的名稱。自訂限制只能包含字母 (包括大寫和小寫) 或數字，例如 custom.denyPrimeJobs。這個欄位最多可包含 70 個字元。
RESOURCE_NAME：內含要限制的物件和欄位的 Google Cloud資源完整名稱，例如：dataflow.googleapis.com/Job。
CONDITION：針對支援服務資源表示法所撰寫的 CEL 條件。這個欄位最多可輸入 1000 個字元。例如："resource.environment.serviceOptions.exists(value, value=='enable_prime')"。

如要進一步瞭解可編寫條件的資源，請參閱「支援的資源」。

ACTION：符合 condition 時採取的動作。只能是 ALLOW。

允許動作是指如果條件評估結果為 true，系統就會允許建立或更新資源的作業。這也表示系統會封鎖條件中明確列出的情況以外的所有其他情況。

DISPLAY_NAME：容易記得的限制名稱。這個欄位最多可包含 200 個半形字元。
DESCRIPTION：違反政策時，會以錯誤訊息形式顯示且易於理解的限制說明。這個欄位最多可輸入 2000 個字元。

為新的自訂限制建立 YAML 檔案後，您必須加以設定，才能用於組織的組織政策。如要設定自訂限制，請使用 gcloud org-policies set-custom-constraint 指令：

gcloud org-policies set-custom-constraint CONSTRAINT_PATH

請將 CONSTRAINT_PATH 替換為自訂限制檔案的完整路徑，例如：/home/user/customconstraint.yaml。

這項作業完成後，自訂限制會顯示在 Google Cloud 組織政策清單中，供組織政策使用。

如要確認是否存在自訂限制，請使用 gcloud org-policies list-custom-constraints 指令：

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

請將 ORGANIZATION_ID 替換成組織資源的 ID。

詳情請參閱「查看組織政策」。

強制執行自訂組織政策

如要強制執行限制，請建立參照該限制的組織政策，然後將組織政策套用至 Google Cloud 資源。

控制台

前往 Google Cloud 控制台的「Organization policies」(組織政策) 頁面。
前往「Organization policies」(組織政策)
在專案選擇工具中，選取要設定組織政策的專案。
在「Organization policies」(組織政策) 頁面的清單中選取限制，即可查看該限制的「Policy details」(政策詳細資料) 頁面。
如要為這項資源設定組織政策，請按一下「Manage policy」(管理政策)。
在「Edit policy」(編輯政策) 頁面，選取「Override parent's policy」(覆寫上層政策)。
按一下「Add a rule」(新增規則)。
在「Enforcement」(強制執行) 部分，選取是否要強制執行這項機構政策。
選用：如要根據標記設定組織政策的條件，請按一下「Add condition」(新增條件)。請注意，如果為組織政策新增條件式規則，您必須至少新增一項無條件規則，否則無法儲存政策。詳情請參閱「使用標記設定組織政策」。
按一下「Test changes」(測試變更)，模擬組織政策的影響。詳情請參閱「使用 Policy Simulator 測試組織政策變更」。
如要在模擬測試模式下強制執行組織政策，請按一下「設定模擬測試政策」。詳情請參閱「以模擬測試模式建立組織政策」。
確認試營運模式中的機構政策運作正常後，請按一下「設定政策」，設定正式政策。

gcloud

如要建立含有布林值規則的組織政策，請建立參照限制的政策 YAML 檔案：

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

dryRunSpec:
  rules:
  - enforce: true

請替換下列項目：

PROJECT_ID：要強制執行限制的專案。
CONSTRAINT_NAME：要為自訂限制定義的名稱，例如：custom.denyPrimeJobs。

如要以模擬測試模式強制執行組織政策，請執行下列指令並加上 dryRunSpec 旗標：

gcloud org-policies set-policy POLICY_PATH --update-mask=dryRunSpec

請將 POLICY_PATH 替換為組織政策 YAML 檔案的完整路徑。政策最多需要 15 分鐘才會生效。

確認模擬測試模式中的機構政策能發揮預期效果後，請使用 org-policies set-policy 指令和 spec 旗標設定正式政策：

gcloud org-policies set-policy POLICY_PATH --update-mask=spec

請將 POLICY_PATH 替換為組織政策 YAML 檔案的完整路徑。政策最多需要 15 分鐘才會生效。

範例：建立限制，禁止建立啟用主要功能的作業

gcloud

建立 denyPrimeJobs.yaml 限制檔案，並加入下列資訊。將 ORGANIZATION_ID 替換為您的組織 ID。

name: organizations/ORGANIZATION_ID/customConstraints/custom.denyPrimeJobs
resource_types: dataflow.googleapis.com/Job
condition: "resource.environment.serviceOptions.exists(value, value=='enable_prime')"
action_type: DENY
method_types: CREATE
display_name: Restrict creation of job with prime enabled
description: Deny creation of jobs with prime enabled.

設定自訂限制。

gcloud org-policies set-custom-constraint denyPrimeJobs.yaml

建立 enforce-policy-denyPrimeJobs.yaml 政策檔案，並加入下列資訊。在本例中，這項限制是在專案層級強制執行。您也可以在機構或資料夾層級設定這項限制。將 PROJECT_ID 替換為專案 ID。
```
      name: projects/PROJECT_ID/policies/custom.denyPrimeJobs
      spec:
        rules:
        – enforce: true
```

執行下列指令強制執行政策。

gcloud org-policies set-policy enforce-policy-denyPrimeJobs.yaml

如要測試限制，請嘗試使用 enable_prime 選項建立 Dataflow 工作。請按照「使用 Java 建立 Dataflow 管道」快速入門導覽課程的指示，建立 WordCount 工作。

mvn -Pdataflow-runner compile \
exec:java \
-Dexec.mainClass=org.apache.beam.examples.WordCount \
-Dexec.args="--project=PROJECT_ID \
--gcpTempLocation=gs://BUCKET_NAME/temp/ \
--output=gs://BUCKET_NAME/output \
--runner=DataflowRunner \
--region=us-central1 \
--dataflowServiceOptions=enable_prime" \
-Pdataflow-runner

輸出結果會與下列範例相似：

"details" : [ {
  "@type" : "type.googleapis.com/google.rpc.ErrorInfo",
  "reason" : "CUSTOM_ORG_POLICY_VIOLATION"
}]

稽核記錄應顯示違規詳細資料，如下所示：

  policyViolationInfo: {
    orgPolicyViolationInfo: {
    violationInfo: [
    0: {
      constraint: "customConstraints/custom.denyPrimeJobs"
      errorMessage: "Restrict creation of job with prime enabled"
      policyType: "CUSTOM_CONSTRAINT"
    }]}}

條件的運算式欄位

下表列出可用於建立條件的運算式欄位。條件是以一般運算語言 (CEL) 編寫。運算式欄位的值須區分大小寫。

如需下列運算式欄位的說明，以及可指定的值，請參閱 Dataflow Job JSON 表示法。

運算式欄位	值類型
`name`	`string`
`type`	`string`
`transformNameMapping`	`map`
`location`	`string`
`environment`	`message`
`environment.serviceOptions`	`list of string`
`environment.serviceKmsKeyName`	`string`
`environment.serviceAccountEmail`	`string`
`environment.workerRegion`	`string`
`environment.workerZone`	`string`
`environment.streamingMode`	`string`
`environment.debugOptions`	`message`
`environment.debugOptions.enableHotKeyLogging`	`bool`

應用實例

下表列出部分應用實例。

用途	動作	自訂限制
禁止使用主要工作	DENY	`resource.environment.serviceOptions.exists(value, value=='enable_prime')`
防止 VM 接受儲存在專案中繼資料中的 SSH 金鑰。	DENY	`!resource.environment.serviceOptions.exists(value, value=='block_project_ssh_keys')`
禁止工作，但不設定工作可執行的秒數上限	DENY	`!resource.environment.serviceOptions.exists(value, value.contains('max_workflow_runtime_walltime_seconds=')`

後續步驟

如要進一步瞭解組織政策，請參閱組織政策服務簡介。
進一步瞭解如何建立及管理組織政策。
查看預先定義組織政策限制的完整清單。

使用自訂限制條件管理 Dataflow 資源 透過集合功能整理內容 你可以依據偏好儲存及分類內容。

優點

政策繼承

定價

限制

事前準備

必要的角色

所需權限

建立自訂限制

設定自訂限制

控制台

gcloud

強制執行自訂組織政策

控制台

gcloud

範例：建立限制，禁止建立啟用主要功能的作業

gcloud

條件的運算式欄位

應用實例

後續步驟

使用自訂限制條件管理 Dataflow 資源