Crear restricciones personalizadas para la búsqueda vectorial

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/Index
  • aiplatform.googleapis.com/IndexEndpoint

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.

Antes de empezar

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

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

  3. Verify that billing is enabled for your Google Cloud project.

  4. Install the Google Cloud CLI.

  5. Si utilizas un proveedor de identidades (IdP) externo, primero debes iniciar sesión en la CLI de gcloud con tu identidad federada.

  6. Para inicializar gcloud CLI, ejecuta el siguiente comando: 

    gcloud init

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

  8. Verify that billing is enabled for your Google Cloud project.

  9. Install the Google Cloud CLI.

  10. Si utilizas un proveedor de identidades (IdP) externo, primero debes iniciar sesión en la CLI de gcloud con tu identidad federada.

  11. Para inicializar gcloud CLI, ejecuta el siguiente comando: 

    gcloud init
  12. Asegúrate de que conoces el ID de tu organización.

    13. Roles obligatorios

    Para obtener los permisos que necesitas para gestionar políticas de organización personalizadas, pide a tu administrador que te conceda el rol de gestión de identidades y accesos Administrador de políticas de organización (roles/orgpolicy.policyAdmin) en el recurso de la organización. 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
- UPDATE
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.disableUnencryptedIndexes. 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/Index.

    • 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, "has(resource.encryptionSpec) == false".

    • 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.disableUnencryptedIndexes.

    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 impiden la creación de índices que no estén cifrados en una organización determinada.

    Antes de empezar, debes saber lo siguiente:

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

    Crear una restricción personalizada

    1. Guarda el siguiente archivo como constraint-disable-unencrypted-indexes.yaml:

      name: organizations/ORGANIZATION_ID/customConstraints/custom.disableUnencryptedIndexes
resourceTypes:
- aiplatform.googleapis.com/Index
methodTypes:
- CREATE
condition: "has(resource.encryptionSpec) == false"
actionType: DENY
displayName: Block creation of unencrypted Indexes
description: This constraint blocks the creation of Index resources that aren't encrypted

      Sustituye ORGANIZATION_ID por el ID de tu organización.

      Define una restricción que bloquea la creación de recursos de índice que no tienen una especificación de cifrado.

    2. Aplica la restricción:

      gcloud org-policies set-custom-constraint ~/constraint-disable-unencrypted-indexes.yaml

    3. 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.disableUnencryptedIndexes   DENY          CREATE         aiplatform.googleapis.com/Index   Block creation of unencrypted Indexes
...

    Crear la política

    1. Guarda el siguiente archivo como policy-disable-unencrypted-indexes.yaml:

      name: organizations/ORGANIZATION_ID/policies/custom.disableUnencryptedIndexes
spec:
  rules:
  - enforce: true

      Sustituye ORGANIZATION_ID por el ID de tu organización.

    2. Aplica la política:

      gcloud org-policies set-policy ~/policy-disable-unencrypted-indexes.yaml

    3. Comprueba que la política exista:

      gcloud org-policies list --organization=ORGANIZATION_ID

      El resultado debería ser similar al siguiente:

      CONSTRAINT                            LIST_POLICY   BOOLEAN_POLICY   ETAG
custom.disableUnencryptedIndexes     -             SET              COCsm5QGENiXi2E=

    Después de aplicar la política, espera unos dos minutos para que Google Cloud empiece a aplicarla.

    Probar la política

    1. Crea un recurso Index sin cifrado:

      gcloud ai indexes create \
--metadata-file=<var>LOCAL_PATH_TO_METADATA_FILE</var> \
--display-name=<var>INDEX_NAME</var> \
--region=<var>LOCATION</var> \
--project=<var>PROJECT_ID</var>

      El resultado debería ser similar al siguiente:

      ERROR: (gcloud.ai.indexes.create) FAILED_PRECONDITION: Operation denied by org policy on resource 'projects/PROJECT_ID/locations/LOCATION': ["custom.disableUnencryptedIndexes": "This constraint blocks the creation of Index resources that aren't encrypted"]
- '@type': type.googleapis.com/google.rpc.ErrorInfo
domain: googleapis.com
metadata:
    customConstraints: customConstraints/custom.disableUnencryptedIndexes
    service: aiplatform.googleapis.com
reason: CUSTOM_ORG_POLICY_VIOLATION

    Ejemplos de políticas de organización personalizadas para casos prácticos habituales

    En esta tabla se muestran ejemplos de sintaxis de algunas restricciones personalizadas habituales.

    Descripción Sintaxis de las restricciones
    No permitir endpoints de índice públicos. 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.denyPublicIndexEndpoint
    resourceTypes:
    - aiplatform.googleapis.com/IndexEndpoint
    methodTypes:
    - CREATE
    - UPDATE
    condition: resource.publicEndpointEnabled == false
    actionType: DENY
    displayName: Deny public IndexEndpoint
    description: IndexEndpoint shouldn't be public

    Recursos compatibles con Vertex AI

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

    Recurso Campo
    aiplatform.googleapis.com/Index resource.description
    resource.displayName
    resource.encryptionSpec.kmsKeyName
    resource.indexUpdateMethod
    resource.metadata
    resource.metadataSchemaUri
    aiplatform.googleapis.com/IndexEndpoint resource.description
    resource.displayName
    resource.encryptionSpec.kmsKeyName
    resource.network
    resource.privateServiceConnectConfig.enablePrivateServiceConnect
    resource.privateServiceConnectConfig.projectAllowlist
    resource.publicEndpointEnabled

    Siguientes pasos