Usar restricciones personalizadas con flujos de trabajo

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

• aiplatform.googleapis.com/PipelineJob

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

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

El Google Cloud servicio de políticas de organización te permite controlar los recursos de tu organización de forma centralizada y programática. Como administrador de políticas de organización, puedes definir una política de organización, que es un conjunto de restricciones llamadas restricciones que se aplican a losGoogle Cloud recursos y a los elementos descendientes de esos recursos en la Google Cloud jerarquía de recursos. Puedes aplicar políticas de organización a nivel de organización, carpeta o proyecto.

La política de la organización proporciona restricciones gestionadas integradas para varios servicios de Google Cloud . Sin embargo, si quieres tener un control más granular 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 organización se heredan de los descendientes de los recursos en los que se aplican. Por ejemplo, si aplicas una política a una carpeta, Google Cloud se aplicará a todos los proyectos de la carpeta. Para obtener más información sobre este comportamiento y cómo cambiarlo, consulta las reglas de evaluación de la jerarquía.

Ventajas

Puedes usar una política de organización personalizada para permitir o denegar operaciones específicas en recursos de Vertex AI Pipelines. Por ejemplo, si el URI de plantilla especificado para crear un recurso PipelineJob no cumple una validación de restricción personalizada definida por tu política de organización, la solicitud fallará y se devolverá un error a la persona que la haya llamado.

Limitaciones

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

Antes de empezar

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 (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

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 utilizas un proveedor de identidades (IdP) externo, primero debes iniciar sesión en la CLI de gcloud 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 (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

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 utilizas un proveedor de identidades (IdP) externo, primero debes iniciar sesión en la CLI de gcloud con tu identidad federada.

Para inicializar gcloud CLI, ejecuta el siguiente comando:

gcloud init

1. Obtén el ID de recurso de tu 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 gestionar las políticas de la organización, pide a tu administrador que te conceda los siguientes roles de gestión de identidades y accesos:

• Para gestionar las políticas de la organización, haz lo siguiente: Administrador de políticas de organización (roles/orgpolicy.policyAdmin) en el recurso de 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 conceder roles, consulta el artículo Gestionar el acceso a proyectos, carpetas y organizaciones.

También puedes conseguir los permisos necesarios a través de roles personalizados u otros roles predefinidos.

Crear 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 admite el servicio en el que se aplica la política de la organización. Las condiciones de tus restricciones personalizadas se definen mediante el lenguaje de expresión común (CEL). Para obtener más información sobre cómo crear condiciones en restricciones personalizadas con CEL, consulta la sección sobre CEL del artículo Crear y gestionar 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
condition: "CONDITION"
actionType: ACTION
displayName: DISPLAY_NAME
description: DESCRIPTION

Haz los cambios siguientes:

• ORGANIZATION_ID: el ID de tu organización, como 123456789.

• CONSTRAINT_NAME: el nombre que quieras asignar a la nueva restricción personalizada. Una restricción personalizada debe empezar por custom. y solo puede incluir letras mayúsculas, letras minúsculas o números. Por ejemplo, custom.denyPipelineTemplate. La longitud máxima de este campo es de 70 caracteres.

• RESOURCE_NAME: nombre completo del recursoGoogle Cloud que contiene el objeto y el campo que quieres restringir. Por ejemplo, aiplatform.googleapis.com/PipelineJob/resource.templateUri.

• CONDITION: una condición CEL que se escribe en una representación de un recurso de servicio compatible. Este campo tiene una longitud máxima de 1000 caracteres. Consulta los recursos admitidos para obtener más información sobre los recursos con los que puedes escribir condiciones. Por ejemplo, "resource.templateUri.contains("test")".

• ACTION: la acción que se debe llevar a cabo si se cumple la condición condition. Los valores posibles son ALLOW y DENY.

• DISPLAY_NAME: nombre descriptivo de la restricción. Este campo tiene una longitud máxima de 200 caracteres.

• DESCRIPTION: descripción de la restricción que se mostrará como mensaje de error cuando se infrinja la política. Este campo tiene una longitud máxima de 2000 caracteres.

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

Configurar una restricción personalizada

Una vez que hayas creado el archivo YAML de una nueva restricción personalizada, debes configurarla para que esté disponible en las políticas de 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

Sustituye CONSTRAINT_PATH por la ruta completa a tu archivo de restricciones personalizadas. Por ejemplo, /home/user/customconstraint.yaml. Una vez completado el proceso, las restricciones personalizadas estarán disponibles como políticas de organización en la lista de Google Cloud políticas de organización. Para verificar que la restricción personalizada existe, usa el comando gcloud org-policies list-custom-constraints:

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

Sustituye ORGANIZATION_ID por el ID del recurso de tu organización. Para obtener más información, consulta Ver políticas de la organización.

Aplicar una política de organización personalizada

Para aplicar una restricción, crea una política de organización que haga referencia a ella y, a continuación, aplica esa política de organización a un Google Cloud recurso.

Consola

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

   Ir a Políticas de organización

2. En el selector de proyectos, elige el proyecto para el que quieras definir la política de organización.
3. En la lista de la página Políticas de organización, selecciona la restricción para ver la página Detalles de la política correspondiente.
4. Para configurar la política de la organización de este recurso, haz clic en Gestionar política.
5. En la página Editar política, selecciona Anular política del recurso superior.
6. Haz clic en Añadir regla.
7. En la sección Aplicación, selecciona si quieres activar o desactivar la aplicación de esta política de la organización.
8. Opcional: Para que la política de la organización dependa de una etiqueta, haz clic en Añadir condición. Ten en cuenta que, si añades una regla condicional a una política de organización, debes añadir al menos una regla incondicional o la política no se podrá guardar. Para obtener más información, consulta Configurar una política de organización con etiquetas.
9. Haz clic en Probar cambios para simular el efecto de la política de la organización. La simulación de políticas no está disponible para las restricciones gestionadas antiguas. Para obtener más información, consulta el artículo Probar los cambios en las políticas de la organización con el simulador de políticas.
10. Para finalizar y aplicar la política de organización, haz clic en Definir política. La política tarda hasta 15 minutos en aplicarse.

gcloud

Para crear una política de 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
    

Haz los cambios siguientes:

• PROJECT_ID: el proyecto en el que quieras aplicar la restricción.
• CONSTRAINT_NAME: el nombre que has definido para tu restricción personalizada. Por ejemplo, custom.denyPipelineTemplate.

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
    

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

Probar la política de organización personalizada

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

Antes de empezar, debes saber lo siguiente:

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

Crear 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'
   

   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 debería ser similar al siguiente:

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

Crear 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
   

   Sustituye PROJECT_ID por el ID del proyecto.

2. Aplica la política:

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

3. Comprueba que la política exista:

     gcloud org-policies list --project=PROJECT_ID
   

   El resultado debería ser similar al siguiente:

     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 empiece a aplicarla.

Probar la política

Intenta crear una canalización de aprendizaje automático con el URI de la plantilla que contenga test.

REST

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

Antes de usar los datos de la solicitud, haz las siguientes sustituciones:

• LOCATION: la región en la que quieres crear la ejecución del flujo de procesamiento. 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: el Google Cloud proyecto en el que quieres crear la ejecución de la canalización.
• DISPLAY_NAME: el nombre de la ejecución del flujo de procesamiento. Se mostrará en la consola 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

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

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 siguiente:

{
  "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 admitidos de Vertex AI Pipelines

En la siguiente tabla se enumeran los recursos de Vertex AI Pipelines a los que puede 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

Siguientes pasos

• Consulta más información sobre el servicio de políticas de organización.
• Consulta más información sobre cómo crear y gestionar políticas de la organización.
• Consulta la lista completa de restricciones de políticas de la organización gestionadas.