建立自訂限制條件

本文說明管理員如何查看、建立及管理自訂組織政策。您可以透過自訂組織政策,自訂組織政策限制的特定欄位。

事前準備

必要的角色

如要取得管理組織政策所需的權限,請要求管理員授予您下列組織 IAM 角色:

如要進一步瞭解如何授予角色,請參閱「管理專案、資料夾和組織的存取權」。

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

您可以將 IAM 條件新增至組織政策管理員角色繫結,委派組織政策的管理權限。如要控管主體可管理組織政策的資源,您可以根據特定標記設定角色繫結條件。詳情請參閱「建立組織政策」。

自訂限制

自訂限制是在 YAML 檔案中定義,其中包含限制適用的資源、方法、條件和動作。自訂限制行為和支援的參數因服務而異。自訂限制的條件是使用一般運算語言 (CEL) 定義。

設定自訂限制

您可以使用 Google Cloud 控制台或 Google Cloud CLI 建立自訂限制,並設定用於組織政策。

控制台

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

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

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

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

  10. 如要定義條件,請按一下「編輯條件」圖示 。
    1. 在「Add condition」(新增條件) 面板中,建立參照支援服務資源的 CEL 條件,例如 resource.management.autoUpgrade == false。這個欄位最多可輸入 1000 個字元。如要進一步瞭解 CEL 的用法,請參閱 一般運算語言。如要進一步瞭解可在自訂限制中使用的服務資源,請參閱「 支援自訂限制的服務」。
    2. 按一下 [儲存]。
  11. 在「Action」下方,選取是否要在符合條件時允許或拒絕評估的方法。
  12. 「拒絕」動作表示如果條件評估為 true,系統會禁止建立或更新資源。

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

  13. 按一下「Create constraint」(建立限制)。
  14. 在每個欄位中輸入值後,右側會顯示這項自訂限制的對等 YAML 設定。

gcloud

  1. 如要建立自訂限制,請使用下列格式建立 YAML 檔案:
  2. name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
    resourceTypes: RESOURCE_NAME
    methodTypes:
      - CREATE
    condition: "CONDITION"
    actionType: ACTION
    displayName: DISPLAY_NAME
    description: DESCRIPTION

    更改下列內容:

    • ORGANIZATION_ID:組織 ID,例如 123456789。
    • CONSTRAINT_NAME:新自訂限制的名稱。自訂限制只能包含英文字母 (包括大小寫) 或數字,例如 custom.disableGkeAutoUpgrade。這個欄位最多可包含 70 個字元,不含前置字元 (custom.),例如 organizations/123456789/customConstraints/custom。請勿在限制 ID 中輸入 PII 或機密資料,因為錯誤訊息可能會顯示上述資訊。
    • RESOURCE_NAME:內含要限制的物件和欄位的 Google Cloud資源完整名稱,例如:container.googleapis.com/NodePool。大多數資源類型最多支援 20 項自訂限制。如果嘗試建立更多自訂限制,作業會失敗。
    • methodTypes:強制執行限制的 REST 方法。只能是 CREATE。
    • 如要查看各項服務支援的方法,請在「 支援自訂限制的服務」中找到該服務。

    • CONDITION:針對支援服務資源表示法所撰寫的 CEL 條件。這個欄位最多可輸入 1000 個字元。例如:"resource.management.autoUpgrade == false"。
    • ACTION:符合 condition 時採取動作。可能的值為 ALLOW 和 DENY。
    • 「允許」動作表示如果條件評估為 true,則允許建立或更新資源。這也表示除了條件中明確列出的情況外,其他所有情況都會遭到封鎖。

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

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

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

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

  5. 如要確認是否存在自訂限制,請使用 gcloud org-policies list-custom-constraints 指令:
  6. gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID

    將 ORGANIZATION_ID 替換為組織資源的 ID。

    詳情請參閱「 查看組織政策」。

更新自訂限制

如要更新自訂限制,您可以在Google Cloud 控制台編輯限制,也可以建立新的 YAML 檔案,然後再次使用 set-custom-constraint gcloud CLI 指令。自訂限制沒有版本管理功能,因此會覆寫現有的自訂限制。如果自訂限制已強制執行,更新後的自訂限制會立即生效。

控制台

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

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

  2. 選取頁面頂端的專案挑選器。

  3. 在專案挑選器中,選取要更新組織政策的資源。

  4. 在「Organization policies」(組織政策) 頁面的清單中,選取要編輯的限制,開啟該限制的「Policy details」(政策詳細資料) 頁面。

  5. 按一下「 編輯限制」。

  6. 變更顯示名稱、說明、強制執行方法、條件和動作。限制建立後,即無法變更限制 ID 或資源類型。

  7. 按一下 [儲存變更]。

gcloud

  1. 使用 gcloud org-policies describe-custom-constraint 指令,取得目前的自訂限制。

    gcloud org-policies describe-custom-constraint CONSTRAINT_NAME \
      --organization=ORGANIZATION_ID \
      --format=FORMAT > PATH
    

    更改下列內容:

    • ORGANIZATION_ID:組織 ID,例如 123456789。

    • CONSTRAINT_NAME:自訂限制的名稱,例如 custom.disableGkeAutoUpgrade。

    • FORMAT:允許政策的格式。使用 json 或 yaml。

    • PATH:自訂限制的新輸出檔案路徑。

  2. 修改自訂限制的本機副本,反映您要對顯示名稱、說明、強制執行方法、條件和動作進行的變更。限制建立後,即無法變更限制 ID 或資源類型。

  3. 更新自訂限制的 YAML 檔案後,請加以設定,才能用於組織的組織政策。如要設定自訂限制,請使用 gcloud org-policies set-custom-constraint 指令:

    gcloud org-policies set-custom-constraint CONSTRAINT_PATH
    

    請將 CONSTRAINT_PATH 替換成自訂限制檔案的完整路徑。

更新完成後,更新後的自訂限制即可用於組織政策。如果原始限制已強制執行,更新後的限制會立即生效。

刪除自訂限制

您可以使用 Google Cloud 控制台或 Google Cloud CLI 刪除自訂限制。

控制台

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

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

  2. 選取頁面頂端的專案挑選器。

  3. 在專案挑選器中,選取要刪除組織政策的資源。

  4. 在「Organization policies」(組織政策) 頁面的清單中,選取要刪除的限制,開啟該限制的「Policy details」(政策詳細資料) 頁面。

  5. 按一下「刪除」圖示 。

  6. 按一下「Delete」(刪除),確認刪除限制。

gcloud

如要刪除自訂限制,請使用 org-policies delete-custom-constraint gcloud CLI 指令:

gcloud org-policies delete-custom-constraint custom.CONSTRAINT_NAME \
  --organization=ORGANIZATION_ID

更改下列內容:

  • ORGANIZATION_ID:組織 ID,例如 123456789。

  • CONSTRAINT_NAME:自訂限制的名稱。例如:custom.disableGkeAutoUpgrade。

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

Deleted custom constraint [organizations/123456789/customConstraints/custom.disableGkeAutoUpgrade]

如果刪除自訂限制,系統會刪除使用該限制建立的所有政策。幾分鐘後,您就可以使用已刪除自訂限制的名稱。

測試及分析組織政策變更

建議您測試並模擬執行所有組織政策變更,瞭解變更對環境的影響。

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

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

強制執行自訂組織政策

設定自訂限制後,其運作方式與預先定義的布林值限制相同。 Google Cloud 在評估是否允許使用者要求時,會先檢查自訂限制。如果任何自訂組織政策拒絕要求,要求就會遭拒。接著, Google Cloud會檢查該資源是否強制執行預先定義的組織政策。

如要強制執行限制,請建立參照該限制的組織政策,然後將該政策套用至 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 檔案:
  2. name: projects/PROJECT_ID/policies/CONSTRAINT_NAME
    spec:
      rules:
      - enforce: true
    
    dryRunSpec:
      rules:
      - enforce: true

    更改下列內容:

    • PROJECT_ID:要強制執行限制的專案。
    • CONSTRAINT_NAME:要為自訂限制定義的名稱,例如:custom.disableGkeAutoUpgrade。
  3. 如要在模擬測試模式中強制執行組織政策,請執行下列指令並加上 dryRunSpec 旗標:
  4. gcloud org-policies set-policy POLICY_PATH --update-mask=dryRunSpec

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

  5. 確認模擬測試模式中的組織政策運作正常後,請使用 org-policies set-policy 指令和 spec 旗標設定正式政策:
  6. gcloud org-policies set-policy POLICY_PATH --update-mask=spec

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

限制範例

您可以定義自訂限制,類似於 Google 提供的預先定義限制。常見的自訂限制 YAML 檔案大致如下:

name: organizations/1234567890123/customConstraints/custom.disableGkeAutoUpgrade
resourceTypes: container.googleapis.com/NodePool
methodTypes:
  - CREATE
  - UPDATE
condition: "resource.management.autoUpgrade == false"
actionType: ALLOW
displayName: Disable GKE auto upgrade
description: Only allow GKE NodePool resource to be created or updated if
AutoUpgrade is not enabled where this custom constraint is enforced.

一般運算語言

組織政策服務會使用一般運算語言 (CEL) 評估自訂限制的條件。CEL 是一種開放原始碼的非圖靈完備語言,可實作運算式評估的通用語意。

每項支援自訂限制的服務,都會提供一組特定的資源和這些資源的欄位。可用欄位為強型別,可由自訂限制直接參照。

您可以根據欄位類型,建構參照服務資源欄位的 CEL 條件。組織政策服務支援部分 CEL 資料類型、運算式和巨集。以下各節列出可用的資料類型,以及搭配使用的常見運算式和巨集。

如要進一步瞭解各項服務可用的運算式和巨集,請參閱「支援自訂限制的服務」。

下列 JSON 範例顯示您可以使用自訂限制參照的各個潛在欄位類型:

{
  "integerValue": 1,
  "stringValue": "A text string",
  "booleanValue": true,
  "nestedValue": {
    "nestedStringValue": "Another text string"
  },
  "listValue": ["foo", "bar"],
  "mapValue": {
    "costCenter": "123"
  }
}

對於每個 CEL 運算式,當條件評估為 true 時,系統會強制執行自訂限制。您可以使用 and (&&) 和 or (||) 結合運算式,建立複雜的查詢。為自訂限制建立 YAML 或 JSON 檔案時,請用雙引號 (") 括住完整查詢。

整數

整數欄位 (例如上例中的 integerValue) 允許在條件中使用比較運算子。例如:

resource.integerValue == 1
resource.integerValue > 5
resource.integerValue < 10

字串

字串欄位 (例如上例中的 stringValue) 可使用字串常值、規則運算式或 CEL 運算式進行評估。例如:

resource.stringValue == "abc"
// stringValue is exactly "abc".

resource.stringValue.matches("dev$")
// stringValue matches a regular expression, which specifies the string ends
// with the word "dev".

resource.stringValue.startsWith("startValue")
// stringValue starts with "startValue".

resource.stringValue.endsWith("endValue")
// stringValue ends with "endValue".

resource.stringValue.contains("fooBar")
// stringValue contains "fooBar".

巢狀欄位 (例如上一個範例中的 nestedStringValue) 必須使用完整路徑參照。例如:

resource.nestedValue.nestedStringValue == "foo"
// nestedValue contains the object nestedStringValue, which has a value of "foo".

布林值

布林值欄位 (例如上例中的 booleanValue) 包含布林值,也就是 true 或 false。

清單

清單欄位 (例如上一個範例中的 listValue) 可依清單大小、清單內容,以及清單中是否有特定元素來評估。

例如:

resource.listValue.size() >= 1 && resource.listValue[0] == "bar"
// listValue has size greater than or equal to one, and the first element is "bar".

resource.listValue.exists(value, value == "foo")
// listValue has at least one element that is exactly "foo".

resource.listValue.all(value, value.contains("foo"))
// listValue is a list of values that are all exactly "foo".

地圖

對應欄位 (例如上例中的 mapValue) 是鍵/值組合,可根據特定元素的存在和值進行評估。

例如:

has(resource.mapValue.foo) && resource.mapValue.foo == "bar"
// mapValue contains the key "foo", and that key has the value "bar".

疑難排解自訂限制問題

以下各節說明建立自訂限制時的常見問題,並介紹這些問題的解決方法。

方法類型錯誤

建立自訂限制時,會列出要強制執行的方法,通常是 CREATE,或同時包含 CREATE 和 UPDATE。如果您指定資源不支援的方法類型,例如 Compute Engine 映像檔資源的 UPDATE 方法,就無法儲存自訂限制。

未評估的標記

自訂限制支援組織、資料夾或專案資源的標記。如要進一步瞭解哪些服務支援標記,請參閱特定服務的說明文件。

跨服務限制

部分服務 (例如 Compute Engine) 涉及大量相關資源。違反自訂組織政策時,系統會顯示錯誤訊息,即使自訂限制適用於其他服務也一樣。

舉例來說,Compute Engine 資源的自訂限制可能會封鎖 Managed Service for Apache Spark 動作。

排解 CEL 錯誤

組織政策服務會編譯及驗證您建立的條件,如果條件語法不正確,就會傳回錯誤。如果無法建立或儲存自訂限制,可能是發生無效的 CEL 語法錯誤,必須先解決。

在 Google Cloud 控制台中,無效的 CEL 語法錯誤會標上「Error」(錯誤) 圖示。醒目顯示這個圖示時,系統會顯示工具提示,提供語法錯誤的詳細資訊。

某些條件可能會編譯,但在 Google Cloud嘗試強制執行限制時發生錯誤。舉例來說,如果您設定的限制條件嘗試存取不存在的清單索引或對應鍵,則限制會在強制執行時失敗並傳回錯誤,並封鎖任何建立資源的嘗試。

以下各節說明常見的 CEL 錯誤,以及這些錯誤的可能解決方法。

運算式無效或類型不符

如果條件含有無效運算式或類型不符,在您嘗試設定自訂限制時,系統會傳回錯誤。舉例來說,假設有下列無效的自訂限制,會比較字串和整數:

name: organizations/1234567890123/customConstraints/custom.badConfig
resourceTypes: dataproc.googleapis.com/Cluster
methodTypes:
  - CREATE
  - UPDATE
condition: "resource.config.masterConfig.numInstances == 'mismatch'"
actionType: ALLOW
displayName: Number of instances is a string
description: Demonstrate that type mismatches cause an error.

如果嘗試使用 Google Cloud CLI 設定該限制,系統會產生錯誤:

ERROR: (gcloud.org-policies.set-custom-constraint) INVALID_ARGUMENT: Custom constraint condition [resource.config.masterConfig.numInstances == "mismatch"] is invalid. Error: ERROR: <input>:1:15: found no matching overload for '_==_' applied to '(int, string)' (candidates: (%A0, %A0))
 | resource.config.masterConfig.numInstances == "mismatch"
 | ..........................................^.

在 Google Cloud 控制台中,無效的 CEL 語法錯誤會標上「Error」(錯誤) 圖示。醒目顯示這個圖示時,系統會顯示工具提示,提供語法錯誤的詳細資訊。

組織政策服務會編譯及驗證您建立的條件,如果條件語法不正確,就會傳回錯誤。不過,某些條件可能會編譯,但在 Google Cloud 嘗試強制執行限制時傳回錯誤。舉例來說,如果您設定的限制條件嘗試存取不存在的清單索引或對應鍵,則限制會在強制執行時失敗並傳回錯誤,且會封鎖任何建立資源的嘗試。

建立依賴清單或對應元素的條件時,建議您先檢查條件,確保條件在所有情況下都有效。舉例來說,在參照特定清單元素之前,請先檢查 list.size(),或在參照地圖元素之前使用 has()。

支援的服務

每項服務都會定義一組自訂限制欄位,可用於對服務資源強制執行組織政策。如需支援自訂限制的服務清單,請參閱「支援自訂限制的服務」。

如要進一步瞭解如何設定組織政策掃描器,請參閱「組織政策安全漏洞發現項目」。

強制為資源加上必要標記

您可以使用自訂組織政策,強制對資源套用必要標記。強制執行必要標記時,您只能建立符合組織標記政策的資源,也就是資源會與政策中指定的必要標記鍵標記值繫結。詳情請參閱「設定自訂限制來強制執行標記」。

後續步驟