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

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

    • pubsub.googleapis.com/Schema
    • pubsub.googleapis.com/Snapshot
    • pubsub.googleapis.com/Subscription
    • pubsub.googleapis.com/Topic

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

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

    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.

      Go to project selector

    3. Make sure that billing is enabled for your Google Cloud project.

    4. Install the Google Cloud CLI.

    5. To initialize the gcloud CLI, run the following command: 

      gcloud init

    6. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

      Go to project selector

    7. Make sure that billing is enabled for your Google Cloud project.

    8. Install the Google Cloud CLI.

    9. To initialize the gcloud CLI, run the following command: 

      gcloud init
    10. 組織 ID を確実に把握します。

    必要なロール

    カスタム組織のポリシーを管理するために必要な権限を取得するには、組織リソースに対する組織ポリシー管理者 （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.messageRetentionSet。このフィールドの最大長は 70 文字です。

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

    • CONDITION: サポート対象のサービス リソースの表現に対して書き込まれる CEL 条件。このフィールドの最大長は 1000 文字です。条件の書き込み先として使用できるリソースの詳細については、サポート対象のリソースをご覧ください。例: "has(resource.messageRetentionDuration)"

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

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

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

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

    カスタム制約を設定する

    新しいカスタム制約の 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 リソースに適用します。

    Console

    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.messageRetentionSet のようにします。

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

        gcloud org-policies set-policy POLICY_PATH

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

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

    次の例では、特定のプロジェクト内のすべての新しいトピックで、メッセージの転送保証を適用することを要求するカスタムの制約とポリシーを作成します。

    始める前に、次のことを理解しておく必要があります。

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

    制約を作成します。

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

      name: organizations/ORGANIZATION_ID/customConstraints/custom.messageRetentionSet
resourceTypes:
- Topic
methodTypes:
- CREATE
- UPDATE
condition: "has(resource.messageRetentionDuration)"
actionType: ALLOW
displayName: Require message retention
description: All topics must set a message retention duration.

      これにより、すべてのトピックでメッセージの保持期間を設定しなければならないという制約が定義されます。

      1. 制約を適用します。

        gcloud org-policies set-custom-constraint constraint-require-message-retention.yaml

      2. 制約が存在することを確認します。

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

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

        CUSTOM_CONSTRAINT                       ACTION_TYPE   METHOD_TYPES     RESOURCE_TYPES                     DISPLAY_NAME
custom.messageRetentionSet              ALLOW         CREATE,UPDATE    pubsub.googleapis.com/Topic        Require message retention
...

      ポリシーを作成するには:

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

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

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

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

        gcloud org-policies set-policy policy-`policy-require-message-retention.yaml`:

      3. ポリシーが存在することを確認します。

        gcloud org-policies list --project=PROJECT_ID

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

        CONSTRAINT                         LIST_POLICY    BOOLEAN_POLICY    ETAG
custom.messageRetentionSet         -              SET               COCsm5QGENiXi2E=

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

      ポリシーのテスト

      メッセージ保持を有効にせずにトピックを作成してみてください。

      gcloud pubsub topics create org-policy-test \
  --project=PROJECT_ID \

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

      Operation denied by custom org policies: ["customConstraints/custom.messageRetentionSet": "All topics must set a message retention duration."].

ERROR: Failed to create topic [projects/PROJECT_ID/topics/org-policy-test]: Operation denied by org policy: ["customConstraints/custom.messageRetentionSet": "All topics must set a message retention duration."].
ERROR: (gcloud.pubsub.topics.create) Failed to create the following: [org-policy-test].

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

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

      説明 制約の構文
      トピックでメッセージの転送中の保証を適用し、許可された永続性リージョンを少なくとも 1 つ指定することを必須にします。 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.enforceInTransitWithRegions
  resourceTypes:
  - pubsub.googleapis.com/Topic
  methodTypes:
  - CREATE
  - UPDATE
  condition: "resource.messageStoragePolicy.enforceInTransit == true && resource.messageStoragePolicy.allowedPersistenceRegions.size() >= 1"
  actionType: ALLOW
  displayName: Require in-transit enforcement and regions
  description: All topics must enable in-transit message storage policy enforcement and contain a non-empty list of allowed persistence regions.
      トピックでメッセージの転送中保証を適用し、特定のリージョンを除外する 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.enforceInTransitWithoutUsEast1
  resourceTypes:
  - pubsub.googleapis.com/Topic
  methodTypes:
  - CREATE
  - UPDATE
  condition: "resource.messageStoragePolicy.enforceInTransit && !resource.messageStoragePolicy.allowedPersistenceRegions.exists(r, r == 'us-east1')"
  actionType: ALLOW
  displayName: Require in-transit enforcement and restrict regions
  description: All topics must enable in-transit message storage policy enforcement, and exclude us-east1 from the allowed persistence regions.
      サブスクリプションのメッセージの保持期間の最小値を要求する 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.minMessageRetentionDuration
  resourceTypes:
  - pubsub.googleapis.com/Subscription
  methodTypes:
  - CREATE
  - UPDATE
  condition: "resource.messageRetentionDuration < duration('30m')"
  actionType: DENY
  displayName: Minimum message retention duration
  description: All subscriptions must retain unacked messages for at least 30 minutes.
      デッド レタリングを有効にするには定期購入が必要 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.requireDeadLetterPolicy
  resourceTypes:
  - pubsub.googleapis.com/Subscription
  methodTypes:
  - CREATE
  - UPDATE
  condition: "has(resource.deadLetterPolicy)"
  actionType: ALLOW
  displayName: Require dead letter policy
  description: All subscriptions must set a dead letter policy.
      スキーマのタイプを Avro にする必要があります。 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.schemaIsAvro
  resourceTypes:
  - pubsub.googleapis.com/Schema
  methodTypes:
  - CREATE
  - UPDATE
  condition: "resource.type == 'AVRO'"
  actionType: ALLOW
  displayName: Schema is Avro
  description: All schemas must be of type Avro.
      サブスクリプションに認証済み push を必須にする 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.authenticatedPush
  resourceTypes:
  - pubsub.googleapis.com/Subscription
  methodTypes:
  - CREATE
  - UPDATE
  condition: "has(resource.pushConfig.pushEndpoint) && has(resource.pushConfig.oidcToken.serviceAccountEmail) && has(resource.pushConfig.oidcToken.audience)"
  actionType: ALLOW
  displayName: Subscription uses authenticated push
  description: All subscriptions must enable push authentication.
      トピックで CMEK を有効にすることを必須にする 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.topicHasCmek
  resourceTypes:
  - pubsub.googleapis.com/Topic
  methodTypes:
  - CREATE
  - UPDATE
  condition: "has(resource.kmsKeyName)"
  actionType: ALLOW
  displayName: Topic has CMEK
  description: All topics must use a Cloud KMS CryptoKey.

      Pub/Sub でサポートされているリソース

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

      リソース フィールド
      pubsub.googleapis.com/Schema resource.definition
      resource.name
      resource.type
      pubsub.googleapis.com/Snapshot resource.expireTime
      resource.name
      resource.topic
      pubsub.googleapis.com/Subscription resource.ackDeadlineSeconds
      resource.bigqueryConfig.dropUnknownFields
      resource.bigqueryConfig.serviceAccountEmail
      resource.bigqueryConfig.table
      resource.bigqueryConfig.useTableSchema
      resource.bigqueryConfig.useTopicSchema
      resource.bigqueryConfig.writeMetadata
      resource.cloudStorageConfig.bucket
      resource.cloudStorageConfig.filenameDatetimeFormat
      resource.cloudStorageConfig.filenamePrefix
      resource.cloudStorageConfig.filenameSuffix
      resource.cloudStorageConfig.maxBytes
      resource.cloudStorageConfig.maxDuration
      resource.cloudStorageConfig.maxMessages
      resource.cloudStorageConfig.serviceAccountEmail
      resource.deadLetterPolicy.deadLetterTopic
      resource.deadLetterPolicy.maxDeliveryAttempts
      resource.enableExactlyOnceDelivery
      resource.enableMessageOrdering
      resource.expirationPolicy.ttl
      resource.filter
      resource.messageRetentionDuration
      resource.name
      resource.pushConfig.attributes
      resource.pushConfig.noWrapper.writeMetadata
      resource.pushConfig.oidcToken.audience
      resource.pushConfig.oidcToken.serviceAccountEmail
      resource.pushConfig.pushEndpoint
      resource.retainAckedMessages
      resource.retryPolicy.maximumBackoff
      resource.retryPolicy.minimumBackoff
      resource.topic
      pubsub.googleapis.com/Topic resource.ingestionDataSourceSettings.awsKinesis.awsRoleArn
      resource.ingestionDataSourceSettings.awsKinesis.consumerArn
      resource.ingestionDataSourceSettings.awsKinesis.gcpServiceAccount
      resource.ingestionDataSourceSettings.awsKinesis.streamArn
      resource.kmsKeyName
      resource.messageRetentionDuration
      resource.messageStoragePolicy.allowedPersistenceRegions
      resource.messageStoragePolicy.enforceInTransit
      resource.name
      resource.schemaSettings.encoding
      resource.schemaSettings.firstRevisionId
      resource.schemaSettings.lastRevisionId
      resource.schemaSettings.schema

      次のステップ