使用自訂機構政策

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

  • bigtableadmin.googleapis.com/AppProfile
  • bigtableadmin.googleapis.com/Backup
  • bigtableadmin.googleapis.com/Cluster
  • bigtableadmin.googleapis.com/Instance
  • bigtableadmin.googleapis.com/Table

如要進一步瞭解機構政策,請參閱自訂機構政策

關於機構政策和限制

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

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

政策繼承

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

限制

自訂機構政策尚未在下列項目中強制執行:

事前準備

  1. 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.
  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

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

  4. Install the Google Cloud CLI.

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

  6. To initialize the gcloud CLI, run the following command:

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

    Go to project selector

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

  9. Install the Google Cloud CLI.

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

  11. To initialize the gcloud CLI, run the following command:

    gcloud init
  12. 請確認您知道機構 ID。
  13. 必要的角色

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

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

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

    • ACTION:如果符合 condition,應採取的動作。可能的值為 ALLOWDENY

    • 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.requireDeletionProtectionOnTable

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

        gcloud org-policies set-policy POLICY_PATH
        

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

    測試自訂機構政策

    以下範例會建立自訂限制和政策,規定特定專案中的所有新資料表都必須啟用刪除保護機制。

    開始之前,請先瞭解下列事項:

    • 您的機構 ID
    • 專案 ID

    建立限制

    1. 將下列檔案儲存為 constraint-require-table-deletion-protection.yaml

      name: organizations/ORGANIZATION_ID/customConstraints/custom.requireDeletionProtectionOnTable
      resourceTypes:
      - bigtableadmin.googleapis.com/Table
      methodTypes:
      - CREATE
      condition: "resource.deletionProtection == true"
      actionType: ALLOW
      displayName: Only allow tables with deletion_protection set to true.
      description: All tables must have deletion_protection set to true.
      

      這項限制會規定每個資料表都必須將 deletion_protection 設為 true。

    2. 套用限制:

      gcloud org-policies set-custom-constraint constraint-require-table-deletion-protection.yaml
      
    3. 確認限制條件是否存在:

      gcloud org-policies describe-custom-constraint custom.requireDeletionProtectionOnTable  --organization=ORGANIZATION_ID
      

      輸出內容應會顯示您剛建立的限制。

    建立政策

    1. PROJECT_ID 設為專案 ID,然後將下列檔案儲存為 policy-require-table-deletion-protection.yaml

      name: projects/PROJECT_ID/policies/custom.requireDeletionProtectionOnTable
      spec:
        rules:
        - enforce: true
      
    2. 套用政策:

      
      gcloud org-policies set-policy policy-require-table-deletion-protection.yaml
      
      
    3. 確認政策存在:

      gcloud org-policies describe custom.requireDeletionProtectionOnTable --project=PROJECT_ID
      

      輸出內容應會顯示您剛建立的政策。

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

    測試政策

    gcloud bigtable tables create TABLE_ID --instance=INSTANCE_NAME --column-families="my-family" --no-deletion-protection
    

    由於現有限制規定所有新資料表都必須啟用防刪除功能,因此無法建立這個資料表。

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

    Operation denied by custom org policy: ["customConstraints/custom.requireDeletionProtectionOnTable": All tables must have deletion_protection set to true.]
    

    如要修正先前的錯誤,請建立啟用防刪除功能的資料表。請參閱以下範例:

    gcloud bigtable tables create TABLE_ID --instance=INSTANCE_NAME --column-families="my-family" --deletion-protection
    

    已成功建立資料表,並啟用防刪除功能。

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

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

    說明 限制語法
    拒絕未啟用單一資料列交易的應用程式設定檔
    name: organizations/ORGANIZATION_ID/customConstraints/custom.denyAppProfilesWithoutTransactionalWrites
    resourceTypes:
    - bigtableadmin.googleapis.com/AppProfile
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.singleClusterRouting.allowTransactionalWrites != true"
    actionType: DENY
    displayName: Deny app profiles where AllowTransactionalWrites is not enabled.
            description: All app profiles must have AllowTransactionalWrites enabled.
          
    強制僅在美國建立叢集
      name: organizations/ORGANIZATION_ID/customConstraints/custom.requireClustersToBeInUS
      resourceTypes:
      - bigtableadmin.googleapis.com/Cluster
      methodTypes:
      - CREATE
      condition: "resource.location.contains('/locations/us-')"
      actionType: ALLOW
      displayName: Require all clusters to be in the US.
      description: Clusters must be in the US.
          

    Bigtable 支援的資源

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

    資源 欄位
    bigtableadmin.googleapis.com/AppProfile resource.dataBoostIsolationReadOnly.computeBillingOwner
    resource.description
    resource.multiClusterRoutingUseAny.clusterIds
    resource.name
    resource.singleClusterRouting.allowTransactionalWrites
    resource.singleClusterRouting.clusterId
    resource.standardIsolation.priority
    bigtableadmin.googleapis.com/Backup resource.backupType
    resource.expireTime
    resource.hotToStandardTime
    resource.name
    resource.sourceTable
    bigtableadmin.googleapis.com/Cluster resource.clusterConfig.clusterAutoscalingConfig.autoscalingLimits.maxServeNodes
    resource.clusterConfig.clusterAutoscalingConfig.autoscalingLimits.minServeNodes
    resource.clusterConfig.clusterAutoscalingConfig.autoscalingTargets.cpuUtilizationPercent
    resource.clusterConfig.clusterAutoscalingConfig.autoscalingTargets.storageUtilizationGibPerNode
    resource.defaultStorageType
    resource.encryptionConfig.kmsKeyName
    resource.location
    resource.name
    resource.nodeScalingFactor
    resource.serveNodes
    bigtableadmin.googleapis.com/Instance resource.displayName
    resource.name
    bigtableadmin.googleapis.com/Table resource.automatedBackupPolicy.frequency
    resource.automatedBackupPolicy.retentionPeriod
    resource.changeStreamConfig.retentionPeriod
    resource.columnFamilies[*].gcRule.maxAge
    resource.columnFamilies[*].gcRule.maxNumVersions
    resource.columnFamilies[*].valueType.bytesType.encoding.raw.escapeNulls
    resource.columnFamilies[*].valueType.int64Type.encoding.bigEndianBytes.bytesType.encoding.raw.escapeNulls
    resource.columnFamilies[*].valueType.stringType.encoding.utf8Bytes.nullEscapeChar
    resource.columnFamilies[*].valueType.structType.encoding.delimitedBytes.delimiter
    resource.columnFamilies[*].valueType.structType.fields.fieldName
    resource.columnFamilies[*].valueType.timestampType.encoding.unixMicrosInt64.bigEndianBytes.bytesType.encoding.raw.escapeNulls
    resource.deletionProtection
    resource.name

    後續步驟