Utilizzare i criteri dell'organizzazione personalizzati

Questa pagina mostra come utilizzare i vincoli personalizzati del servizio Organization Policy per limitare operazioni specifiche sulle seguenti risorse Google Cloud :

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

Per saperne di più sul criterio dell'organizzazione, consulta Criteri dell'organizzazione personalizzati.

Informazioni sui criteri e sui vincoli dell'organizzazione

Il servizio Google Cloud Policy dell'organizzazione offre un controllo centralizzato e programmatico sulle risorse della tua organizzazione. In qualità di amministratore dei criteri dell'organizzazione, puoi definire un criterio dell'organizzazione, ovvero un insieme di restrizioni chiamate vincoli che si applicano alle Google Cloud risorse e ai relativi discendenti nella Google Cloud gerarchia delle risorse. Puoi applicare i criteri dell'organizzazione a livello di organizzazione, cartella o progetto.

Organization Policy fornisce vincoli gestiti integrati per vari servizi Google Cloud . Tuttavia, se vuoi un controllo più granulare e personalizzabile sui campi specifici limitati nelle norme dell'organizzazione, puoi anche creare vincoli personalizzati e utilizzarli in una norma dell'organizzazione.

Ereditarietà delle norme

Per impostazione predefinita, i criteri dell'organizzazione vengono ereditati dai discendenti delle risorse su cui applichi il criterio. Ad esempio, se applichi un criterio a una cartella, Google Cloud il criterio viene applicato a tutti i progetti nella cartella. Per scoprire di più su questo comportamento e su come modificarlo, consulta le regole di valutazione della gerarchia.

Prima di iniziare

  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. Assicurati di conoscere il tuo ID organizzazione.
  13. Ruoli obbligatori

    Per ottenere le autorizzazioni necessarie per gestire le policy dell'organizzazione personalizzate, chiedi all'amministratore di concederti il ruolo IAM Organization Policy Administrator (roles/orgpolicy.policyAdmin) nella risorsa organizzazione. Per saperne di più sulla concessione dei ruoli, consulta Gestisci l'accesso a progetti, cartelle e organizzazioni.

    Potresti anche riuscire a ottenere le autorizzazioni richieste tramite i ruoli personalizzati o altri ruoli predefiniti.

    Creare un vincolo personalizzato

    Un vincolo personalizzato viene definito in un file YAML dalle risorse, dai metodi, dalle condizioni e dalle azioni supportati dal servizio su cui stai applicando il criterio dell'organizzazione. Le condizioni per i vincoli personalizzati sono definite utilizzando Common Expression Language (CEL). Per ulteriori informazioni su come creare condizioni nei vincoli personalizzati utilizzando CEL, consulta la sezione CEL di Creazione e gestione di vincoli personalizzati.

    Per creare un vincolo personalizzato, crea un file YAML utilizzando il seguente formato:

    name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
    resourceTypes:
    - RESOURCE_NAME
    methodTypes:
    - CREATE
    - UPDATE
    condition: "CONDITION"
    actionType: ACTION
    displayName: DISPLAY_NAME
    description: DESCRIPTION
    

    Sostituisci quanto segue:

    • ORGANIZATION_ID: l'ID organizzazione, ad esempio 123456789.

    • CONSTRAINT_NAME: il nome che vuoi assegnare al nuovo vincolo personalizzato. Un vincolo personalizzato deve iniziare con custom. e può includere solo lettere maiuscole, minuscole o numeri. Ad esempio, alertDocHasProject. La lunghezza massima di questo campo è 70 caratteri.

    • RESOURCE_NAME: il nome completo della risorsaGoogle Cloud contenente l'oggetto e il campo che vuoi limitare. Ad esempio: monitoring.googleapis.com/AlertPolicy.

    • CONDITION: una condizione CEL scritta in base a una rappresentazione di una risorsa di servizio supportata. Questo campo ha una lunghezza massima di 1000 caratteri. Per saperne di più sulle risorse disponibili per scrivere condizioni, consulta Risorse supportate. Ad esempio, resource.documentation.content.contains('${resource.project}').

    • ACTION: l'azione da intraprendere se la condizione condition è soddisfatta. I valori possibili sono ALLOW e DENY.

    • DISPLAY_NAME: un nome facile da ricordare per il vincolo. Questo campo ha una lunghezza massima di 200 caratteri.

    • DESCRIPTION: una descrizione comprensibile del vincolo da visualizzare come messaggio di errore in caso di violazione della policy. Questo campo ha una lunghezza massima di 2000 caratteri.

    Per saperne di più su come creare un vincolo personalizzato, consulta Definizione di vincoli personalizzati.

    Configurare un vincolo personalizzato

    Dopo aver creato il file YAML per un nuovo vincolo personalizzato, devi configurarlo per renderlo disponibile per i criteri dell'organizzazione nella tua organizzazione. Per configurare un vincolo personalizzato, utilizza il comando gcloud org-policies set-custom-constraint:
    gcloud org-policies set-custom-constraint CONSTRAINT_PATH
    Sostituisci CONSTRAINT_PATH con il percorso completo del tuo file di vincoli personalizzati. Ad esempio: /home/user/customconstraint.yaml. Una volta completati, i vincoli personalizzati sono disponibili come policy dell'organizzazione nell'elenco delle policy dell'organizzazione Google Cloud . Per verificare che il vincolo personalizzato esista, utilizza il comando gcloud org-policies list-custom-constraints:
    gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID
    Sostituisci ORGANIZATION_ID con l'ID della risorsa dell'organizzazione. Per saperne di più, consulta Visualizzare le policy dell'organizzazione.

    Applicare una policy dell'organizzazione personalizzata

    Puoi applicare un vincolo creando un criterio dell'organizzazione che lo fa riferimento e poi applicando questo criterio dell'organizzazione a una risorsa. Google Cloud

    Console

    1. Nella console Google Cloud , vai alla pagina Policy dell'organizzazione.

      Vai a Policy dell'organizzazione

    2. Nel selettore di progetti, seleziona il progetto per cui vuoi impostare il criterio dell'organizzazione.
    3. Dall'elenco nella pagina Criteri organizzazione, seleziona il vincolo per visualizzare la pagina Dettagli criterio relativa a quel vincolo.
    4. Per configurare la policy dell'organizzazione per questa risorsa, fai clic su Gestisci policy.
    5. Nella pagina Modifica policy, seleziona Esegui override della policy dell'unità organizzativa principale.
    6. Fai clic su Aggiungi una regola.
    7. Nella sezione Applicazione, seleziona se l'applicazione di questa policy dell'organizzazione è attiva o disattivata.
    8. (Facoltativo) Per rendere la policy dell'organizzazione condizionale in base a un tag, fai clic su Aggiungi condizione. Tieni presente che se aggiungi una regola condizionale a una policy dell'organizzazione, devi aggiungere almeno una regola incondizionata o la policy non può essere salvata. Per saperne di più, vedi Impostazione di un criterio dell'organizzazione con tag.
    9. Fai clic su Testa modifiche per simulare l'effetto della policy dell'organizzazione. La simulazione delle policy non è disponibile per i vincoli gestiti legacy. Per saperne di più, consulta Testare le modifiche alle policy dell'organizzazione con Policy Simulator.
    10. Per completare e applicare la policy dell'organizzazione, fai clic su Imposta policy. L'applicazione del criterio richiede fino a 15 minuti.

    gcloud

    Per creare una policy dell'organizzazione con regole booleane, crea un file YAML della policy che faccia riferimento al vincolo:

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

    Sostituisci quanto segue:

    • PROJECT_ID: il progetto su cui vuoi applicare il vincolo.
    • CONSTRAINT_NAME: il nome del vincolo che vuoi applicare. Ad esempio, alertDocHasProject.

    Per applicare il criterio dell'organizzazione contenente il vincolo, esegui questo comando:

        gcloud org-policies set-policy POLICY_PATH
        

    Sostituisci POLICY_PATH con il percorso completo del file YAML del criterio dell'organizzazione. L'applicazione del criterio richiede fino a 15 minuti.

    Testa il criterio dell'organizzazione personalizzato

    L'esempio seguente crea un vincolo e un criterio personalizzati che controllano se la documentazione di un criterio di avviso menziona il nome del progetto.

    Prima di iniziare, sostituisci quanto segue:

    • ORGANIZATION_ID: L'identificatore numerico univoco dell'organizzazione. Per informazioni su come ottenere questo identificatore, vedi Ottenere l'ID organizzazione.
    • PROJECT_ID: l'identificatore del progetto.

    Crea il vincolo

    1. Salva il seguente file come 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
      

      Sostituisci ORGANIZATION_ID con l'ID organizzazione.

      Questo vincolo impedisce la creazione o l'aggiornamento di una criterio di avviso se il nome del progetto risorsa non è presente nella documentazione della criterio di avvisoso.

    2. Applica il vincolo:

      gcloud org-policies set-custom-constraint ~/constraint-alert-doc-has-project.yaml
      
    3. Verifica che il vincolo esista:

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

      L'output è simile al seguente:

      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.
      

    Crea la policy

    1. Salva il seguente file come policy-alert-doc-has-project.yaml:

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

      Sostituisci PROJECT_ID con l'ID progetto.

    2. Applica le norme:

      gcloud org-policies set-policy ~/policy-alert-doc-has-project.yaml
      
    3. Verifica che il criterio esista:

      gcloud org-policies list --project=PROJECT_ID
      

      L'output è simile al seguente:

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

    Dopo aver applicato il criterio, attendi circa due minuti prima che Google Cloud inizi a applicarlo.

    Testare la policy

    Prova a creare un criterio di avviso con una documentazione che escluda il nome del progetto risorsa.

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

    Sostituisci PROJECT_ID con l'ID progetto.

    L'output è il seguente:

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

    Esempi di norme personalizzate dell'organizzazione per i casi d'uso comuni

    La tabella seguente fornisce la sintassi di alcuni vincoli personalizzati per casi d'uso comuni:

    Descrizione Sintassi del vincolo
    I criteri di avviso devono avere una sola condizione
        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
        
    I criteri di avviso devono utilizzare almeno due canali di notifica
        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
        
    Consenti solo i canali di notifica via email
        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
        
    I posticipi devono durare meno di un'ora
        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
        

    Risorse supportate da Cloud Monitoring

    La seguente tabella elenca le risorse Cloud Monitoring a cui puoi fare riferimento nei vincoli personalizzati.

    Risorsa Campo
    monitoring.googleapis.com/AlertPolicy resource.alertStrategy.autoClose
    resource.alertStrategy.notificationChannelStrategy.notificationChannelNames
    resource.alertStrategy.notificationChannelStrategy.renotifyInterval
    resource.alertStrategy.notificationRateLimit.period
    resource.combiner
    resource.conditions.conditionAbsent.aggregations.alignmentPeriod
    resource.conditions.conditionAbsent.aggregations.crossSeriesReducer
    resource.conditions.conditionAbsent.aggregations.groupByFields
    resource.conditions.conditionAbsent.aggregations.perSeriesAligner
    resource.conditions.conditionAbsent.duration
    resource.conditions.conditionAbsent.filter
    resource.conditions.conditionAbsent.trigger.count
    resource.conditions.conditionAbsent.trigger.percent
    resource.conditions.conditionMatchedLog.filter
    resource.conditions.conditionMatchedLog.labelExtractors
    resource.conditions.conditionMonitoringQueryLanguage.duration
    resource.conditions.conditionMonitoringQueryLanguage.evaluationMissingData
    resource.conditions.conditionMonitoringQueryLanguage.query
    resource.conditions.conditionMonitoringQueryLanguage.trigger.count
    resource.conditions.conditionMonitoringQueryLanguage.trigger.percent
    resource.conditions.conditionPrometheusQueryLanguage.alertRule
    resource.conditions.conditionPrometheusQueryLanguage.duration
    resource.conditions.conditionPrometheusQueryLanguage.evaluationInterval
    resource.conditions.conditionPrometheusQueryLanguage.labels
    resource.conditions.conditionPrometheusQueryLanguage.query
    resource.conditions.conditionPrometheusQueryLanguage.ruleGroup
    resource.conditions.conditionSql.booleanTest.column
    resource.conditions.conditionSql.daily.periodicity
    resource.conditions.conditionSql.hourly.minuteOffset
    resource.conditions.conditionSql.hourly.periodicity
    resource.conditions.conditionSql.minutes.periodicity
    resource.conditions.conditionSql.query
    resource.conditions.conditionSql.rowCountTest.comparison
    resource.conditions.conditionSql.rowCountTest.threshold
    resource.conditions.conditionThreshold.aggregations.alignmentPeriod
    resource.conditions.conditionThreshold.aggregations.crossSeriesReducer
    resource.conditions.conditionThreshold.aggregations.groupByFields
    resource.conditions.conditionThreshold.aggregations.perSeriesAligner
    resource.conditions.conditionThreshold.comparison
    resource.conditions.conditionThreshold.denominatorAggregations.alignmentPeriod
    resource.conditions.conditionThreshold.denominatorAggregations.crossSeriesReducer
    resource.conditions.conditionThreshold.denominatorAggregations.groupByFields
    resource.conditions.conditionThreshold.denominatorAggregations.perSeriesAligner
    resource.conditions.conditionThreshold.denominatorFilter
    resource.conditions.conditionThreshold.duration
    resource.conditions.conditionThreshold.evaluationMissingData
    resource.conditions.conditionThreshold.filter
    resource.conditions.conditionThreshold.forecastOptions.forecastHorizon
    resource.conditions.conditionThreshold.thresholdValue
    resource.conditions.conditionThreshold.trigger.count
    resource.conditions.conditionThreshold.trigger.percent
    resource.conditions.displayName
    resource.conditions.name
    resource.displayName
    resource.documentation.content
    resource.documentation.links.displayName
    resource.documentation.links.url
    resource.documentation.mimeType
    resource.documentation.subject
    resource.enabled
    resource.name
    resource.notificationChannels
    resource.severity
    monitoring.googleapis.com/NotificationChannel resource.description
    resource.displayName
    resource.enabled
    resource.type
    monitoring.googleapis.com/Snooze resource.criteria.policies
    resource.displayName
    resource.interval.endTime
    resource.interval.startTime

    Passaggi successivi