Benutzerdefinierte Einschränkungen für Organisationsrichtlinien erstellen

Cloud Composer 3 | Cloud Composer 2 | Cloud Composer 1

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:

• composer.googleapis.com/Environment

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.

Vorteile

Mit benutzerdefinierten Organisationsrichtlinien können Sie bestimmte Werte für Cloud Composer-Ressourcen zulassen oder ablehnen. Wenn beispielsweise eine Anfrage zum Erstellen oder Aktualisieren einer Cloud Composer-Umgebung die benutzerdefinierte Beschränkungsvalidierung, die durch Ihre Organisationsrichtlinie festgelegt wurde, nicht erfüllt, schlägt die Anfrage fehl und dem Aufrufer wird ein Fehler zurückgegeben. Außerdem gilt für die Verwendung benutzerdefinierter Organisationsrichtlinien Folgendes:

1. Verbessert die Sicherheit. Sie können beispielsweise Richtlinien definieren, die die Erstellung von Umgebungen mit öffentlichen IP-Adressen verbieten, die privat verwendete öffentliche IP-Adressen aktivieren oder die Verwendung eines bestimmten Netzwerks und Subnetzwerks festlegen.

2. Bietet detaillierte Kontrolle über Ressourcen, die beim Erstellen oder Aktualisieren einer Umgebung erstellt oder verwendet werden.

Beschränkungen

Wie alle Beschränkungen für Organisationsrichtlinien gelten Richtlinienänderungen nicht rückwirkend für vorhandene Instanzen.

• Eine neue Richtlinie hat keine Auswirkungen auf vorhandene Instanzkonfigurationen.
• Eine vorhandene Instanzkonfiguration bleibt gültig, es sei denn, Sie ändern sie über dieGoogle Cloud -Konsole, die Google Cloud CLI oder RPC von einem Compliance-Status in einen Nicht-Compliance-Status.

Bevor Sie benutzerdefinierte Organisationsrichtlinien für den Ressourcentyp der UPDATE-Methode erzwingen, müssen Sie dafür sorgen, dass vorhandene Umgebungen den einzelnen Richtlinien entsprechen.

Da bei einem Aktualisierungsvorgang nur ein Feld aktualisiert werden kann, kann es zu einem Deadlock kommen, wenn mehrere Felder einer vorhandenen Umgebung gleichzeitig gegen die Richtlinien verstoßen.

Führen Sie einen der folgenden Schritte aus, um die Blockierung zu vermeiden:

• (Empfohlen) Sorgen Sie dafür, dass alle vorhandenen Umgebungen einer Richtlinie entsprechen, bevor Sie die Richtlinie für die Ressourcen erzwingen. Mit dem Policy Simulator können Sie prüfen, welche der vorhandenen Umgebungen nach der Durchsetzung der Richtlinie nicht mehr den Richtlinien entsprechen.

• Deaktivieren Sie die Erzwingung der Richtlinie, aktualisieren Sie vorhandene Umgebungen auf den konformen Status und erzwingen Sie die Richtlinie noch einmal.

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.

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.

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.restrictEnvironmentSize. 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: composer.googleapis.com/Environment

• 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.config.environmentSize == "ENVIRONMENT_SIZE_SMALL".

• 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.restrictEnvironmentSize.

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

Im folgenden Beispiel werden eine benutzerdefinierte Einschränkung und eine Richtlinie erstellt, die nur kleine Cloud Composer-Umgebungen zulassen.

Bevor Sie beginnen, sollten Sie Folgendes kennen:

• Ihre Organisations-ID.
• Ihre Projekt-ID

Einschränkung erstellen

1. Speichern Sie die folgende Datei als 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. Wenden Sie die Einschränkung an:

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

Richtlinie erstellen

1. Speichern Sie die folgende Datei als policy-require-only-small-environments.yaml:

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

2. Wenden Sie die Richtlinie an:

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

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

Richtlinie testen

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

Das Erstellen dieser Umgebung schlägt aufgrund der Einschränkung fehl, dass nur kleine Composer-Umgebungen zulässig sind.

Die Ausgabe sieht etwa so aus:

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.]

Erstellen Sie eine Umgebung mit geringer Größe, um den vorherigen Fehler zu beheben. Beispiel:

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

Die Umgebungserstellung wurde gestartet.

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

In dieser Tabelle finden Sie Syntaxbeispiele für einige gängige benutzerdefinierte Beschränkungen.

Beschreibung	Beschränkungssyntax
Nur Cloud Composer-Umgebungen mit privater IP-Adresse zulassen	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
Die maximale Anzahl der Worker muss 10 oder weniger betragen.	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

Unterstützte Cloud Composer-Ressourcen

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

Ressource	Feld
composer.googleapis.com/Environment	resource.config.environmentSize
	resource.config.maintenanceWindow.recurrence
	resource.config.masterAuthorizedNetworksConfig.enabled
	resource.config.nodeConfig.enableIpMasqAgent
	resource.config.nodeConfig.network
	resource.config.nodeConfig.serviceAccount
	resource.config.nodeConfig.subnetwork
	resource.config.privateEnvironmentConfig.cloudComposerConnectionSubnetwork
	resource.config.privateEnvironmentConfig.enablePrivateBuildsOnly
	resource.config.privateEnvironmentConfig.enablePrivateEnvironment
	resource.config.privateEnvironmentConfig.enablePrivatelyUsedPublicIps
	resource.config.privateEnvironmentConfig.networkingConfig.connectionType
	resource.config.privateEnvironmentConfig.privateClusterConfig.enablePrivateEndpoint
	resource.config.recoveryConfig.scheduledSnapshotsConfig.enabled
	resource.config.recoveryConfig.scheduledSnapshotsConfig.snapshotCreationSchedule
	resource.config.recoveryConfig.scheduledSnapshotsConfig.snapshotLocation
	resource.config.recoveryConfig.scheduledSnapshotsConfig.timeZone
	resource.config.resilienceMode
	resource.config.softwareConfig.cloudDataLineageIntegration.enabled
	resource.config.softwareConfig.imageVersion
	resource.config.softwareConfig.webServerPluginsMode
	resource.config.workloadsConfig.dagProcessor.count
	resource.config.workloadsConfig.dagProcessor.cpu
	resource.config.workloadsConfig.dagProcessor.memoryGb
	resource.config.workloadsConfig.dagProcessor.storageGb
	resource.config.workloadsConfig.scheduler.count
	resource.config.workloadsConfig.scheduler.cpu
	resource.config.workloadsConfig.scheduler.memoryGb
	resource.config.workloadsConfig.scheduler.storageGb
	resource.config.workloadsConfig.triggerer.count
	resource.config.workloadsConfig.triggerer.cpu
	resource.config.workloadsConfig.triggerer.memoryGb
	resource.config.workloadsConfig.webServer.cpu
	resource.config.workloadsConfig.webServer.memoryGb
	resource.config.workloadsConfig.webServer.storageGb
	resource.config.workloadsConfig.worker.cpu
	resource.config.workloadsConfig.worker.maxCount
	resource.config.workloadsConfig.worker.memoryGb
	resource.config.workloadsConfig.worker.minCount
	resource.config.workloadsConfig.worker.storageGb
	resource.name

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.