Nesta página, mostramos como usar restrições personalizadas do serviço de políticas da organização para restringir operações específicas nos seguintes recursos do Google Cloud :
aiplatform.googleapis.com/MetadataStore
Para saber mais sobre a política da organização, consulte Políticas da organização personalizadas.
Sobre políticas e restrições da organização
O Google Cloud Organization Policy Service oferece controle centralizado e programático sobre os recursos da sua organização. Como administrador de políticas da organização, é possível definir uma política da organização, que é um conjunto de limites chamado restrições que se aplicam aosGoogle Cloud recursos e aos descendentes deles na hierarquia de recursos doGoogle Cloud . É possível aplicar políticas da organização no nível da organização, da pasta ou para envolvidos no projeto.
A política da organização oferece restrições gerenciadas integradas para vários serviços do Google Cloud . No entanto, se você quiser um controle mais granular e personalizável sobre os campos específicos restritos nas suas políticas da organização, crie também restrições personalizadas e use-as em uma política da organização.
Herança de políticas
Por padrão, as políticas da organização são herdadas pelos descendentes dos recursos em que a política é aplicada. Por exemplo, se você aplicar uma política em uma pasta, Google Cloud vai aplicar a política a todos os projetos da pasta. Para saber mais sobre esse comportamento e como alterá-lo, consulte Regras de avaliação de hierarquia.
Vantagens
É possível usar uma política da organização personalizada para permitir ou negar operações específicas em
recursos do Vertex ML Metadata. Por exemplo, se uma solicitação para criar ou
atualizar a descrição de um recurso MetadataStore não atender a uma validação de
restrição personalizada definida pela política da organização, a solicitação vai falhar
e um erro será retornado ao autor da chamada.
Antes de começar
1. Criar seu projeto- 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 - Consiga o ID do recurso da organização.
-
Para gerenciar políticas da organização:
Administrador de políticas da organização (
roles/orgpolicy.policyAdmin) no recurso da organização -
Crie ou atualize um metastore:
Administrador da Vertex AI (
roles/aiplatform.admin) ou Usuário da Vertex AI (roles/aiplatform.user) no recurso do projeto ORGANIZATION_ID: o ID da organização, como123456789.CONSTRAINT_NAME: o nome da sua nova restrição personalizada. Uma restrição personalizada precisa começar comcustom.e só pode incluir letras maiúsculas, minúsculas ou números. Por exemplo,custom.denyMetadataStoreDescription. O comprimento máximo desse campo é de 70 caracteres.RESOURCE_NAME: o nome totalmente qualificado do recursoGoogle Cloud que contém o objeto e o campo que você quer restringir. Por exemplo,aiplatform.googleapis.com/MetadataStore/resource.Description.CONDITION: uma condição de CEL gravada em uma representação de um recurso de serviço compatível. Esse campo tem um comprimento máximo de 1000 caracteres. Consulte Recursos compatíveis para mais informações sobre os recursos disponíveis para gravar condições. Por exemplo,"resource.displayName.startsWith('Test')"ACTION: a ação a ser realizada se oconditionfor atendido. Os valores possíveis sãoALLOWeDENY.DISPLAY_NAME: um nome legível para a restrição. Esse campo tem um comprimento máximo de 200 caracteres.DESCRIPTION: uma descrição legível da restrição a ser exibida como uma mensagem de erro quando a política for violada. Esse campo tem um comprimento máximo de 2000 caracteres.- No console Google Cloud , acesse a página Políticas da organização.
- No seletor de projetos, selecione o projeto em que você quer definir a política da organização.
- Na lista da página Políticas da organização, selecione a restrição para acessar a página Detalhes da política dela.
- Para personalizar a política da organização nesse recurso, clique em Gerenciar política.
- Na página Editar política, selecione Substituir a política do editor principal.
- Clique em Adicionar uma regra.
- Na seção Aplicação, selecione se a aplicação dessa política da organização está ativada ou desativada.
- Opcional: para tornar a política da organização condicional em uma tag, clique em Adicionar condição. Se você adicionar uma regra condicional a uma política da organização, inclua pelo menos uma regra não condicional. Caso contrário, não será possível salvar a política. Para mais informações, consulte Como configurar uma política da organização com tags.
- Clique em Testar mudanças para simular o efeito da política da organização. A simulação de política não está disponível para restrições gerenciadas legadas. Para mais informações, consulte Testar mudanças na política da organização com o Simulador de política.
- Para concluir e aplicar a política da organização, clique em Definir política. A política levará até 15 minutos para entrar em vigor.
-
PROJECT_ID: o projeto em que você quer aplicar a restrição. -
CONSTRAINT_NAME: o nome definido para a restrição personalizada. Por exemplo,custom.denyMetadataStoreDescription. - O código da sua organização.
- Um ID do projeto
Salve o seguinte arquivo 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'Isso define uma restrição em que a descrição de novos repositórios de metadados não pode começar com "test".
Aplique a restrição:
gcloud org-policies set-custom-constraint ~/constraint-validate-displayname-test.yamlVerifique se a restrição existe:
gcloud org-policies list-custom-constraints --organization=ORGANIZATION_IDO resultado será assim:
CUSTOM_CONSTRAINT ACTION_TYPE METHOD_TYPES RESOURCE_TYPES DISPLAY_NAME custom.denyMetadataStoreDescription DENY CREATE resource.Description Deny metadata store descriptions that start with 'test' ...
Salve o seguinte arquivo como
policy-validate-displayname-test.yaml:name: projects/PROJECT_ID/policies/custom.denyMetadataStoreDescription spec: rules: - enforce: trueSubstitua
PROJECT_IDpela ID do seu projeto.Aplique a política:
gcloud org-policies set-policy ~/policy-validate-displayname-test.yamlVerifique se a política existe:
gcloud org-policies list --project=PROJECT_IDO resultado será assim:
CONSTRAINT LIST_POLICY BOOLEAN_POLICY ETAG custom.denyMetadataStoreDescription - SET COCsm5QGENiXi2E=Depois de aplicar a política, aguarde cerca de dois minutos para que o Google Cloud comece a aplicar a política.
- LOCATION: a região em que você quer criar o repositório de metadados. Para mais informações sobre as regiões em que o Vertex ML Metadata está disponível, consulte o guia de locais do Vertex ML Metadata.
- PROJECT_ID: o projeto do Google Cloud em que você quer criar o repositório de metadados.
- Saiba mais sobre o Serviço de política da organização.
- Saiba mais sobre como criar e gerenciar políticas da organização.
- Confira a lista completa de restrições da política da organização gerenciadas.
Funções exigidas
Para conseguir as permissões necessárias para gerenciar políticas da organização, peça ao administrador para conceder a você os seguintes papéis do IAM:
Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.
Também é possível conseguir as permissões necessárias por meio de papéis personalizados ou de outros papéis predefinidos.
Criar uma restrição personalizada
Uma restrição personalizada é definida em um arquivo YAML pelos recursos, métodos, condições e ações compatíveis com o serviço em que você está aplicando a política da organização. As condições das restrições personalizadas são definidas usando a Common Expression Language (CEL). Para mais informações sobre como criar condições em restrições personalizadas usando a CEL, consulte a seção CEL de Como criar e gerenciar restrições personalizadas.
Para criar uma restrição personalizada, crie um arquivo YAML usando o seguinte formato:
name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
resourceTypes:
- RESOURCE_NAME
methodTypes:
- CREATE
condition: "CONDITION"
actionType: ACTION
displayName: DISPLAY_NAME
description: DESCRIPTION
Substitua:
Para mais informações sobre como criar uma restrição personalizada, consulte Como definir restrições personalizadas.
Configurar uma restrição personalizada
Depois de criar o arquivo YAML para uma nova restrição personalizada, configure-a para disponibilizá-la para as políticas da organização. Para configurar uma restrição personalizada, use o comandogcloud org-policies set-custom-constraint:
gcloud org-policies set-custom-constraint CONSTRAINT_PATH
CONSTRAINT_PATH pelo caminho completo
do arquivo da restrição personalizada. Por exemplo, /home/user/customconstraint.yaml.
Após a conclusão, as restrições personalizadas vão estar disponíveis como políticas da organização
na sua lista de Google Cloud políticas da organização.
Para verificar se a restrição personalizada existe, use o comando gcloud org-policies list-custom-constraints:
gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID
ORGANIZATION_ID pelo ID do recurso da organização.
Para mais informações, consulte
Como visualizar as políticas da organização.
Aplicar uma política da organização personalizada
Para aplicar uma restrição, crie uma política da organização que faça referência a ela e aplique essa política a um recurso Google Cloud .Console
gcloud
Para criar uma política da organização com regras booleanas, crie um arquivo YAML da política que faça referência à restrição:
name: projects/PROJECT_ID/policies/CONSTRAINT_NAME spec: rules: - enforce: true
Substitua:
Para aplicar a política da organização que contém a restrição, execute o seguinte comando:
gcloud org-policies set-policy POLICY_PATH
Substitua POLICY_PATH pelo caminho completo do arquivo YAML da política da organização. A política leva até 15 minutos para entrar em vigor.
Testar a política personalizada da organização
O exemplo a seguir cria uma restrição e uma política personalizadas que não permitem que a descrição de um repositório de metadados comece com "test".
Antes de começar, você precisa saber o seguinte:
Crie a restrição.
Crie a política
Testar a política
Tente criar um repositório de metadados com a descrição "test_metadata_store".
REST
Para criar um recurso MetadataStore, envie uma solicitação POST usando o método metadataStores/create.
Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:
Método HTTP e URL:
POST https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/metadataStores?metadata_store_id=default
Corpo JSON da solicitação:
{
"description":"test_metadata_store",
"encryptionSpec": {
"kmsKeyName":""
},
"dataplexConfig":{"enabledPipelinesLineage":"false"}
}
Para enviar a solicitação, escolha uma destas opções:
curl
Salve o corpo da solicitação em um arquivo com o nome request.json e execute o comando a seguir:
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
Salve o corpo da solicitação em um arquivo com o nome request.json e execute o comando a seguir:
$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
Você receberá uma resposta JSON semelhante a esta:
{
"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 compatíveis com o Vertex ML Metadata
A tabela a seguir lista os recursos do Vertex ML Metadata que podem ser referenciados em restrições personalizadas.| Recurso | Campo |
|---|---|
| aiplatform.googleapis.com/MetadataStore |
resource.dataplexConfig.enabledPipelinesLineage
|
resource.description
| |
resource.encryptionSpec.kmsKeyName
|