建立自訂機構政策限制

Cloud Composer 3 | Cloud Composer 2 | Cloud Composer 1

本頁說明如何使用 Organization Policy Service 自訂限制，限制對下列 Google Cloud 資源執行的特定作業：

• composer.googleapis.com/Environment

如要進一步瞭解機構政策，請參閱「自訂機構政策」。

關於機構政策和限制

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

機構政策提供各種 Google Cloud 服務的內建代管限制。不過，如要更精細地自訂機構政策中受限的特定欄位，也可以建立自訂限制，並在機構政策中使用這些自訂限制。

政策繼承

根據預設，機構政策會由您強制執行政策的資源子系繼承。舉例來說，如果您對資料夾強制執行政策， Google Cloud 系統會對該資料夾中的所有專案強制執行政策。如要進一步瞭解這項行為及如何變更，請參閱「階層評估規則」。

優點

您可以透過自訂機構政策，允許或拒絕 Cloud Composer 資源的特定值。舉例來說，如果建立或更新 Cloud Composer 環境的要求，無法滿足機構政策設定的自訂限制驗證，要求就會失敗，並向呼叫端傳回錯誤。此外，使用自訂機構政策時：

1. 提升安全性。舉例來說，您可以定義政策，禁止建立公開 IP 環境、啟用私人使用的公開 IP 位址，或指定特定網路和子網路的使用方式。

2. 在建立或更新環境時，可精細控管要建立或使用的資源。

限制

與所有機構政策限制一樣，政策變更不會回溯套用至現有執行個體。

• 新政策不會影響現有的執行個體設定。
• 除非您使用Google Cloud 主控台、Google Cloud CLI 或 RPC，將現有執行個體設定從符合規範的值變更為不符合規範的值，否則現有設定仍有效。

在資源的 UPDATE 方法類型上強制執行自訂機構政策前，請先確認現有環境是否符合各項政策。

由於一項更新作業只能更新一個欄位，如果現有環境的多個欄位同時違反政策，就可能發生死結。

如要避免死結，請採取下列任一做法：

• (建議) 先確保所有現有環境都符合政策規定，再對資源強制執行政策。如要查看現有環境中，哪些環境在政策強制執行後不符合規定，請使用政策模擬器。

• 停用政策強制執行功能，將現有環境更新為符合規範的狀態，然後重新強制執行政策。

事前準備

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.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Make sure 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.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

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

Install the Google Cloud CLI.

如果您使用外部識別資訊提供者 (IdP)，請先 使用聯合身分登入 gcloud CLI。

如要初始化 gcloud CLI，請執行下列指令：

gcloud init

1. 請確認您知道機構 ID。

必要的角色

如要取得管理自訂機構政策所需的權限，請要求管理員為您授予機構資源的機構政策管理員 (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.restrictEnvironmentSize。這個欄位的長度上限為 70 個字元。

• RESOURCE_NAME：包含要限制物件和欄位的Google Cloud 資源完整名稱。例如：composer.googleapis.com/Environment。

• CONDITION：針對支援服務資源的代表項目編寫的 CEL 條件。這個欄位的長度上限為 1000 個字元。如要進一步瞭解可編寫條件的資源，請參閱「支援的資源」。例如：resource.config.environmentSize == "ENVIRONMENT_SIZE_SMALL"。

• ACTION：如果符合 condition，應採取的動作。可能的值為 ALLOW 和 DENY。

• 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 資源。

控制台

1. 前往 Google Cloud 控制台的「Organization policies」(組織政策) 頁面。

   前往「機構政策」

2. 在專案選擇工具中，選取要設定機構政策的專案。
3. 在「Organization policies」(機構政策) 頁面上的清單中選取限制條件，即可查看該限制條件的「Policy details」(政策詳情) 頁面。
4. 如要設定這項資源的機構政策，請按一下「管理政策」。
5. 在「編輯政策」頁面中，選取「覆寫上層政策」。
6. 按一下「新增規則」。
7. 在「Enforcement」(強制執行) 區段中，選取是否要強制執行這項機構政策。
8. 選用：如要根據標記設定機構政策條件，請按一下「新增條件」。請注意，如果為組織政策新增條件式規則，您必須至少新增一項無條件規則，否則無法儲存政策。詳情請參閱「使用標記設定組織政策」。
9. 按一下「測試變更」，模擬機構政策的影響。舊版受管理限制不支援政策模擬。詳情請參閱「 使用 Policy Simulator 測試組織政策變更」。
10. 如要完成並套用機構政策，請按一下「設定政策」。這項政策最多需要 15 分鐘才會生效。

gcloud

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

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

取代下列項目：

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

如要強制執行包含限制的機構政策，請執行下列指令：

    gcloud org-policies set-policy POLICY_PATH
    

將 POLICY_PATH 替換為機構政策 YAML 檔案的完整路徑。這項政策最多需要 15 分鐘才會生效。

測試自訂機構政策

以下範例會建立自訂限制和政策，只允許小型 Cloud Composer 環境。

開始之前，請先瞭解下列事項：

• 您的機構 ID
• 您的專案 ID

建立限制

1. 將下列檔案儲存為 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. 套用限制：

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

建立政策

1. 將下列檔案儲存為 policy-require-only-small-environments.yaml：

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

2. 套用政策：

   
   gcloud org-policies set-policy policy-require-only-small-environments.yaml
   
   

套用政策後，請等待約兩分鐘，讓 Google Cloud開始強制執行政策。

測試政策

gcloud composer environments create ENVIRONMENT_NAME \
  --location=LOCATION \
  --image-version="composer-2.13.8-airflow-2.10.5" \
  --environment-size=medium

由於現有限制只允許建立小型 Composer 環境，因此無法建立這個環境。

輸出結果會與下列內容相似：

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.]

如要解決先前的錯誤，請建立小型環境。例如：

gcloud composer environments create ENVIRONMENT_NAME \
  --location=LOCATION \
  --image-version="composer-2.13.8-airflow-2.10.5" \
  --environment-size=small

已順利開始建立環境。

常見用途的自訂機構政策範例

下表提供一些常見用途的自訂限制語法：

說明	限制語法
僅允許私人 IP Cloud Composer 環境	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
工作站數量上限不得超過 10 個	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 支援的資源

下表列出可在自訂限制中參照的 Cloud Composer 資源。

資源	欄位
composer.googleapis.com/Environment	resource.config.environmentSize
	resource.config.maintenanceWindow.recurrence
	resource.config.masterAuthorizedNetworksConfig.enabled
	resource.config.nodeConfig.enableIpMasqAgent
	resource.config.nodeConfig.network
	resource.config.nodeConfig.serviceAccount
	resource.config.nodeConfig.subnetwork
	resource.config.privateEnvironmentConfig.cloudComposerConnectionSubnetwork
	resource.config.privateEnvironmentConfig.enablePrivateBuildsOnly
	resource.config.privateEnvironmentConfig.enablePrivateEnvironment
	resource.config.privateEnvironmentConfig.enablePrivatelyUsedPublicIps
	resource.config.privateEnvironmentConfig.networkingConfig.connectionType
	resource.config.privateEnvironmentConfig.privateClusterConfig.enablePrivateEndpoint
	resource.config.recoveryConfig.scheduledSnapshotsConfig.enabled
	resource.config.recoveryConfig.scheduledSnapshotsConfig.snapshotCreationSchedule
	resource.config.recoveryConfig.scheduledSnapshotsConfig.snapshotLocation
	resource.config.recoveryConfig.scheduledSnapshotsConfig.timeZone
	resource.config.resilienceMode
	resource.config.softwareConfig.cloudDataLineageIntegration.enabled
	resource.config.softwareConfig.imageVersion
	resource.config.softwareConfig.webServerPluginsMode
	resource.config.workloadsConfig.dagProcessor.count
	resource.config.workloadsConfig.dagProcessor.cpu
	resource.config.workloadsConfig.dagProcessor.memoryGb
	resource.config.workloadsConfig.dagProcessor.storageGb
	resource.config.workloadsConfig.scheduler.count
	resource.config.workloadsConfig.scheduler.cpu
	resource.config.workloadsConfig.scheduler.memoryGb
	resource.config.workloadsConfig.scheduler.storageGb
	resource.config.workloadsConfig.triggerer.count
	resource.config.workloadsConfig.triggerer.cpu
	resource.config.workloadsConfig.triggerer.memoryGb
	resource.config.workloadsConfig.webServer.cpu
	resource.config.workloadsConfig.webServer.memoryGb
	resource.config.workloadsConfig.webServer.storageGb
	resource.config.workloadsConfig.worker.cpu
	resource.config.workloadsConfig.worker.maxCount
	resource.config.workloadsConfig.worker.memoryGb
	resource.config.workloadsConfig.worker.minCount
	resource.config.workloadsConfig.worker.storageGb
	resource.name

後續步驟

• 進一步瞭解機構政策服務。
• 進一步瞭解如何建立及管理機構政策。
• 請參閱受管理機構政策限制的完整清單。