Benutzerdefinierte Einschränkungen für Organisationsrichtlinien erstellen

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

  • composer.googleapis.com/Environment

Weitere Informationen zu Organisationsrichtlinien finden Sie unter Benutzerdefinierte Organisationsrichtlinien.

Informationen zu Organisationsrichtlinien und Beschränkungen

Mit dem Organisationsrichtliniendienst von Cloud de Confiance 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ür Ressourcen vonCloud de Confiance und nachfolgende Elemente dieser Ressourcen in der Ressourcenhierarchie vonCloud de Confiance by S3NS gelten. Sie können Organisationsrichtlinien auf Organisations-, Ordner- oder Projektebene erzwingen.

Die Organisationsrichtlinie bietet integrierte verwaltete Beschränkungen für verschiedene Dienste von Cloud de Confiance . 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 Cloud de Confiance 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 Managed Service for Apache Airflow-Ressourcen zulassen oder ablehnen. Wenn beispielsweise eine Anfrage zum Erstellen oder Aktualisieren einer Managed Airflow-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 können Sie mit benutzerdefinierten Organisationsrichtlinien:

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

  2. Bietet eine 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 dieCloud de Confiance -Konsole, die Google Cloud CLI oder RPC von einem Compliance-Status in einen Nicht-Compliance-Status.

Bevor Sie benutzerdefinierte Organisationsrichtlinien für den UPDATE-Methodentyp der Ressource erzwingen, müssen Sie dafür sorgen, dass vorhandene Umgebungen mit den einzelnen Richtlinien konform sind.

Da mit 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 den Deadlock 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 Richtliniensimulator können Sie prüfen, welche der vorhandenen Umgebungen nach der Durchsetzung der Richtlinie nicht mehr konform sind.

  • Deaktivieren Sie die Erzwingung der Richtlinie, aktualisieren Sie vorhandene Umgebungen auf den konformen Zustand und erzwingen Sie die Richtlinie wieder.

Hinweis

  1. In the Cloud de Confiance console, on the project selector page, select or create a Cloud de Confiance project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  2. Verify that billing is enabled for your Cloud de Confiance project.

  3. Install the Google Cloud CLI.

  4. Configure the gcloud CLI to use your federated identity.

    For more information, see Sign in to the gcloud CLI with your federated identity.

  5. To initialize the gcloud CLI, run the following command: 

    gcloud init
  6. 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 benutzerdefinierten 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.

Von Managed Service for Apache Airflow unterstützte Ressourcen

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

Ressource Feld

Benutzerdefinierte Beschränkung einrichten

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.

Console

So erstellen Sie eine benutzerdefinierte Einschränkung:

  1. Wechseln Sie in der Cloud de Confiance 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. Klicken Sie auf Benutzerdefinierte Einschränkung.
  4. Geben Sie im Feld Anzeigename einen menschenlesbaren Namen für die Einschränkung ein. Dieser Name wird in Fehlermeldungen verwendet und kann zur Identifizierung und Fehlerbehebung verwendet werden. Verwenden Sie keine personenidentifizierbaren Informationen oder sensiblen Daten in Anzeigenamen, da diese in Fehlermeldungen angezeigt werden können. Dieses Feld kann bis zu 200 Zeichen enthalten.
  5. Geben Sie im Feld Einschränkungs-ID die gewünschte ID für die neue benutzerdefinierte Einschränkung ein. Eine benutzerdefinierte Einschränkung darf nur Buchstaben (einschließlich Groß- und Kleinbuchstaben) oder Ziffern enthalten, z. B. custom.restrictEnvironmentSize. Dieses Feld kann bis zu 70 Zeichen enthalten, das Präfix (custom.) wird nicht gezählt, z. B. organizations/123456789/customConstraints/custom. Die Einschränkungs-ID darf keine personenidentifizierbaren Informationen oder vertraulichen Daten enthalten, da diese in Fehlermeldungen angezeigt werden können.
  6. Geben Sie im Feld Beschreibung eine für Menschen lesbare Beschreibung der Einschränkung ein. Diese Beschreibung wird als Fehlermeldung verwendet, wenn gegen die Richtlinie verstoßen wird. Geben Sie Details dazu an, warum der Richtlinienverstoß aufgetreten ist und wie er behoben werden kann. Nehmen Sie keine personenidentifizierbaren Informationen oder vertraulichen Daten in die Beschreibung auf, da diese in Fehlermeldungen preisgegeben werden könnten. Dieses Feld kann bis zu 2.000 Zeichen enthalten.
  7. Wählen Sie im Feld Ressourcentyp den Namen der REST-Ressource von Cloud de Confiance aus, die das Objekt und das Feld enthält, das Sie einschränken möchten, zum Beispiel container.googleapis.com/NodePool. Die meisten Ressourcentypen unterstützen bis zu 20 benutzerdefinierte Einschränkungen. Wenn Sie versuchen, weitere benutzerdefinierte Einschränkungen zu erstellen, schlägt der Vorgang fehl.
  8. Wählen Sie unter Methode erzwingen aus, ob die Einschränkung für eine REST-Methode CREATE oder sowohl für die Methoden CREATE als auch UPDATE erzwungen werden soll. Wenn Sie die Einschränkung mit der Methode UPDATE für eine Ressource erzwingen, die gegen die Einschränkung verstößt, werden Änderungen an dieser Ressource durch die Organisationsrichtlinie blockiert, es sei denn, die Änderung behebt den Verstoß.

    9. Die unterstützten Methoden für die einzelnen Dienste finden Sie unter Dienste, die benutzerdefinierte Einschränkungen unterstützen.

  9. Klicken Sie zum Definieren einer Bedingung auf Bedingung bearbeiten.
    1. Erstellen Sie im Bereich Bedingung hinzufügen eine CEL-Bedingung, die auf eine unterstützte Dienstressource verweist, z. B. resource.management.autoUpgrade == false. Dieses Feld kann bis zu 1.000 Zeichen enthalten. Weitere Informationen zur CEL-Verwendung finden Sie unter Common Expression Language. Weitere Informationen zu den Dienstressourcen, die Sie in Ihren benutzerdefinierten Einschränkungen verwenden können, finden Sie unter Unterstützte Dienste für benutzerdefinierte Einschränkungen.
    2. Klicken Sie auf Speichern.
  10. Wählen Sie unter Aktion aus, ob die ausgewertete Methode zugelassen oder abgelehnt werden soll, wenn die Bedingung erfüllt ist.

    11. Die Aktion „Verweigern“ bedeutet, dass der Vorgang zum Erstellen oder Aktualisieren der Ressource blockiert wird, wenn die Bedingung als „wahr“ ausgewertet wird.

    Die Aktion „Zulassen“ bedeutet, dass der Vorgang zum Erstellen oder Aktualisieren der Ressource nur zulässig ist, wenn die Bedingung als wahr ausgewertet wird. Alle anderen Fälle, die nicht explizit in der Bedingung aufgeführt sind, werden blockiert.

  11. Klicken Sie auf Einschränkung erstellen.

    12. Wenn Sie in jedes Feld einen Wert eingegeben haben, wird rechts die entsprechende YAML-Konfiguration für diese benutzerdefinierte Einschränkung angezeigt.

gcloud

  1. Zum Erstellen einer benutzerdefinierten Beschränkung erstellen Sie eine YAML-Datei im folgenden Format: 
    2. 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 darf nur Buchstaben (einschließlich Groß- und Kleinbuchstaben) oder Ziffern enthalten, z. B. custom.restrictEnvironmentSize. Dieses Feld kann bis zu 70 Zeichen enthalten, das Präfix (custom.) wird nicht gezählt, z. B. organizations/123456789/customConstraints/custom. Beziehen Sie weder personenidentifizierbare Informationen noch sensible Daten in die ID der Einschränkung ein, da sie in Fehlermeldungen preisgegeben werden könnten.
    • RESOURCE_NAME: Der vollständig qualifizierte Name der Ressource von Cloud de Confiance, die das Objekt und das Feld enthält, das Sie beschränken möchten. Beispiel: composer.googleapis.com/Environment. Die meisten Ressourcentypen unterstützen bis zu 20 benutzerdefinierte Einschränkungen. Wenn Sie versuchen, mehr benutzerdefinierte Einschränkungen zu erstellen, schlägt der Vorgang fehl.
    • methodTypes: die REST-Methoden, für die die Einschränkung erzwungen wird. Kann CREATE oder sowohl CREATE als auch UPDATE sein. Wenn Sie die Einschränkung mit der Methode UPDATE für eine Ressource erzwingen, die gegen die Einschränkung verstößt, werden Änderungen an dieser Ressource durch die Organisationsrichtlinie blockiert, es sei denn, die Änderung behebt den Verstoß.

      • Die unterstützten Methoden für die einzelnen Dienste finden Sie unter Dienste, die benutzerdefinierte Einschränkungen unterstützen.

    • CONDITION: eine CEL-Bedingung, die für eine Darstellung einer unterstützten Dienstressource geschrieben wird. Dieses Feld kann bis zu 1.000 Zeichen enthalten. Beispiel: resource.config.environmentSize == "ENVIRONMENT_SIZE_SMALL".

      • Weitere Informationen zu den verfügbaren Ressourcen, auf die Bedingungen geschrieben werden können, finden Sie unter Unterstützte Ressourcen.

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

      • Die Aktion „Zulassen“ bedeutet, dass der Vorgang zum Erstellen oder Aktualisieren der Ressource zulässig ist, wenn die Bedingung als „wahr“ ausgewertet wird. Das bedeutet auch, dass jeder andere Fall als der, der in der Bedingung explizit aufgeführt ist, blockiert wird.

      Die Aktion „Verweigern“ bedeutet, dass der Vorgang zum Erstellen oder Aktualisieren der Ressource blockiert wird, wenn die Bedingung als „wahr“ ausgewertet wird.

    • DISPLAY_NAME: Ein menschenlesbarer Name für die Einschränkung. Dieser Name wird in Fehlermeldungen verwendet und kann zur Identifizierung und Fehlerbehebung genutzt werden. Verwenden Sie keine personenidentifizierbaren Informationen oder vertraulichen Daten in Anzeigenamen, da diese in Fehlermeldungen angezeigt werden können. Dieses Feld kann bis zu 200 Zeichen enthalten.
    • DESCRIPTION: Eine nutzerfreundliche Beschreibung der Einschränkung, die als Fehlermeldung angezeigt werden soll, wenn die Richtlinie verletzt wird. Dieses Feld kann bis zu 2.000 Zeichen enthalten.
  2. 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: 
    3. 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 Organisationsrichtlinien von Cloud de Confiance by S3NS verfügbar.

  3. Prüfen Sie mit dem Befehl gcloud org-policies list-custom-constraints, ob die benutzerdefinierte Einschränkung vorhanden ist: 
    4. 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 Ressource von Cloud de Confiance by S3NS anwenden.

Console

  1. Wechseln Sie in der Cloud de Confiance 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 diese Organisationsrichtlinie erzwungen werden soll oder nicht.
  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 Organisationsrichtlinien mit Tags einschränken.
  9. Klicken Sie auf Änderungen testen, um die Auswirkungen der Organisationsrichtlinie zu simulieren. Weitere Informationen finden Sie unter Änderungen an Organisationsrichtlinien mit dem Richtliniensimulator testen.
  10. Klicken Sie auf Probelaufrichtlinie festlegen, um die Organisationsrichtlinie im Probelaufmodus zu erzwingen. Weitere Informationen finden Sie unter Organisationsrichtlinien testen.
  11. Nachdem Sie überprüft haben, ob die Organisationsrichtlinie im Probelaufmodus wie erwartet funktioniert, legen Sie die aktive Richtlinie fest, indem Sie auf Richtlinie festlegen klicken.

gcloud

  1. Wenn Sie eine Organisationsrichtlinie mit booleschen Regeln erstellen möchten, erstellen Sie eine YAML-Richtliniendatei, die auf die Beschränkung verweist: 
    2. name: projects/PROJECT_ID/policies/CONSTRAINT_NAME
spec:
  rules:
  - enforce: true

dryRunSpec:
  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 Beschränkung definiert haben. Beispiel: custom.restrictEnvironmentSize.
  2. Führen Sie den folgenden Befehl mit dem Flag dryRunSpec aus, um die Organisationsrichtlinie im Probelaufmodus zu erzwingen: 
    3. gcloud org-policies set-policy POLICY_PATH --update-mask=dryRunSpec

    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.

  3. Nachdem Sie überprüft haben, ob die Organisationsrichtlinie im Probelaufmodus wie vorgesehen funktioniert, legen Sie die Live-Richtlinie mit dem Befehl org-policies set-policy und dem Flag spec fest: 
    4. gcloud org-policies set-policy POLICY_PATH --update-mask=spec

    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 Managed Airflow-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 Cloud de Confiancedie Richtlinie durchgesetzt hat.

Richtlinie testen

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

Die Erstellung dieser Umgebung schlägt aufgrund der geltenden Einschränkung fehl, die nur kleine Composer-Umgebungen zulässt.

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 kleine Umgebung, um den vorherigen Fehler zu beheben. Beispiel:

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

Die Erstellung der Umgebung 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 Einschränkungssyntax
Nur Managed Airflow-Umgebungen mit privaten IP-Adressen 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 von Workern darf höchstens 10 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

Nächste Schritte