カスタム組織ポリシーを使用する

このページでは、組織のポリシー サービスのカスタム制約を使用して、次の Google Cloud リソースに対する特定のオペレーションを制限する方法について説明します。

  • cloudquotas.googleapis.com/QuotaPreference

組織のポリシーの詳細については、カスタムの組織のポリシーをご覧ください。

組織のポリシーと制約について

Google Cloud 組織のポリシー サービスを使用すると、組織のリソースをプログラマティックに一元管理できます。組織のポリシー管理者は組織のポリシーを定義できます。組織のポリシーは、Google Cloud リソース階層内のGoogle Cloud リソースやそれらのリソースの子孫に適用される、制約と呼ばれる一連の制限です。組織のポリシーは、組織、フォルダ、プロジェクトのいずれかの単位で適用できます。

組織のポリシーを利用することで、あらかじめ用意されたマネージド制約をさまざまな Google Cloud サービスに適用できます。ただし、組織のポリシーで制限されている特定の項目をより細かくカスタマイズして制御したい場合は、カスタム制約を作成して、それを組織のポリシーで使うこともできます。

ポリシーの継承

デフォルトでは、組織のポリシーは、そのポリシーを適用したリソースの子孫に継承されます。たとえば、フォルダにポリシーを適用した場合、 Google Cloud はそのフォルダ内のすべてのプロジェクトにそのポリシーを適用します。この動作の詳細と変更方法については、階層評価ルールをご覧ください。

制限事項

カスタムの組織のポリシーの適用により、QuotaPreference リソースを作成または更新するオペレーションが制限されます。割り当て変更のシナリオでは QuotaPreference リソースが作成または更新されないため、次の制限が適用されます。

  • Service Usage API を使用する場合: Service Usage API で開始された割り当て値の変更は、QuotaPreference リソースを変更しないため、カスタム組織のポリシーの適用の対象になりません。Service Usage API を介して開始された割り当て値の変更を制限するには、serviceusage.quota.update 権限に対して IAM 拒否ポリシーを実装します。

  • Google Cloud コンソールで割り当ての変更を開始する場合: Google Cloud コンソールを使用して開始された割り当て値の変更は、カスタム組織のポリシーの適用対象になりません。これは、 Google Cloud コンソールが QuotaPreference リソースを作成しないためです。

始める前に

  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 ファイルで定義されます。カスタム制約の条件は、Common Expression Language(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.restrictQuotaChangeCpusPerProjectPerRegionこのフィールドの最大長は 70 文字です。

    • RESOURCE_NAME: 制限するオブジェクトとフィールドを含むGoogle Cloud リソースの完全修飾名。例: cloudquotas.googleapis.com/cloudquotas.googleapis.com/QuotaPreference

    • CONDITION: サポート対象のサービス リソースの表現に対して書き込まれる CEL 条件。このフィールドの最大長は 1,000 文字です。条件の書き込み先として使用できるリソースの詳細については、サポート対象のリソースをご覧ください。例: "resource.service == compute.googleapis.com && resource.quotaId == CPUS-per-project-region"

    • ACTION: condition が満たされている場合に実行するアクション。有効な値は ALLOWDENY です。

    • DISPLAY_NAME: 制約の名前。わかりやすい名前を入力してください。このフィールドの最大長は 200 文字です。

    • DESCRIPTION: ポリシー違反時にエラー メッセージとして表示される制約の説明。わかりやすい説明を入力してください。このフィールドの最大長は 2,000 文字です。

    カスタム制約の作成方法については、カスタム制約の定義をご覧ください。

    カスタム制約を設定する

    新しいカスタム制約の 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 コンソールで [組織のポリシー] ページに移動します。

      [組織のポリシー] に移動

    2. プロジェクト選択ツールで、組織のポリシーを設定するプロジェクトを選択します。
    3. [組織のポリシー] ページのリストで制約を選択して、その制約の [ポリシーの詳細] ページを表示します。
    4. このリソースの組織のポリシーを構成するには、[ポリシーを管理] をクリックします。
    5. [ポリシーの編集] ページで、[Override parent's policy] を選択します。
    6. [ルールを追加] をクリックします。
    7. [適用] セクションで、この組織のポリシーの適用を有効にするかどうかを選択します。
    8. 省略可: タグで組織のポリシーに条件を設定するには、[条件を追加] をクリックします。組織のポリシーに条件付きルールを追加する場合は、少なくとも 1 つは無条件のルールを追加する必要があります。そうしないとポリシーを保存できないのでご注意ください。詳細については、タグ付きの組織のポリシーの設定をご覧ください。
    9. [変更内容をテスト] をクリックして、組織のポリシーの効果をシミュレートします。以前のマネージド制約ではポリシー シミュレーションを使用できません。詳細については、Policy Simulator で組織のポリシーの変更をテストするをご覧ください。
    10. 組織のポリシーを完成させて適用するには、[ポリシーを設定] をクリックします。ポリシーが有効になるまでに最大 15 分かかります。

    gcloud

    ブール型ルールを含む組織のポリシーを作成するには、制約を参照するポリシー YAML ファイルを作成します。

          name: projects/PROJECT_ID/policies/CONSTRAINT_NAME
          spec:
            rules:
            - enforce: true
        

    次のように置き換えます。

    • PROJECT_ID: 制約を適用するプロジェクト。
    • CONSTRAINT_NAME: カスタム制約に定義した名前。たとえば、custom.restrictQuotaChangeCpusPerProjectPerRegion のようにします。

    制約を含む組織のポリシーを適用するには、次のコマンドを実行します。

        gcloud org-policies set-policy POLICY_PATH
        

    POLICY_PATH は、組織のポリシーの YAML ファイルのパスに置き換えます。ポリシーが有効になるまでに最大 15 分かかります。

    カスタム組織のポリシーをテストする

    次の例では、CPUS-per-project-region 割り当て ID を持つ compute.googleapis.com サービスの特定のプロジェクト内のすべての QuotaPreference 設定を拒否するカスタム制約とポリシーを作成します。

    事前に次のものを確認してください。

    • 組織の ID
    • プロジェクト ID

    以降の例では、ORGANIZATION_IDPROJECT_ID を構成の文字列に置き換えます。

    制約の例を作成する

    次のコード スニペットは、割り当て設定の制約を作成する例を示しています。独自の割り当て設定の制約を作成する場合は、構成に応じてこれらのフィールドを更新します。

    1. 次のファイルに quota-constraint.yaml という名前を付けて保存します。

      name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictCPUsPerProjectRegion
      resourceTypes:
        - cloudquotas.googleapis.com/QuotaPreference
      methodTypes:
        - CREATE
        - UPDATE
      condition: "resource.service == 'compute.googleapis.com' && resource.quotaId == 'CPUS-per-project-region'"
      actionType: DENY
      displayName: Restrict quota update for compute CPUS-per-project-region
      description: Deny quota change for the 'CPUS-per-project-region' quota ID of 'compute.googleapis.com' service.
      

      次のように置き換えます。

      これは、compute.googleapis.com サービスの CPUS-per-project-region 割り当て ID に対して割り当てを変更できない制約を定義します。

    2. 制約を適用します。

      gcloud org-policies set-custom-constraint quota-constraint.yaml
      
    3. 制約が存在することを確認します。

      gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID
      
    4. 出力は次のようになります。

      CUSTOM_CONSTRAINT                    ACTION_TYPE  METHOD_TYPES   RESOURCE_TYPES                              DISPLAY_NAME
      custom.restrictCPUsPerProjectRegion  DENY         CREATE,UPDATE  cloudquotas.googleapis.com/QuotaPreference  Restrict quota update for compute CPUS-per-project-region
      

    ポリシーを作成する

    1. 次のファイルに quota-policy.yaml という名前を付けて保存します。

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

      PROJECT_ID は、実際のプロジェクト ID に置き換えます。

    2. ポリシーを適用します。

      gcloud org-policies set-policy quota-policy.yaml
      
    3. ポリシーが存在することを確認します。

      gcloud org-policies list --project=PROJECT_ID
      

      出力は次のようになります。

      CONSTRAINT                           LIST_POLICY  BOOLEAN_POLICY  ETAG
      custom.restrictCPUsPerProjectRegion  -            SET             CNXIq78GEODKiK4D-
      
      

    ポリシーを適用したら、 Google Cloud がポリシーの適用を開始するまで 2 分ほど待ちます。

    ポリシーをテストする

    ポリシーをテストするには、割り当て設定リクエストを作成します。

    • たとえば、次の gcloud CLI コマンドを実行して、Compute Engine の割り当て設定を作成します。

      gcloud beta quotas preferences create \
          --service=compute.googleapis.com \
          --quota-id=CPUS-per-project-region \
          --preferred-value=30 \
          --project=PROJECT_ID
      
    • 出力は次のようになります。

      Operation denied by org policy on resource 'projects/PROJECT_ID/locations/global': ["customConstraints/custom.restrictCPUsPerProjectRegion": "Deny quota change for the 'CPUS-per-project-region' quota ID of 'compute.googleapis.com' service."]
      

    ポリシーと制約の例を削除する

    ポリシーをテストしたら、削除できます。

    1. ポリシーを削除します。

      gcloud org-policies delete custom.restrictCPUsPerProjectRegion --project=PROJECT_ID
      
    2. 制約を削除します。

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

    一般的なユースケースのカスタムの組織のポリシーの例

    次の表に、一般的なユースケースのカスタム制約の構文を示します。

    説明 制約の構文
    特定のサービスの割り当て ID の変更を許可しない
      name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictCPUsPerProjectRegionQuota
      resourceTypes:
        - cloudquotas.googleapis.com/QuotaPreference
      methodTypes:
        - CREATE
        - UPDATE
      condition: |-
        resource.service == 'compute.googleapis.com'
         && resource.quotaId == 'CPUS-per-project-region'
      actionType: DENY
      displayName: Deny quota update for compute CPUS-per-project-region
      description: Deny quota change for the 'CPUS-per-project-region' quota ID of 'compute.googleapis.com' service.
      
    割り当て値を指定された値未満に制限する
      name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictCPUsPerProjectRegionQuotaLimit
      resourceTypes:
        - cloudquotas.googleapis.com/QuotaPreference
      methodTypes:
        - CREATE
        - UPDATE
      condition: |-
        resource.service == 'compute.googleapis.com'
         && resource.quotaId == 'CPUS-per-project-region'
         && resource.quotaConfig.preferredValue <= 25
      actionType: ALLOW
      displayName: Restrict quota update for compute CPUS-per-project-region
      description: Restrict quota change for the 'CPUS-per-project-region' quota ID of 'compute.googleapis.com' service.

    Cloud Quotas でサポートされているリソース

    次の表に、カスタム制約で参照できる Cloud Quotas リソースを示します。

    リソース フィールド
    cloudquotas.googleapis.com/QuotaPreference resource.dimensions
    resource.name
    resource.quotaConfig.preferredValue
    resource.quotaId
    resource.service

    次のステップ