Benutzerdefinierte Organisationsrichtlinien verwenden

    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:

    • pubsub.googleapis.com/Schema
    • pubsub.googleapis.com/Snapshot
    • pubsub.googleapis.com/Subscription
    • pubsub.googleapis.com/Topic

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

      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. Beispiel: custom.messageRetentionSet. Die maximale Länge dieses Feldes beträgt 70 Zeichen.

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

    • 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.messageRetentionDuration)".

    • 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. Rufen Sie in der Google Cloud -Konsole 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. 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.messageRetentionSet.

    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, bei der für alle neuen Themen in einem bestimmten Projekt Garantien für die Übertragung von Nachrichten erzwungen werden müssen.

    Bevor Sie beginnen, müssen Sie Folgendes wissen:

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

    Einschränkung erstellen

    1. Speichern Sie die folgende Datei als constraint-require-message-retention.yaml:

      name: organizations/ORGANIZATION_ID/customConstraints/custom.messageRetentionSet
      resourceTypes:
      - Topic
      methodTypes:
      - CREATE
      - UPDATE
      condition: "has(resource.messageRetentionDuration)"
      actionType: ALLOW
      displayName: Require message retention
      description: All topics must set a message retention duration.
      

      Dadurch wird eine Einschränkung definiert, bei der für jedes Thema eine Nachrichtenaufbewahrungsdauer festgelegt werden muss.

      1. Wenden Sie die Einschränkung an:

        gcloud org-policies set-custom-constraint constraint-require-message-retention.yaml
        
      2. 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.messageRetentionSet              ALLOW         CREATE,UPDATE    pubsub.googleapis.com/Topic        Require message retention
        ...
        

      Richtlinie erstellen

      1. Speichern Sie die folgende Datei als policy-require-message-retention.yaml:

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

        Ersetzen Sie PROJECT_ID durch Ihre Projekt-ID.

      2. Wenden Sie die Richtlinie an:

        gcloud org-policies set-policy policy-`policy-require-message-retention.yaml`:
        
      3. Prüfen Sie, ob die Richtlinie vorhanden ist:

        gcloud org-policies list --project=PROJECT_ID
        

        Die Ausgabe sieht in etwa so aus:

        CONSTRAINT                         LIST_POLICY    BOOLEAN_POLICY    ETAG
        custom.messageRetentionSet         -              SET               COCsm5QGENiXi2E=
        

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

      Richtlinie testen

      Versuchen Sie, ein Thema zu erstellen, ohne dass die Nachrichtenaufbewahrung aktiviert ist:

      gcloud pubsub topics create org-policy-test \
        --project=PROJECT_ID \
      

      Die Ausgabe sieht so aus:

      Operation denied by custom org policies: ["customConstraints/custom.messageRetentionSet": "All topics must set a message retention duration."].
      
      ERROR: Failed to create topic [projects/PROJECT_ID/topics/org-policy-test]: Operation denied by org policy: ["customConstraints/custom.messageRetentionSet": "All topics must set a message retention duration."].
      ERROR: (gcloud.pubsub.topics.create) Failed to create the following: [org-policy-test].
      

      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
      Für Themen müssen während der Übertragung Garantien für Nachrichten erzwungen und mindestens eine zulässige Speicherregion angegeben werden.
        name: organizations/ORGANIZATION_ID/customConstraints/custom.enforceInTransitWithRegions
        resourceTypes:
        - pubsub.googleapis.com/Topic
        methodTypes:
        - CREATE
        - UPDATE
        condition: "resource.messageStoragePolicy.enforceInTransit == true && resource.messageStoragePolicy.allowedPersistenceRegions.size() >= 1"
        actionType: ALLOW
        displayName: Require in-transit enforcement and regions
        description: All topics must enable in-transit message storage policy enforcement and contain a non-empty list of allowed persistence regions.
        
      Für Themen die Durchsetzung von Garantien für die Nachrichtenübermittlung erzwingen und eine bestimmte Region ausschließen
        name: organizations/ORGANIZATION_ID/customConstraints/custom.enforceInTransitWithoutUsEast1
        resourceTypes:
        - pubsub.googleapis.com/Topic
        methodTypes:
        - CREATE
        - UPDATE
        condition: "resource.messageStoragePolicy.enforceInTransit && !resource.messageStoragePolicy.allowedPersistenceRegions.exists(r, r == 'us-east1')"
        actionType: ALLOW
        displayName: Require in-transit enforcement and restrict regions
        description: All topics must enable in-transit message storage policy enforcement, and exclude us-east1 from the allowed persistence regions.
        
      Mindestaufbewahrungsdauer für Nachrichten für Abos
        name: organizations/ORGANIZATION_ID/customConstraints/custom.minMessageRetentionDuration
        resourceTypes:
        - pubsub.googleapis.com/Subscription
        methodTypes:
        - CREATE
        - UPDATE
        condition: "resource.messageRetentionDuration < duration('30m')"
        actionType: DENY
        displayName: Minimum message retention duration
        description: All subscriptions must retain unacked messages for at least 30 minutes.
        
      Unzustellbare Nachrichten nur für Abonnenten aktivieren
        name: organizations/ORGANIZATION_ID/customConstraints/custom.requireDeadLetterPolicy
        resourceTypes:
        - pubsub.googleapis.com/Subscription
        methodTypes:
        - CREATE
        - UPDATE
        condition: "has(resource.deadLetterPolicy)"
        actionType: ALLOW
        displayName: Require dead letter policy
        description: All subscriptions must set a dead letter policy.
        
      Schemas müssen vom Typ „Avro“ sein
        name: organizations/ORGANIZATION_ID/customConstraints/custom.schemaIsAvro
        resourceTypes:
        - pubsub.googleapis.com/Schema
        methodTypes:
        - CREATE
        - UPDATE
        condition: "resource.type == 'AVRO'"
        actionType: ALLOW
        displayName: Schema is Avro
        description: All schemas must be of type Avro.
        
      Authentifizierte Push-Mitteilungen für Abos anfordern
        name: organizations/ORGANIZATION_ID/customConstraints/custom.authenticatedPush
        resourceTypes:
        - pubsub.googleapis.com/Subscription
        methodTypes:
        - CREATE
        - UPDATE
        condition: "has(resource.pushConfig.pushEndpoint) && has(resource.pushConfig.oidcToken.serviceAccountEmail) && has(resource.pushConfig.oidcToken.audience)"
        actionType: ALLOW
        displayName: Subscription uses authenticated push
        description: All subscriptions must enable push authentication.
        
      Themen für die Aktivierung von CMEK erforderlich machen
        name: organizations/ORGANIZATION_ID/customConstraints/custom.topicHasCmek
        resourceTypes:
        - pubsub.googleapis.com/Topic
        methodTypes:
        - CREATE
        - UPDATE
        condition: "has(resource.kmsKeyName)"
        actionType: ALLOW
        displayName: Topic has CMEK
        description: All topics must use a Cloud KMS CryptoKey.
        

      Von Pub/Sub unterstützte Ressourcen

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

      Ressource Feld
      pubsub.googleapis.com/Schema resource.definition
      resource.name
      resource.type
      pubsub.googleapis.com/Snapshot resource.expireTime
      resource.name
      resource.topic
      pubsub.googleapis.com/Subscription resource.ackDeadlineSeconds
      resource.bigqueryConfig.dropUnknownFields
      resource.bigqueryConfig.serviceAccountEmail
      resource.bigqueryConfig.table
      resource.bigqueryConfig.useTableSchema
      resource.bigqueryConfig.useTopicSchema
      resource.bigqueryConfig.writeMetadata
      resource.cloudStorageConfig.bucket
      resource.cloudStorageConfig.filenameDatetimeFormat
      resource.cloudStorageConfig.filenamePrefix
      resource.cloudStorageConfig.filenameSuffix
      resource.cloudStorageConfig.maxBytes
      resource.cloudStorageConfig.maxDuration
      resource.cloudStorageConfig.maxMessages
      resource.cloudStorageConfig.serviceAccountEmail
      resource.deadLetterPolicy.deadLetterTopic
      resource.deadLetterPolicy.maxDeliveryAttempts
      resource.enableExactlyOnceDelivery
      resource.enableMessageOrdering
      resource.expirationPolicy.ttl
      resource.filter
      resource.messageRetentionDuration
      resource.name
      resource.pushConfig.attributes
      resource.pushConfig.noWrapper.writeMetadata
      resource.pushConfig.oidcToken.audience
      resource.pushConfig.oidcToken.serviceAccountEmail
      resource.pushConfig.pushEndpoint
      resource.retainAckedMessages
      resource.retryPolicy.maximumBackoff
      resource.retryPolicy.minimumBackoff
      resource.topic
      pubsub.googleapis.com/Topic resource.ingestionDataSourceSettings.awsKinesis.awsRoleArn
      resource.ingestionDataSourceSettings.awsKinesis.consumerArn
      resource.ingestionDataSourceSettings.awsKinesis.gcpServiceAccount
      resource.ingestionDataSourceSettings.awsKinesis.streamArn
      resource.kmsKeyName
      resource.messageRetentionDuration
      resource.messageStoragePolicy.allowedPersistenceRegions
      resource.messageStoragePolicy.enforceInTransit
      resource.name
      resource.schemaSettings.encoding
      resource.schemaSettings.firstRevisionId
      resource.schemaSettings.lastRevisionId
      resource.schemaSettings.schema

      Nächste Schritte