Benutzerdefinierte Einschränkungen für Backup for GKE erstellen

Auf dieser Seite erfahren Sie, wie Sie benutzerdefinierte Beschränkungen des Organisationsrichtliniendienstes verwenden, um bestimmte Vorgänge für die folgenden Google Cloud -Ressourcen einzuschränken:

• gkebackup.googleapis.com/BackupPlan
• gkebackup.googleapis.com/Backup
• gkebackup.googleapis.com/RestorePlan
• gkebackup.googleapis.com/Restore

Weitere Informationen zu Organisationsrichtlinien finden Sie unter Benutzerdefinierte Organisationsrichtlinien.

Informationen zu Organisationsrichtlinien und Beschränkungen

Mit dem Google Cloud -Organisationsrichtliniendienst können Sie die Ressourcen Ihrer Organisation zentral und programmatisch steuern. Als Administrator für Organisationsrichtlinien können Sie eine Organisationsrichtlinie definieren, also eine Reihe von Beschränkungen, die fürGoogle Cloud -Ressourcen und nachfolgende Elemente dieser Ressourcen in der Google Cloud -Ressourcenhierarchie gelten. Sie können Organisationsrichtlinien auf Organisations-, Ordner- oder Projektebene erzwingen.

Die Organisationsrichtlinie bietet integrierte verwaltete Beschränkungen für verschiedene Google Cloud -Dienste. Wenn Sie jedoch eine detailliertere, anpassbare Steuerung der spezifischen Felder wünschen, die in Ihren Organisationsrichtlinien beschränkt werden, können Sie auch benutzerdefinierte Beschränkungen erstellen und diese benutzerdefinierten Beschrä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 Bewertung der Hierarchie.

Hinweise

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.

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

Verify that billing is enabled for your Google Cloud project.

Install the Google Cloud CLI.

Wenn Sie einen externen Identitätsanbieter (IdP) verwenden, müssen Sie sich zuerst mit Ihrer föderierten Identität in der gcloud CLI anmelden.

Führen Sie folgenden Befehl aus, um die gcloud CLI zu initialisieren:

gcloud init

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

Verify that billing is enabled for your Google Cloud project.

Install the Google Cloud CLI.

Wenn Sie einen externen Identitätsanbieter (IdP) verwenden, müssen Sie sich zuerst mit Ihrer föderierten Identität in der gcloud CLI anmelden.

Führen Sie folgenden Befehl aus, um die gcloud CLI zu initialisieren:

gcloud init

1. 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 von 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 Beschränkung erstellen

Eine benutzerdefinierte Beschrä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 Beschränkungen werden mithilfe der Common Expression Language (CEL) definiert. Weitere Informationen zum Erstellen von Bedingungen in benutzerdefinierten Beschränkungen mit CEL finden Sie im Abschnitt CEL unter Benutzerdefinierte Beschränkungen erstellen und verwalten.

Zum Erstellen einer benutzerdefinierten Beschränkung erstellen Sie eine YAML-Datei im folgenden Format:

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 Beschränkung verwenden möchten. Eine benutzerdefinierte Beschränkung muss mit custom. beginnen und darf nur Großbuchstaben, Kleinbuchstaben oder Ziffern enthalten. Beispiel: custom.retentionPolicyEnforced. Die maximale Länge dieses Feldes beträgt 70 Zeichen.

• RESOURCE_NAME: Der vollständig qualifizierte Name derGoogle Cloud -Ressource, die das Objekt und das Feld enthält, das Sie beschränken möchten. Beispiel: gkebackup.googleapis.com/Backup

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

• 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 Beschränkung. Dieses Feld hat eine maximale Länge von 200 Zeichen.

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

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

Benutzerdefinierte Beschränkung einrichten

Nachdem Sie die YAML-Datei für eine neue benutzerdefinierte Beschrä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 Beschrä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 Beschränkungsdatei. Beispiel: /home/user/customconstraint.yaml Nach Abschluss des Vorgangs sind Ihre benutzerdefinierten Beschrä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 Beschrä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 Beschrä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 Beschrä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 unbedingte Regel hinzufügen, da die Richtlinie sonst nicht gespeichert werden kann. Weitere Informationen finden Sie unter Organisationsrichtlinie mit Tags festlegen.
9. Klicken Sie auf Änderungen testen, um die Auswirkungen der Organisationsrichtlinie zu simulieren. Die Richtliniensimulation ist für veraltete verwaltete Beschränkungen nicht verfügbar. Weitere Informationen finden Sie unter Änderungen an Organisationsrichtlinien mit dem Policy Simulator 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

Wenn Sie eine Organisationsrichtlinie mit booleschen Regeln erstellen möchten, erstellen Sie eine YAML-Richtliniendatei, die auf die Beschrä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 Beschränkung erzwingen möchten.
• CONSTRAINT_NAME: der Name, den Sie für Ihre benutzerdefinierte Beschränkung definiert haben. Beispiel: custom.retentionPolicyEnforced.

Führen Sie den folgenden Befehl aus, um die Organisationsrichtlinie mit der Beschrä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

In den folgenden Schritten wird gezeigt, wie Sie eine benutzerdefinierte Einschränkung und Richtlinie erstellen, mit der Nutzer eine Sicherung für GKE-Sicherung erstellen können, wenn das Feld retainDays auf einen Wert über 30 festgelegt ist.

Bevor Sie beginnen, sollten Sie Folgendes vorbereiten:

• Ihre Organisations-ID.
• Ihre Projekt-ID

Einschränkung erstellen

1. Speichern Sie die folgende Datei als CONSTRAINT_FILE_NAME.yaml:

   name: organizations/ORGANIZATION_ID/customConstraints/custom.retentionPolicyEnforced
   resourceTypes:
   - gkebackup.googleapis.com/Backup
   methodTypes:
   - CREATE
   condition: "resource.retainDays > 30"
   actionType: ALLOW
   displayName: Enforce retention policy
   description: Enforce backup creation with a retention policy greater than 30 days.
   

   Ersetzen Sie ORGANIZATION_ID durch Ihre Organisations-ID.

   In dieser Datei wird eine Einschränkung definiert, bei der das Feld retainDays in der Methode CREATE größer als 30 sein muss.

2. Wenden Sie die Einschränkung mit dem Befehl gcloud org-policies set-custom-constraint an:

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

3. Prüfen Sie mit dem Befehl gcloud org-policies list-custom-constraints, ob die Einschränkung vorhanden ist:

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

   Die Ausgabe sieht etwa so aus:

   CUSTOM_CONSTRAINT                ACTION_TYPE  METHOD_TYPES   RESOURCE_TYPES                    DISPLAY_NAME
   custom.retentionPolicyEnforced   DENY         CREATE,UPDATE  gkebackup.googleapis.com/Backup   Enforce retention policy
   ...
   

Richtlinie erstellen

1. Speichern Sie die folgende Datei als POLICY_FILE_NAME.yaml:

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

   Ersetzen Sie PROJECT_ID durch Ihre Projekt-ID.

2. Wenden Sie die Richtlinie mit dem Befehl gcloud org-policies set-policy an:

   gcloud org-policies set-policy POLICY_FILE_NAME.yaml
   

3. Prüfen Sie mit dem Befehl gcloud org-policies list, ob die Richtlinie vorhanden ist:

   gcloud org-policies list --project=PROJECT_ID
   

   Die Ausgabe sieht etwa so aus:

   CONSTRAINT                         LIST_POLICY  BOOLEAN_POLICY  ETAG
   custom.retentionPolicyEnforced     -            SET             CPiLkMMGEKDFq6IB-
   

Warten Sie nach dem Anwenden der Richtlinie etwa zwei Minuten, bis Google Cloud die Richtlinie durchgesetzt hat.

Richtlinie testen

1. Erstellen Sie ein Backup, ohne das Feld retainDays auf einen Wert größer als 30 festzulegen:

   gcloud beta container backup-restore backups create test-backup --backup-plan=test-backup-plan --location=us-central1
   

   Die Ausgabe sieht etwa so aus:

   ERROR: (gcloud.beta.container.backup-restore.backups.create) FAILED_PRECONDITION: Operation denied by org policy on resource 'pprojects/test-project/locations/us-central1/backupPlans/autopilot-cluster-1-backup-1/backups/test-backup-1': ["customConstraints/custom.retentionPolicyEnforced": "Enforce backup creation with a retention policy greater than 30 days."].
   - '@type': type.googleapis.com/google.rpc.DebugInfo
     detail: "generic::failed_precondition: Operation denied by org policy on resource\
       \ 'projects/test-project/locations/us-central1/backupPlans/autopilot-cluster-1-backup-1/backups/test-backup-1':\
       \ [\"customConstraints/custom.retentionPolicyEnforced\": \"Enforce backup creation with a retention \
       \ policy greater than 30 days.\"]."
     .
     .
     .
   - '@type': type.googleapis.com/google.rpc.DebugInfo
   - '@type': type.googleapis.com/google.rpc.ErrorInfo
     domain: gkebackup.googleapis.com
     metadata:
       customConstraints: customConstraints/custom.backupRetainDays
       resource: projects/test-project/locations/us-central1/backupPlans/autopilot-cluster-1-backup-1/backups/test-backup-1
     reason: CUSTOM_ORG_POLICY_VIOLATION
   

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

In der folgenden Tabelle sind benutzerdefinierte Organisationsrichtlinien aufgeführt, die für Sie nützlich sein könnten:

Beschreibung	Beschränkungssyntax
Sicherungen nur erstellen, wenn sie eine Aufbewahrungsdauer von mehr als 20 Tagen haben	name: organizations/ORGANIZATION_ID/customConstraints/custom.retainDaysLimit resourceTypes: - gkebackup.googleapis.com/Backup methodTypes: - CREATE - UPDATE condition: resource.retainDays > 20 actionType: ALLOW displayName: Minimum Backup Retention period description: Minimum Backup Retention period of 20 days is required
Erstellung von Sicherungsplänen mit einem anderen als dem beabsichtigten „cronSchedule“ deaktivieren	name: organizations/ORGANIZATION_ID/customConstraints/custom.disableInvalidScheduleBackupPlan resourceTypes: - gkebackup.googleapis.com/BackupPlan methodTypes: - CREATE - UPDATE condition: resource.backupSchedule.cronSchedule != "5 20 * * *" actionType: DENY displayName: Backup plan cron schedule constraint description: Deny Backup plan creation or update if cron schedule is not set to 5 20 * * *.

Von Backup for GKE unterstützte Ressourcen

In der folgenden Tabelle sind die Backup for GKE-Ressourcen aufgeführt, auf die Sie in benutzerdefinierten Beschränkungen verweisen können.

Ressource	Feld
gkebackup.googleapis.com/Backup	resource.deleteLockDays
	resource.description
	resource.retainDays
gkebackup.googleapis.com/BackupPlan	resource.backupConfig.allNamespaces
	resource.backupConfig.encryptionKey.gcpKmsEncryptionKey
	resource.backupConfig.includeSecrets
	resource.backupConfig.includeVolumeData
	resource.backupConfig.permissiveMode
	resource.backupConfig.selectedApplications.namespacedNames.name
	resource.backupConfig.selectedApplications.namespacedNames.namespace
	resource.backupConfig.selectedNamespaces.namespaces
	resource.backupSchedule.cronSchedule
	resource.backupSchedule.paused
	resource.backupSchedule.rpoConfig.exclusionWindows.daily
	resource.backupSchedule.rpoConfig.exclusionWindows.daysOfWeek.daysOfWeek
	resource.backupSchedule.rpoConfig.exclusionWindows.duration
	resource.backupSchedule.rpoConfig.targetRpoMinutes
	resource.cluster
	resource.deactivated
	resource.description
	resource.retentionPolicy.backupDeleteLockDays
	resource.retentionPolicy.backupRetainDays
	resource.retentionPolicy.locked
gkebackup.googleapis.com/Restore	resource.backup
	resource.description
	resource.filter.exclusionFilters.groupKind.resourceGroup
	resource.filter.exclusionFilters.groupKind.resourceKind
	resource.filter.exclusionFilters.name
	resource.filter.exclusionFilters.namespace
	resource.filter.inclusionFilters.groupKind.resourceGroup
	resource.filter.inclusionFilters.groupKind.resourceKind
	resource.filter.inclusionFilters.name
	resource.filter.inclusionFilters.namespace
	resource.volumeDataRestorePolicyOverrides.policy
	resource.volumeDataRestorePolicyOverrides.selectedPvcs.namespacedNames.name
	resource.volumeDataRestorePolicyOverrides.selectedPvcs.namespacedNames.namespace
gkebackup.googleapis.com/RestorePlan	resource.backupPlan
	resource.cluster
	resource.description
	resource.restoreConfig.allNamespaces
	resource.restoreConfig.clusterResourceConflictPolicy
	resource.restoreConfig.clusterResourceRestoreScope.allGroupKinds
	resource.restoreConfig.clusterResourceRestoreScope.excludedGroupKinds.resourceGroup
	resource.restoreConfig.clusterResourceRestoreScope.excludedGroupKinds.resourceKind
	resource.restoreConfig.clusterResourceRestoreScope.noGroupKinds
	resource.restoreConfig.clusterResourceRestoreScope.selectedGroupKinds.resourceGroup
	resource.restoreConfig.clusterResourceRestoreScope.selectedGroupKinds.resourceKind
	resource.restoreConfig.excludedNamespaces.namespaces
	resource.restoreConfig.namespacedResourceRestoreMode
	resource.restoreConfig.noNamespaces
	resource.restoreConfig.restoreOrder.groupKindDependencies.requiring.resourceGroup
	resource.restoreConfig.restoreOrder.groupKindDependencies.requiring.resourceKind
	resource.restoreConfig.restoreOrder.groupKindDependencies.satisfying.resourceGroup
	resource.restoreConfig.restoreOrder.groupKindDependencies.satisfying.resourceKind
	resource.restoreConfig.selectedApplications.namespacedNames.name
	resource.restoreConfig.selectedApplications.namespacedNames.namespace
	resource.restoreConfig.selectedNamespaces.namespaces
	resource.restoreConfig.substitutionRules.newValue
	resource.restoreConfig.substitutionRules.originalValuePattern
	resource.restoreConfig.substitutionRules.targetGroupKinds.resourceGroup
	resource.restoreConfig.substitutionRules.targetGroupKinds.resourceKind
	resource.restoreConfig.substitutionRules.targetJsonPath
	resource.restoreConfig.substitutionRules.targetNamespaces
	resource.restoreConfig.transformationRules.description
	resource.restoreConfig.transformationRules.fieldActions.fromPath
	resource.restoreConfig.transformationRules.fieldActions.op
	resource.restoreConfig.transformationRules.fieldActions.path
	resource.restoreConfig.transformationRules.fieldActions.value
	resource.restoreConfig.transformationRules.resourceFilter.groupKinds.resourceGroup
	resource.restoreConfig.transformationRules.resourceFilter.groupKinds.resourceKind
	resource.restoreConfig.transformationRules.resourceFilter.jsonPath
	resource.restoreConfig.transformationRules.resourceFilter.namespaces
	resource.restoreConfig.volumeDataRestorePolicy
	resource.restoreConfig.volumeDataRestorePolicyBindings.policy
	resource.restoreConfig.volumeDataRestorePolicyBindings.volumeType

Nächste Schritte

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