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

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

compute.googleapis.com/Router

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

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

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

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

ポリシーの継承

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

制限事項

resource.bgpPeers フィールドと resource.interfaces フィールドの一部のサブフィールドは、現時点ではサポートされていません。

resource.bgp フィールドと resource.encryptedInterconnectRouter フィールドのカスタム組織ポリシーは、デフォルト値に適用されない場合があります。これは変更される可能性があります。

始める前に

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.

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

Go to project selector

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

Install the Google Cloud CLI.

To initialize the gcloud CLI, run the following command:

gcloud init

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

Go to project selector

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

Install the Google Cloud CLI.

To initialize the gcloud CLI, run the following command:

gcloud init

組織 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.restrictPeerAsn）。このフィールドの最大長は 70 文字です。
RESOURCE_NAME: 制限するオブジェクトとフィールドを含む Google Cloud リソースの完全修飾名。例: compute.googleapis.com/Router
CONDITION: サポート対象のサービスリソースの表現に対して書き込まれる CEL 条件。このフィールドの最大長は 1,000 文字です。条件の書き込み先として使用できるリソースの詳細については、サポート対象のリソースをご覧ください。例: "resource.bgpPeers.all(b, b.peerAsn == 61234)"
ACTION: condition が満たされている場合に実行するアクション。有効な値は ALLOW と DENY です。
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 リソースに適用します。

コンソール

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

gcloud

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

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

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

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

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

    gcloud org-policies set-policy POLICY_PATH

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

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

次の例では、特定のプロジェクト内のすべての新しい Cloud Router が、IPv6 のみをサポートすることを要求するカスタムの制約とポリシーを作成します。

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

組織の ID
プロジェクト ID

制約を作成する

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

name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictPeerAsn
resourceTypes:
- compute.googleapis.com/Router
methodTypes:
- CREATE
- UPDATE
condition: "resource.bgpPeers.all(b, b.peerAsn == 61234)"
actionType: ALLOW
displayName: Restrict BGP peer ASNs.
description: All BGP Peers must connect with peer ASN 61234.

これにより、すべての Cloud Router のすべての BGP ピア ASN を、指定の数にするように要求する制約が定義されます。

制約を適用します。

gcloud org-policies set-custom-constraint ~/constraint-restrict-peer-asn.yaml

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

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

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

CUSTOM_CONSTRAINT                       ACTION_TYPE  METHOD_TYPES   RESOURCE_TYPES                      DISPLAY_NAME
custom.restrictPeerAsn                  ALLOW        CREATE,UPDATE  compute.googleapis.com/Router       Restrict BGP peer ASNs.
...

ポリシーを作成する

次のファイルに policy-restrict-peer-asn.yaml という名前を付けて保存します。
```
name: projects/PROJECT_ID/policies/custom.restrictPeerAsn
spec:
  rules:
  - enforce: true
```
PROJECT_ID は、実際のプロジェクト ID に置き換えます。

ポリシーを適用します。

gcloud org-policies set-policy ~/policy-restrict-peer-asn.yaml

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

gcloud org-policies list --project=PROJECT_ID

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

CONSTRAINT                             LIST_POLICY    BOOLEAN_POLICY    ETAG
custom.restrictPeerAsn                 -              SET               COCsm5QGENiXi2E=

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

ポリシーのテスト

単一のインターフェースを持つ Cloud Router をプロジェクトに作成します。

 gcloud compute routers create r1 --region=us-central1
 gcloud compute routers add-interface r1 --region=us-central1 \
   --interface-name=i1 --vpn-tunnel=vpn-tunnel1

BGP ピアを追加してみます。

 gcloud compute routers add-bgp-peer r1 --region=us-central1 \
   --peer-name=p1 --interface=i1 --peer-asn=61235

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

Operation denied by custom org policies: ["customConstraints/custom.restrictPeerAsn": "BGP Peer ASN must be 61234."]

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

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

説明	制約の構文
BGP ピア ASN を制限する	name: organizations/`ORGANIZATION_ID`/customConstraints/custom.restrictBgpPeerAsn resourceTypes: - compute.googleapis.com/Router methodTypes: - CREATE - UPDATE condition: "resource.bgpPeers.all(b, b.peerAsn == 61234)" actionType: ALLOW displayName: Restrict BGP peer ASNs. description: All BGP Peers must connect with peer ASN 61234.

説明

制約の構文

BGP ピア ASN を制限する

  name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictBgpPeerAsn
  resourceTypes:
  - compute.googleapis.com/Router
  methodTypes:
  - CREATE
  - UPDATE
  condition: "resource.bgpPeers.all(b, b.peerAsn == 61234)"
  actionType: ALLOW
  displayName: Restrict BGP peer ASNs.
  description: All BGP Peers must connect with peer ASN 61234.

Cloud Router でサポートされているリソースとオペレーション

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

リソース	フィールド
compute.googleapis.com/Router	`resource.bgp.advertisedGroups`
	`resource.bgp.advertisedIpRanges.description`
	`resource.bgp.advertisedIpRanges.range`
	`resource.bgp.advertiseMode`
	`resource.bgp.asn`
	`resource.bgp.keepaliveInterval`
	`resource.bgpPeers.advertisedGroups`
	`resource.bgpPeers.advertisedIpRanges.description`
	`resource.bgpPeers.advertisedIpRanges.range`
	`resource.bgpPeers.advertisedRoutePriority`
	`resource.bgpPeers.advertiseMode`
	`resource.bgpPeers.customLearnedIpRanges.range`
	`resource.bgpPeers.customLearnedRoutePriority`
	`resource.bgpPeers.md5AuthenticationKeyName`
	`resource.bgpPeers.peerAsn`
	`resource.bgpPeers.routerApplianceInstance`
	`resource.description`
	`resource.encryptedInterconnectRouter`
	`resource.interfaces.linkedVpnTunnel`
	`resource.interfaces.subnetwork`
	`resource.md5AuthenticationKeys.name`
	`resource.name`
	`resource.nats.autoNetworkTier`
	`resource.nats.drainNatIps`
	`resource.nats.enableDynamicPortAllocation`
	`resource.nats.enableEndpointIndependentMapping`
	`resource.nats.endpointTypes`
	`resource.nats.icmpIdleTimeoutSec`
	`resource.nats.logConfig.enable`
	`resource.nats.logConfig.filter`
	`resource.nats.maxPortsPerVm`
	`resource.nats.minPortsPerVm`
	`resource.nats.name`
	`resource.nats.natIpAllocateOption`
	`resource.nats.natIps`
	`resource.nats.rules.action.sourceNatActiveIps`
	`resource.nats.rules.action.sourceNatActiveRanges`
	`resource.nats.rules.action.sourceNatDrainIps`
	`resource.nats.rules.action.sourceNatDrainRanges`
	`resource.nats.rules.description`
	`resource.nats.rules.match`
	`resource.nats.rules.ruleNumber`
	`resource.nats.sourceSubnetworkIpRangesToNat`
	`resource.nats.subnetworks.name`
	`resource.nats.subnetworks.secondaryIpRangeNames`
	`resource.nats.subnetworks.sourceIpRangesToNat`
	`resource.nats.tcpEstablishedIdleTimeoutSec`
	`resource.nats.tcpTimeWaitTimeoutSec`
	`resource.nats.tcpTransitoryIdleTimeoutSec`
	`resource.nats.type`
	`resource.nats.udpIdleTimeoutSec`
	`resource.nccGateway`
	`resource.network`

次のステップ

Cloud Router のトラブルシューティングについては、トラブルシューティングをご覧ください。
組織ポリシーサービスの詳細を学習する。
組織のポリシーの作成と管理の方法について学習する。
事前定義された組織のポリシーの制約の完全なリストを確認する。