為 GKE 備份服務建立自訂限制

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

• gkebackup.googleapis.com/BackupPlan
• gkebackup.googleapis.com/Backup
• gkebackup.googleapis.com/RestorePlan
• gkebackup.googleapis.com/Restore

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

關於機構政策和限制

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

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

政策繼承

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

事前準備

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

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.

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.

如果您使用外部識別資訊提供者 (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.retentionPolicyEnforced。這個欄位的長度上限為 70 個字元。

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

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

• 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.retentionPolicyEnforced。

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

    gcloud org-policies set-policy POLICY_PATH
    

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

測試自訂機構政策

下列步驟說明如何建立自訂限制和政策，讓使用者在 retainDays 欄位設為大於 30 的值時，建立 Backup for GKE 備份。

開始之前，請先備妥下列項目：

• 機構 ID
• 您的專案 ID

建立限制

1. 將下列檔案儲存為 CONSTRAINT_FILE_NAME.yaml：

   name: organizations/ORGANIZATION_ID/customConstraints/custom.retentionPolicyEnforced
   resourceTypes:
   - gkebackup.googleapis.com/Backup
   methodTypes:
   - CREATE
   condition: "resource.retainDays > 30"
   actionType: ALLOW
   displayName: Enforce retention policy
   description: Enforce backup creation with a retention policy greater than 30 days.
   

   將 ORGANIZATION_ID 替換為機構 ID。

   這個檔案定義的限制是 retainDays 欄位在 CREATE 方法中必須大於 30。

2. 使用 gcloud org-policies set-custom-constraint 指令套用限制：

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

3. 使用 gcloud org-policies list-custom-constraints 指令確認限制條件是否存在：

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

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

   CUSTOM_CONSTRAINT                ACTION_TYPE  METHOD_TYPES   RESOURCE_TYPES                    DISPLAY_NAME
   custom.retentionPolicyEnforced   DENY         CREATE,UPDATE  gkebackup.googleapis.com/Backup   Enforce retention policy
   ...
   

建立政策

1. 將下列檔案儲存為 POLICY_FILE_NAME.yaml：

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

   將 PROJECT_ID 替換為您的專案 ID。

2. 使用 gcloud org-policies set-policy 指令套用政策：

   gcloud org-policies set-policy POLICY_FILE_NAME.yaml
   

3. 使用 gcloud org-policies list 指令確認政策是否存在：

   gcloud org-policies list --project=PROJECT_ID
   

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

   CONSTRAINT                         LIST_POLICY  BOOLEAN_POLICY  ETAG
   custom.retentionPolicyEnforced     -            SET             CPiLkMMGEKDFq6IB-
   

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

測試政策

1. 建立備份，但未將 retainDays 欄位設為大於 30 的值：

   gcloud beta container backup-restore backups create test-backup --backup-plan=test-backup-plan --location=us-central1
   

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

   ERROR: (gcloud.beta.container.backup-restore.backups.create) FAILED_PRECONDITION: Operation denied by org policy on resource 'pprojects/test-project/locations/us-central1/backupPlans/autopilot-cluster-1-backup-1/backups/test-backup-1': ["customConstraints/custom.retentionPolicyEnforced": "Enforce backup creation with a retention policy greater than 30 days."].
   - '@type': type.googleapis.com/google.rpc.DebugInfo
     detail: "generic::failed_precondition: Operation denied by org policy on resource\
       \ 'projects/test-project/locations/us-central1/backupPlans/autopilot-cluster-1-backup-1/backups/test-backup-1':\
       \ [\"customConstraints/custom.retentionPolicyEnforced\": \"Enforce backup creation with a retention \
       \ policy greater than 30 days.\"]."
     .
     .
     .
   - '@type': type.googleapis.com/google.rpc.DebugInfo
   - '@type': type.googleapis.com/google.rpc.ErrorInfo
     domain: gkebackup.googleapis.com
     metadata:
       customConstraints: customConstraints/custom.backupRetainDays
       resource: projects/test-project/locations/us-central1/backupPlans/autopilot-cluster-1-backup-1/backups/test-backup-1
     reason: CUSTOM_ORG_POLICY_VIOLATION
   

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

下表列出可能對您有所幫助的自訂機構政策：

說明	限制語法
僅允許建立保留期限超過 20 天的備份	name: organizations/ORGANIZATION_ID/customConstraints/custom.retainDaysLimit resourceTypes: - gkebackup.googleapis.com/Backup methodTypes: - CREATE - UPDATE condition: resource.retainDays > 20 actionType: ALLOW displayName: Minimum Backup Retention period description: Minimum Backup Retention period of 20 days is required
禁止建立 cronSchedule 與預期不同的備份方案	name: organizations/ORGANIZATION_ID/customConstraints/custom.disableInvalidScheduleBackupPlan resourceTypes: - gkebackup.googleapis.com/BackupPlan methodTypes: - CREATE - UPDATE condition: resource.backupSchedule.cronSchedule != "5 20 * * *" actionType: DENY displayName: Backup plan cron schedule constraint description: Deny Backup plan creation or update if cron schedule is not set to 5 20 * * *.

Backup for GKE 支援的資源

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

資源	欄位
gkebackup.googleapis.com/Backup	resource.deleteLockDays
	resource.description
	resource.retainDays
gkebackup.googleapis.com/BackupPlan	resource.backupConfig.allNamespaces
	resource.backupConfig.encryptionKey.gcpKmsEncryptionKey
	resource.backupConfig.includeSecrets
	resource.backupConfig.includeVolumeData
	resource.backupConfig.permissiveMode
	resource.backupConfig.selectedApplications.namespacedNames.name
	resource.backupConfig.selectedApplications.namespacedNames.namespace
	resource.backupConfig.selectedNamespaces.namespaces
	resource.backupSchedule.cronSchedule
	resource.backupSchedule.paused
	resource.backupSchedule.rpoConfig.exclusionWindows.daily
	resource.backupSchedule.rpoConfig.exclusionWindows.daysOfWeek.daysOfWeek
	resource.backupSchedule.rpoConfig.exclusionWindows.duration
	resource.backupSchedule.rpoConfig.targetRpoMinutes
	resource.cluster
	resource.deactivated
	resource.description
	resource.retentionPolicy.backupDeleteLockDays
	resource.retentionPolicy.backupRetainDays
	resource.retentionPolicy.locked
gkebackup.googleapis.com/Restore	resource.backup
	resource.description
	resource.filter.exclusionFilters.groupKind.resourceGroup
	resource.filter.exclusionFilters.groupKind.resourceKind
	resource.filter.exclusionFilters.name
	resource.filter.exclusionFilters.namespace
	resource.filter.inclusionFilters.groupKind.resourceGroup
	resource.filter.inclusionFilters.groupKind.resourceKind
	resource.filter.inclusionFilters.name
	resource.filter.inclusionFilters.namespace
	resource.volumeDataRestorePolicyOverrides.policy
	resource.volumeDataRestorePolicyOverrides.selectedPvcs.namespacedNames.name
	resource.volumeDataRestorePolicyOverrides.selectedPvcs.namespacedNames.namespace
gkebackup.googleapis.com/RestorePlan	resource.backupPlan
	resource.cluster
	resource.description
	resource.restoreConfig.allNamespaces
	resource.restoreConfig.clusterResourceConflictPolicy
	resource.restoreConfig.clusterResourceRestoreScope.allGroupKinds
	resource.restoreConfig.clusterResourceRestoreScope.excludedGroupKinds.resourceGroup
	resource.restoreConfig.clusterResourceRestoreScope.excludedGroupKinds.resourceKind
	resource.restoreConfig.clusterResourceRestoreScope.noGroupKinds
	resource.restoreConfig.clusterResourceRestoreScope.selectedGroupKinds.resourceGroup
	resource.restoreConfig.clusterResourceRestoreScope.selectedGroupKinds.resourceKind
	resource.restoreConfig.excludedNamespaces.namespaces
	resource.restoreConfig.namespacedResourceRestoreMode
	resource.restoreConfig.noNamespaces
	resource.restoreConfig.restoreOrder.groupKindDependencies.requiring.resourceGroup
	resource.restoreConfig.restoreOrder.groupKindDependencies.requiring.resourceKind
	resource.restoreConfig.restoreOrder.groupKindDependencies.satisfying.resourceGroup
	resource.restoreConfig.restoreOrder.groupKindDependencies.satisfying.resourceKind
	resource.restoreConfig.selectedApplications.namespacedNames.name
	resource.restoreConfig.selectedApplications.namespacedNames.namespace
	resource.restoreConfig.selectedNamespaces.namespaces
	resource.restoreConfig.substitutionRules.newValue
	resource.restoreConfig.substitutionRules.originalValuePattern
	resource.restoreConfig.substitutionRules.targetGroupKinds.resourceGroup
	resource.restoreConfig.substitutionRules.targetGroupKinds.resourceKind
	resource.restoreConfig.substitutionRules.targetJsonPath
	resource.restoreConfig.substitutionRules.targetNamespaces
	resource.restoreConfig.transformationRules.description
	resource.restoreConfig.transformationRules.fieldActions.fromPath
	resource.restoreConfig.transformationRules.fieldActions.op
	resource.restoreConfig.transformationRules.fieldActions.path
	resource.restoreConfig.transformationRules.fieldActions.value
	resource.restoreConfig.transformationRules.resourceFilter.groupKinds.resourceGroup
	resource.restoreConfig.transformationRules.resourceFilter.groupKinds.resourceKind
	resource.restoreConfig.transformationRules.resourceFilter.jsonPath
	resource.restoreConfig.transformationRules.resourceFilter.namespaces
	resource.restoreConfig.volumeDataRestorePolicy
	resource.restoreConfig.volumeDataRestorePolicyBindings.policy
	resource.restoreConfig.volumeDataRestorePolicyBindings.volumeType

後續步驟

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