En esta página, se muestra cómo usar las restricciones personalizadas del servicio de políticas de la organización para restringir operaciones específicas en los siguientes recursos de Google Cloud :
aiplatform.googleapis.com/MetadataStore
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 políticas y restricciones de la organización
El Google Cloud Servicio de políticas 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 deGoogle Cloud y a sus descendientes 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 proporciona 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 de la carpeta. 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 denegar operaciones específicas en recursos de Vertex ML Metadata. Por ejemplo, si una solicitud para crear o actualizar la descripción de un recurso MetadataStore no satisface una validación de restricción personalizada establecida por la política de tu organización, la solicitud fallará y se devolverá un error al llamador.
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.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Vertex AI API.
-
Install the Google Cloud CLI.
-
If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.
-
To initialize the gcloud CLI, run the following command:
gcloud init -
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Vertex AI API.
-
Install the Google Cloud CLI.
-
If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.
-
To initialize the gcloud CLI, run the following command:
gcloud init - Obtén el ID de tu recurso de organización.
-
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 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 ORGANIZATION_ID: el ID de la organización, como123456789.CONSTRAINT_NAME: el nombre que deseas para tu nueva restricción personalizada. Una restricción personalizada debe comenzar concustom.y solo puede incluir letras mayúsculas, minúsculas o números. Por ejemplo,custom.denyMetadataStoreDescription. La longitud máxima de este campo es de 70 caracteres.RESOURCE_NAME: Es el nombre completamente calificado del recursoGoogle Cloud que contiene el objeto y el campo que deseas 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 compatible. La longitud máxima de este campo es 1000 caracteres. Consulta Recursos compatibles con el fin de obtener más información sobre los recursos disponibles para escribir condiciones. Por ejemplo,"resource.displayName.startsWith('Test')"ACTION: la acción que se realiza si se cumplecondition. Los valores posibles sonALLOWyDENY.DISPLAY_NAME: un nombre descriptivo para la restricción. La longitud máxima de este campo es 200 caracteres.DESCRIPTION: una descripción fácil de usar 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 2000 caracteres.- En la consola de Google Cloud , ve a la página Políticas de la organización.
- En el selector de proyectos, selecciona el proyecto para el que deseas configurar la política de la organización.
- En la lista de la página Políticas de la organización, selecciona tu 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 elemento superior.
- Haz clic en Agregar una regla.
- En la sección Aplicación, selecciona si la aplicación de esta política de la organización está activada o desactivada.
- Opcional: haz clic en Agregar condición para que la política de la organización sea condicional en una etiqueta. 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.
- 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 administradas heredadas. Para obtener más información, consulta Prueba los cambios en las políticas de la organización con Policy Simulator.
- Para finalizar y aplicar la política de la organización, haz clic en Establecer política. La política tarda hasta 15 minutos en aplicarse.
-
PROJECT_ID: el proyecto en el que deseas aplicar tu restricción. -
CONSTRAINT_NAME: el nombre que definiste para tu restricción personalizada. Por ejemplo:custom.denyMetadataStoreDescription - El ID de tu organización
- Un ID del proyecto
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'Esto define una restricción en la que la descripción de los nuevos almacenes de metadatos no puede comenzar con "prueba".
Aplica la restricción:
gcloud org-policies set-custom-constraint ~/constraint-validate-displayname-test.yamlVerifica que la restricción exista:
gcloud org-policies list-custom-constraints --organization=ORGANIZATION_IDEl resultado es similar a este:
CUSTOM_CONSTRAINT ACTION_TYPE METHOD_TYPES RESOURCE_TYPES DISPLAY_NAME custom.denyMetadataStoreDescription DENY CREATE resource.Description Deny metadata store descriptions that start with 'test' ...
Guarda el siguiente archivo como
policy-validate-displayname-test.yaml:name: projects/PROJECT_ID/policies/custom.denyMetadataStoreDescription spec: rules: - enforce: trueReemplaza
PROJECT_IDcon el ID del proyecto.Aplica la política:
gcloud org-policies set-policy ~/policy-validate-displayname-test.yamlVerifica que la política exista:
gcloud org-policies list --project=PROJECT_IDEl resultado es similar a este:
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 comience a aplicarla.
- LOCATION: Es la región en la que deseas 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: Es el proyecto Google Cloud en el que deseas crear el almacén de metadatos.
- 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.
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 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 mediante roles personalizados o cualquier otro rol predefinido.
Crea 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 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 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:
Para obtener más información sobre cómo crear una restricción personalizada, consulta Define restricciones personalizadas.
Configura una restricción personalizada
Después de crear el archivo YAML para 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 comandogcloud org-policies set-custom-constraint:
gcloud org-policies set-custom-constraint CONSTRAINT_PATH
CONSTRAINT_PATH por la ruta de acceso completa al
archivo de restricción personalizado. Por ejemplo, /home/user/customconstraint.yaml.
Una vez completadas, tus restricciones personalizadas estarán disponibles como políticas de la organización en tu lista de Google Cloud políticas de la organización.
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
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 de manera forzosa una política de la organización personalizada
Puedes aplicar una restricción si creas una política de la organización que haga referencia a ella y, luego, aplicas esa política a un recurso Google Cloud .Console
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
Reemplaza lo siguiente:
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
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 crean una restricción y una política personalizadas que no permiten que la descripción de un almacén de metadatos comience con "prueba".
Antes de comenzar, debes saber lo siguiente:
Crea la restricción
Crea la política
Prueba 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 con el método metadataStores/create.
Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:
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
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
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 que se muestra a continuación:
{
"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 compatibles con Vertex ML Metadata
En la siguiente tabla, se enumeran los recursos de Vertex ML Metadata a los que puedes hacer referencia en las restricciones personalizadas.| Recurso | Campo |
|---|---|
| aiplatform.googleapis.com/MetadataStore |
resource.dataplexConfig.enabledPipelinesLineage
|
resource.description
| |
resource.encryptionSpec.kmsKeyName
|