カスタム制約を使用して MongoDB 互換の Firestore リソースを管理する

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

  • firestore.googleapis.com/Database

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

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

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

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

ポリシーの継承

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

利点

  • セキュリティ、コンプライアンス、ガバナンス: カスタムの組織のポリシーを使用して、次のように適用できます。

    • 障害復旧要件を適用するには、削除保護やポイントインタイム リカバリなどの特定の障害復旧設定をデータベースに要求します。

    • データベースの作成を特定のロケーションのみに制限できます。

    • データベースに CMEK（顧客管理の暗号鍵）を必須にできます。

  • 監査: カスタムの組織のポリシーの制約が監査ログに記録されます。制約の変更や制約のチェックなどのオペレーションを行うと、対応する Cloud Audit Logs が生成されます。

始める前に

  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. 外部 ID プロバイダ（IdP）を使用している場合は、まず連携 ID を使用して 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. 外部 ID プロバイダ（IdP）を使用している場合は、まず連携 ID を使用して gcloud CLI にログインする必要があります。

  11. gcloud CLI を初期化するには、次のコマンドを実行します。

    gcloud init
  12. 組織 ID を確認します。

    13. 必要なロール

    カスタムの組織のポリシーを管理するために必要な権限を取得するには、組織のリソースに対する組織のポリシー管理者（roles/orgpolicy.policyAdmin）の IAM ロールを付与するよう管理者に依頼してください。ロールの付与については、プロジェクト、フォルダ、組織へのアクセス権の管理をご覧ください。

    必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。

    カスタム制約を設定する

    カスタム制約は、組織のポリシーを適用しているサービスでサポートされるリソース、メソッド、条件、アクションを使用して YAML ファイルで定義されます。カスタム制約の条件は、Common Expression Language（CEL）を使用して定義されます。CEL を使用してカスタム制約で条件を作成する方法については、カスタム制約の作成と管理の CEL セクションをご覧ください。

    コンソール

    カスタム制約を作成する手順は次のとおりです。

    1. Google Cloud コンソールで [組織のポリシー] ページに移動します。

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

    2. プロジェクト選択ツールから、組織のポリシーを設定するプロジェクトを選択します。
    3. [ カスタム制約] をクリックします。
    4. [表示名] ボックスに、制約のわかりやすい名前を入力します。この名前はエラー メッセージで使用され、識別とデバッグに使用できます。エラー メッセージで漏えいする可能性があるため、表示名には PII や機密データを使用しないでください。このフィールドには、最大 200 文字まで入力できます。
    5. [制約 ID] ボックスに、新しいカスタム制約の名前を入力します。カスタム制約には、英字（大文字と小文字を含む）または数字のみを含めることができます（例: custom.disableGkeAutoUpgrade）。このフィールドには、接頭辞（custom.）を除き、最大 70 文字まで含めることができます（例: organizations/123456789/customConstraints/custom）。エラー メッセージで漏えいする可能性があるため、制約 ID には PII や機密データを含めないでください。
    6. [説明] ボックスに、制約の説明を入力します。この説明は、ポリシー違反時にエラー メッセージとして使用されます。ポリシー違反が発生した理由と、ポリシー違反を解決する方法に関する詳細を含めます。エラー メッセージで漏えいする可能性があるため、説明には PII や機密データを含めないでください。このフィールドには、最大 2,000 文字を入力できます。
    7. [リソースの種類] ボックスで、制限するオブジェクトとフィールドを含む 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 の使用方法の詳細については、 Common Expression Language をご覧ください。カスタム制約で使用できるサービス リソースの詳細については、 カスタム制約でサポートされているサービスをご覧ください。
      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: 新しいカスタム制約に付ける名前。カスタム制約には、文字（大文字と小文字を含む）または数字のみを含めることができます（例: custom.deleteProtectionRequired）。このフィールドには、最大 70 文字まで入力できます。
      • RESOURCE_NAME: 制限するオブジェクトとフィールドを含む Google Cloudリソースの完全修飾名。例: firestore.googleapis.com/Database。
      • CONDITION: サポートされているサービス リソースの表現に対して書き込まれる CEL 条件。このフィールドには、最大 1,000 文字を入力できます。例: "resource.deleteProtectionState == \"DELETE_PROTECTION_ENABLED\""。

        • 条件の書き込み先として使用できるリソースの詳細については、サポート対象のリソースをご覧ください。

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

        • 許可アクションは、条件が true と評価された場合に、リソースを作成または更新するオペレーションが許可されることを意味します。つまり、条件に明示的にリストされているケースを除き、他のすべてのケースはブロックされます。

        拒否アクションは、条件が true と評価された場合に、リソースを作成または更新するオペレーションがブロックされることを意味します。

      • DISPLAY_NAME: 制約の名前。わかりやすい名前を入力してください。このフィールドには、最大 200 文字を入力できます。
      • DESCRIPTION: ポリシー違反時にエラー メッセージとして表示される制約の説明。わかりやすい説明を入力してください。このフィールドには、最大 2,000 文字を入力できます。
    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 コンソールで [組織のポリシー] ページに移動します。

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

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

    gcloud

    1. ブール型ルールを含む組織のポリシーを作成するには、制約を参照するポリシー YAML ファイルを作成します。
      2.         name: projects/PROJECT_ID/policies/CONSTRAINT_NAME
        spec:
          rules:
          - enforce: true
        
        dryRunSpec:
          rules:
          - enforce: true

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

      • PROJECT_ID: 制約を適用するプロジェクト。
      • CONSTRAINT_NAME: カスタム制約に定義した名前。例: custom.deleteProtectionRequired。
    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 分かかります。

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

    始める前に、以下を把握しておく必要があります。

    • 組織の ID

    1. 次のように deleteProtectionRequired.yaml ファイルを作成します。

       name: organizations/ORGANIZATION_ID/customConstraints/custom.deleteProtectionRequired
 resourceTypes:
 - firestore.googleapis.com/Database
 methodTypes:
 - CREATE
 - UPDATE
 condition: "resource.deleteProtectionState == \"DELETE_PROTECTION_ENABLED\""
 actionType: ALLOW
 displayName: Firestore with MongoDB compatibility Delete Protection Required
 description: To ensure the data security, Delete Protection is required to be enabled for Firestore databases.

      これにより、MongoDB 互換の Firestore データベースのすべての CREATE メソッドと UPDATE メソッドが、deleteProtectionState が DELETE_PROTECTION_ENABLED であるという制約を満たすようになります。その結果、削除保護を明示的に有効にせずにデータベースの作成、更新、復元、クローンの作成を行うと、オペレーションは拒否されます。

    2. 組織レベルでカスタム制約を設定します。

      gcloud org-policies set-custom-constraint deleteProtectionRequired.yaml

    ポリシーのテスト

    組織内のプロジェクトで --delete-protection フラグを設定せずにデータベースを作成してみます。

    gcloud firestore database create \
   --project=PROJECT_ID \
   --database=DATABASE_ID \

    次のような出力が表示されます。

    Operation denied by custom org policies: ["customConstraints/custom.deleteProtectionRequired": "To ensure the data security, Delete Protection is required to be enabled for Firestore databases"]

    組織のポリシーの変更をテストして分析する

    環境の状態と変更による影響をより深く理解するために、組織のポリシーに対するすべての変更のテストとドライランを行うことをおすすめします。

    組織のポリシー用の Policy Simulator は、現在の環境に対する制約と組織のポリシーの影響を理解するのに役立ちます。このツールを使用すると、すべてのリソース構成を確認して、本番環境に適用される前に違反が発生する場所を確認できます。詳しい手順については、Policy Simulator で組織のポリシーへの変更をテストするをご覧ください。

    現在の影響を把握したら、ドライラン モードで組織のポリシーを作成して、今後 30 日間のポリシーの影響と潜在的な違反を把握できます。ドライラン モードの組織のポリシーは、ポリシーの違反が監査ログに記録されながら違反アクションは拒否されないタイプの組織のポリシーです。ドライラン モードでカスタムの制約から組織のポリシーを作成するには、 Google Cloud コンソールまたは Google Cloud CLI を使用します。詳しい手順については、ドライラン モードで組織のポリシーを作成するをご覧ください。

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

    次の表では一般的なカスタム制約の構文例をまとめています。

    説明 制約の構文
    データベース名は特定のパターンに従う必要があります。カスタム組織のポリシーのデータベース名の形式は projects/project-id/databases/database-id ですが、データベース管理オペレーションでは database-id のみが指定されます。 
    name: organizations/ORGANIZATION_ID/customConstraints/custom.nameSuffixMobile
resourceTypes:
- firestore.googleapis.com/Database
methodTypes:
- CREATE
condition: "resource.name.endsWith('-mobile')"
actionType: ALLOW
displayName: Firestore database names end with "-mobile"
description: Only allow the creation of database names ending with suffix "-mobile"
    データベースは、指定されたロケーションでのみ作成できます。 
    name: organizations/ORGANIZATION_ID/customConstraints/custom.locationUsCentral1
resourceTypes:
- firestore.googleapis.com/Database
methodTypes:
- CREATE
condition: "resource.locationId == 'us-central1'"
actionType: ALLOW
displayName: Firestore database location id us-central1
description: Only allow the creation of databases in region us-central1
    データベースでpoint-in-time-recoveryを有効にする必要があります。 
    name: organizations/ORGANIZATION_ID/customConstraints/custom.pitrEnforce
resourceTypes:
- firestore.googleapis.com/Database
methodTypes:
- CREATE
- UPDATE
condition: "resource.pointInTimeRecoveryEnablement == "POINT_IN_TIME_RECOVERY_ENABLED""
actionType: ALLOW
displayName: Firestore database enables PiTR
description: Only allow the creation and updating of a databases if PiTR is enabled.
    削除保護が有効になっていない限り、データベースの作成を許可しません。 
    name: organizations/ORGANIZATION_ID/customConstraints/custom.deleteProtectionRequired
resourceTypes:
- firestore.googleapis.com/Database
methodTypes:
- CREATE
- UPDATE
condition: "resource.deleteProtectionState == "DELETE_PROTECTION_ENABLED""
actionType: ALLOW
displayName: Firestore with MongoDB compatibility Delete Protection Required
description: To ensure the data security, Delete Protection is required to be enabled for Firestore databases.
    データベースは、指定された CMEK（顧客管理の暗号鍵）構成を使用する必要があります。 
    name: organizations/ORGANIZATION_ID/customConstraints/custom.cmekKeyNotDev
resourceTypes:
- firestore.googleapis.com/Database
methodTypes:
- CREATE
- UPDATE
condition: "resource.cmekConfig.kmsKeyName.matches('dev$')"
actionType: DENY
displayName: Firestore database CMEK key not dev
description: Disallow the creation and updating of databases with CMEK KMS keys ending with "dev".
    データベースは、指定されたデータベース エディションを使用する必要があります。 
    name: organizations/ORGANIZATION_ID/customConstraints/custom.enterpriseEditionRequired
resourceTypes:
- firestore.googleapis.com/Database
methodTypes:
- CREATE
- UPDATE
condition: "resource.databaseEdition == "ENTERPRISE""
actionType: ALLOW
displayName: Firestore Enterprise Edition Required
description: Only allow the creation and updating of databases with Enterprise Edition.

    MongoDB 互換の Firestore でサポートされているリソース

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

    リソース フィールド
    firestore.googleapis.com/Database resource.appEngineIntegrationMode
    resource.cmekConfig.kmsKeyName
    resource.concurrencyMode
    resource.deleteProtectionState
    resource.locationId
    resource.name
    resource.pointInTimeRecoveryEnablement
    resource.type

    次のステップ