Administra recursos de Dataflow con restricciones personalizadas

LaGoogle Cloud Política 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 y a sus subordinados deGoogle Cloud en la Google Cloud jerarquía de recursos. 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 deGoogle 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 políticas de la organización personalizadas.

Beneficios

Puedes usar una política de organización personalizada para permitir o denegar la creación de trabajos de Dataflow con condiciones basadas en atributos de recursos compatibles, como el nombre, el tipo y las opciones de servicio del trabajo.

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 jerarquía.

Precios

El Servicio de políticas de la organización, que incluye las políticas de la organización predefinidas y personalizadas, se ofrece sin cargo.

Limitaciones

Las restricciones personalizadas para los recursos Job de Dataflow solo se pueden configurar con la Google Cloud consola o Google Cloud CLI.
Las restricciones personalizadas solo se pueden aplicar en el método CREATE para los recursos Job de Dataflow.
Las restricciones personalizadas recién aplicadas no se aplican de forma automática a los recursos existentes.

Antes de comenzar

Para obtener más información sobre qué son las políticas y restricciones de la organización y cómo funcionan, consulta la Introducción al servicio de políticas de la organización.

Roles obligatorios

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

Este rol predefinido contiene los permisos necesarios para administrar las políticas de la organización. Para ver los permisos exactos que son necesarios, expande la sección Permisos requeridos:

Permisos necesarios

Se requieren los siguientes permisos para administrar las políticas de la organización:

orgpolicy.constraints.list
orgpolicy.policies.create
orgpolicy.policies.delete
orgpolicy.policies.list
orgpolicy.policies.update
orgpolicy.policy.get
orgpolicy.policy.set

También puedes obtener estos permisos con roles personalizados o con otros roles predefinidos.

Crea 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 mediante CEL, consulta la sección CEL de Crea y administra restricciones personalizadas.

Para crear un archivo YAML para una restricción personalizada, haz lo siguiente:

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

Reemplaza lo siguiente:

ORGANIZATION_ID: Es el ID de la organización, como 123456789.
CONSTRAINT_NAME: el nombre que deseas para tu nueva restricción personalizada. Una restricción personalizada debe comenzar con custom. y solo puede incluir letras mayúsculas, minúsculas o números, por ejemplo, custom.denyPrimeJobs. La longitud máxima de este campo es de 70 caracteres, sin contar el prefijo, por ejemplo, organizations/123456789/customConstraints/custom.
RESOURCE_NAME: el nombre (no el URI) del recurso REST de la API de Dataflow que contiene el objeto y el campo que deseas restringir. Por ejemplo, dataflow.googleapis.com/Job.
CONDITION: Es 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 de 1,000 caracteres. Consulta Recursos admitidos y obtén más información sobre los recursos disponibles para escribir condiciones. Por ejemplo, "resource.environment.serviceOptions.exists(value, value=='enable_prime')".
ACTION: Es la acción que se realiza si se cumple condition. Los valores admitidos son ALLOW y DENY.
DISPLAY_NAME: un nombre descriptivo para la restricción. La longitud máxima de este campo es 200 caracteres.
DESCRIPTION: Es una descripción fácil 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 de 2,000 caracteres.

Para obtener más información sobre cómo crear una restricción personalizada, consulta Define restricciones personalizadas.

Configura una restricción personalizada

Console

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

En la consola de Google Cloud , accede a la página Políticas de la organización.
Ir a Políticas de la organización
En el selector de proyectos, elige uno cuya política de la organización quieras configurar.
Haz clic en Restricción personalizada.
En el cuadro Nombre visible, ingresa un nombre legible por humanos para la restricción. Este nombre se usa en los mensajes de error y se puede usar para la identificación y depuración. No uses información de identificación personal (PII) ni datos sensibles en los nombres visibles, ya que podrían exponerse en mensajes de error. Este campo puede contener hasta 200 caracteres.
En el cuadro ID de restricción, ingresa el ID que quieras asignar a la nueva restricción personalizada. Las restricciones personalizadas solo pueden contener letras (mayúsculas y minúsculas) o números, por ejemplo, custom.denyPrimeJobs. Este campo puede contener hasta 70 caracteres, sin contar el prefijo (custom.), por ejemplo, organizations/123456789/customConstraints/custom. No incluyas IIP ni datos sensibles en el ID de la restricción, ya que podrían exponerse en mensajes de error.
En el cuadro Descripción, ingresa una descripción legible por humanos de la restricción. Esta se usa como mensaje de error cuando se infringe la política. Incluye detalles sobre el motivo por el cual se produjo el incumplimiento de la política y cómo resolverlo. No incluyas IIP ni datos sensibles en la descripción, ya que podrían exponerse en mensajes de error. Este campo puede contener hasta 2,000 caracteres.
En el cuadro Tipo de recurso, selecciona el nombre del recurso de REST Google Cloud que contiene el objeto y el campo que quieres 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, la operación fallará.
Esta restricción solo se puede aplicar en el método CREATE de REST.

Para ver los métodos compatibles con cada servicio, busca el servicio en Servicios que admiten restricciones personalizadas.

Para definir una condición, haz clic en Editar condición.

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 las restricciones personalizadas, consulta Servicios compatibles con restricciones personalizadas.
Haz clic en Guardar.

En Acción, selecciona si quieres permitir o rechazar el método evaluado en caso de cumplirse la condición.

La acción de rechazo implica 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 implica que la operación para crear o actualizar el recurso solo se permite si la condición se evalúa como verdadera. El resto de casos se bloquean, excepto los que se indican explícitamente en la condición.

Haz clic en Crear restricción.

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

gcloud

Para crear una restricción personalizada, crea un archivo YAML con el formato siguiente:

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

Reemplaza los valores que se indican a continuación:

ORGANIZATION_ID: Es el ID de la organización, como 123456789.
CONSTRAINT_NAME: Es el nombre que quieres usar para la nueva restricción personalizada. Una restricción personalizada solo puede contener letras (mayúsculas y minúsculas) o números, por ejemplo, custom.denyPrimeJobs. 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.
RESOURCE_NAME: Es el nombre completamente calificado del recurso de Google Cloudque contiene el objeto y el campo que quieres restringir. Por ejemplo, dataflow.googleapis.com/Job. La mayoría de los tipos de recursos admiten hasta 20 restricciones personalizadas. Si intentas crear más, la operación fallará.
methodTypes: Son los métodos de REST en los que se aplica la restricción. Solo puede ser CREATE.

Para ver los métodos compatibles con cada servicio, busca el servicio en Servicios que admiten restricciones personalizadas.

CONDITION: Es una condición de CEL que se escribe con base en una representación de un recurso de servicio compatible. Este campo puede contener hasta 1,000 caracteres. Por ejemplo, "resource.environment.serviceOptions.exists(value, value=='enable_prime')".

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 la condition. Solo puede ser ALLOW.

La acción de permitir implica que, si la condición se evalúa como verdadera, se permite la operación para crear o actualizar el recurso. Esto también quiere decir que se bloquea el resto de casos, excepto el que se indica de forma explícita en la condición.

DISPLAY_NAME: Es 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 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.
DESCRIPTION: Es una descripción simple 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.

Después de crear el archivo YAML de una nueva restricción personalizada, debes configurarla con el objetivo de que esté disponible para las políticas de la organización de tu empresa. Para configurar una restricción personalizada, usa el el comando gcloud org-policies set-custom-constraint:

gcloud org-policies set-custom-constraint CONSTRAINT_PATH

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

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

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

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

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
En el selector de proyectos, elige el proyecto cuya política de la organización quieres configurar.
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.
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 superior.
Haz clic en Agregar una regla.
En la sección Aplicación, selecciona si quieres que se aplique o no esta política de la organización.
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 una regla sin condición como mínimo; de lo contrario, la política no se puede guardar. Para obtener más información, consulta Cómo definir el alcance de las políticas de la organización con etiquetas.
Haz clic en Probar cambios para simular el efecto de la política de la organización. Para obtener más información, consulta Prueba los cambios en políticas de la organización con Policy Simulator.
Para aplicar la política de la organización en modo de ejecución de prueba, haz clic en Establecer política de ejecución de prueba. Para obtener más información, consulta Prueba las políticas de la organización.
Luego de verificar que la política de la organización en el modo de ejecución de prueba funciona según lo previsto, haz clic en Configurar política para configurar la política activa.

gcloud

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:

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

dryRunSpec:
  rules:
  - enforce: true

Reemplaza los valores que se indican a continuación:

PROJECT_ID: Es el proyecto en el que quieres aplicar tu restricción.
CONSTRAINT_NAME: Es el nombre que definiste para tu restricción personalizada. Por ejemplo: custom.denyPrimeJobs.

Para aplicar la política de la organización en el modo de ejecución de prueba, ejecuta el comando siguiente con la marca dryRunSpec:

gcloud org-policies set-policy POLICY_PATH --update-mask=dryRunSpec

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.

Luego de verificar que la política de la organización en modo de ejecución de prueba funciona según lo previsto, configura la política activa con el comando org-policies set-policy y la marca spec:

gcloud org-policies set-policy POLICY_PATH --update-mask=spec

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.

Ejemplo: Crea una restricción para denegar la creación de un trabajo con Prime habilitado

gcloud

Crea un archivo de restricción denyPrimeJobs.yaml con la siguiente información: Reemplaza ORGANIZATION_ID por el ID de tu organización.

name: organizations/ORGANIZATION_ID/customConstraints/custom.denyPrimeJobs
resource_types: dataflow.googleapis.com/Job
condition: "resource.environment.serviceOptions.exists(value, value=='enable_prime')"
action_type: DENY
method_types: CREATE
display_name: Restrict creation of job with prime enabled
description: Deny creation of jobs with prime enabled.

Establece la restricción personalizada.

gcloud org-policies set-custom-constraint denyPrimeJobs.yaml

Crea un archivo de política enforce-policy-denyPrimeJobs.yaml con la siguiente información. En este ejemplo, la restricción se aplica a nivel del proyecto. También puedes establecer esta restricción a nivel de la organización o de la carpeta. Reemplaza PROJECT_ID por el ID del proyecto.
```
      name: projects/PROJECT_ID/policies/custom.denyPrimeJobs
      spec:
        rules:
        – enforce: true
```

Ejecuta el siguiente comando para aplicar la política.

gcloud org-policies set-policy enforce-policy-denyPrimeJobs.yaml

Para probar la restricción, intenta crear un trabajo de Dataflow con la opción enable_prime. Sigue la guía de inicio rápido Crea una canalización de Dataflow con Java para crear un trabajo de WordCount.

mvn -Pdataflow-runner compile \
exec:java \
-Dexec.mainClass=org.apache.beam.examples.WordCount \
-Dexec.args="--project=PROJECT_ID \
--gcpTempLocation=gs://BUCKET_NAME/temp/ \
--output=gs://BUCKET_NAME/output \
--runner=DataflowRunner \
--region=us-central1 \
--dataflowServiceOptions=enable_prime" \
-Pdataflow-runner

El resultado es similar al siguiente ejemplo.

"details" : [ {
  "@type" : "type.googleapis.com/google.rpc.ErrorInfo",
  "reason" : "CUSTOM_ORG_POLICY_VIOLATION"
}]

El registro de auditoría debe mostrar los detalles del incumplimiento de la siguiente manera:

  policyViolationInfo: {
    orgPolicyViolationInfo: {
    violationInfo: [
    0: {
      constraint: "customConstraints/custom.denyPrimeJobs"
      errorMessage: "Restrict creation of job with prime enabled"
      policyType: "CUSTOM_CONSTRAINT"
    }]}}

Campos de expresión para las condiciones

La siguiente tabla contiene los campos de expresión que puedes usar para crear condiciones. Las condiciones se escriben en Common Expression Language (CEL). El valor de los campos de expresión distingue mayúsculas de minúsculas.

Para obtener descripciones de los siguientes campos de expresión y los valores que puedes especificar, consulta la representación JSON de Job de flujo de datos.

Campo de expresión	Tipo de valor
`name`	`string`
`type`	`string`
`transformNameMapping`	`map`
`location`	`string`
`environment`	`message`
`environment.serviceOptions`	`list of string`
`environment.serviceKmsKeyName`	`string`
`environment.serviceAccountEmail`	`string`
`environment.workerRegion`	`string`
`environment.workerZone`	`string`
`environment.streamingMode`	`string`
`environment.debugOptions`	`message`
`environment.debugOptions.enableHotKeyLogging`	`bool`

Ejemplos de casos de uso

En la siguiente tabla, se muestran algunos ejemplos de casos de uso.

Caso de uso	Acción	Restricción personalizada
No permitir el uso de trabajos principales	DENY	`resource.environment.serviceOptions.exists(value, value=='enable_prime')`
Evita que las VMs acepten claves SSH almacenadas en metadatos del proyecto.	DENY	`!resource.environment.serviceOptions.exists(value, value=='block_project_ssh_keys')`
No permitir trabajos sin establecer la cantidad máxima de segundos que puede ejecutarse	DENY	`!resource.environment.serviceOptions.exists(value, value.contains('max_workflow_runtime_walltime_seconds=')`

¿Qué sigue?

Consulta Introducción al Servicio de las Políticas de la Organización para obtener más información sobre las 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.

Administra recursos de Dataflow con restricciones personalizadas Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

Beneficios

Herencia de políticas

Precios

Limitaciones

Antes de comenzar

Roles obligatorios

Permisos necesarios

Crea una restricción personalizada

Configura una restricción personalizada

Console

gcloud

Aplica una política de la organización personalizada

Consola

gcloud

Ejemplo: Crea una restricción para denegar la creación de un trabajo con Prime habilitado

gcloud

Campos de expresión para las condiciones

Ejemplos de casos de uso

¿Qué sigue?

Administra recursos de Dataflow con restricciones personalizadas