Benutzerdefinierte Einschränkungen für die Vektorsuche erstellen

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

  • aiplatform.googleapis.com/Index
  • aiplatform.googleapis.com/IndexEndpoint

Weitere Informationen zu Organisationsrichtlinien finden Sie unter Benutzerdefinierte Organisationsrichtlinien.

Informationen zu Organisationsrichtlinien und Einschrä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 Einschränkungen, die fürGoogle 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 integrierte verwaltete 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, Google Cloud erzwingt 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.

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.

    Go to project selector

  3. Make sure that billing is enabled for your Google Cloud project.

  4. Install the Google Cloud CLI.

  5. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

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

    gcloud init

  7. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  8. Make sure that billing is enabled for your Google Cloud project.

  9. Install the Google Cloud CLI.

  10. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

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

    gcloud init
  12. Sie müssen Ihre Organisations-ID kennen.

    13. Erforderliche Rollen

    Bitten Sie Ihren Administrator, Ihnen die IAM-Rolle Organisationsrichtlinienadministrator (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.

    Zum Erstellen einer benutzerdefinierten Einschrä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 Einschränkung verwenden möchten. Eine benutzerdefinierte Einschränkung muss mit custom. beginnen und darf nur Großbuchstaben, Kleinbuchstaben oder Ziffern enthalten. Beispiel: custom.disableUnencryptedIndexes. 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 einschränken möchten. Beispiel: aiplatform.googleapis.com/Index

    • 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: "has(resource.encryptionSpec) == false".

    • 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 Einschränkung erzwingen, indem Sie eine Organisationsrichtlinie erstellen, die darauf verweist, und diese Organisationsrichtlinie dann auf eine Google Cloud -Ressource anwenden.

    Console

    1. Rufen Sie in der Google Cloud Console die Seite Organisationsrichtlinien auf.

      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. Klicken Sie auf Änderungen testen, um die Auswirkungen der Organisationsrichtlinie zu simulieren. Die Richtliniensimulation ist für Legacy-Verwaltungseinschränkungen nicht verfügbar. 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

    Wenn Sie eine Organisationsrichtlinie mit booleschen Regeln erstellen möchten, 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.disableUnencryptedIndexes.

    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

    Im folgenden Beispiel werden eine benutzerdefinierte Einschränkung und eine Richtlinie erstellt, die das Erstellen von nicht verschlüsselten Indexen in einer bestimmten Organisation blockiert.

    Bevor Sie beginnen, sollten Sie Folgendes kennen:

    • Ihre Organisations-ID.
    • Eine Projekt-ID.

    Benutzerdefinierte Einschränkung erstellen

    1. Speichern Sie die folgende Datei als constraint-disable-unencrypted-indexes.yaml:

      name: organizations/ORGANIZATION_ID/customConstraints/custom.disableUnencryptedIndexes
resourceTypes:
- aiplatform.googleapis.com/Index
methodTypes:
- CREATE
condition: "has(resource.encryptionSpec) == false"
actionType: DENY
displayName: Block creation of unencrypted Indexes
description: This constraint blocks the creation of Index resources that aren't encrypted

      Ersetzen Sie ORGANIZATION_ID durch Ihre Organisations-ID.

      Damit wird eine Einschränkung definiert, die das Erstellen von Indexressourcen ohne Verschlüsselungsspezifikation verhindert.

    2. Wenden Sie die Einschränkung an:

      gcloud org-policies set-custom-constraint ~/constraint-disable-unencrypted-indexes.yaml

    3. Prüfen Sie, ob die Einschränkung vorhanden ist:

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

      Die Ausgabe sieht in etwa so aus:

      CUSTOM_CONSTRAINT                  ACTION_TYPE   METHOD_TYPES   RESOURCE_TYPES                    DISPLAY_NAME
custom.disableUnencryptedIndexes   DENY          CREATE         aiplatform.googleapis.com/Index   Block creation of unencrypted Indexes
...

    Richtlinie erstellen

    1. Speichern Sie die folgende Datei als policy-disable-unencrypted-indexes.yaml:

      name: organizations/ORGANIZATION_ID/policies/custom.disableUnencryptedIndexes
spec:
  rules:
  - enforce: true

      Ersetzen Sie ORGANIZATION_ID durch Ihre Organisations-ID.

    2. Wenden Sie die Richtlinie an:

      gcloud org-policies set-policy ~/policy-disable-unencrypted-indexes.yaml

    3. Prüfen Sie, ob die Richtlinie vorhanden ist:

      gcloud org-policies list --organization=ORGANIZATION_ID

      Die Ausgabe sieht etwa so aus:

      CONSTRAINT                            LIST_POLICY   BOOLEAN_POLICY   ETAG
custom.disableUnencryptedIndexes     -             SET              COCsm5QGENiXi2E=

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

    Richtlinie testen

    1. Indexressource ohne Verschlüsselung erstellen:

      gcloud ai indexes create \
--metadata-file=<var>LOCAL_PATH_TO_METADATA_FILE</var> \
--display-name=<var>INDEX_NAME</var> \
--region=<var>LOCATION</var> \
--project=<var>PROJECT_ID</var>

      Die Ausgabe sieht etwa so aus:

      ERROR: (gcloud.ai.indexes.create) FAILED_PRECONDITION: Operation denied by org policy on resource 'projects/PROJECT_ID/locations/LOCATION': ["custom.disableUnencryptedIndexes": "This constraint blocks the creation of Index resources that aren't encrypted"]
- '@type': type.googleapis.com/google.rpc.ErrorInfo
domain: googleapis.com
metadata:
    customConstraints: customConstraints/custom.disableUnencryptedIndexes
    service: aiplatform.googleapis.com
reason: CUSTOM_ORG_POLICY_VIOLATION

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

    In der folgenden Tabelle finden Sie die Syntax einiger benutzerdefinierter Einschränkungen für gängige Anwendungsfälle:

    Beschreibung Einschränkungssyntax
    Öffentliche Indexendpunkte sind nicht zulässig. 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.denyPublicIndexEndpoint
    resourceTypes:
    - aiplatform.googleapis.com/IndexEndpoint
    methodTypes:
    - CREATE
    - UPDATE
    condition: resource.publicEndpointEnabled == false
    actionType: DENY
    displayName: Deny public IndexEndpoint
    description: IndexEndpoint shouldn't be public

    Von Vertex AI unterstützte Ressourcen

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

    Ressource Feld
    aiplatform.googleapis.com/Index resource.description
    resource.displayName
    resource.encryptionSpec.kmsKeyName
    resource.indexUpdateMethod
    resource.metadata
    resource.metadataSchemaUri
    aiplatform.googleapis.com/IndexEndpoint resource.description
    resource.displayName
    resource.encryptionSpec.kmsKeyName
    resource.network
    resource.privateServiceConnectConfig.enablePrivateServiceConnect
    resource.privateServiceConnectConfig.projectAllowlist
    resource.publicEndpointEnabled

    Nächste Schritte