使用自訂機構政策

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

  • monitoring.googleapis.com/AlertPolicy
  • monitoring.googleapis.com/NotificationChannel
  • monitoring.googleapis.com/Snooze

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

關於組織政策和限制

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.

    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.

    Go to project selector

  3. Verify 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.

    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.

    Go to project selector

  8. Verify 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 一節。

    控制台

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

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

      前往組織政策

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

      9. 並非所有 Google Cloud 服務都支援這兩種方法。如要查看各項服務支援的方法，請在「 支援的服務」中找出該服務。

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

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

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

    11. 按一下「建立限制」。

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

    gcloud

    1. 如要建立自訂限制，請使用下列格式建立 YAML 檔案： 
      2.       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：新自訂限制的名稱。自訂限制只能包含字母 (包括大寫和小寫) 或數字，例如 alertDocHasProject。這個欄位最多可包含 70 個字元。
      • RESOURCE_NAME：內含您要限制的物件或欄位的 Google Cloud資源完整名稱，例如： monitoring.googleapis.com/AlertPolicy。
      • CONDITION：針對支援服務資源表示法所撰寫的 CEL 條件。這個欄位最多可輸入 1,000 個半形字元。例如： resource.documentation.content.contains('${resource.project}')。

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

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

        • 如果條件評估結果為 true，表示允許執行建立或更新資源的作業。這也表示系統會封鎖條件中明確列出的情況以外的所有其他情況。

        如果條件評估結果為 true，系統會封鎖建立或更新資源的作業。

      • DISPLAY_NAME：限制的易記名稱。這個欄位最多可包含 200 個半形字元。
      • DESCRIPTION：違反政策時，要以錯誤訊息形式顯示的限制說明。這個欄位最多可輸入 2000 個字元。
    2. 為新的自訂限制建立 YAML 檔案後，您必須加以設定，才能用於貴機構的組織政策。如要設定自訂限制，請使用 gcloud org-policies set-custom-constraint 指令：
      3.         gcloud org-policies set-custom-constraint CONSTRAINT_PATH

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

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

    3. 如要確認是否存在自訂限制，請使用 gcloud org-policies list-custom-constraints 指令：
      4.       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. 如要為這項資源設定組織政策，請按一下「Manage policy」(管理政策)。
    5. 在「Edit policy」(編輯政策) 頁面中，選取「Override parent's policy」(覆寫上層政策)。
    6. 按一下「Add a rule」(新增規則)。
    7. 在「強制執行」部分中，選取是否要強制執行這項機構政策。
    8. 選用：如要根據標記設定組織政策條件，請按一下「Add condition」(新增條件)。請注意，如果為組織政策新增條件式規則，您必須至少新增一項無條件規則，否則無法儲存政策。詳情請參閱「 使用標記設定組織政策」一文。
    9. 如要完成並套用組織政策，請按一下「Set policy」(設定政策)。政策最多需要 15 分鐘才會生效。

    gcloud

    1. 如要建立含有布林值規則的組織政策，請建立參照限制的政策 YAML 檔案：
      2.         name: projects/PROJECT_ID/policies/CONSTRAINT_NAME
        spec:
          rules:
          - enforce: true

      取代下列項目：

      • PROJECT_ID：您要強制執行限制的專案。
      • CONSTRAINT_NAME：要強制執行的限制名稱。例如 alertDocHasProject。
    2. 如要強制執行包含限制的組織政策，請執行下列指令： 
      3.         gcloud org-policies set-policy POLICY_PATH

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

    測試自訂組織政策

    下列範例會建立自訂限制和政策，檢查快訊政策的說明文件是否提及專案名稱。

    開始之前，請先取代下列項目：

    • ORGANIZATION_ID：組織的專屬數字 ID。如要瞭解如何取得這個 ID，請參閱「取得機構 ID」。
    • PROJECT_ID：專案的 ID。

    建立限制

    1. 將下列檔案儲存為 constraint-alert-doc-has-project.yaml：

          actionType: DENY
    condition: resource.documentation.content.contains('${resource.project}')
    description: Requires documentation to include the project name.
    displayName: Alerting policy documentation must include project name.
    methodTypes:
      - CREATE
      - UPDATE
    name: organizations/ORGANIZATION_ID/customConstraints/custom.alertDocHasProject
    resourceTypes:
      - monitoring.googleapis.com/AlertPolicy

      請將 ORGANIZATION_ID 替換成組織 ID。

      如果快訊政策說明文件中缺少資源專案名稱，這項限制會禁止建立或更新快訊政策。

    2. 套用限制：

      gcloud org-policies set-custom-constraint ~/constraint-alert-doc-has-project.yaml

    3. 確認限制是否存在：

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

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

      CUSTOM_CONSTRAINT: custom.alertDocHasProject
ACTION_TYPE: DENY
METHOD_TYPES: CREATE,UPDATE
RESOURCE_TYPES: monitoring.googleapis.com/AlertPolicy
DISPLAY_NAME: Alerting policy documentation must include the project name.

    建立政策

    1. 將下列檔案儲存為 policy-alert-doc-has-project.yaml：

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

      將 PROJECT_ID 替換為專案 ID。

    2. 套用政策：

      gcloud org-policies set-policy ~/policy-alert-doc-has-project.yaml

    3. 確認政策是否存在：

      gcloud org-policies list --project=PROJECT_ID

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

      CONSTRAINT: custom.alertDocHasProject
LIST_POLICY: -
BOOLEAN_POLICY: SET
ETAG: CKSx5LwGEPjBuKwD-

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

    測試政策

    請嘗試建立快訊政策，並在說明文件中排除資源專案名稱。

      gcloud monitoring policies create \
    --display-name="CPU Utilization - 5% Threshold" \
    --project=PROJECT_ID \
    --condition-display-name="Condition 1" \
    --condition-filter='resource.type="gce_instance" AND metric.type="compute.googleapis.com/instance/cpu/utilization"' \
    --duration='60s' \
    --if='>5' \
    --combiner='AND' \
    --documentation='The ${metric.display_name} of the ${resource.type} ${resource.label.instance_id} has exceeded 5% for over 60 seconds.' \

    將 PROJECT_ID 替換為專案 ID。

    輸出內容如下：

      Operation denied by custom org policies: ["customConstraints/alertDocHasProject": "Alerting policy documentation must include project name."]

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

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

    說明 限制語法
    快訊政策只能有一個條件 
        actionType: DENY
    condition: "resource.conditions.size() > 1"
    description: Requires alerting policies to have only one condition.
    displayName: Alerting policies must have only one condition
    methodTypes:
      - CREATE
      - UPDATE
    name: organizations/ORGANIZATION_ID/customConstraints/custom.oneCondition
    resourceTypes:
      - monitoring.googleapis.com/AlertPolicy
    快訊政策必須使用至少兩個通知管道 
        actionType: DENY
    condition: "resource.notificationChannels.size() < 2"
    description: Alerting policies must use at least two notification channels.
    displayName: Policies must have a backup notification channel
    methodTypes:
      - CREATE
      - UPDATE
    name: organizations/ORGANIZATION_ID/customConstraints/custom.alertOnTwoChannels
    resourceTypes:
      - monitoring.googleapis.com/AlertPolicy
    只允許電子郵件通知管道 
        actionType: DENY
    condition: "resource.type != 'email'"
    description: Requires notification channels to use only the email channel
    type.
    displayName: Always use email for notification channels
    methodTypes:
      - CREATE
      - UPDATE
    name: organizations/ORGANIZATION_ID/customConstraints/custom.emailChannelsOnly
    resourceTypes:
      - monitoring.googleapis.com/NotificationChannel
    貪睡時間不得超過一小時 
        actionType: DENY
    condition: "int(resource.interval.endTime) > int(resource.interval.startTime) + 3600"
    description: Requires snoozes to be under 1 hour.
    displayName: Snooze must be less than 1 hour
    methodTypes:
    - CREATE
    - UPDATE
    name: organizations/ORGANIZATION_ID/customConstraints/custom.setMaxSnooze
    resourceTypes:
    - monitoring.googleapis.com/Snooze

    Cloud Monitoring 支援的資源

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

    資源 欄位
    monitoring.googleapis.com/AlertPolicy resource.alertStrategy.autoClose
    resource.alertStrategy.notificationChannelStrategy.notificationChannelNames
    resource.alertStrategy.notificationChannelStrategy.renotifyInterval
    resource.alertStrategy.notificationRateLimit.period
    resource.combiner
    resource.conditions.conditionAbsent.aggregations.alignmentPeriod
    resource.conditions.conditionAbsent.aggregations.crossSeriesReducer
    resource.conditions.conditionAbsent.aggregations.groupByFields
    resource.conditions.conditionAbsent.aggregations.perSeriesAligner
    resource.conditions.conditionAbsent.duration
    resource.conditions.conditionAbsent.filter
    resource.conditions.conditionAbsent.trigger.count
    resource.conditions.conditionAbsent.trigger.percent
    resource.conditions.conditionMatchedLog.filter
    resource.conditions.conditionMatchedLog.labelExtractors
    resource.conditions.conditionMonitoringQueryLanguage.duration
    resource.conditions.conditionMonitoringQueryLanguage.evaluationMissingData
    resource.conditions.conditionMonitoringQueryLanguage.query
    resource.conditions.conditionMonitoringQueryLanguage.trigger.count
    resource.conditions.conditionMonitoringQueryLanguage.trigger.percent
    resource.conditions.conditionPrometheusQueryLanguage.alertRule
    resource.conditions.conditionPrometheusQueryLanguage.duration
    resource.conditions.conditionPrometheusQueryLanguage.evaluationInterval
    resource.conditions.conditionPrometheusQueryLanguage.labels
    resource.conditions.conditionPrometheusQueryLanguage.query
    resource.conditions.conditionPrometheusQueryLanguage.ruleGroup
    resource.conditions.conditionSql.booleanTest.column
    resource.conditions.conditionSql.daily.periodicity
    resource.conditions.conditionSql.hourly.minuteOffset
    resource.conditions.conditionSql.hourly.periodicity
    resource.conditions.conditionSql.minutes.periodicity
    resource.conditions.conditionSql.query
    resource.conditions.conditionSql.rowCountTest.comparison
    resource.conditions.conditionSql.rowCountTest.threshold
    resource.conditions.conditionThreshold.aggregations.alignmentPeriod
    resource.conditions.conditionThreshold.aggregations.crossSeriesReducer
    resource.conditions.conditionThreshold.aggregations.groupByFields
    resource.conditions.conditionThreshold.aggregations.perSeriesAligner
    resource.conditions.conditionThreshold.comparison
    resource.conditions.conditionThreshold.denominatorAggregations.alignmentPeriod
    resource.conditions.conditionThreshold.denominatorAggregations.crossSeriesReducer
    resource.conditions.conditionThreshold.denominatorAggregations.groupByFields
    resource.conditions.conditionThreshold.denominatorAggregations.perSeriesAligner
    resource.conditions.conditionThreshold.denominatorFilter
    resource.conditions.conditionThreshold.duration
    resource.conditions.conditionThreshold.evaluationMissingData
    resource.conditions.conditionThreshold.filter
    resource.conditions.conditionThreshold.forecastOptions.forecastHorizon
    resource.conditions.conditionThreshold.thresholdValue
    resource.conditions.conditionThreshold.trigger.count
    resource.conditions.conditionThreshold.trigger.percent
    resource.conditions.displayName
    resource.conditions.name
    resource.displayName
    resource.documentation.content
    resource.documentation.links.displayName
    resource.documentation.links.url
    resource.documentation.mimeType
    resource.documentation.subject
    resource.enabled
    resource.name
    resource.notificationChannels
    resource.severity
    monitoring.googleapis.com/NotificationChannel resource.description
    resource.displayName
    resource.enabled
    resource.type
    monitoring.googleapis.com/Snooze resource.criteria.policies
    resource.displayName
    resource.interval.endTime
    resource.interval.startTime

    後續步驟