Usa políticas de la organización personalizadas

En esta página, se muestra cómo usar las restricciones personalizadas del servicio de políticas de la organización para limitar operaciones específicas en los siguientes recursos de Google Cloud :

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

Para obtener más información sobre la política de la organización, consulta Políticas de la organización personalizadas.

Acerca de las restricciones y políticas de la organización

El servicio de políticas de la organización de Google Cloud te brinda un control centralizado y programático sobre los recursos de tu organización. Como administrador de políticas de la organización, puedes definir una política de la organización, que es un conjunto de limitaciones llamadas restricciones que se aplican a los recursos y a sus subordinados deGoogle Cloud en la jerarquía de recursos deGoogle Cloud . Puedes aplicar políticas de la organización a nivel de la organización, carpeta o proyecto.

La política de la organización brinda restricciones administradas integradas para varios servicios de Google Cloud . Sin embargo, si deseas un control más detallado y personalizable sobre los campos específicos que están restringidos en las políticas de tu organización, también puedes crear restricciones personalizadas y usarlas en una política de la organización.

Herencia de políticas

De forma predeterminada, las políticas de la organización se heredan según los subordinados de los recursos en los que se aplica la política. Por ejemplo, si aplicas una política en una carpeta, Google Cloud aplica la política en todos los proyectos en ella. Para obtener más información sobre este comportamiento y cómo cambiarlo, consulta Reglas de evaluación de la jerarquía.

Antes de comenzar

  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.

    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

  3. Verify that billing is enabled for your Google Cloud project.

  4. Install the Google Cloud CLI.

  5. Si usas un proveedor de identidad externo (IdP), primero debes Acceder a la gcloud CLI con tu identidad federada.

  6. Para inicializar gcloud CLI, ejecuta el siguiente comando:

    gcloud init
  7. In the Google Cloud console, on the project selector page, select or create a Google Cloud 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

  8. Verify that billing is enabled for your Google Cloud project.

  9. Install the Google Cloud CLI.

  10. Si usas un proveedor de identidad externo (IdP), primero debes Acceder a la gcloud CLI con tu identidad federada.

  11. Para inicializar gcloud CLI, ejecuta el siguiente comando:

    gcloud init
  12. Asegúrate de saber el ID de la organización.
  13. Roles obligatorios

    Si deseas obtener los permisos que necesitas para administrar las políticas de la organización personalizadas, pídele a tu administrador que te otorgue el rol de IAM Administrador de políticas de la organización (roles/orgpolicy.policyAdmin) en el recurso de organización. Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.

    También puedes obtener los permisos necesarios a través de roles personalizados o cualquier otro rol predefinido.

    Configura una restricción personalizada

    Una restricción personalizada se define en un archivo YAML con los recursos, los métodos, las condiciones y las acciones que son compatibles con el servicio en el que aplicas la política de la organización. Las condiciones para tus restricciones personalizadas se definen con Common Expression Language (CEL). Si deseas obtener más información para compilar condiciones en restricciones personalizadas con CEL, consulta la sección CEL de Crea y administra restricciones personalizadas.

    Console

    Para crear una restricción personalizada, haz lo siguiente:

    1. En la consola de Google Cloud , ve a la página Políticas de la organización.

      Ir a Políticas de la organización

    2. En el selector de proyectos, selecciona el proyecto para el que deseas configurar la política de la organización.
    3. Haz clic en Restricción personalizada.
    4. En el cuadro Nombre visible, ingresa un nombre legible para la restricción. Este nombre se usa en los mensajes de error y se puede usar para la identificación y la depuración. No uses PII ni datos sensibles en los nombres visibles, ya que podrían exponerse en mensajes de error. Este campo puede contener hasta 200 caracteres.
    5. En el cuadro ID de restricción, ingresa el nombre que deseas para la nueva restricción personalizada. Una restricción personalizada solo puede contener letras (incluidas mayúsculas y minúsculas) o números, por ejemplo, custom.disableGkeAutoUpgrade. Este campo puede contener hasta 70 caracteres, sin contar el prefijo (custom.), por ejemplo, organizations/123456789/customConstraints/custom. No incluyas PII ni datos sensibles en el ID de la restricción, ya que podrían exponerse en mensajes de error.
    6. En el cuadro Description, ingresa una descripción legible de la restricción. Esta descripción se usa como mensaje de error cuando se infringe la política. Incluye detalles sobre por qué se produjo el incumplimiento de política y cómo resolverlo. No incluyas PII ni datos sensibles en la descripción, ya que podrían exponerse en mensajes de error. Este campo puede contener hasta 2,000 caracteres.
    7. En el cuadro Tipo de recurso, selecciona el nombre del recurso de Google Cloud REST que contiene el objeto y el campo que deseas restringir, por ejemplo, container.googleapis.com/NodePool. La mayoría de los tipos de recursos admiten hasta 20 restricciones personalizadas. Si intentas crear más restricciones personalizadas, la operación fallará.
    8. En Método de aplicación, selecciona si deseas aplicar la restricción en un método de REST CREATE o en los métodos CREATE y UPDATE. Si aplicas la restricción con el método UPDATE en un recurso que la incumple, la política de la organización bloqueará los cambios en ese recurso, a menos que el cambio resuelva el incumplimiento.
    9. No todos los servicios de Google Cloud admiten ambos métodos. Para ver los métodos compatibles para cada servicio, busca el servicio en Servicios compatibles.

    10. Para definir una condición, haz clic en Editar condición.
      1. En el panel Agregar condición, crea una condición de CEL que haga referencia a un recurso de servicio compatible, por ejemplo, resource.management.autoUpgrade == false. Este campo puede contener hasta 1,000 caracteres. Para obtener detalles sobre el uso de CEL, consulta Common Expression Language. Para obtener más información sobre los recursos de servicio que puedes usar en tus restricciones personalizadas, consulta Servicios compatibles con restricciones personalizadas.
      2. Haz clic en Guardar.
    11. En Acción, selecciona si deseas permitir o rechazar el método evaluado si se cumple la condición.
    12. La acción de rechazo significa que la operación para crear o actualizar el recurso se bloquea si la condición se evalúa como verdadera.

      La acción de permitir significa que la operación para crear o actualizar el recurso solo se permite si la condición se evalúa como verdadera. Se bloquean todos los demás casos, excepto los que se indican explícitamente en la condición.

    13. Haz clic en Crear restricción.
    14. Cuando ingreses un valor en cada campo, aparecerá a la derecha la configuración de YAML equivalente para esta restricción personalizada.

    gcloud

    1. Para crear una restricción personalizada, crea un archivo YAML con el siguiente formato:
    2.       name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
            resourceTypes:
            - RESOURCE_NAME
            methodTypes:
            - CREATE
      - UPDATE
      condition: "CONDITION" actionType: ACTION displayName: DISPLAY_NAME description: DESCRIPTION

      Reemplaza lo siguiente:

      • ORGANIZATION_ID: Es el ID de tu organización, como 123456789.
      • CONSTRAINT_NAME: Es el nombre que deseas para tu nueva restricción personalizada. Una restricción personalizada solo puede contener letras (incluidas mayúsculas y minúsculas) o números, por ejemplo, alertDocHasProject. Este campo puede contener hasta 70 caracteres.
      • RESOURCE_NAME: Es el nombre completamente calificado del recurso de Google Cloud que contiene el objeto y el campo que deseas restringir. Por ejemplo: monitoring.googleapis.com/AlertPolicy.
      • CONDITION: Una condición de CEL que se escribe en una representación de un recurso de servicio compatible. Este campo puede contener hasta 1,000 caracteres. Por ejemplo: resource.documentation.content.contains('${resource.project}').
      • Para obtener más información sobre los recursos disponibles para escribir condiciones, consulta Recursos admitidos.

      • ACTION: Es la acción que se realiza si se cumple condition. Los valores posibles son ALLOW y DENY.
      • La acción de permitir significa que, si la condición se evalúa como verdadera, se permite la operación para crear o actualizar el recurso. Esto también significa que se bloquean todos los demás casos, excepto el que se indica explícitamente en la condición.

        La acción de rechazo significa que, si la condición se evalúa como verdadera, se bloquea la operación para crear o actualizar el recurso.

      • DISPLAY_NAME: Es un nombre descriptivo para la restricción. Este campo puede contener hasta 200 caracteres.
      • DESCRIPTION: Una descripción fácil de usar de la restricción que se mostrará como un mensaje de error cuando se infrinja la política. Este campo puede contener hasta 2,000 caracteres.
    3. Después de crear el archivo YAML de una nueva restricción personalizada, debes configurarla para que esté disponible para las políticas de la organización de tu organización. Para configurar una restricción personalizada, usa el comando gcloud org-policies set-custom-constraint:
    4.         gcloud org-policies set-custom-constraint CONSTRAINT_PATH
            

      Reemplaza CONSTRAINT_PATH por la ruta de acceso completa a tu archivo de restricción personalizado. Por ejemplo, /home/user/customconstraint.yaml

      Una vez que se complete esta operación, tus restricciones personalizadas estarán disponibles como políticas de la organización en la lista de Google Cloud políticas de la organización.

    5. Para verificar que la restricción personalizada exista, usa el comando gcloud org-policies list-custom-constraints:
    6.       gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID
            

      Reemplaza ORGANIZATION_ID por el ID del recurso de tu organización.

      Para obtener más información, consulta Cómo visualizar las políticas de la organización.

    Aplica de manera forzosa una política de la organización personalizada

    Puedes aplicar una restricción cuando creas una política de la organización que haga referencia a ella y, luego, aplicas esa política a un recurso de Google Cloud .

    Consola

    1. En la consola de Google Cloud , ve a la página Políticas de la organización.

      Ir a Políticas de la organización

    2. En el selector de proyectos, selecciona el proyecto para el que deseas configurar la política de la organización.
    3. En la lista de la página Políticas de la organización, selecciona una restricción para ver la página Detalles de la política de esa restricción.
    4. Si deseas configurar las políticas de la organización para este recurso, haz clic en Administrar política.
    5. En la página Editar política, selecciona Anular la política del superior.
    6. Haz clic en Agregar una regla.
    7. En la sección Aplicación, selecciona si se aplica o no esta política de la organización.
    8. Opcional: para que la política de la organización sea condicional en una etiqueta, haz clic en Agregar condición. Ten en cuenta que, si agregas una regla condicional a una política de la organización, debes agregar al menos una regla sin condición o la política no se puede guardar. Para obtener más información, consulta Configura una política de la organización con etiquetas.
    9. Para finalizar y aplicar la política de la organización, haz clic en Configurar política. La política tarda hasta 15 minutos en aplicarse.

    gcloud

    1. Para crear una política de la organización con reglas booleanas, crea un archivo YAML de política que haga referencia a la restricción:
    2.         name: projects/PROJECT_ID/policies/CONSTRAINT_NAME
              spec:
                rules:
                - enforce: true
              
            

      Reemplaza lo siguiente:

      • PROJECT_ID: Es el proyecto en el que deseas aplicar tu restricción.
      • CONSTRAINT_NAME: Es el nombre de la restricción que deseas aplicar. Por ejemplo: alertDocHasProject
    3. Para aplicar la política de la organización que contiene la restricción, ejecuta el siguiente comando:
    4.         gcloud org-policies set-policy POLICY_PATH
            

      Reemplaza POLICY_PATH por la ruta de acceso completa al archivo YAML de la política de la organización. La política tarda hasta 15 minutos en aplicarse.

    Prueba la política de la organización personalizada

    En el siguiente ejemplo, se crea una restricción y una política personalizadas que verifican si la documentación de una política de alertas menciona el nombre del proyecto.

    Antes de comenzar, reemplaza lo siguiente:

    • ORGANIZATION_ID: Es el identificador numérico único de la organización. Para obtener información sobre cómo obtener este identificador, consulta Obtén el ID de tu organización.
    • PROJECT_ID: Es el identificador del proyecto.

    Crea la restricción

    1. Guarda el siguiente archivo como 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
      

      Reemplaza ORGANIZATION_ID por el ID de tu organización.

      Esta restricción evita que se cree o actualice una política de alertas si falta el nombre del proyecto de recursos en la documentación de la política de alertas.

    2. Aplica la restricción:

      gcloud org-policies set-custom-constraint ~/constraint-alert-doc-has-project.yaml
      
    3. Verifica que la restricción exista:

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

      El resultado es similar a este:

      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 política

    1. Guarda el siguiente archivo como policy-alert-doc-has-project.yaml:

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

      Reemplaza PROJECT_ID con el ID del proyecto.

    2. Aplica la política:

      gcloud org-policies set-policy ~/policy-alert-doc-has-project.yaml
      
    3. Verifica que la política exista:

      gcloud org-policies list --project=PROJECT_ID
      

      El resultado es similar a este:

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

    Después de aplicar la política, espera unos dos minutos para que Google Cloud comience a aplicarla.

    Prueba la política

    Intenta crear una política de alertas con documentación que excluya el nombre del proyecto del recurso.

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

    Reemplaza PROJECT_ID con el ID del proyecto.

    Esta es la salida:

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

    Ejemplos de políticas de la organización personalizadas para casos de uso comunes

    En esta tabla, se brindan ejemplos de sintaxis para algunas restricciones personalizadas comunes.

    Descripción Sintaxis de la restricción
    Las políticas de alertas deben tener solo una condición
        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
        
    Las políticas de alertas deben usar al menos dos canales de notificación
        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
        
    Solo permitir canales de notificación por correo electrónico
        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
        
    Las posposiciones deben durar menos de una hora
        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
        

    Recursos compatibles con Cloud Monitoring

    En la siguiente tabla, se enumeran los recursos de Cloud Monitoring a los que puedes hacer referencia en las restricciones personalizadas.

    Recurso 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

    ¿Qué sigue?