Firestore-Ressourcen mit benutzerdefinierten Einschränkungen verwalten

Firestore-Ressourcen mit benutzerdefinierten Einschränkungen verwalten

Auf dieser Seite erfahren Sie, wie Sie mit benutzerdefinierten Einschränkungen des Organisationsrichtliniendienstes bestimmte Vorgänge für die folgenden Google Cloud-Ressourcen einschränken:

• firestore.googleapis.com/Database

Weitere Informationen zu Organisationsrichtlinien finden Sie unter Benutzerdefinierte Organisationsrichtlinien.

Informationen zu Organisationsrichtlinien und Einschränkungen

Mit der Google Cloud-Organisationsrichtliniendienst können Sie die Ressourcen Ihrer Organisation zentral und programmatisch steuern. Als Administrator für Organisationsrichtlinien können Sie Folgendes definieren: Organisationsrichtlinie, wobei es sich um eine Reihe von Einschränkungenhandelt, die für Google Cloud-Ressourcen und untergeordnete Elemente dieser Ressourcen in der Google Cloud-Ressourcenhierarchie gelten. Sie können Organisationsrichtlinien auf Organisations-, Ordner- oder Projektebene erzwingen.

Die Organisationsrichtlinie bietet vordefinierte Einschränkungen für verschiedene Google Cloud-Dienste. Wenn Sie jedoch eine detailliertere, anpassbare Steuerung der spezifischen Felder wünschen, die in Ihren Organisationsrichtlinien eingeschränkt werden, können Sie auch benutzerdefinierte Einschränkungen erstellen und diese benutzerdefinierten Einschränkungen in einer Organisationsrichtlinie verwenden.

Übernahme von Richtlinien

Standardmäßig werden Organisationsrichtlinien von den Nachfolgerelementen der Ressourcen übernommen, für die Sie die Richtlinie erzwingen. Wenn Sie beispielsweise eine Richtlinie für einen Ordner erzwingen, erzwingt Google Cloud die Richtlinie für alle Projekte in dem Ordner. Weitere Informationen zu diesem Verhalten und zu dessen Änderung finden Sie unter Regeln für die Evaluierung der Hierarchie.

Vorteile

• Sicherheit, Compliance und Governance: Sie können benutzerdefinierte Organisationsrichtlinien so verwenden:

  • Zur Durchsetzung von Anforderungen für die Notfallwiederherstellung können Sie für Datenbanken bestimmte Einstellungen für die Notfallwiederherstellung wie den Löschschutz und die Wiederherstellung zu einem bestimmten Zeitpunkt verlangen.

  • Sie können die Datenbankerstellung auf bestimmte Standorte beschränken.

  • Sie können CMEK (vom Kunden verwalteter Verschlüsselungsschlüssel) für Datenbanken erforderlich machen.

• Audit: Benutzerdefinierte Einschränkungen von Organisationsrichtlinien werden protokolliert. Bei allen Vorgängen, einschließlich Einschränkungensänderungen und Einschränkungensprüfungen, werden entsprechende Cloud-Audit-Logs generiert.

Hinweise

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.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the 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.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the 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. Sie müssen Ihre Organisations-ID kennen.

Erforderliche Rollen

Bitten Sie Ihren Administrator, Ihnen die IAM-Rolle Organization policy administrator (roles/orgpolicy.policyAdmin) für die Organisationsressource zu gewähren, um die Berechtigungen zu erhalten, die Sie zum Verwalten benutzerdefinierter Organisationsrichtlinien benötigen. Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten.

Sie können die erforderlichen Berechtigungen auch über benutzerdefinierte Rollen oder andere vordefinierte Rollen erhalten.

Benutzerdefinierte Einschränkung erstellen

Eine benutzerdefinierte Einschränkung wird in einer YAML-Datei durch die Ressourcen, Methoden, Bedingungen und Aktionen definiert, die von dem Dienst unterstützt werden, für den Sie die Organisationsrichtlinie erzwingen. Bedingungen für Ihre benutzerdefinierten Einschränkungen werden mithilfe der Common Expression Language (CEL) definiert. Weitere Informationen zum Erstellen von Bedingungen in benutzerdefinierten Einschränkungen mit CEL finden Sie im Abschnitt CEL unter Benutzerdefinierte Einschränkungen erstellen und verwalten.

Erstellen Sie eine YAML-Datei im folgenden Format, um eine benutzerdefinierte Einschränkung zu erstellen:

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

Ersetzen Sie Folgendes:

• ORGANIZATION_ID: Ihre Organisations-ID, z. B. 123456789.

• CONSTRAINT_NAME: Name, den Sie für Ihre neue benutzerdefinierte Einschränkung verwenden möchten. Eine benutzerdefinierte Einschränkung muss mit custom. beginnen und darf nur Großbuchstaben, Kleinbuchstaben oder Ziffern enthalten, z. B. custom.deleteProtectionRequired. Die maximale Länge dieses Feldes beträgt 70 Zeichen.

• RESOURCE_NAME: der voll qualifizierte Name der Google Cloud-Ressource, die das Objekt und das Feld enthält, das Sie einschränken möchten. Beispiel: firestore.googleapis.com/Database.

• CONDITION: eine CEL-Bedingung, die für eine Darstellung einer unterstützten Dienstressource geschrieben wird. Dieses Feld hat eine maximale Länge von 1000 Zeichen. Weitere Informationen zu den verfügbaren Ressourcen, auf die Bedingungen geschrieben werden können, finden Sie unter Unterstützte Ressourcen. Beispiel: "resource.deleteProtectionState == \"DELETE_PROTECTION_ENABLED\"".

• ACTION: Aktion, die ausgeführt werden soll, wenn condition erfüllt ist. Mögliche Werte sind ALLOW und DENY.

• DISPLAY_NAME: Ein nutzerfreundlicher Name für die Einschränkung. Dieses Feld hat eine maximale Länge von 200 Zeichen.

• DESCRIPTION: Eine nutzerfreundliche Beschreibung der Einschränkung, die als Fehlermeldung angezeigt werden soll, wenn die Richtlinie verletzt wird Dieses Feld hat eine maximale Länge von 2000 Zeichen.

Weitere Informationen zum Erstellen einer benutzerdefinierten Einschränkung finden Sie unter Benutzerdefinierte Einschränkungen definieren.

Benutzerdefinierte Einschränkung einrichten

Nachdem Sie die YAML-Datei für eine neue benutzerdefinierte Einschränkung erstellt haben, müssen Sie sie einrichten, um sie für Organisationsrichtlinien in Ihrer Organisation verfügbar zu machen. Verwenden Sie zum Einrichten einer benutzerdefinierten Einschränkung den Befehl gcloud org-policies set-custom-constraint:

gcloud org-policies set-custom-constraint CONSTRAINT_PATH

Ersetzen Sie CONSTRAINT_PATH durch den vollständigen Pfad zu Ihrer benutzerdefinierten Einschränkungsdatei. Beispiel: /home/user/customconstraint.yaml Nach Abschluss des Vorgangs sind Ihre benutzerdefinierten Einschränkungen als Organisationsrichtlinien in der Liste der Google Cloud-Organisationsrichtlinien verfügbar. Prüfen Sie mit dem Befehl gcloud org-policies list-custom-constraints, ob die benutzerdefinierte Einschränkung vorhanden ist:

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

Ersetzen Sie ORGANIZATION_ID durch die ID Ihrer Organisationsressource. Weitere Informationen finden Sie unter Organisationsrichtlinien aufrufen.

Benutzerdefinierte Organisationsrichtlinie erzwingen

Sie können eine boolesche Einschränkung erzwingen, indem Sie eine Organisationsrichtlinie erstellen, die darauf verweist, und diese Organisationsrichtlinie dann auf eine Google Cloud-Ressource anwenden.

Console

1. Wechseln Sie in der Google Cloud Console zur Seite Organisationsrichtlinien.

   Zu den Organisationsrichtlinien

2. Wählen Sie in der Projektauswahl das Projekt aus, für das Sie die Organisationsrichtlinie festlegen möchten.
3. Wählen Sie auf der Seite Organisationsrichtlinien die gewünschte Einschränkung aus, um die Seite Richtliniendetails aufzurufen.
4. Zum Konfigurieren der Organisationsrichtlinie für diese Ressource klicken Sie auf Richtlinie verwalten.
5. Wählen Sie auf der Seite Richtlinie bearbeiten die Option Richtlinie der übergeordneten Ressource überschreiben aus.
6. Klicken Sie auf Regel hinzufügen.
7. Wählen Sie im Abschnitt Erzwingung aus, ob die Erzwingung dieser Organisationsrichtlinie aktiviert oder deaktiviert werden soll.
8. Klicken Sie optional auf Bedingung hinzufügen, um die Organisationsrichtlinie von einem Tag abhängig zu machen. Wenn Sie einer Organisationsrichtlinie eine bedingte Regel hinzufügen, müssen Sie mindestens eine bedingungsfreie Regel hinzufügen oder die Richtlinie kann nicht gespeichert werden. Weitere Informationen finden Sie unter Organisationsrichtlinie mit Tags festlegen.
9. Wenn dies eine benutzerdefinierte Einschränkung ist, können Sie auf Änderungen testen klicken, um die Auswirkungen dieser Organisationsrichtlinie zu simulieren. Weitere Informationen finden Sie unter Änderungen an Organisationsrichtlinien mit dem Richtliniensimulator testen.
10. Klicken Sie auf Richtlinie festlegen, um den Vorgang abzuschließen und die Organisationsrichtlinie anzuwenden. Es kann bis zu 15 Minuten dauern, bis die Richtlinie wirksam wird.

gcloud

Um eine Organisationsrichtlinie zu erstellen, die eine boolesche Einschränkung erzwingt, erstellen Sie eine YAML-Richtliniendatei, die auf die Einschränkung verweist:

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

Ersetzen Sie Folgendes:

• PROJECT_ID: das Projekt, für das Sie die Einschränkung erzwingen möchten
• CONSTRAINT_NAME: der Name, den Sie für Ihre benutzerdefinierte Einschränkung definiert haben. Beispiel: custom.deleteProtectionRequired.

Führen Sie den folgenden Befehl aus, um die Organisationsrichtlinie mit der Einschränkung zu erzwingen:

    gcloud org-policies set-policy POLICY_PATH
    

Ersetzen Sie POLICY_PATH durch den vollständigen Pfad zur YAML-Datei Ihrer Organisationsrichtlinie. Es kann bis zu 15 Minuten dauern, bis die Richtlinie wirksam wird.

Benutzerdefinierte Organisationsrichtlinie testen

Bevor Sie beginnen, müssen Sie Folgendes wissen:

• Ihre Organisations-ID.

1. Erstellen Sie die Datei deleteProtectionRequired.yaml so:

    name: organizations/ORGANIZATION_ID/customConstraints/custom.deleteProtectionRequired
    resourceTypes:
    - firestore.googleapis.com/Database
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.deleteProtectionState == \"DELETE_PROTECTION_ENABLED\""
    actionType: ALLOW
    displayName: Firestore Delete Protection Required
    description: To ensure the data security, Delete Protection is required to be enabled for Firestore databases.
   

   Dadurch wird sichergestellt, dass alle Methoden vom Typ CREATE und UPDATE für eine Firestore-Datenbank die Einschränkung erfüllen, dass deleteProtectionState DELETE_PROTECTION_ENABLED ist. Daher werden alle Vorgänge zum Erstellen, Aktualisieren, Wiederherstellen und Klonen von Datenbanken abgelehnt, bei denen der Löschschutz nicht explizit aktiviert wurde.

2. Richten Sie die benutzerdefinierte Einschränkung auf Organisationsebene ein:

   gcloud org-policies set-custom-constraint deleteProtectionRequired.yaml
   

Richtlinie testen

Versuchen Sie, in einem Projekt in der Organisation eine Datenbank zu erstellen, ohne das Flag --delete-protection festzulegen:

gcloud firestore database create \
   --project=PROJECT_ID \
   --database=DATABASE_ID \

Die Ausgabe sieht so aus:

Operation denied by custom org policies: ["customConstraints/custom.deleteProtectionRequired": "To ensure the data security, Delete Protection is required to be enabled for Firestore databases"]

Änderungen an Organisationsrichtlinien testen und analysieren

Wir empfehlen, alle Änderungen an den Richtlinien Ihrer Organisation zu testen und in einer Simulation durchzugehen, um den Zustand Ihrer Umgebung und die Auswirkungen von Änderungen besser nachvollziehen zu können.

Mit dem Policy Simulator für die Organisationsrichtlinie können Sie die Auswirkungen einer Einschränkung und einer Organisationsrichtlinie auf Ihre aktuelle Umgebung nachvollziehen. Mit diesem Tool können Sie alle Ressourcenkonfigurationen prüfen, um zu sehen, wo Verstöße auftreten, bevor sie in Ihrer Produktionsumgebung erzwungen werden. Eine ausführliche Anleitung finden Sie unter Änderungen an Organisationsrichtlinien mit dem Richtliniensimulator testen.

Wenn Sie die aktuellen Auswirkungen kennen, können Sie eine Organisationsrichtlinie im Testmodus erstellen, um die Auswirkungen und potenziellen Verstöße gegen eine Richtlinie in den nächsten 30 Tagen zu verstehen. Eine Organisationsrichtlinie im Modus „Probelauf“ ist eine Art von Organisationsrichtlinie, bei der Verstöße gegen die Richtlinie in einem Audit-Log protokolliert, aber die entsprechenden Aktionen nicht abgelehnt werden. Sie können eine Organisationsrichtlinie im Modus „Testlauf“ aus einer benutzerdefinierten Einschränkung mit der Google Cloud Console oder der Google Cloud CLI erstellen. Eine ausführliche Anleitung finden Sie unter Organisationsrichtlinie im Modus „Probelauf“ erstellen.

Beispiele für benutzerdefinierte Organisationsrichtlinien für häufige Anwendungsfälle

Die folgende Tabelle enthält die Syntax einiger benutzerdefinierter Einschränkungen für gängige Anwendungsfälle:

Beschreibung	Einschränkungssyntax
Datenbanknamen müssen einem bestimmten Muster folgen. Hinweis: Das Format eines Datenbanknamens in benutzerdefinierten Organisationsrichtlinien ist projects/project-id/databases/database-id, während bei Datenbankverwaltungsvorgängen nur database-id angegeben wird.	name: organizations/ORGANIZATION_ID/customConstraints/custom.nameSuffixMobile resourceTypes: - firestore.googleapis.com/Database methodTypes: - CREATE condition: "resource.name.endsWith('-mobile')" actionType: ALLOW displayName: Firestore database names end with "-mobile" description: Only allow the creation of database names ending with suffix "-mobile"
Datenbanken können nur an bestimmten Standorten erstellt werden.	name: organizations/ORGANIZATION_ID/customConstraints/custom.locationUsCentral1 resourceTypes: - firestore.googleapis.com/Database methodTypes: - CREATE condition: "resource.locationId == 'us-central1'" actionType: ALLOW displayName: Firestore database location id us-central1 description: Only allow the creation of databases in region us-central1
Datenbanken müssen den angegebenen Typ haben.	name: organizations/ORGANIZATION_ID/customConstraints/custom.typeFirestore resourceTypes: - firestore.googleapis.com/Database methodTypes: - CREATE - UPDATE condition: "resource.type=="FIRESTORE_NATIVE"" actionType: ALLOW displayName: Firestore database type Firestore_Native description: Only allow creation and updating of databases if the type is Firestore in native mode.
Datenbanken müssen den angegebenen Parallelitätsmodus verwenden.	name: organizations/ORGANIZATION_ID/customConstraints/custom.concurrencyNotPessimistic resourceTypes: - firestore.googleapis.com/Database methodTypes: - CREATE - UPDATE condition: "resource.concurrencyMode == 'PESSIMISTIC'" actionType: DENY displayName: Firestore database concurrencyMode not pessimistic description: Disallow the creation and updating of databases with pessimistic concurrency mode.
Für Datenbanken muss die point-in-time-recovery aktiviert sein.	name: organizations/ORGANIZATION_ID/customConstraints/custom.pitrEnforce resourceTypes: - firestore.googleapis.com/Database methodTypes: - CREATE - UPDATE condition: "resource.pointInTimeRecoveryEnablement == "POINT_IN_TIME_RECOVERY_ENABLED"" actionType: ALLOW displayName: Firestore database enables PiTR description: Only allow the creation and updating of a databases if PiTR is enabled.
Datenbanken müssen den angegebenen App Engine-Integrationsmodus verwenden.	name: organizations/ORGANIZATION_ID/customConstraints/custom.enableAppEngineIntegrationMode resourceTypes: - firestore.googleapis.com/Database methodTypes: - CREATE - UPDATE condition: "resource.appEngineIntegrationMode == 'ENABLED'" actionType: ALLOW displayName: Firestore Database App Engine integration mode enabled description: Only allow the creation and updating of databases with App Engine Integration Mode enabled.
Das Erstellen von Datenbanken ist nur zulässig, wenn der Löschschutz aktiviert ist.	name: organizations/ORGANIZATION_ID/customConstraints/custom.deleteProtectionRequired resourceTypes: - firestore.googleapis.com/Database methodTypes: - CREATE - UPDATE condition: "resource.deleteProtectionState == "DELETE_PROTECTION_ENABLED"" actionType: ALLOW displayName: Firestore Delete Protection Required description: To ensure the data security, Delete Protection is required to be enabled for Firestore databases.
Für Datenbanken muss die angegebene CMEK-Konfiguration (Customer-Managed Encryption Key, vom Kunden verwalteter Verschlüsselungsschlüssel) verwendet werden.	name: organizations/ORGANIZATION_ID/customConstraints/custom.cmekKeyNotDev resourceTypes: - firestore.googleapis.com/Database methodTypes: - CREATE - UPDATE condition: "resource.cmekConfig.kmsKeyName.matches('dev$')" actionType: DENY displayName: Firestore database CMEK key not dev description: Disallow the creation and updating of databases with CMEK KMS keys ending with "dev".

Von Firestore unterstützte Ressourcen

In der folgenden Tabelle sind die Firestore-Ressourcen aufgeführt, auf die Sie in benutzerdefinierten Einschränkungen verweisen können.

Ressource	Feld
firestore.googleapis.com/Database	resource.appEngineIntegrationMode
	resource.cmekConfig.kmsKeyName
	resource.concurrencyMode
	resource.deleteProtectionState
	resource.locationId
	resource.name
	resource.pointInTimeRecoveryEnablement
	resource.type

Nächste Schritte

• Weitere Informationen zum Organisationsrichtliniendienst
• Organisationsrichtlinien erstellen und verwalten
• Eine vollständige Liste der vordefinierten Einschränkungen für Organisationsrichtlinien finden Sie hier.