Usa restricciones personalizadas con canalizaciones

Versión preliminar

Este producto o función está sujeto a las "Condiciones de la Oferta de la Fase Previa a la DG" en la sección Condiciones Generales del Servicio de las Condiciones Específicas del Servicio. Los productos y las funciones de la fase previa a la DG están disponibles sin modificaciones y pueden estar sujetos a asistencia limitada. Para obtener más información, consulta las descripciones de la etapa de lanzamiento.

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 :

• aiplatform.googleapis.com/PipelineJob

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.

Beneficios

Puedes usar una política de organización personalizada para permitir o rechazar operaciones específicas en los recursos de Vertex AI Pipelines. Por ejemplo, si el URI de la plantilla especificado para crear un recurso PipelineJob no satisface una validación de restricción personalizada establecida por la política de la organización, la solicitud falla y se devuelve un error a la persona que llama.

Limitaciones

Las políticas de la organización personalizadas no se aplican a las ejecuciones de canalizaciones programadas con la API de Scheduler.

Antes de comenzar

1. Configura tu proyecto

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.

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.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Vertex AI, Compute Engine, and Cloud Storage APIs.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the APIs

Install the Google Cloud CLI.

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

Para inicializar gcloud CLI, ejecuta el siguiente comando:

gcloud init

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.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Vertex AI, Compute Engine, and Cloud Storage APIs.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the APIs

Install the Google Cloud CLI.

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

Para inicializar gcloud CLI, ejecuta el siguiente comando:

gcloud init

1. Obtén el ID de tu recurso de organización.
2. Define y compila una canalización que puedas usar para probar la restricción personalizada.

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 los siguientes roles de IAM:

• Para administrar las políticas de la organización: Administrador de políticas de la organización (roles/orgpolicy.policyAdmin) en el recurso de la organización
• Crea o actualiza una canalización de AA: Administrador de Vertex AI (roles/aiplatform.admin) o Usuario de Vertex AI (roles/aiplatform.user) en el recurso del proyecto

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.

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.

9. 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.
10. En Acción, selecciona si deseas permitir o rechazar el método evaluado si se cumple la condición.

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.

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

1. 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
      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, custom.denyPipelineTemplate. 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: aiplatform.googleapis.com/PipelineJob/resource.templateUri.
• 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.templateUri.contains("test")".

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

        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.

3. 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 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. 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 las políticas de la organización con Policy Simulator.
10. 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 Crea una política de la organización en modo de ejecución de prueba.
11. Después 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 Establecer política para establecer la política activa.

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:

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

Reemplaza lo siguiente:

• PROJECT_ID: Es el proyecto en el que deseas aplicar tu restricción.
• CONSTRAINT_NAME: Es el nombre que definiste para tu restricción personalizada. Por ejemplo: custom.denyPipelineTemplate
2. Para aplicar la política de la organización en el modo de ejecución de prueba, ejecuta el siguiente comando 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.

3. Después de verificar que la política de la organización en modo de ejecución de prueba funcione 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.

Prueba la política de la organización personalizada

En el siguiente ejemplo, se crea una restricción y una política personalizadas que no permiten que se creen ejecuciones de canalizaciones especificando un URI de plantilla que contenga "test".

Antes de comenzar, debes saber lo siguiente:

• El ID de tu organización
• Un ID del proyecto

Crea la restricción

1. Guarda el siguiente archivo como constraint-validate-pipeline-template-uri.yaml:

   name: organizations/ORGANIZATION_ID/customConstraints/custom.denyPipelineTemplate
   resourceTypes:
   - resource.templateUri
   methodTypes:
     - CREATE
     condition: "resource.templateUri.contains("test")"
     actionType: DENY
     displayName: Deny pipeline runs if the template URI contains 'test'
     description: Deny the creation of a new pipeline run if it's based on a template URI containing 'test'
   

   Esto define una restricción en la que el URI de la plantilla de canalización no puede contener test.

   1. Aplica la restricción:

      gcloud org-policies set-custom-constraint ~/constraint-validate-pipeline-template-uri.yaml
      

   2. Verifica que la restricción exista:

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

      El resultado es similar a este:

      CUSTOM_CONSTRAINT                          ACTION_TYPE  METHOD_TYPES   RESOURCE_TYPES          DISPLAY_NAME
      custom.denyPipelineTemplate                DENY         CREATE         resource.templateUri    Deny pipeline runs if the template URI contains 'test'
      ...
      

Crea la política

1. Guarda el siguiente archivo como policy-validate-pipeline-template-uri.yaml:

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

   Reemplaza PROJECT_ID con el ID del proyecto.

2. Aplica la política:

     gcloud org-policies set-policy ~/policy-validate-pipeline-template-uri.yaml
   

3. Verifica que la política exista:

     gcloud org-policies list --project=PROJECT_ID
   

   El resultado es similar a este:

     CONSTRAINT                    LIST_POLICY    BOOLEAN_POLICY    ETAG
     custom.denyPipelineTemplate   -              SET               COCsm5QGENiXi2E=
   

   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 canalización de AA con el URI de la plantilla que contiene test.

REST

Para crear un recurso PipelineJob, envía una solicitud POST con el método pipelineJobs/create.

Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:

• LOCATION: Es la región en la que deseas crear la ejecución de la canalización. Para obtener más información sobre las regiones en las que está disponible Vertex AI Pipelines, consulta la guía de ubicaciones de Vertex AI Pipelines.
• PROJECT_ID: Es el proyecto Google Cloud en el que deseas crear la ejecución de la canalización.
• DISPLAY_NAME: Es el nombre de la ejecución de la canalización. Esto se mostrará en la consola de Google Cloud .

Método HTTP y URL:

POST https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/pipelineJobs

Cuerpo JSON de la solicitud:

{
  "displayName":"DISPLAY_NAME",
  "templateUri":"test_pipeline_template.json"
}

Para enviar tu solicitud, elige una de estas opciones:

curl

Nota: Con el siguiente comando, se supone que accediste a la CLI de gcloud con tu cuenta de usuario a través de la ejecución de gcloud init o gcloud auth login, o a través del uso de Cloud Shell, que accede de forma automática a la CLI de gcloud. Para comprobar la cuenta activa actual, ejecuta gcloud auth list.

Guarda el cuerpo de la solicitud en un archivo llamado request.json y ejecuta el siguiente comando:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/pipelineJobs"

PowerShell

Nota: En el siguiente comando, se supone que accediste a la CLI de gcloud con tu cuenta de usuario a través de la ejecución de gcloud init o gcloud auth login . Para comprobar la cuenta activa actual, ejecuta gcloud auth list.

Guarda el cuerpo de la solicitud en un archivo llamado request.json y ejecuta el siguiente comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/pipelineJobs" | Select-Object -Expand Content

Deberías recibir una respuesta JSON similar a la que se muestra a continuación:

{
  "error": {
    "code": 400,
    "message": "Operation denied by org policy on resource 'projects/PROJECT_ID/locations/LOCATION': [\"customConstraints/custom.denyPipelineTemplate\": \"Deny the creation of a new pipeline run if it's based on a template URI containing 'test'\"]",
    "status": "FAILED_PRECONDITION",
    "details": [
      {
        "@type": "type.googleapis.com/google.rpc.ErrorInfo",
        "reason": "CUSTOM_ORG_POLICY_VIOLATION",
        "domain": "googleapis.com",
        "metadata": {
          "service": "aiplatform.googleapis.com",
          "customConstraints": "customConstraints/custom.denyPipelineTemplate"
        }
      }
    ]
  }
}

Recursos compatibles con Vertex AI Pipelines

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

Recurso	Campo
aiplatform.googleapis.com/PipelineJob	resource.displayName
	resource.encryptionSpec.kmsKeyName
	resource.network
	resource.pipelineSpec
	resource.preflightValidations
	resource.pscInterfaceConfig.networkAttachment
	resource.reservedIpRanges
	resource.runtimeConfig.failurePolicy
	resource.runtimeConfig.gcsOutputDirectory
	resource.runtimeConfig.inputArtifacts[*].artifactId
	resource.runtimeConfig.parameterValues[*].boolValue
	resource.runtimeConfig.parameterValues[*].listValue.values
	resource.runtimeConfig.parameterValues[*].nullValue
	resource.runtimeConfig.parameterValues[*].numberValue
	resource.runtimeConfig.parameterValues[*].stringValue
	resource.runtimeConfig.parameterValues[*].structValue
	resource.serviceAccount
	resource.templateUri

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