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

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

本頁面說明如何使用「組織政策服務」自訂限制條件，限制對下列 Google Cloud 資源執行的特定作業：

• firestore.googleapis.com/Database

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

關於組織政策和限制

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

組織政策提供各種 Google Cloud 服務的內建代管限制。不過，如要更精細地自訂組織政策中受限的特定欄位，您也可以建立「自訂限制」，並用於組織政策。

政策繼承

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

優點

• 安全性、法規遵循與管理：您可以透過下列方式使用自訂機構政策：

  • 如要強制執行災難復原規定，您可以要求資料庫採用特定的災難復原設定，例如防刪除功能和時間點復原。

  • 您可以限制只能在特定位置建立資料庫。

  • 您可以要求資料庫使用 CMEK (客戶自行管理的加密金鑰)。

• 稽核：自訂的組織政策限制會記錄在稽核記錄中。任何作業 (包括限制修改和限制檢查) 都會產生對應的 Cloud 稽核記錄。

事前準備

登入 Google Cloud 帳戶。如果您是 Google Cloud新手，歡迎 建立帳戶，親自體驗產品的實際應用成效。新客戶還能獲得價值 $300 美元的免費抵免額，能用於執行、測試及部署工作負載。

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 role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

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

Verify that billing is enabled for your Google Cloud project.

Install the Google Cloud CLI.

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

To initialize the gcloud CLI, run the following command:

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 role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

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

Verify that billing is enabled for your Google Cloud project.

Install the Google Cloud CLI.

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

To initialize the gcloud CLI, run the following command:

gcloud init

1. 請確認您知道組織 ID。

必要的角色

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

您或許也能透過自訂角色或其他預先定義的角色，取得必要權限。

Firestore 支援的資源

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

資源	欄位
firestore.googleapis.com/Database	resource.appEngineIntegrationMode
	resource.cmekConfig.kmsKeyName
	resource.concurrencyMode
	resource.deleteProtectionState
	resource.locationId
	resource.name
	resource.pointInTimeRecoveryEnablement
	resource.type

設定自訂限制

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

控制台

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

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

   前往「Organization policies」(組織政策)

2. 在專案挑選器中，選取要設定組織政策的專案。
3. 按一下「 Custom constraint」(自訂限制)。
4. 在「顯示名稱」方塊中，輸入限制條件的人類可讀名稱。這個名稱會用於錯誤訊息，可用於識別和偵錯。請勿在顯示名稱中使用個人識別資訊 (PII) 或機密資料，因為這類名稱可能會在錯誤訊息中曝光。這個欄位最多可輸入 200 個字元。
5. 在「Constraint ID」(限制 ID) 方塊中，輸入新自訂限制的 ID。自訂限制只能包含字母 (包括大寫和小寫) 或數字，例如 custom.deleteProtectionRequired。這個欄位最多可包含 70 個字元，不含前置字元 (custom.)，例如 organizations/123456789/customConstraints/custom。請勿在限制 ID 中輸入 PII 或機密資料，因為錯誤訊息可能會顯示上述資訊。
6. 在「Description」(說明) 方塊中，輸入人類可讀的限制說明。違反政策時，系統會將這段說明做為錯誤訊息顯示。請詳細說明違反政策的原因，以及如何解決違規問題。請勿在說明中輸入 PII 或機密資料，因為錯誤訊息可能會顯示上述資訊。這個欄位最多可輸入 2000 個半形字元。
7. 在「Resource type」(資源類型) 方塊中，選取包含要限制的物件和欄位的 Google Cloud REST 資源名稱，例如 container.googleapis.com/NodePool。大多數資源類型最多支援 20 項自訂限制。如果嘗試建立更多自訂限制，作業會失敗。
8. 在「Enforcement method」(強制執行方法) 下方，選取要對 REST CREATE 方法強制執行限制，還是同時對 CREATE 和 UPDATE 方法強制執行限制。如果您使用 UPDATE 方法對違反限制的資源強制執行限制，組織政策會禁止對該資源進行變更，除非變更可解決違規問題。

如要查看各項服務支援的方法，請在「 支援自訂限制的服務」中找到該服務。

9. 如要定義條件，請按一下「 編輯條件」。
1. 在「新增條件」面板中，建立參照支援服務資源的 CEL 條件，例如 resource.management.autoUpgrade == false。這個欄位最多可輸入 1000 個字元。如要進一步瞭解 CEL 的用法，請參閱「 一般運算語言」。如要進一步瞭解可在自訂限制中使用的服務資源，請參閱「 支援自訂限制的服務」。
2. 按一下 [儲存]。
10. 在「Action」下方，選取在符合條件時，要允許或拒絕評估的方法。

「拒絕」動作代表如果條件評估結果為 true，系統會禁止建立或更新資源。

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

11. 按一下「Create constraint」(建立限制)。

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

gcloud

1. 如要建立自訂限制，請使用下列格式建立 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.deleteProtectionRequired。這個欄位最多可包含 70 個字元，不含前置字元 (custom.)，例如 organizations/123456789/customConstraints/custom。請勿在限制 ID 中輸入 PII 或機密資料，因為錯誤訊息可能會顯示上述資訊。
• RESOURCE_NAME：內含要限制的物件和欄位的 Google Cloud資源完整名稱，例如：firestore.googleapis.com/Database。大多數資源類型最多支援 20 個自訂限制。如果您嘗試建立更多自訂限制，作業就會失敗。
• methodTypes：強制執行限制的 REST 方法。可以是 CREATE，或同時為 CREATE 和 UPDATE。如果您使用 UPDATE 方法對違反限制的資源強制執行限制，組織政策會禁止對該資源進行變更，除非變更可解決違規問題。

如要查看各項服務支援的方法，請在「 支援自訂限制的服務」中找出該服務。

• CONDITION：針對支援服務資源表示法所撰寫的 CEL 條件。這個欄位最多可輸入 1000 個字元。例如："resource.deleteProtectionState == \"DELETE_PROTECTION_ENABLED\""。

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

• ACTION：符合 condition 時採取動作。可能的值為 ALLOW 和 DENY。

「允許」動作代表如果條件評估為 true，系統就會允許建立或更新資源。這也表示除了條件中明確列出的情況外，所有其他情況都會遭到封鎖。

「拒絕」動作是指如果條件評估結果為 true，系統就會禁止建立或更新資源。

• DISPLAY_NAME：限制的人類可讀名稱。這個名稱會用於錯誤訊息，可用於識別和偵錯。請勿在顯示名稱中使用 PII 或機密資料，因為錯誤訊息可能會顯示這類資訊。這個欄位最多可輸入 200 個字元。
• DESCRIPTION：違反政策時，會以錯誤訊息形式顯示且易於理解的限制說明。這個欄位最多可包含 2000 個半形字元。
2. 為新的自訂限制建立 YAML 檔案後，您必須加以設定，才能用於組織的組織政策。如要設定自訂限制，請使用 gcloud org-policies set-custom-constraint 指令：

gcloud org-policies set-custom-constraint CONSTRAINT_PATH

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

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

3. 如要確認是否存在自訂限制，請使用 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」(組織政策) 頁面。

   前往「Organization policies」(組織政策)

2. 在專案挑選器中，選取要設定組織政策的專案。
3. 在「Organization policies」(組織政策) 頁面的清單中選取限制，即可查看該限制的「Policy details」(政策詳細資料) 頁面。
4. 如要為這項資源設定組織政策，請按一下「Manage policy」(管理政策)。
5. 在「Edit policy」(編輯政策) 頁面，選取「Override parent's policy」(覆寫上層政策)。
6. 按一下「Add a rule」(新增規則)。
7. 在「Enforcement」(強制執行) 部分，選取是否要強制執行這項組織政策。
8. 選用：如要根據標記設定組織政策的條件，請按一下「Add condition」(新增條件)。請注意，如果為組織政策新增條件式規則，您必須至少新增一項無條件規則，否則無法儲存政策。詳情請參閱「 使用標記設定組織政策的範圍」。
9. 按一下「Test changes」(測試變更)，模擬組織政策的影響。詳情請參閱「 使用 Policy Simulator 測試組織政策變更」。
10. 如要在模擬測試模式下強制執行組織政策，請按一下「Set dry run policy」(設定模擬測試政策)。詳情請參閱「 測試組織政策」。
11. 確認空跑模式中的組織政策運作正常後，請按一下「Set policy」(設定政策)，設定正式政策。

gcloud

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

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

dryRunSpec:
  rules:
  - enforce: true

請替換下列項目：

• PROJECT_ID：要強制執行限制的專案。
• CONSTRAINT_NAME：要為自訂限制定義的名稱，例如 custom.deleteProtectionRequired。
2. 如要以模擬測試模式強制執行組織政策，請執行下列指令並加上 dryRunSpec 旗標：

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

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

3. 確認模擬測試模式中的組織政策運作正常後，請使用 org-policies set-policy 指令和 spec 旗標設定正式政策：

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

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

測試自訂組織政策

開始之前，請先確認您知曉下列資訊：

• 組織 ID

1. 按照下列方式建立 deleteProtectionRequired.yaml 檔案：

    name: organizations/ORGANIZATION_ID/customConstraints/custom.deleteProtectionRequired
    resourceTypes:
    - firestore.googleapis.com/Database
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.deleteProtectionState == \"DELETE_PROTECTION_ENABLED\""
    actionType: ALLOW
    displayName: Firestore Delete Protection Required
    description: To ensure the data security, Delete Protection is required to be enabled for Firestore databases.
   

   這可確保 Firestore 資料庫上的所有 CREATE 和 UPDATE 方法都符合 deleteProtectionState 為 DELETE_PROTECTION_ENABLED 的限制。因此，如果建立/更新/還原/複製資料庫時，未明確啟用刪除保護功能，系統就會拒絕操作。

2. 在組織層級設定自訂限制：

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

測試政策

嘗試在組織中的專案建立資料庫，但不設定 --delete-protection 旗標：

gcloud firestore database create \
   --project=PROJECT_ID \
   --database=DATABASE_ID \

輸出內容如下：

Operation denied by custom org policies: ["customConstraints/custom.deleteProtectionRequired": "To ensure the data security, Delete Protection is required to be enabled for Firestore databases"]

測試及分析組織政策變更

建議您測試並模擬執行組織政策的所有變更，進一步瞭解環境狀態及變更對環境的影響。

組織政策的政策模擬器可協助您瞭解限制和組織政策對目前環境的影響。您可以使用這項工具，在正式環境強制執行政策前，查看所有資源設定，找出違規之處。如需詳細操作說明，請參閱「使用 Policy Simulator 測試組織政策變更」。

瞭解目前的效果後，您可以在模擬執行模式下建立機構政策，瞭解政策在未來 30 天內的影響和潛在違規情形。模擬測試模式下的組織政策是一種組織政策，違反政策的行為會記錄在稽核記錄中，但不會遭到拒絕。您可以使用 Google Cloud 控制台或 Google Cloud CLI，透過自訂限制建立模擬測試模式的組織政策。如需詳細操作說明，請參閱「在模擬測試模式中建立組織政策」。

常見用途的自訂組織政策範例

下表提供一些常見自訂限制的語法範例。

說明	限制語法
資料庫名稱必須遵循特定模式。請注意，自訂組織政策中的資料庫名稱格式為 projects/project-id/databases/database-id，而資料庫管理作業中僅指定 database-id。	name: organizations/ORGANIZATION_ID/customConstraints/custom.nameSuffixMobile resourceTypes: - firestore.googleapis.com/Database methodTypes: - CREATE condition: "resource.name.endsWith('-mobile')" actionType: ALLOW displayName: Firestore database names end with "-mobile" description: Only allow the creation of database names ending with suffix "-mobile"
資料庫只能在指定的位置建立。	name: organizations/ORGANIZATION_ID/customConstraints/custom.locationUsCentral1 resourceTypes: - firestore.googleapis.com/Database methodTypes: - CREATE condition: "resource.locationId == 'us-central1'" actionType: ALLOW displayName: Firestore database location id us-central1 description: Only allow the creation of databases in region us-central1
資料庫必須屬於指定的類型。	name: organizations/ORGANIZATION_ID/customConstraints/custom.typeFirestore resourceTypes: - firestore.googleapis.com/Database methodTypes: - CREATE - UPDATE condition: "resource.type=="FIRESTORE_NATIVE"" actionType: ALLOW displayName: Firestore database type Firestore_Native description: Only allow creation and updating of databases if the type is Firestore in native mode.
資料庫必須使用指定的並行模式。	name: organizations/ORGANIZATION_ID/customConstraints/custom.concurrencyNotPessimistic resourceTypes: - firestore.googleapis.com/Database methodTypes: - CREATE - UPDATE condition: "resource.concurrencyMode == 'PESSIMISTIC'" actionType: DENY displayName: Firestore database concurrencyMode not pessimistic description: Disallow the creation and updating of databases with pessimistic concurrency mode.
資料庫必須啟用point-in-time-recovery功能。	name: organizations/ORGANIZATION_ID/customConstraints/custom.pitrEnforce resourceTypes: - firestore.googleapis.com/Database methodTypes: - CREATE - UPDATE condition: "resource.pointInTimeRecoveryEnablement == "POINT_IN_TIME_RECOVERY_ENABLED"" actionType: ALLOW displayName: Firestore database enables PiTR description: Only allow the creation and updating of a databases if PiTR is enabled.
資料庫必須使用指定的 App Engine 整合模式。	name: organizations/ORGANIZATION_ID/customConstraints/custom.enableAppEngineIntegrationMode resourceTypes: - firestore.googleapis.com/Database methodTypes: - CREATE - UPDATE condition: "resource.appEngineIntegrationMode == 'ENABLED'" actionType: ALLOW displayName: Firestore Database App Engine integration mode enabled description: Only allow the creation and updating of databases with App Engine Integration Mode enabled.
除非啟用防刪除功能，否則不允許建立資料庫。	name: organizations/ORGANIZATION_ID/customConstraints/custom.deleteProtectionRequired resourceTypes: - firestore.googleapis.com/Database methodTypes: - CREATE - UPDATE condition: "resource.deleteProtectionState == "DELETE_PROTECTION_ENABLED"" actionType: ALLOW displayName: Firestore Delete Protection Required description: To ensure the data security, Delete Protection is required to be enabled for Firestore databases.
資料庫必須使用指定的客戶自行管理的加密金鑰 (CMEK) 設定。	name: organizations/ORGANIZATION_ID/customConstraints/custom.cmekKeyNotDev resourceTypes: - firestore.googleapis.com/Database methodTypes: - CREATE - UPDATE condition: "resource.cmekConfig.kmsKeyName.matches('dev$')" actionType: DENY displayName: Firestore database CMEK key not dev description: Disallow the creation and updating of databases with CMEK KMS keys ending with "dev".
資料庫必須使用指定的資料庫版本。	name: organizations/ORGANIZATION_ID/customConstraints/custom.standardEditionRequired resourceTypes: - firestore.googleapis.com/Database methodTypes: - CREATE - UPDATE condition: "resource.databaseEdition == "STANDARD"" actionType: ALLOW displayName: Firestore Standard Edition Required description: Only allow the creation and updating of databases with Standard Edition.
建立資料庫資源時，必須與特定標記建立關聯。	name: organizations/ORGANIZATION_ID/customConstraints/custom.requireTagAtDbCreation resourceTypes: - firestore.googleapis.com/Database methodTypes: - GOVERN_TAGS condition: '!resource.matchDirectTag("ORGANIZATION_ID/TAG_KEY", "TAG_VALUE")' actionType: DENY displayName: Require a specific tag when databases get created description: Denies the database creation operations if the request does not contain the tag ORGANIZATION_ID/TAG_KEY with the value TAG_VALUE.

後續步驟

• 進一步瞭解組織政策服務。
• 進一步瞭解如何建立及管理組織政策。
• 查看代管組織政策限制的完整清單。