カスタムの組織のポリシー制約

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

  • storagetransfer.googleapis.com/TransferJob

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

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

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

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

ポリシーの継承

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

利点

  • セキュリティとガバナンス: データ移転オペレーションに対する一元管理を適用し、広範なユーザー権限に関連するセキュリティ リスクを軽減します。
  • きめ細かい制御: 転送ジョブを特定の許可されたソースバケットまたは宛先バケットに制限するか、転送を特定のサービス ペア(Cloud Storage から Cloud Storage への転送のみなど)に制限します。

始める前に

  1. Google Cloud アカウントにログインします。Google Cloud を初めて使用する場合は、アカウントを作成して、実際のシナリオでの Google プロダクトのパフォーマンスを評価してください。新規のお客様には、ワークロードの実行、テスト、デプロイができる無料クレジット $300 分を差し上げます。
  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. 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. Google Cloud CLI をインストールします。

  10. 外部 ID プロバイダ(IdP)を使用している場合は、まず連携 ID を使用して gcloud CLI にログインする必要があります。

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

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

必要なロール

カスタムの組織のポリシーを管理するために必要な権限を取得するには、組織のリソースに対する組織のポリシー管理者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 サービスが両方のメソッドをサポートしているわけではありません。各サービスでサポートされているメソッドを確認するには、 カスタム制約をサポートするサービスをご覧ください。

  10. 条件を定義するには、[ 条件を編集] をクリックします。
    1. [条件を追加] パネルで、サポートされているサービス リソースを参照する CEL 条件を作成します(例: resource.management.autoUpgrade == false)。このフィールドには、最大 1,000 文字まで入力できます。CEL の使用方法の詳細については、Common Expression Language をご覧ください。 カスタム制約で使用できるサービス リソースの詳細については、カスタム制約のサポート サービスをご覧ください。
    2. [保存] をクリックします。
  11. [アクション] で、条件が満たされた場合に評価対象のメソッドを許可するか拒否するかを選択します。
  12. 拒否アクションは、条件が true と評価された場合に、リソースを作成または更新するオペレーションがブロックされることを意味します。

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

  13. [制約を作成] をクリックします。
  14. 各フィールドに値を入力すると、このカスタム制約に対応する 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.enforceCloudStorageToCloudStorageOnly)。このフィールドには、最大 70 文字まで入力できます。
    • RESOURCE_NAME: 制限するオブジェクトとフィールドを含む Google Cloud リソースの完全修飾名。例: storagetransfer.googleapis.com/TransferJob
    • CONDITION: サポート対象のサービス リソースの表現に対して記述する CEL 条件。このフィールドには、最大 1,000 文字まで入力できます。例: "has(resource.transferSpec.gcsDataSource) && has(resource.transferSpec.gcsDataSink)"
    • 条件を記述できるリソースの詳細については、サポートされているリソースをご覧ください。

    • ACTION: condition が満たされた場合に実行するアクション。 有効な値は ALLOWDENY です。
    • 許可アクションは、条件が true と評価された場合に、リソースを作成または更新するオペレーションが許可されることを意味します。つまり、条件に明記されているケース以外はすべてブロックされます。

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

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

コンソール

  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.enforceCloudStorageToCloudStorageOnly
  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 分かかります。

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

次の例では、新しく作成されるすべての転送ジョブでロギングが有効になっていることを必須にするカスタムの制約とポリシーを作成します。ポリシーで禁止されているジョブ(ロギングが無効になっているジョブなど)を作成して、ポリシーをテストできます。

制約を作成する

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

    name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictLogging
    resourceTypes:
    - storagetransfer.googleapis.com/TransferJob
    methodTypes:
    - CREATE
    condition: resource.loggingConfig.logActions.size() > 0 && resource.loggingConfig.logActionStates.size() > 0
    actionType: ALLOW
    displayName: Require transfer job logging
    description: All new transfer jobs must have logging enabled.
    

    ORGANIZATION_ID は、実際の組織 ID に置き換えます。

  2. 制約を適用します。

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

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

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

    CUSTOM_CONSTRAINT           ACTION_TYPE    METHOD_TYPES    RESOURCE_TYPES                        DISPLAY_NAME
    custom.restrictLogging      ALLOW          CREATE          transfer.googleapis.com/TransferJob   Require transfer job logging
    ...
    

ポリシーを作成する

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

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

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

    この例では、この制約をプロジェクト レベルで適用しますが、組織レベルまたはフォルダレベルで設定することもできます。

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

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

    gcloud org-policies list --project=PROJECT_ID
    

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

    CONSTRAINT                        LIST_POLICY    BOOLEAN_POLICY    ETAG
    custom.restrictLogging            -              SET               CIqk123GELiZn6cC-
    

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

ポリシーのテスト

ロギング構成が完全に省略されているか、空の構成に設定されている転送ジョブを作成してみます。

gcloud transfer jobs create SOURCE DESTINATION \
  --name="transfer-without-logging"

リクエストは失敗し、次のようなエラーが返されます。

ERROR: (gcloud.transfer.jobs.create) FAILED_PRECONDITION: Operation denied by org policy: ["customConstraints/custom.restrictLogging": "All new transfer jobs must have logging enabled."].
- '@type': type.googleapis.com/google.rpc.ErrorInfo
  domain: iam.googleapis.com
  metadata:
    customConstraints: customConstraints/custom.restrictLogging
  reason: CUSTOM_ORG_POLICY_VIOLATION

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

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

説明 制約の構文
転送を制限して、Cloud Storage から Cloud Storage への転送のみを許可する
name: organizations/ORGANIZATION_ID/customConstraints/custom.enforceCloudStorageToCloudStorageOnly
resourceTypes:
- storagetransfer.googleapis.com/TransferJob
methodTypes:
- CREATE
- UPDATE
condition: "has(resource.transferSpec.gcsDataSource) && has(resource.transferSpec.gcsDataSink)"
actionType: ALLOW
displayName: Enforce Cloud Storage to Cloud Storage transfers only
description: Only allow transfer jobs that move data from Cloud Storage to Cloud Storage.
転送を承認済みソースバケットの特定のリストに制限する
name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictSourceBuckets
resourceTypes:
- storagetransfer.googleapis.com/TransferJob
methodTypes:
- CREATE
- UPDATE
condition: "!(resource.transferSpec.gcsDataSource.bucketName in ['approved-bucket-1', 'approved-bucket-2'])"
actionType: DENY
displayName: Restrict source buckets
description: Deny transfer jobs that do not use an approved source bucket.

Storage Transfer Service でサポートされているリソース

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

リソース フィールド
storagetransfer.googleapis.com/TransferJob resource.description
resource.eventStream.eventStreamExpirationTime
resource.eventStream.eventStreamStartTime
resource.eventStream.name
resource.latestOperationName
resource.loggingConfig.enableOnpremGcsTransferLogs
resource.loggingConfig.logActions
resource.loggingConfig.logActionStates
resource.name
resource.notificationConfig.eventTypes
resource.notificationConfig.payloadFormat
resource.notificationConfig.pubsubTopic
resource.projectId
resource.replicationSpec.gcsDataSink.bucketName
resource.replicationSpec.gcsDataSink.managedFolderTransferEnabled
resource.replicationSpec.gcsDataSink.path
resource.replicationSpec.gcsDataSource.bucketName
resource.replicationSpec.gcsDataSource.managedFolderTransferEnabled
resource.replicationSpec.gcsDataSource.path
resource.replicationSpec.objectConditions.excludePrefixes
resource.replicationSpec.objectConditions.includePrefixes
resource.replicationSpec.objectConditions.lastModifiedBefore
resource.replicationSpec.objectConditions.lastModifiedSince
resource.replicationSpec.objectConditions.matchGlob
resource.replicationSpec.objectConditions.maxTimeElapsedSinceLastModification
resource.replicationSpec.objectConditions.minTimeElapsedSinceLastModification
resource.replicationSpec.transferOptions.deleteObjectsFromSourceAfterTransfer
resource.replicationSpec.transferOptions.deleteObjectsUniqueInSink
resource.replicationSpec.transferOptions.metadataOptions.acl
resource.replicationSpec.transferOptions.metadataOptions.gid
resource.replicationSpec.transferOptions.metadataOptions.kmsKey
resource.replicationSpec.transferOptions.metadataOptions.mode
resource.replicationSpec.transferOptions.metadataOptions.storageClass
resource.replicationSpec.transferOptions.metadataOptions.symlink
resource.replicationSpec.transferOptions.metadataOptions.temporaryHold
resource.replicationSpec.transferOptions.metadataOptions.timeCreated
resource.replicationSpec.transferOptions.metadataOptions.uid
resource.replicationSpec.transferOptions.overwriteObjectsAlreadyExistingInSink
resource.replicationSpec.transferOptions.overwriteWhen
resource.schedule.endTimeOfDay
resource.schedule.repeatInterval
resource.schedule.scheduleEndDate
resource.schedule.scheduleStartDate
resource.schedule.startTimeOfDay
resource.serviceAccount
resource.status
resource.transferSpec.awsS3CompatibleDataSource.bucketName
resource.transferSpec.awsS3CompatibleDataSource.endpoint
resource.transferSpec.awsS3CompatibleDataSource.path
resource.transferSpec.awsS3CompatibleDataSource.region
resource.transferSpec.awsS3CompatibleDataSource.s3Metadata.authMethod
resource.transferSpec.awsS3CompatibleDataSource.s3Metadata.listApi
resource.transferSpec.awsS3CompatibleDataSource.s3Metadata.protocol
resource.transferSpec.awsS3CompatibleDataSource.s3Metadata.requestModel
resource.transferSpec.awsS3DataSource.bucketName
resource.transferSpec.awsS3DataSource.cloudfrontDomain
resource.transferSpec.awsS3DataSource.managedPrivateNetwork
resource.transferSpec.awsS3DataSource.path
resource.transferSpec.awsS3DataSource.privateNetworkService
resource.transferSpec.awsS3DataSource.roleArn
resource.transferSpec.azureBlobStorageDataSource.container
resource.transferSpec.azureBlobStorageDataSource.federatedIdentityConfig.clientId
resource.transferSpec.azureBlobStorageDataSource.federatedIdentityConfig.tenantId
resource.transferSpec.azureBlobStorageDataSource.path
resource.transferSpec.azureBlobStorageDataSource.privateNetworkService
resource.transferSpec.azureBlobStorageDataSource.storageAccount
resource.transferSpec.gcsDataSink.bucketName
resource.transferSpec.gcsDataSink.managedFolderTransferEnabled
resource.transferSpec.gcsDataSink.path
resource.transferSpec.gcsDataSource.bucketName
resource.transferSpec.gcsDataSource.managedFolderTransferEnabled
resource.transferSpec.gcsDataSource.path
resource.transferSpec.gcsIntermediateDataLocation.bucketName
resource.transferSpec.gcsIntermediateDataLocation.managedFolderTransferEnabled
resource.transferSpec.gcsIntermediateDataLocation.path
resource.transferSpec.hdfsDataSource.path
resource.transferSpec.httpDataSource.listUrl
resource.transferSpec.objectConditions.excludePrefixes
resource.transferSpec.objectConditions.includePrefixes
resource.transferSpec.objectConditions.lastModifiedBefore
resource.transferSpec.objectConditions.lastModifiedSince
resource.transferSpec.objectConditions.matchGlob
resource.transferSpec.objectConditions.maxTimeElapsedSinceLastModification
resource.transferSpec.objectConditions.minTimeElapsedSinceLastModification
resource.transferSpec.posixDataSink.rootDirectory
resource.transferSpec.posixDataSource.rootDirectory
resource.transferSpec.sinkAgentPoolName
resource.transferSpec.sourceAgentPoolName
resource.transferSpec.transferManifest.location
resource.transferSpec.transferOptions.deleteObjectsFromSourceAfterTransfer
resource.transferSpec.transferOptions.deleteObjectsUniqueInSink
resource.transferSpec.transferOptions.metadataOptions.acl
resource.transferSpec.transferOptions.metadataOptions.gid
resource.transferSpec.transferOptions.metadataOptions.kmsKey
resource.transferSpec.transferOptions.metadataOptions.mode
resource.transferSpec.transferOptions.metadataOptions.storageClass
resource.transferSpec.transferOptions.metadataOptions.symlink
resource.transferSpec.transferOptions.metadataOptions.temporaryHold
resource.transferSpec.transferOptions.metadataOptions.timeCreated
resource.transferSpec.transferOptions.metadataOptions.uid
resource.transferSpec.transferOptions.overwriteObjectsAlreadyExistingInSink
resource.transferSpec.transferOptions.overwriteWhen

次のステップ