Criar restrições personalizadas de política da organização

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/CustomJob
• aiplatform.googleapis.com/HyperparameterTuningJob
• aiplatform.googleapis.com/NasJob

Para saber mais sobre políticas da organização, consulte Políticas personalizadas da organização.

Sobre políticas da organização e restrições

O serviço de políticas da organização do Google Cloud oferece controle centralizado e programático sobre os recursos da sua organização. Um administrador de políticas da organização pode definir políticas da organização, ou seja, conjuntos de restrições que se aplicam aos recursos doGoogle Cloud e aos elementos que descendem dele na hierarquia de recursos doGoogle Cloud . É possível aplicar políticas da organização no nível de projetos, de pastas ou da organização.

Uma política da organização oferece restrições gerenciadas e integradas para vários serviços do Google Cloud . No entanto, para ter controle mais granular e personalizável sobre os campos específicos restritos nas políticas da organização, também é possível criar restrições personalizadas e usá-las nessas políticas.

Herança de políticas

Por padrão, as políticas da organização são herdadas pelos elementos que descendem dos recursos em que elas são aplicadas. Por exemplo, se você aplicar uma política a uma pasta, o Google Cloud vai aplicá-la a todos os projetos dessa pasta. Para saber mais sobre esse comportamento e como alterá-lo, consulte Regras de avaliação de hierarquia.

Vantagens

É possível usar políticas personalizadas da organização para permitir ou negar valores específicos em recursos de treinamento da Vertex AI. Por exemplo, se uma solicitação para criar um job de treinamento personalizado não atender à 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.

Limitações

Como ocorre com todas as restrições de política da organização, as mudanças de política não se aplicam retroativamente aos recursos atuais.

• Uma nova política não afeta as configurações de recursos atuais.
• Uma configuração de recurso atual permanece válida, a menos que você mude um valor na configuração de um valor aceito para um inválido.

Antes de começar

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.

Install the Google Cloud CLI.

Ao usar um provedor de identidade (IdP) externo, primeiro faça login na gcloud CLI com sua identidade federada.

Para inicializar a gcloud CLI, execute o seguinte 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.

Install the Google Cloud CLI.

Ao usar um provedor de identidade (IdP) externo, primeiro faça login na gcloud CLI com sua identidade federada.

Para inicializar a gcloud CLI, execute o seguinte comando:

gcloud init

1. Verifique qual é o ID da organização.

Papéis necessários

Para receber as permissões necessárias a fim de gerenciar as políticas da organização, peça ao administrador para conceder a você o papel do IAM de Administrador de políticas da organização (roles/orgpolicy.policyAdmin) no recurso da organização. 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 usando papéis personalizados ou 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 saber como criar condições em restrições personalizadas usando a CEL, consulte a seção CEL em Como criar e gerenciar restrições personalizadas.

Para criar uma restrição personalizada, crie um arquivo YAML com o seguinte formato:

name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME resourceTypes: - RESOURCE_NAME methodTypes: - CREATE - UPDATE condition: "CONDITION" actionType: ACTION displayName: DISPLAY_NAME description: DESCRIPTION 

Substitua:

• ORGANIZATION_ID: o ID da organização, como 123456789.

• CONSTRAINT_NAME: o nome da nova restrição personalizada. Uma restrição personalizada precisa começar com custom. e só pode incluir letras maiúsculas, minúsculas ou números. Por exemplo, custom.restrictMachineType. Esse campo pode ter no máximo 70 caracteres.

• RESOURCE_NAME: o nome totalmente qualificado do recurso doGoogle Cloud que contém o objeto e o campo que você quer restringir. Por exemplo, aiplatform.googleapis.com/CustomJob.

• CONDITION: uma condição de CEL gravada em uma representação de um recurso de serviço compatível. Esse campo pode ter no máximo 1000 caracteres. Consulte Recursos compatíveis para mais informações sobre os recursos disponíveis para gravação de condições. Por exemplo, "resource.jobSpec.workerPoolSpecs.exists(spec, spec.machineSpec.machineType != \"n1-standard-4\")".

• ACTION: a ação a ser realizada ao atender a condition. Os valores possíveis são ALLOW e DENY.

• DISPLAY_NAME: um nome legível para a restrição. Esse campo pode ter no máximo 200 caracteres.

• DESCRIPTION: uma descrição legível da restrição a ser exibida como mensagem de erro quando a política é violada. Esse campo pode ter no máximo 2000 caracteres.

Para saber 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, faça a configuração necessária para disponibilizá-la para as políticas da organização. Para configurar uma restrição personalizada, use o comando gcloud org-policies set-custom-constraint:

gcloud org-policies set-custom-constraint CONSTRAINT_PATH

Substitua CONSTRAINT_PATH pelo caminho completo para o 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 lista de políticas da organização do Google Cloud . Para verificar a existência da restrição personalizada, use o comando gcloud org-policies list-custom-constraints:

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

Substitua ORGANIZATION_ID pelo ID do recurso da organização. Para mais informações, consulte Como visualizar políticas da organização.

Aplicar uma política personalizada da organização

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 do Google Cloud .

Console

1. No console do Google Cloud , acesse a página Políticas da organização.

   Acessar a página Políticas da organização

2. No seletor de projetos, selecione o projeto em que você quer definir a política da organização.
3. Na lista da página Políticas da organização, selecione uma restrição para acessar a página Detalhes da política associada.
4. Para configurar a política da organização nesse recurso, clique em Gerenciar política.
5. Na página Editar política, selecione Substituir a política do recurso pai.
6. Clique em Adicionar regra.
7. Na seção Aplicação, escolha entre ativar ou desativar a aplicação dessa política da organização.
8. 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 para que a política seja salva. Para mais informações, consulte Como configurar uma política da organização com tags.
9. Clique em Testar mudanças para simular o efeito da política da organização. A simulação da 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.
10. 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.

gcloud

Para criar uma política da organização com regras booleanas, crie um arquivo YAML para a política que faça referência à restrição:

      name: projects/PROJECT_ID/policies/CONSTRAINT_NAME       spec:         rules:         - enforce: true     

Substitua:

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

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 para o 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 política personalizada que restringe o tipo de máquina.

Antes de começar, você precisa saber o seguinte:

• O ID da sua organização.
• Um ID de projeto

Criar a restrição

1. Salve o seguinte arquivo como constraint-custom-job.yaml:

   name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictMachineType resourceTypes: - aiplatform.googleapis.com/CustomJob methodTypes: - CREATE condition: "resource.jobSpec.workerPoolSpecs.exists(spec, spec.machineSpec.machineType != \"n1-standard-4\")" actionType: DENY displayName: Restrict machine type custom training jobs description: All new custom training jobs must use n1-standard-4 machines. 

   Isso define uma restrição em que cada novo job de treinamento personalizado precisa usar o tipo de máquina n1-standard-4. Se um job de treinamento personalizado não usar esse tipo de máquina, a criação dele será negada.

2. Aplique a restrição:

   gcloud org-policies set-custom-constraint ~/constraint-custom-job.yaml 

3. Verifique se a restrição existe:

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

   O resultado será o seguinte:

   CUSTOM_CONSTRAINT                            ACTION_TYPE  METHOD_TYPES   RESOURCE_TYPES                                     DISPLAY_NAME custom.restrictMachineType                   DENY         CREATE         aiplatform.googleapis.com/CustomJob                Restrict machine type custom training jobs ... 

Criar a política

1. Salve o seguinte arquivo como policy-deny-custom-job.yaml:

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

   Substitua PROJECT_ID pelo ID do seu projeto.

2. Aplique a política:

   gcloud org-policies set-policy ~/policy-deny-custom-job.yaml 

3. Verifique se a política existe:

   gcloud org-policies list --project=PROJECT_ID 

   O resultado será assim:

   CONSTRAINT                          LIST_POLICY  BOOLEAN_POLICY        ETAG custom.restrictMachineType          -            SET                   CLj9zMIGEIiS3K4D- 

Depois de aplicar a política, aguarde cerca de dois minutos para que o Google Cloud comece a aplicar a política.

Testar a política

Tente criar um job de treinamento personalizado da Vertex AI com um tipo de máquina restrito:

gcloud ai custom-jobs create \   --region=LOCATION \   --display-name=JOB_NAME \   --worker-pool-spec=machine-type=n1-standard-8,replica-count=REPLICA_COUNT,container-image-uri=CUSTOM_CONTAINER_IMAGE_URI 

A saída é esta:

Operation denied by org policy on resource 'projects/PROJECT_ID/locations/LOCATION': ["customConstraints/custom.restrictMachineType": "All new custom training jobs must use n1-standard-4 machines."] 

Exemplos de políticas personalizadas da organização para casos de uso comuns

Confira na tabela a sintaxe de algumas restrições personalizadas comuns.

Descrição

Sintaxe da restrição

Restringir o tipo de máquina para jobs de treinamento personalizado da Vertex AI

name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictMachineType resourceTypes: - aiplatform.googleapis.com/CustomJob methodTypes: - CREATE condition: "resource.jobSpec.workerPoolSpecs.exists(spec, spec.machineSpec.machineType != "n1-standard-4")" actionType: DENY displayName: Restrict machine type custom training jobs description: All new custom training jobs must use n1-standard-4 machines.

Recursos compatíveis com a Vertex AI

A tabela a seguir lista os recursos da Vertex AI que podem ser referenciados em restrições personalizadas.

A seguir

• Saiba mais sobre o Serviço de políticas da organização.
• Saiba como criar e gerenciar políticas da organização.
• Confira a lista completa de restrições de política da organização gerenciadas.