使用自訂組織政策

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

組織政策提供各種Google Cloud 服務的預先定義限制。不過，如要更精細地自訂組織政策中受限的特定欄位，您也可以建立自訂組織政策。

優點

  • 安全性、法規遵循與管理：您可以按照下列方式使用自訂組織政策：
    • 如要強制執行安全性規定，您可以強制使用客戶自行管理的加密金鑰 (CMEK)。
    • 建立或更新存放區時，您可以限制傳遞的任何欄位。

政策繼承

根據預設，您強制執行政策的資源子系會繼承組織政策。舉例來說，如果您對資料夾強制執行政策， Google Cloud 會對該資料夾中的所有專案強制執行政策。如要進一步瞭解這項行為以及如何變更，請參閱這篇文章。

定價

組織政策服務 (包括預先定義和自訂組織政策) 免費提供。

事前準備

  1. 啟用 Artifact Registry 並安裝 Google Cloud CLI。
  2. (選用) 設定 gcloud CLI 指令的預設值。
  3. 如需使用客戶自行管理的加密金鑰 (CMEK) 加密存放區內容，請在 Cloud KMS 中為存放區建立並啟用金鑰。
  4. 請確認您知道組織 ID。

必要的角色

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

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

這些預先定義的角色具備管理組織政策所需的權限。如要查看確切的必要權限，請展開「Required permissions」(必要權限) 部分：

所需權限

必須具備下列權限，才能管理組織政策：。

  • orgpolicy.constraints.list
  • orgpolicy.policies.create
  • orgpolicy.policies.delete
  • orgpolicy.policies.list
  • orgpolicy.policies.update
  • orgpolicy.policy.get
  • orgpolicy.policy.set

您或許還可透過自訂角色或其他預先定義的角色取得這些權限。

建立自訂限制

自訂限制是在 YAML 檔案中定義，其中包含您要強制執行組織政策的服務所支援的資源、方法、條件和動作。自訂限制的條件是使用一般運算語言 (CEL) 來定義。如要進一步瞭解如何使用 CEL 在自訂限制中建構條件，請參閱「建立及管理自訂限制」的 CEL 相關章節。

Artifact Registry 支援對 REPOSITORY 資源的 CREATE 和 UPDATE 方法套用自訂限制。

為自訂限制建立 YAML 檔案，如下所示：

name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
resourceTypes:
- artifactregistry.googleapis.com/Repository
methodTypes:
- CREATE
- UPDATE
condition: "CONDITION"
actionType: ACTION
displayName: DISPLAY_NAME
description: DESCRIPTION

更改下列內容：

  • ORGANIZATION_ID：組織 ID，例如 123456789。

  • CONSTRAINT_NAME：新自訂限制的名稱。自訂限制必須以 custom. 開頭，且只能包含大/小寫英文字母或數字，例如 custom.enableDockerRemotes。這個欄位的長度上限為 70 個字元，不含前置字元，例如 organizations/123456789/customConstraints/custom.enableDockerRemotes。

  • CONDITION：針對支援服務資源表示法所撰寫的 CEL 條件。這個欄位的長度上限為 1,000 個字元。如要進一步瞭解可編寫條件的資源 (例如 (resource.mode == 'REMOTE' && resource.format == 'DOCKER') || (resource.mode != 'REMOTE'))，請參閱「支援的資源」。

  • ACTION：符合 condition 時採取動作。可以是 ALLOW 或 DENY。

  • DISPLAY_NAME：容易記得的限制名稱。這個欄位的長度上限為 200 個字元。

  • DESCRIPTION：違反政策時，會以錯誤訊息形式顯示且易於理解的限制說明。這個欄位的長度上限為 2,000 個字元，例如 All remote repositories must be Docker format.

想進一步瞭解如何建立自訂限制，請參閱定義自訂限制。

設定自訂限制

控制台

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

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

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

  2. 在專案挑選器中，選取要設定組織政策的專案。
  3. 按一下「 Custom constraint」(自訂限制)。
  4. 在「Display name」(顯示名稱) 方塊中，輸入人類可讀的限制名稱。這個名稱會用於錯誤訊息，可用於識別和偵錯。請勿在顯示名稱中使用個人識別資訊 (PII) 或機密資料，因為這類名稱可能會在錯誤訊息中曝光。這個欄位最多可包含 200 個字元。
  5. 在「Constraint ID」(限制 ID) 方塊中，輸入新自訂限制的 ID。自訂限制只能包含英文字母 (包括大小寫) 或數字，例如 custom.enableDockerRemotes。這個欄位最多可包含 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. 如要查看各項服務支援的方法，請在「 支援自訂限制的服務」中找到該服務。

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

    11. 「拒絕」動作表示如果條件評估為 true，系統會禁止建立或更新資源。

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

  11. 按一下「Create constraint」(建立限制)。

    12. 在每個欄位中輸入值後，右側會顯示這項自訂限制的對等 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.enableDockerRemotes。這個欄位最多可包含 70 個字元，不含前置字元 (custom.)，例如 organizations/123456789/customConstraints/custom。請勿在限制 ID 中輸入 PII 或機密資料，因為錯誤訊息可能會顯示上述資訊。
    • RESOURCE_NAME：內含要限制的物件和欄位的 Google Cloud資源完整名稱，例如：artifactregistry.googleapis.com/Repository。大多數資源類型最多支援 20 項自訂限制。如果嘗試建立更多自訂限制，作業會失敗。
    • methodTypes：強制執行限制的 REST 方法。只能是 CREATE。

      • 如要查看各項服務支援的方法，請在「 支援自訂限制的服務」中找到該服務。

    • CONDITION：針對支援服務資源表示法所撰寫的 CEL 條件。這個欄位最多可輸入 1000 個字元。例如：(resource.mode == 'REMOTE' && resource.format == 'DOCKER') || (resource.mode != 'REMOTE')。

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

    • ACTION：符合 condition 時採取動作。只能是 ALLOW。

      • 「允許」動作表示如果條件評估為 true，則允許建立或更新資源。這也表示除了條件中明確列出的情況外，其他所有情況都會遭到封鎖。

    • DISPLAY_NAME：人類可讀的限制名稱。這個名稱會用於錯誤訊息，可用於識別和偵錯。請勿在顯示名稱中使用 PII 或機密資料，因為這類名稱可能會在錯誤訊息中顯示。這個欄位最多可包含 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」(組織政策) 頁面。

    前往「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.enableDockerRemotes。
  2. 如要在模擬測試模式中強制執行組織政策，請執行下列指令並加上 dryRunSpec 旗標：
    3. gcloud org-policies set-policy POLICY_PATH --update-mask=dryRunSpec

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

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

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

測試自訂組織政策

下列遠端存放區建立範例假設已建立自訂組織政策，並在建立存放區時強制執行，只允許建立 Docker 格式的遠端存放區。

嘗試在專案中建立 Python 遠端存放區：

  gcloud artifacts repositories create REMOTE-REPOSITORY-NAME \
      --project=PROJECT_ID \
      --repository-format=python \
      --location=LOCATION \
      --description="DESCRIPTION" \
      --mode=remote-repository \
      --remote-repo-config-desc="REMOTE-REPOSITORY-DESCRIPTION" \
      --disable-vulnerability-scanning \
      --remote-python-repo=UPSTREAM \
      --remote-username="USERNAME" \
      --remote-password-secret-version="PASSWORD"

更改下列內容：

  • REMOTE-REPOSITORY-NAME：存放區名稱。在專案中的每個存放區位置，存放區名稱不得重複。
  • PROJECT_ID：專案 ID。如果省略這個旗標，系統會使用目前或預設的專案。
  • LOCATION：存放區的區域或多區域位置。如果您設定了預設值，則可省略這個旗標。如要查看支援的位置清單，請執行 gcloud artifacts locations list 指令。
  • DESCRIPTION：選用。存放區說明。請勿輸入機密資料，因為存放區說明不會加密。
  • REMOTE-REPOSITORY-DESCRIPTION：選用。這個遠端存放區的外部存放區設定說明。
  • USERNAME：選用。用於驗證上游存放區的使用者名稱。
  • PASSWORD：選用。包含上游存放區密碼的密鑰版本。

  • UPSTREAM 替換為預設上游名稱、Artifact Registry 存放區路徑，或上游存放區的使用者定義網址。

    如果是 Artifact Registry 上游存放區，請按照下列格式設定存放區路徑：projects/UPSTREAM_PROJECT_ID/locations/REGION/repositories/UPSTREAM_REPOSITORY。

    如要瞭解可用的預設上游和支援的使用者定義上游，請參閱「支援的格式」。

  • --disable-vulnerability-scanning：選用旗標，可設定存放區停用自動安全漏洞掃描功能。

  • --allow-vulnerability-scanning：這是選用旗標，可設定存放區，允許自動掃描安全漏洞。詳情請參閱「啟用或停用自動掃描功能」。

    舉例來說，下列指令會在 Google Cloud 專案my-project的us-east1區域中，建立名為my-repo的遠端存放區，並可使用使用者名稱my-username和密鑰版本projects/my-project/secrets/my-secret/versions/1向上游存放區進行驗證。

    gcloud artifacts repositories create my-repo \
    --project=my-project \
    --repository-format=python \
    --location=us-east1 \
    --description="Remote Python repository" \
    --mode=remote-repository \
    --remote-repo-config-desc="PyPI" \
    --remote-username=my-username \
    --remote-password-secret-version=projects/my-project/secrets/my-secret/versions/1 \
    --remote-python-repo=PYPI

輸出內容如下：

Operation denied by custom org policies: ["customConstraints/custom.enableDockerRemotes": "All remote repositories must be Docker format."]

Artifact Registry 支援的資源

Artifact Registry 支援自訂限制，適用於存放區資源的建立和更新作業，但 labels 欄位除外。

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

下表提供一些實用的自訂組織政策語法：

說明 限制語法
停用建立遠端存放區的功能 
    name: organizations/ORGANIZATION_ID/customConstraints/custom.disableRemotes
    resourceTypes:
    - artifactregistry.googleapis.com/Repository
    methodTypes:
    - CREATE
    condition: "resource.mode in ['STANDARD', 'VIRTUAL']"
    actionType: ALLOW
    displayName: Disable remote repository creation
    description: All repositories must be standard or virtual mode.
強制執行 Docker 格式存放區的標記不可變性 
    name: organizations/ORGANIZATION_ID/customConstraints/custom.enforceTagImmutability
    resourceTypes:
    - artifactregistry.googleapis.com/Repository
    methodTypes:
    - CREATE
    condition: "resource.format == 'DOCKER' && !resource.dockerConfig.immutableTags"
    actionType: DENY
    displayName: Enforce tag immutability
    description: All new Docker repositories must have tag immutability enabled.
要求使用 CMEK 金鑰 
    name: organizations/ORGANIZATION_ID/customConstraints/custom.requireCmekKey
    resourceTypes:
    - artifactregistry.googleapis.com/Repository
    methodTypes:
    - CREATE
    condition: "resource.kmsKeyName.contains('projects/my-project/')"
    actionType: ALLOW
    displayName: Enforce the use of a CMEK key from my-project
    description: All repositories must be created with a CMEK key from my-project.
禁止存放區停用平台記錄 
    name: organizations/ORGANIZATION_ID/customConstraints/custom.preventDisablingPlatformLogs
    resourceTypes:
    - artifactregistry.googleapis.com/Repository
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.platformLogsConfig.loggingState != 'DISABLED'"
    actionType: ALLOW
    displayName: Prevent disabling platform logs
    description: Repositories must not opt out of platform logs. Repositories that inherit the project-level configuration are allowed.
要求平台記錄擷取 INFO 和嚴重性更高的事件 
    name: organizations/ORGANIZATION_ID/customConstraints/custom.requireInfoLogSeverity
    resourceTypes:
    - artifactregistry.googleapis.com/Repository
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.platformLogsConfig.loggingState != 'DISABLED' && resource.platformLogsConfig.severityLevel != 'ERROR'"
    actionType: ALLOW
    displayName: Require INFO severity platform logs
    description: Repositories must not restrict platform logs to error events only.

後續步驟