カスタムの組織のポリシーの制約を作成する

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

Cloud Composer 3 | Cloud Composer 2 | Cloud Composer 1

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

• composer.googleapis.com/Environment

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

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

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

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

ポリシーの継承

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

利点

カスタムの組織のポリシーを使用すると、Cloud Composer リソースの特定の値を許可または拒否できます。たとえば、Cloud Composer 環境の作成または更新を行うリクエストが、組織のポリシーによって設定されたカスタム制約検証の要件を満たしていない場合、リクエストは失敗し、エラーが呼び出し元に返されます。また、カスタム組織ポリシーを使用すると、次のことができます。

1. セキュリティが強化されます。たとえば、パブリック IP 環境の作成を禁止するポリシー、プライベートで使用されるパブリック IP アドレスを有効にするポリシー、特定のネットワークとサブネットワークの使用を指定するポリシーを定義できます。

2. 環境の作成または更新時に作成または使用されるリソースをきめ細かく制御できます。

制限事項

すべての組織のポリシーの制約と同様に、ポリシーの変更は既存のインスタンスに遡及的には適用されません。

• 新しいポリシーは、既存のインスタンス構成には影響しません。
• Google Cloud コンソール、Google Cloud CLI、または RPC を使用してコンプライアンス値から非コンプライアンス値に変更しない限り、既存のインスタンス構成は有効なままです。

リソースの UPDATE メソッド タイプにカスタム組織のポリシーを適用する前に、既存の環境が各ポリシーに準拠していることを確認します。

1 つの更新オペレーションで更新できるフィールドは 1 つだけであるため、既存の環境の複数のフィールドがポリシーに同時に違反している場合、デッドロックが発生する可能性があります。

デッドロックを回避するには、次のいずれかを行います。

• （推奨）リソースにポリシーを適用する前に、既存のすべての環境をポリシーに準拠させます。ポリシーの適用後にコンプライアンス違反となる既存の環境を確認するには、ポリシー シミュレーターを使用します。

• ポリシーの適用を無効にし、既存の環境をコンプライアンス状態に更新してから、ポリシーを再度適用します。

始める前に

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.restrictEnvironmentSize。このフィールドの最大長は 70 文字です。

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

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

• 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 リソースに適用します。

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

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

    gcloud org-policies set-policy POLICY_PATH
    

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

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

次の例では、小規模な Cloud Composer 環境のみを許可するカスタムの制約とポリシーを作成します。

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

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

制約を作成する

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

   name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictEnvironmentSize
   resourceTypes:
   - composer.googleapis.com/Environment
   methodTypes:
   - CREATE
   condition: resource.config.environmentSize == "ENVIRONMENT_SIZE_SMALL"
   actionType: ALLOW
   displayName: Only allow small Composer environments.
   description: All environments must be small.
   

2. 制約を適用します。

   gcloud org-policies set-custom-constraint constraint-require-only-small-environments.yaml
   

ポリシーを作成する

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

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

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

   
   gcloud org-policies set-policy policy-require-only-small-environments.yaml
   
   

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

ポリシーのテスト

gcloud composer environments create ENVIRONMENT_NAME \
  --location=LOCATION \
  --image-version="composer-3-airflow-2.10.2-build.12" \
  --environment-size=medium

この環境の作成は、小規模な Composer 環境サイズのみを必要とする制約が設定されているため失敗します。

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

You can't perform this action on a Composer environment due to Custom Organization Policy constraints set on your project. The following constraint(s) were violated: ["customConstraints/custom.restrictEnvironmentSize": All environments must be small.]

前のエラーに対処するには、小規模な環境を作成します。次に例を示します。

gcloud composer environments create ENVIRONMENT_NAME \
  --location=LOCATION \
  --image-version="composer-3-airflow-2.10.2-build.12" \
  --environment-size=small

環境の作成が正常に開始されました。

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

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

説明	制約の構文
プライベート IP Cloud Composer 環境のみを許可する	name: organizations/ORGANIZATION_ID/customConstraints/custom.allowOnlyPrivateIp resourceTypes: - composer.googleapis.com/Environment methodTypes: - CREATE condition: resource.config.privateEnvironmentConfig.enablePrivateEnvironment == true actionType: ALLOW displayName: Only Private IP environments description: All environments must use Private IP networking
ワーカーの最大数は 10 以下にする必要があります	name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictMaxWorketCount resourceTypes: - composer.googleapis.com/Environment methodTypes: - CREATE - UPDATE condition: resource.config.workloadsConfig.worker.maxCount <= 10 actionType: ALLOW displayName: Limit the maximum number of workers description: All environments must have 10 or less workers

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

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

次のステップ

• 組織のポリシー サービスについて詳細を学習する。
• 組織のポリシーの作成と管理の方法について学習する。
• 事前定義された組織のポリシーの制約の完全なリストを確認する。