Benutzerdefinierte Organisationsrichtlinien verwenden

Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.

Auf dieser Seite erfahren Sie, wie Sie mithilfe von benutzerdefinierten Einschränkungen des Organisationsrichtliniendienstes bestimmte Vorgänge für die folgenden Google Cloud Ressourcen einschränken:

• monitoring.googleapis.com/AlertPolicy
• monitoring.googleapis.com/NotificationChannel
• monitoring.googleapis.com/Snooze

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

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

• RESOURCE_NAME: Der vollständige Name derGoogle Cloud Ressource, die das Objekt und das Feld enthält, das Sie einschränken möchten. Beispiel: monitoring.googleapis.com/AlertPolicy

• 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: resource.documentation.content.contains('${resource.project}').

• 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

gcloud org-policies set-custom-constraint CONSTRAINT_PATH

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

Benutzerdefinierte Organisationsrichtlinie erzwingen

      name: projects/PROJECT_ID/policies/CONSTRAINT_NAME
      spec:
        rules:
        - enforce: true
    

    gcloud org-policies set-policy POLICY_PATH
    

Benutzerdefinierte Organisationsrichtlinie testen

Im folgenden Beispiel werden eine benutzerdefinierte Einschränkung und eine Richtlinie erstellt, mit denen geprüft wird, ob in der Dokumentation einer Benachrichtigungsrichtlinie der Projektname erwähnt wird.

Ersetzen Sie vor Beginn Folgendes:

• ORGANIZATION_ID: Die eindeutige numerische Kennung der Organisation. Informationen zum Abrufen dieser Kennung finden Sie unter Organisations-ID abrufen.
• PROJECT_ID: Die Kennung des Projekts.

Einschränkung erstellen

1. Speichern Sie die folgende Datei als constraint-alert-doc-has-project.yaml:

       actionType: DENY
       condition: resource.documentation.content.contains('${resource.project}')
       description: Requires documentation to include the project name.
       displayName: Alerting policy documentation must include project name.
       methodTypes:
         - CREATE
         - UPDATE
       name: organizations/ORGANIZATION_ID/customConstraints/custom.alertDocHasProject
       resourceTypes:
         - monitoring.googleapis.com/AlertPolicy
   

   Ersetzen Sie ORGANIZATION_ID durch Ihre Organisations-ID.

   Durch diese Einschränkung wird verhindert, dass eine Benachrichtigungsrichtlinie erstellt oder aktualisiert wird, wenn der Name des Ressourcenprojekts in der Dokumentation der Benachrichtigungsrichtlinie fehlt.

2. Wenden Sie die Einschränkung an:

   gcloud org-policies set-custom-constraint ~/constraint-alert-doc-has-project.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: custom.alertDocHasProject
   ACTION_TYPE: DENY
   METHOD_TYPES: CREATE,UPDATE
   RESOURCE_TYPES: monitoring.googleapis.com/AlertPolicy
   DISPLAY_NAME: Alerting policy documentation must include the project name.
   

Richtlinie erstellen

1. Speichern Sie die folgende Datei als policy-alert-doc-has-project.yaml:

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

   Ersetzen Sie PROJECT_ID durch Ihre Projekt-ID.

2. Wenden Sie die Richtlinie an:

   gcloud org-policies set-policy ~/policy-alert-doc-has-project.yaml
   

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

   gcloud org-policies list --project=PROJECT_ID
   

   Die Ausgabe sieht etwa so aus:

   CONSTRAINT: custom.alertDocHasProject
   LIST_POLICY: -
   BOOLEAN_POLICY: SET
   ETAG: CKSx5LwGEPjBuKwD-
   

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

Richtlinie testen

Versuchen Sie, eine Benachrichtigungsrichtlinie mit einer Dokumentation zu erstellen, die den Namen des Ressourcenprojekts ausschließt.

  gcloud alpha monitoring policies create \
    --display-name="CPU Utilization - 5% Threshold" \
    --project=PROJECT_ID \
    --condition-display-name="Condition 1" \
    --condition-filter='resource.type="gce_instance" AND metric.type="compute.googleapis.com/instance/cpu/utilization"' \
    --duration='60s' \
    --if='>5' \
    --combiner='AND' \
    --documentation='The ${metric.display_name} of the ${resource.type} ${resource.label.instance_id} has exceeded 5% for over 60 seconds.' \

Ersetzen Sie PROJECT_ID durch Ihre Projekt-ID.

Die Ausgabe sieht so aus:

  Operation denied by custom org policies: ["customConstraints/alertDocHasProject": "Alerting policy documentation must include project name."]

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:

    actionType: DENY
    condition: "resource.conditions.size() > 1"
    description: Requires alerting policies to have only one condition.
    displayName: Alerting policies must have only one condition
    methodTypes:
      - CREATE
      - UPDATE
    name: organizations/ORGANIZATION_ID/customConstraints/custom.oneCondition
    resourceTypes:
      - monitoring.googleapis.com/AlertPolicy
    

    actionType: DENY
    condition: "resource.notificationChannels.size() < 2"
    description: Alerting policies must use at least two notification channels.
    displayName: Policies must have a backup notification channel
    methodTypes:
      - CREATE
      - UPDATE
    name: organizations/ORGANIZATION_ID/customConstraints/custom.alertOnTwoChannels
    resourceTypes:
      - monitoring.googleapis.com/AlertPolicy
    

    actionType: DENY
    condition: "resource.type != 'email'"
    description: Requires notification channels to use only the email channel
    type.
    displayName: Always use email for notification channels
    methodTypes:
      - CREATE
      - UPDATE
    name: organizations/ORGANIZATION_ID/customConstraints/custom.emailChannelsOnly
    resourceTypes:
      - monitoring.googleapis.com/NotificationChannel
    

    actionType: DENY
    condition: "int(resource.interval.endTime) > int(resource.interval.startTime) + 3600"
    description: Requires snoozes to be under 1 hour.
    displayName: Snooze must be less than 1 hour
    methodTypes:
    - CREATE
    - UPDATE
    name: organizations/ORGANIZATION_ID/customConstraints/custom.setMaxSnooze
    resourceTypes:
    - monitoring.googleapis.com/Snooze
    

Von Cloud Monitoring unterstützte Ressourcen

Nächste Schritte

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