En esta página, se muestra cómo usar las restricciones personalizadas del servicio de políticas de la organización para restringir operaciones específicas en los siguientes Google Cloud recursos:
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 políticas y restricciones de la organización
El Google Cloud Servicio de políticas de la organización 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 deGoogle Cloud y a sus descendientes 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 proporciona restricciones predefinidas 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 de la carpeta. 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
- 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.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
- Install the Google Cloud CLI.
-
If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.
-
To initialize the gcloud CLI, run the following command:
gcloud init
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
- Install the Google Cloud CLI.
-
If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.
-
To initialize the gcloud CLI, run the following command:
gcloud init
- Asegúrate de conocer el ID de la organización.
Roles obligatorios
Para 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 de 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 mediante roles personalizados o cualquier otro rol predefinido.
Crea una restricción personalizada
Una restricción personalizada se define en un archivo YAML mediante 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 mediante CEL, consulta la sección CEL de Crea y administra restricciones personalizadas.
Para crear una restricción personalizada, crea un archivo YAML con el siguiente formato:
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
: el ID de la organización, como123456789
.CONSTRAINT_NAME
: el nombre que deseas para tu nueva restricción personalizada. Una restricción personalizada debe comenzar concustom.
y solo puede incluir letras mayúsculas, minúsculas o números. Por ejemplo,alertDocHasProject
. La longitud máxima de este campo es de 70 caracteres.RESOURCE_NAME
: El nombre completamente calificado del recursoGoogle 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. La longitud máxima de este campo es 1000 caracteres. Consulta Recursos compatibles con el fin de obtener más información sobre los recursos disponibles para escribir condiciones. Por ejemplo,resource.documentation.content.contains('${resource.project}')
.ACTION
: la acción que se realiza si se cumplecondition
. Los valores posibles sonALLOW
yDENY
.DISPLAY_NAME
: un nombre descriptivo para la restricción. La longitud máxima de este campo es 200 caracteres.DESCRIPTION
: una descripción fácil de usar de la restricción que se mostrará como un mensaje de error cuando se infringe la política. La longitud máxima de este campo es 2000 caracteres.
Para obtener más información sobre cómo crear una restricción personalizada, consulta Define restricciones personalizadas.
Configura una restricción personalizada
Después de crear el archivo YAML para 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 comandogcloud org-policies set-custom-constraint
:
gcloud org-policies set-custom-constraint CONSTRAINT_PATH
CONSTRAINT_PATH
por la ruta de acceso completa al
archivo de restricción personalizado. Por ejemplo, /home/user/customconstraint.yaml
.
Una vez completadas, tus restricciones personalizadas estarán disponibles como políticas de la organización en tu lista de Google Cloud políticas de la organización.
Para verificar que la restricción personalizada exista, usa el comando gcloud org-policies list-custom-constraints
:
gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID
ORGANIZATION_ID
por el ID del recurso de tu organización.
Para obtener más información, consulta
Visualiza las políticas de la organización.
Aplica de manera forzosa una política de la organización personalizada
Puedes aplicar una restricción booleana si creas una política de la organización que haga referencia a ella y si aplicas esa política a un recurso Google Cloud .Console
- En la consola de Google Cloud, ve a la página Políticas de la organización.
- En el selector de proyectos, selecciona el proyecto para el que deseas configurar la política de la organización.
- En la lista de la página Políticas de la organización, selecciona tu restricción para ver la página Detalles de la política de esa restricción.
- Si deseas configurar las políticas de la organización para este recurso, haz clic en Administrar política.
- En la página Editar política, selecciona Anular la política del elemento superior.
- Haz clic en Agregar una regla.
- En la sección Aplicación, selecciona si la aplicación de esta política de la organización está activada o desactivada.
- Opcional: haz clic en Agregar condición para que la política de la organización sea condicional en una etiqueta. 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.
- Si se trata de una restricción personalizada, puedes hacer clic en Probar cambios para simular el efecto de esta política de la organización. Para obtener más información, consulta Prueba los cambios en las políticas de la organización con Policy Simulator.
- Para finalizar y aplicar la política de la organización, haz clic en Establecer política. La política tarda hasta 15 minutos en aplicarse.
gcloud
Para crear una política de la organización que aplique una restricción booleana, crea un archivo de política en formato YAML que haga referencia a la restricción:
name: projects/PROJECT_ID/policies/CONSTRAINT_NAME spec: rules: - enforce: true
Reemplaza lo siguiente:
-
PROJECT_ID
: 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
.
Para aplicar la política de la organización que contiene la restricción, ejecuta el siguiente comando:
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
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.
Aplica la restricción:
gcloud org-policies set-custom-constraint ~/constraint-alert-doc-has-project.yaml
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
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.
Aplica la política:
gcloud org-policies set-policy ~/policy-alert-doc-has-project.yaml
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 de recursos.
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.' \
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 la siguiente tabla, se proporciona la sintaxis de algunas restricciones personalizadas para casos de uso 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 |
Permitir solo 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 repeticiones deben ser de 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?
- Obtén más información sobre el Servicio de políticas de la organización.
- Obtén más información para crear y administrar políticas de la organización.
- Consulta la lista completa de Restricciones de políticas de la organización predefinidas.