使用自訂機構政策

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

    • pubsub.googleapis.com/Schema
    • pubsub.googleapis.com/Snapshot
    • pubsub.googleapis.com/Subscription
    • pubsub.googleapis.com/Topic

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

    關於機構政策和限制

    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. 如果您使用外部識別資訊提供者 (IdP)，請先 使用聯合身分登入 gcloud CLI。

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

      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. 如果您使用外部識別資訊提供者 (IdP)，請先 使用聯合身分登入 gcloud CLI。

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

      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.messageRetentionSet。這個欄位的長度上限為 70 個字元。

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

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

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

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

          gcloud org-policies set-policy POLICY_PATH

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

      測試自訂機構政策

      以下範例會建立自訂限制和政策，要求特定專案中的所有新主題都必須對訊息強制執行傳輸中保證。

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

      • 您的機構 ID
      • 專案 ID

      建立限制

      1. 將下列檔案儲存為 constraint-require-message-retention.yaml：

        name: organizations/ORGANIZATION_ID/customConstraints/custom.messageRetentionSet
resourceTypes:
- Topic
methodTypes:
- CREATE
- UPDATE
condition: "has(resource.messageRetentionDuration)"
actionType: ALLOW
displayName: Require message retention
description: All topics must set a message retention duration.

        這項限制定義了每個主題都必須設定訊息保留時間。

        1. 套用限制：

          gcloud org-policies set-custom-constraint constraint-require-message-retention.yaml

        2. 確認限制條件是否存在：

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

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

          CUSTOM_CONSTRAINT                       ACTION_TYPE   METHOD_TYPES     RESOURCE_TYPES                     DISPLAY_NAME
custom.messageRetentionSet              ALLOW         CREATE,UPDATE    pubsub.googleapis.com/Topic        Require message retention
...

        建立政策

        1. 將下列檔案儲存為 policy-require-message-retention.yaml：

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

          將 PROJECT_ID 替換為您的專案 ID。

        2. 套用政策：

          gcloud org-policies set-policy policy-`policy-require-message-retention.yaml`:

        3. 確認政策存在：

          gcloud org-policies list --project=PROJECT_ID

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

          CONSTRAINT                         LIST_POLICY    BOOLEAN_POLICY    ETAG
custom.messageRetentionSet         -              SET               COCsm5QGENiXi2E=

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

        測試政策

        請嘗試建立主題，但不要啟用訊息保留功能：

        gcloud pubsub topics create org-policy-test \
  --project=PROJECT_ID \

        輸出內容如下：

        Operation denied by custom org policies: ["customConstraints/custom.messageRetentionSet": "All topics must set a message retention duration."].

ERROR: Failed to create topic [projects/PROJECT_ID/topics/org-policy-test]: Operation denied by org policy: ["customConstraints/custom.messageRetentionSet": "All topics must set a message retention duration."].
ERROR: (gcloud.pubsub.topics.create) Failed to create the following: [org-policy-test].

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

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

        說明 限制語法
        要求主題強制執行訊息的傳輸中保證，並提供至少一個允許的持續性區域 
          name: organizations/ORGANIZATION_ID/customConstraints/custom.enforceInTransitWithRegions
  resourceTypes:
  - pubsub.googleapis.com/Topic
  methodTypes:
  - CREATE
  - UPDATE
  condition: "resource.messageStoragePolicy.enforceInTransit == true && resource.messageStoragePolicy.allowedPersistenceRegions.size() >= 1"
  actionType: ALLOW
  displayName: Require in-transit enforcement and regions
  description: All topics must enable in-transit message storage policy enforcement and contain a non-empty list of allowed persistence regions.
        要求主題強制執行訊息的傳輸中保證，並排除特定區域 
          name: organizations/ORGANIZATION_ID/customConstraints/custom.enforceInTransitWithoutUsEast1
  resourceTypes:
  - pubsub.googleapis.com/Topic
  methodTypes:
  - CREATE
  - UPDATE
  condition: "resource.messageStoragePolicy.enforceInTransit && !resource.messageStoragePolicy.allowedPersistenceRegions.exists(r, r == 'us-east1')"
  actionType: ALLOW
  displayName: Require in-transit enforcement and restrict regions
  description: All topics must enable in-transit message storage policy enforcement, and exclude us-east1 from the allowed persistence regions.
        訂閱項目必須符合最短訊息保留時間 
          name: organizations/ORGANIZATION_ID/customConstraints/custom.minMessageRetentionDuration
  resourceTypes:
  - pubsub.googleapis.com/Subscription
  methodTypes:
  - CREATE
  - UPDATE
  condition: "resource.messageRetentionDuration < duration('30m')"
  actionType: DENY
  displayName: Minimum message retention duration
  description: All subscriptions must retain unacked messages for at least 30 minutes.
        必須訂閱相關服務才能啟用無效信件 
          name: organizations/ORGANIZATION_ID/customConstraints/custom.requireDeadLetterPolicy
  resourceTypes:
  - pubsub.googleapis.com/Subscription
  methodTypes:
  - CREATE
  - UPDATE
  condition: "has(resource.deadLetterPolicy)"
  actionType: ALLOW
  displayName: Require dead letter policy
  description: All subscriptions must set a dead letter policy.
        要求結構定義為 Avro 類型 
          name: organizations/ORGANIZATION_ID/customConstraints/custom.schemaIsAvro
  resourceTypes:
  - pubsub.googleapis.com/Schema
  methodTypes:
  - CREATE
  - UPDATE
  condition: "resource.type == 'AVRO'"
  actionType: ALLOW
  displayName: Schema is Avro
  description: All schemas must be of type Avro.
        訂閱項目必須通過驗證才能推送通知 
          name: organizations/ORGANIZATION_ID/customConstraints/custom.authenticatedPush
  resourceTypes:
  - pubsub.googleapis.com/Subscription
  methodTypes:
  - CREATE
  - UPDATE
  condition: "has(resource.pushConfig.pushEndpoint) && has(resource.pushConfig.oidcToken.serviceAccountEmail) && has(resource.pushConfig.oidcToken.audience)"
  actionType: ALLOW
  displayName: Subscription uses authenticated push
  description: All subscriptions must enable push authentication.
        要求主題啟用 CMEK 
          name: organizations/ORGANIZATION_ID/customConstraints/custom.topicHasCmek
  resourceTypes:
  - pubsub.googleapis.com/Topic
  methodTypes:
  - CREATE
  - UPDATE
  condition: "has(resource.kmsKeyName)"
  actionType: ALLOW
  displayName: Topic has CMEK
  description: All topics must use a Cloud KMS CryptoKey.

        Pub/Sub 支援的資源

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

        資源 欄位
        pubsub.googleapis.com/Schema resource.definition
        resource.name
        resource.type
        pubsub.googleapis.com/Snapshot resource.expireTime
        resource.name
        resource.topic
        pubsub.googleapis.com/Subscription resource.ackDeadlineSeconds
        resource.bigqueryConfig.dropUnknownFields
        resource.bigqueryConfig.serviceAccountEmail
        resource.bigqueryConfig.table
        resource.bigqueryConfig.useTableSchema
        resource.bigqueryConfig.useTopicSchema
        resource.bigqueryConfig.writeMetadata
        resource.cloudStorageConfig.avroConfig.useTopicSchema
        resource.cloudStorageConfig.avroConfig.writeMetadata
        resource.cloudStorageConfig.bucket
        resource.cloudStorageConfig.filenameDatetimeFormat
        resource.cloudStorageConfig.filenamePrefix
        resource.cloudStorageConfig.filenameSuffix
        resource.cloudStorageConfig.maxBytes
        resource.cloudStorageConfig.maxDuration
        resource.cloudStorageConfig.maxMessages
        resource.cloudStorageConfig.serviceAccountEmail
        resource.deadLetterPolicy.deadLetterTopic
        resource.deadLetterPolicy.maxDeliveryAttempts
        resource.enableExactlyOnceDelivery
        resource.enableMessageOrdering
        resource.expirationPolicy.ttl
        resource.filter
        resource.messageRetentionDuration
        resource.messageTransforms.disabled
        resource.messageTransforms.enabled
        resource.messageTransforms.javascriptUdf.code
        resource.messageTransforms.javascriptUdf.functionName
        resource.name
        resource.pushConfig.attributes
        resource.pushConfig.noWrapper.writeMetadata
        resource.pushConfig.oidcToken.audience
        resource.pushConfig.oidcToken.serviceAccountEmail
        resource.pushConfig.pushEndpoint
        resource.retainAckedMessages
        resource.retryPolicy.maximumBackoff
        resource.retryPolicy.minimumBackoff
        resource.topic
        pubsub.googleapis.com/Topic resource.ingestionDataSourceSettings.awsKinesis.awsRoleArn
        resource.ingestionDataSourceSettings.awsKinesis.consumerArn
        resource.ingestionDataSourceSettings.awsKinesis.gcpServiceAccount
        resource.ingestionDataSourceSettings.awsKinesis.streamArn
        resource.ingestionDataSourceSettings.cloudStorage.bucket
        resource.ingestionDataSourceSettings.cloudStorage.matchGlob
        resource.ingestionDataSourceSettings.cloudStorage.minimumObjectCreateTime
        resource.ingestionDataSourceSettings.cloudStorage.textFormat.delimiter
        resource.ingestionDataSourceSettings.platformLogsSettings.severity
        resource.kmsKeyName
        resource.messageRetentionDuration
        resource.messageStoragePolicy.allowedPersistenceRegions
        resource.messageStoragePolicy.enforceInTransit
        resource.messageTransforms.disabled
        resource.messageTransforms.enabled
        resource.messageTransforms.javascriptUdf.code
        resource.messageTransforms.javascriptUdf.functionName
        resource.name
        resource.schemaSettings.encoding
        resource.schemaSettings.firstRevisionId
        resource.schemaSettings.lastRevisionId
        resource.schemaSettings.schema

        後續步驟