カスタム制約を使用して Memorystore for Redis リソースを管理する

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

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

カスタムの組織のポリシーを実装すると、一貫した構成と制限を適用できます。これにより、Memorystore for Redis インスタンスがセキュリティのベストプラクティスと規制要件に準拠します。

利点

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

ポリシーの継承

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

料金

事前定義の組織のポリシーやカスタムの組織のポリシーを含む組織のポリシーサービスは料金なしで利用できます。

制限事項

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

新しいポリシーは、既存のインスタンス構成には影響しません。
Google Cloud コンソール、Google Cloud CLI、RPC のいずれかを使用してインスタンス構成をコンプライアンス状態から非コンプライアンス状態に変更しない限り、既存のインスタンス構成は有効なままです。
メンテナンスはインスタンスの構成を変更しないので、定期メンテナンス更新によってポリシーが適用されることはありません。

始める前に

プロジェクトを設定します。
1. 組織 ID を確認します。

必要なロール

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

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

Memorystore for Redis を作成するために必要なロールをユーザーアカウントに追加する必要もあります。Memorystore for Redis リソースへのアクセスを構成するをご覧ください。

カスタム制約を作成する

カスタム制約を作成するには、YAML ファイルを使用して、制約の対象となるリソース、メソッド、条件、アクションを定義します。これらは、組織のポリシーを適用しているサービスに固有のものです。カスタム制約の条件は、Common Expression Language を使用して定義する必要があります。 Common Expression Language（CEL）に関する GitHub ページをご覧ください。CEL を使用してカスタム制約で条件を作成する方法については、カスタム制約の作成と管理の CEL セクションをご覧ください。

次のテンプレートを使用して、カスタム制約の YAML ファイルを作成します。

name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
resourceTypes:
- redis.googleapis.com/RESOURCE_NAME
methodTypes:
- CREATE
- UPDATE
condition: "CONDITION"
actionType: ACTION
displayName: DISPLAY_NAME
description: DESCRIPTION

以下を置き換えます。

ORGANIZATION_ID: 組織 ID（123456789 など）。
CONSTRAINT_NAME: 新しいカスタム制約に付ける名前。カスタム制約は custom. で始まる必要があり、大文字、小文字、数字のみを含めることができます（例: custom.restrictInstanceToOnereplica）。このフィールドの最大長は 70 文字です。接頭辞（例: organizations/123456789/customConstraints/custom.allowConstraint）はカウントされません。
RESOURCE_NAME: 制限するオブジェクトとフィールドを含む Memorystore for Redis リソースの名前（URI ではない）。例: Instance
CONDITION: サポート対象のサービスリソースの表現に対して書き込まれる CEL 条件。このフィールドの最大長は 1,000 文字です。条件の書き込み先として使用できるリソースの詳細については、サポート対象のリソースをご覧ください。例: "resource.replicaCount >= 2"
ACTION: condition が満たされている場合に実行するアクション。ALLOW または DENY になります。
DISPLAY_NAME: 制約の名前。わかりやすい名前を入力してください。このフィールドの最大長は 200 文字です。
DESCRIPTION: ポリシー違反時にエラーメッセージとして表示される制約の説明。わかりやすい説明を入力してください。このフィールドの最大長は 2000 文字です。

カスタム制約の作成方法の詳細については、カスタム組織のポリシーの作成と管理をご覧ください。

カスタム制約を設定する

コンソール

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

Google Cloud コンソールで [組織のポリシー] ページに移動します。
[組織のポリシー] に移動
プロジェクト選択ツールで、組織のポリシーを設定するプロジェクトを選択します。
[ カスタム制約] をクリックします。
[表示名] ボックスに、人が読める形式で制約の名前を入力します。この名前はエラーメッセージで使用されるほか、識別やデバッグにも使用できます。エラーメッセージで公開される可能性があるため、表示名に個人情報（PII）やセンシティブデータを使用しないでください。このフィールドには、最大 200 文字まで入力できます。
[**制約 ID**] ボックスに、新しいカスタム制約の ID を入力します。カスタム制約の名前に使用できるのは、英字（大文字と小文字）と数字のみです（例: custom.restrictInstanceToOnereplica）。このフィールドには、接頭辞（custom.）を除き、最大 70 文字まで入力できます（例: organizations/123456789/customConstraints/custom）。エラーメッセージで公開される可能性があるため、制約 ID に個人情報（PII）や機密データを含めないでください。
[説明] ボックスに、人が読める形式で制約の説明を入力します。この説明は、ポリシー違反の際にエラーメッセージとして使用されます。ポリシー違反が発生した理由と、ポリシー違反を解決する方法に関する詳細を含めてください。エラーメッセージで公開される可能性があるため、説明に個人情報（PII）や機密データを含めないでください。このフィールドには、最大 2,000 文字まで入力できます。
[リソースの種類] ボックスで、制限するオブジェクトとフィールドを含む Google Cloud REST リソースの名前を選択します（例: container.googleapis.com/NodePool）。ほとんどの種類のリソースは、最大 20 個のカスタム制約をサポートしています。これより多くのカスタム制約を作成しようとすると、オペレーションは失敗します。
この制約は、REST CREATE メソッドにのみ適用できます。

各サービスでサポートされているメソッドを確認するには、カスタム制約をサポートするサービスをご覧ください。

条件を定義するには、 [Edit condition] をクリックします。

[条件を追加] パネルで、サポートされているサービスリソースを参照する CEL 条件を作成します（例: resource.management.autoUpgrade == false）。このフィールドには、最大 1,000 文字まで入力できます。CEL の使用方法の詳細については、Common Expression Language をご覧ください。カスタム制約で使用できるサービスリソースの詳細については、カスタム制約のサポートサービスをご覧ください。
[保存] をクリックします。

[アクション] で、条件が満たされた場合に評価対象のメソッドを許可するか拒否するかを選択します。

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

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

[制約を作成] をクリックします。

各フィールドに値を入力すると、このカスタム制約に対応する YAML 構成が右側に表示されます。

gcloud

カスタム制約を作成するには、次の形式で YAML ファイルを作成します。

name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
resourceTypes: RESOURCE_NAME
methodTypes:
  - CREATE
condition: "CONDITION"
actionType: ACTION
displayName: DISPLAY_NAME
description: DESCRIPTION

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

ORGANIZATION_ID: 組織 ID（例: 123456789）。
CONSTRAINT_NAME: 新しいカスタム制約の名前。カスタム制約の名前に使用できるのは、英字（大文字と小文字）または数字のみです（例: custom.restrictInstanceToOnereplica）。このフィールドには、接頭辞（custom.）を除き、最大 70 文字まで入力できます（例: organizations/123456789/customConstraints/custom）。エラーメッセージで公開される可能性があるため、制約 ID に個人情報（PII）やセンシティブデータを含めないでください。
RESOURCE_NAME: 制限するオブジェクトとフィールドを含む Google Cloud リソースの完全修飾名。例: redis.googleapis.com/Instance。ほとんどの種類のリソースは、最大 20 個のカスタム制約をサポートしています。これより多くのカスタム制約を作成しようとすると、オペレーションは失敗します。
methodTypes: 制約が適用される REST メソッド。 CREATE のみを設定できます。

各サービスでサポートされているメソッドを確認するには、カスタム制約をサポートするサービスをご覧ください。

CONDITION: サポート対象のサービスリソースの表現に対して記述する CEL 条件。このフィールドには、最大 1,000 文字まで入力できます。例: "resource.replicaCount >= 2"。

条件を記述できるリソースの詳細については、サポートされているリソースをご覧ください。

ACTION: condition が満たされている場合に実行するアクション。ALLOW のみを設定できます。

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

DISPLAY_NAME: 人が読める形式の制約名。この名前はエラーメッセージで使用されるほか、識別やデバッグにも使用できます。エラーメッセージで公開される可能性があるため、表示名に個人情報（PII）やセンシティブデータを使用しないでください。このフィールドには、最大 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 で組織のポリシーの変更をテストするをご覧ください。
ドライランモードで組織のポリシーを適用するには、[ドライランポリシーを設定] をクリックします。詳細については、組織のポリシーをテストするをご覧ください。
ドライランモードで組織のポリシーが想定どおりに動作することを確認したら、有効なポリシーを設定するには、[ポリシーを設定] をクリックします。

gcloud

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

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

dryRunSpec:
  rules:
  - enforce: true

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

PROJECT_ID: 制約を適用するプロジェクト。
CONSTRAINT_NAME: カスタム制約に定義した名前。例: custom.restrictInstanceToOnereplica。

ドライランモードで組織のポリシーを適用するには、dryRunSpec フラグを指定して次のコマンドを実行します。

gcloud org-policies set-policy POLICY_PATH --update-mask=dryRunSpec

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

ドライランモードで組織のポリシーが想定どおりに動作することを確認したら、org-policies set-policy コマンドと spec フラグを使用して有効なポリシーを設定します。

gcloud org-policies set-policy POLICY_PATH --update-mask=spec

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

カスタム制約をテストする

カスタム制約をテストするには、Redis インスタンスの作成を試みる gcloud コマンドを実行します。

たとえば、制約で Redis インスタンスのレプリカ数を 1 つ以下にする必要があるとします。この制約をテストするには、次のスニペットに示すように、replica-count を 2 に設定して gcloud redis instances create コマンドを実行します。

gcloud redis instances create redis-test-instance \
    --project=my-project \
    --tier=standard \
    --size=16 \
    --region=us-central1 \
    --redis-version=redis_7_0 \
    --network=projects/my-project/global/networks/default \
    --connect-mode=PRIVATE_SERVICE_ACCESS \
    --read-replicas-mode=READ_REPLICAS_ENABLED \
    --replica-count=2

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

Operation denied by custom org policies: ["customConstraints/custom.restrictInstanceToOnereplica": "Prevent users from creating Redis instances with more than one replica"]

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

Memorystore for Redis リソースを作成または更新する際に、次の Memorystore for Redis カスタム制約フィールドを使用できます。

Memorystore for Redis インスタンス
- resource.alternativeLocationId
- resource.authEnabled
- resource.authorizedNetwork
- resource.availableMaintenanceVersions
- resource.connectMode
- resource.customerManagedKey
- resource.displayName
- resource.locationId
- resource.maintenancePolicy.description
- resource.maintenancePolicy.weeklyMaintenanceWindow.day
- resource.maintenanceVersion
- resource.memorySizeGb
- resource.name
- resource.persistenceConfig.persistenceMode
- resource.persistenceConfig.rdbSnapshotPeriod
- resource.persistenceConfig.rdbSnapshotStartTime
- resource.readReplicasMode
- resource.redisConfigs
- resource.redisVersion
- resource.replicaCount
- resource.reservedIpRange
- resource.secondaryIpRange
- resource.suspensionReasons
- resource.tier
- resource.transitEncryptionMode

カスタム制約の例

次の表に、Redis インスタンスを 1 つのレプリカに制限するカスタム制約の例を示します。

説明	制約の構文
Redis インスタンスを 1 つのレプリカに制限する	name: organizations/`ORGANIZATION_ID`/customConstraints/custom.restrictInstanceToOnereplica resourceTypes: - redis.googleapis.com/Instance methodTypes: - CREATE - UPDATE condition: "resource.replicaCount >= 2" actionType: DENY displayName: Restrict Redis instances to one replica description: Prevent users from creating Redis instances with more than one replica

説明

制約の構文

Redis インスタンスを 1 つのレプリカに制限する

    name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictInstanceToOnereplica
    resourceTypes:
    - redis.googleapis.com/Instance
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.replicaCount >= 2"
    actionType: DENY
    displayName: Restrict Redis instances to one replica
    description: Prevent users from creating Redis instances with more than one replica

次のステップ

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

カスタム制約を使用して Memorystore for Redis リソースを管理する コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

利点

ポリシーの継承

料金

制限事項

始める前に

必要なロール

カスタム制約を作成する

カスタム制約を設定する

コンソール

gcloud

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

コンソール

gcloud

カスタム制約をテストする

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

カスタム制約の例

次のステップ

カスタム制約を使用して Memorystore for Redis リソースを管理する