Usar restricciones personalizadas con almacenes de metadatos

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/MetadataStore

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 ofrece 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 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 Google Cloud servicios. 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 apliques la política. 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 metadatos de Vertex ML. Por ejemplo, si una solicitud para crear o actualizar la descripción de un recurso MetadataStore no cumple una validación de restricción personalizada definida por la política de tu organización, la solicitud fallará y se devolverá un error a la persona que la haya enviado.

Antes de empezar

1. Configurar un 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 API.

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 API

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

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 API

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.

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, sigue estos pasos: Administrador de políticas de organización (roles/orgpolicy.policyAdmin) en el recurso de la organización
• Crea o actualiza un almacén de metadatos: 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 acceso a proyectos, carpetas y organizaciones.

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

Configurar 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 vas a aplicar la política de 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.

Consola

Para crear una restricción personalizada, sigue estos pasos:

1. En la Google Cloud consola, 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 en el que quieras definir la política de la organización.
3. Haz clic en Restricción personalizada.
4. En el cuadro Nombre visible, introduce un nombre legible para la restricción. Este nombre se usa en los mensajes de error y se puede usar para identificar y depurar. No utilices información personal identificable ni datos sensibles en los nombres visibles, ya que estos nombres podrían mostrarse en mensajes de error. Este campo puede contener hasta 200 caracteres.
5. En el cuadro ID de restricción, escribe el nombre que quieras asignar a la nueva restricción personalizada. Una restricción personalizada solo puede contener letras (mayúsculas y minúsculas) o números, como custom.disableGkeAutoUpgrade. Este campo puede contener hasta 70 caracteres, sin contar el prefijo (custom.). Por ejemplo, organizations/123456789/customConstraints/custom. No incluyas IPI ni datos sensibles en el ID de la restricción, ya que podría exponerse en mensajes de error.
6. En el cuadro Description, introduce una descripción de la restricción que sea legible por humanos. Esta descripción se usa como mensaje de error cuando se infringe la política. Incluye detalles sobre por qué se ha producido la infracción de las políticas y cómo resolverla. No incluyas IPI ni datos sensibles en la descripción, ya que podrían exponerse en mensajes de error. Este campo puede contener hasta 2000 caracteres.
7. En el cuadro Tipo de recurso, seleccione el nombre del Google Cloud recurso REST que contenga el objeto y el campo que quiera 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 quieres aplicar la restricción al método CREATE de REST o a los métodos CREATE y UPDATE. Si aplicas la restricción con el método UPDATE en un recurso que la infringe, la política de la organización bloqueará los cambios en ese recurso, a menos que el cambio resuelva la infracción.

No todos los Google Cloud servicios admiten ambos métodos. Para ver los métodos admitidos de cada servicio, busca el servicio en Servicios admitidos.

9. Para definir una condición, haz clic en Editar condición.
1. En el panel Añadir 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 1000 caracteres. Para obtener más información sobre el uso de CEL, consulta el artículo Lenguaje de expresión común. Para obtener más información sobre los recursos de servicio que puede usar en sus restricciones personalizadas, consulte Servicios admitidos en restricciones personalizadas.
2. Haz clic en Guardar.
10. En Acción, seleccione si quiere permitir o denegar el método evaluado si se cumple la condición.

La acción de denegación 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 incluyan explícitamente en la condición.

11. Haz clic en Crear restricción.

Cuando haya introducido un valor en cada campo, aparecerá a la derecha la configuración YAML equivalente de 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
      

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 solo puede contener letras (incluidas mayúsculas y minúsculas) o números. Por ejemplo, custom.denyMetadataStoreDescription. Este campo puede contener hasta 70 caracteres.
• RESOURCE_NAME: nombre completo del recurso Google Cloud que contiene el objeto y el campo que quieres restringir. Por ejemplo, aiplatform.googleapis.com/MetadataStore/resource.Description.
• CONDITION: una condición de CEL que se escribe en una representación de un recurso de servicio admitido. Este campo puede contener hasta 1000 caracteres. Por ejemplo, "resource.displayName.startsWith('Test')".

Para obtener más información sobre los recursos disponibles para escribir condiciones, consulta Recursos admitidos.

• ACTION: la acción que se debe llevar a cabo si se cumple la 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 bloquearán todos los demás casos, excepto el que se haya incluido explícitamente en la condición.

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

• DISPLAY_NAME: nombre descriptivo de la restricción. Este campo puede contener hasta 200 caracteres.
• DESCRIPTION: descripción de la restricción que se puede leer fácilmente y que se muestra como mensaje de error cuando se infringe la política. Este campo puede contener hasta 2000 caracteres.
2. 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 del archivo de restricción personalizada. Por ejemplo, /home/user/customconstraint.yaml.

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

3. 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 las 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 la organización

2. En el selector de proyectos, selecciona el proyecto en 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 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 esta política de la organización se aplica o no.
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 el artículo 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. Para obtener más información, consulta Probar los cambios en las políticas de la organización con el simulador de políticas.
10. Para aplicar la política de la organización en modo de prueba de funcionamiento, haz clic en Definir política de prueba de funcionamiento. Para obtener más información, consulta Crear una política de organización en modo de prueba.
11. Una vez que hayas verificado que la política de la organización en modo de prueba funciona correctamente, define la política activa haciendo clic en Definir política.

gcloud

1. 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
        
        dryRunSpec:
          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.denyMetadataStoreDescription.
2. Para aplicar la política de la organización en el modo de prueba, ejecuta el siguiente comando con la marca dryRunSpec:

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

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.

3. Una vez que haya verificado que la política de la organización en modo de prueba funciona correctamente, defina 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
      

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 que la descripción de un almacén de metadatos empiece por "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-displayname-test.yaml:

   name: organizations/ORGANIZATION_ID/customConstraints/custom.denyMetadataStoreDescription
   resourceTypes:
   - resource.Description
   methodTypes:
     - CREATE
     condition: "resource.displayName.startsWith('Test')"
     actionType: DENY
     displayName: Deny metadata store descriptions that start with 'test'
     description: Only allow metadata store descriptions that don't start with 'test'
   

   Define una restricción por la que la descripción de los nuevos almacenes de metadatos no puede empezar por "test".

   1. Aplica la restricción:

      gcloud org-policies set-custom-constraint ~/constraint-validate-displayname-test.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.denyMetadataStoreDescription    DENY         CREATE         resource.Description   Deny metadata store descriptions that start with 'test'
      ...
      

Crear la política

1. Guarda el siguiente archivo como policy-validate-displayname-test.yaml:

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

   Sustituye PROJECT_ID por el ID del proyecto.

2. Aplica la política:

     gcloud org-policies set-policy ~/policy-validate-displayname-test.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.denyMetadataStoreDescription   -              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 un almacén de metadatos con la descripción "test_metadata_store".

REST

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

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

• LOCATION: región en la que quieres crear el almacén de metadatos. Para obtener más información sobre las regiones en las que está disponible Vertex ML Metadata, consulta la guía de ubicaciones de Vertex ML Metadata.
• PROJECT_ID: el proyecto Google Cloud en el que quieres crear el almacén de metadatos.

Método HTTP y URL:

POST https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/metadataStores?metadata_store_id=default

Cuerpo JSON de la solicitud:

{
  "description":"test_metadata_store",
  "encryptionSpec": {
    "kmsKeyName":""
  },
  "dataplexConfig":{"enabledPipelinesLineage":"false"}
}

Para enviar tu solicitud, elige una de estas opciones:

curl

Nota: En el siguiente comando se presupone que has iniciado sesión en la CLI de gcloud con tu cuenta de usuario ejecutando gcloud init o gcloud auth login , o bien usando Cloud Shell, que inicia sesión automáticamente en la CLI de gcloud . Para comprobar la cuenta activa, ejecuta el comando 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/metadataStores?metadata_store_id=default"

PowerShell

Nota: El siguiente comando presupone que has iniciado sesión en la CLI de gcloud con tu cuenta de usuario ejecutando gcloud init o gcloud auth login . Para comprobar la cuenta activa, ejecuta el comando 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/metadataStores?metadata_store_id=default" | 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.denyMetadataStoreDescription\": \"Only allow metadata store descriptions that don't start with '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.denyMetadataStoreDescription"
        }
      }
    ]
  }
}

Recursos admitidos de Vertex ML Metadata

En la siguiente tabla se enumeran los recursos de metadatos de Vertex ML a los que puede hacer referencia en las restricciones personalizadas.

Recurso	Campo
aiplatform.googleapis.com/MetadataStore	resource.dataplexConfig.enabledPipelinesLineage
	resource.description
	resource.encryptionSpec.kmsKeyName

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 organización gestionadas.