Gerenciar recursos usando restrições personalizadas

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 :

• networkservices.googleapis.com/LbRouteExtension
• networkservices.googleapis.com/LbTrafficExtension

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 com extensões de serviço para fazer o seguinte:

• Permitir apenas um tipo de esquema de balanceamento de carga
• Não permitir determinados tipos de eventos compatíveis
• Restringir o número de cadeias e extensões

Antes de começar

Verifique qual é o ID da organização.

Instale e inicialize a Google Cloud CLI.

1. Install the Google Cloud CLI.

2. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

3. To initialize the gcloud CLI, run the following command:

   gcloud init

Funções exigidas

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.

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

Console

Para criar uma restrição personalizada, faça o seguinte:

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. Clique em Restrição personalizada.
4. Na caixa Nome de exibição, insira um nome legível para a restrição. Esse nome é usado em mensagens de erro e pode ser usado para identificação e depuração. Não use PII ou dados sensíveis em nomes de exibição, porque eles podem ser expostos em mensagens de erro. Esse campo pode ter até 200 caracteres.
5. Na caixa ID da restrição, insira o nome que você quer para a nova restrição personalizada. Uma restrição personalizada só pode conter letras (maiúsculas e minúsculas) ou números, por exemplo, custom.disableGkeAutoUpgrade. Esse campo pode conter até 70 caracteres, sem contar o prefixo (custom.), por exemplo, organizations/123456789/customConstraints/custom. Não inclua PII ou dados sensíveis no ID da restrição, porque eles podem ser expostos em mensagens de erro.
6. Na caixa Descrição, insira uma descrição legível da restrição. Essa descrição é usada como uma mensagem de erro quando a política é violada. Inclua detalhes sobre o motivo da violação e como resolver o problema. Não inclua PII ou dados sensíveis na descrição, porque eles podem ser expostos em mensagens de erro. Esse campo pode conter até 2.000 caracteres.
7. Na caixa Tipo de recurso, selecione o nome do recurso REST do Google Cloud que contém o objeto e o campo que você quer restringir. Por exemplo, container.googleapis.com/NodePool. A maioria dos tipos de recursos aceita até 20 restrições personalizadas. Se você tentar criar mais restrições personalizadas, a operação vai falhar.
8. Em Método de aplicação, selecione se quer aplicar a restrição em um método REST CREATE ou em ambos os métodos CREATE e UPDATE. Se você aplicar a restrição com o método UPDATE em um recurso que a viola, as mudanças nesse recurso serão bloqueadas pela política da organização, a menos que a mudança resolva a violação.

Nem todos os serviços do Google Cloud aceitam os dois métodos. Para ver os métodos compatíveis com cada serviço, encontre o serviço em Serviços compatíveis.

9. Para definir uma condição, clique em Editar condição.
1. No painel Adicionar condição, crie uma condição de CEL que se refira a um recurso de serviço compatível, por exemplo, resource.management.autoUpgrade == false. Esse campo pode ter até 1.000 caracteres. Para detalhes sobre o uso da CEL, consulte Common Expression Language. Para mais informações sobre os recursos de serviço que você pode usar nas restrições personalizadas, consulte Serviços compatíveis com restrição personalizada.
2. Clique em Salvar.
10. Em Ação, selecione se você quer permitir ou negar o método avaliado quando a condição é atendida.

A ação de negação significa que a operação para criar ou atualizar o recurso será bloqueada se a condição for avaliada como verdadeira.

A ação de permissão significa que a operação para criar ou atualizar o recurso só é permitida se a condição for avaliada como verdadeira. Todos os outros casos, exceto os listados explicitamente na condição, estão bloqueados.

11. Clique em Criar restrição.

Quando você digita um valor em cada campo, a configuração YAML equivalente à restrição personalizada aparece à direita.

gcloud

1. 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 sua nova restrição personalizada. Uma restrição personalizada só pode conter letras (maiúsculas e minúsculas) ou números, por exemplo, custom.LbTrafficExtensionDenyBodyEvents. Esse campo pode ter até 70 caracteres.
• RESOURCE_NAME: o nome totalmente qualificado do recurso Google Cloud que contém o objeto e o campo que você quer restringir. Por exemplo, networkservices.googleapis.com/LbTrafficExtension.
• CONDITION: uma condição de CEL gravada em uma representação de um recurso de serviço compatível. Esse campo pode conter até 1.000 caracteres. Por exemplo, "resource.extensionChains.exists(chain, chain.extensions.exists(extension, extension.supportedEvents.exists(event, event.contains("BODY"))))".

Para mais informações sobre os recursos disponíveis para gravação de condições, consulte Recursos compatíveis.

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

A ação "permitir" significa que, se a condição for avaliada como verdadeira, a operação para criar ou atualizar o recurso será permitida. Isso também significa que todos os outros casos, exceto o listado explicitamente na condição, estão bloqueados.

A ação de negação significa que, se a condição for avaliada como verdadeira, a operação para criar ou atualizar o recurso será bloqueada.

• DISPLAY_NAME: um nome legível para a restrição. Esse campo pode ter até 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 pode conter até 2.000 caracteres.
2. 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 do arquivo de restrição personalizada. Por exemplo, /home/user/customconstraint.yaml.

Depois que a operação for concluída, 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 .

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

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 uma regra.
7. Na seção Aplicação, selecione se essa política da organização é aplicada ou nã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 definir uma política da organização com tags.
9. Clique em Testar mudanças para simular o efeito da política da organização. Para mais informações, consulte Testar mudanças na política da organização com o Simulador de política.
10. Para aplicar a política da organização no modo de teste, clique em Definir política de simulação. Para mais informações, consulte Criar uma política da organização no modo de simulação.
11. Depois de verificar se a política da organização no modo de simulação funciona como esperado, clique em Definir política para definir a política ativa.

gcloud

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

dryRunSpec:
  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.LbTrafficExtensionDenyBodyEvents.
2. Para aplicar a política da organização no modo de teste, execute o seguinte comando com a flag dryRunSpec:

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

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.

3. Depois de verificar se a política da organização no modo de simulação funciona conforme o esperado, defina a política ativa com o comando org-policies set-policy e a flag spec:

gcloud org-policies set-policy POLICY_PATH --update-mask=spec

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 personalizada que impede que as extensões de tráfego do Cloud Load Balancing modifiquem o corpo da solicitação ou da resposta.

Criar a restrição

1. Para definir a restrição, crie um arquivo chamado constraint-deny-body-events.yaml com o seguinte conteúdo:

   name: organizations/ORGANIZATION_ID/customConstraints/custom.LbTrafficExtensionDenyBodyEvents
   resourceTypes:
   - networkservices.googleapis.com/LbTrafficExtension
   methodTypes:
   - CREATE
   - UPDATE
   condition: resource.extensionChains.exists(chain, chain.extensions.exists(extension, extension.supportedEvents.exists(event, event.contains("BODY"))))
   actionType: DENY
   displayName: Deny body modifications by traffic extensions.
   description: Deny traffic extensions that are called for REQUEST_BODY or RESPONSE_BODY.
   

   Substitua ORGANIZATION_ID pelo ID da organização.

2. Aplique a restrição:

   gcloud org-policies set-custom-constraint ~/constraint-deny-body-events.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.LbTrafficExtensionDenyBodyEvents  DENY         CREATE,UPDATE    networkservices.googleapis.com/LbTrafficExtension   Deny body modifications by traffic extensions.
   ...
   

Criar a política

1. Crie um arquivo chamado policy-deny-body-events.yaml com a seguinte política:

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

   Substitua PROJECT_ID pela ID do seu projeto.

2. Aplique a política:

   gcloud org-policies set-policy ~/policy-deny-body-events.yaml
   

3. Verifique se a política existe:

   gcloud org-policies list --project=PROJECT_ID
   

   O resultado será o seguinte:

   CONSTRAINT                               LIST_POLICY    BOOLEAN_POLICY    ETAG
   custom.LbTrafficExtensionDenyBodyEvents  -              SET               COCsm5QGENiXi2E=
   

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

Teste a política criando uma extensão de tráfego do Cloud Load Balancing com o campo supportedEvents definido como REQUEST_BODY:

gcloud service-extensions lb-traffic-extensions import TRAFFIC_EXTENSION_NAME \
    --source=PATH_TO_EXTENSION_FILE \
    --location=LOCATION_ID

Substitua:

• TRAFFIC_EXTENSION_NAME: um nome exclusivo para a extensão de tráfego
• PATH_TO_EXTENSION_FILE: o caminho do arquivo de extensão
• LOCATION_ID: o local do projeto.

O resultado será o seguinte:

ERROR: (gcloud.service-extensions.lb-traffic-extensions.import)
FAILED_PRECONDITION: Operation denied by org policy on resource
'projects/123456/locations/global/lbTrafficExtensions/trafficExtension1':
["customConstraints/custom.prohibitBodyModifyingEvents":
"Deny traffic extensions that are called for REQUEST_BODY or RESPONSE_BODY."].

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

Exigir que todas as extensões de rota do Cloud Load Balancing tenham o esquema de balanceamento de carga INTERNAL_MANAGED

name: organizations/ORGANIZATION_ID/customConstraints/custom.lbRouteExtensionInternalManaged resourceTypes: - networkservices.googleapis.com/LbRouteExtension methodTypes: - CREATE - UPDATE condition: "resource.loadBalancingScheme == INTERNAL_MANAGED" actionType: ALLOW displayName: Require all Cloud Load Balancing route extensions to have the INTERNAL_MANAGED load balancing scheme description: All Cloud Load Balancing route extensions must have the INTERNAL_MANAGED load balancing scheme.

Recursos compatíveis com as extensões de serviço

A tabela a seguir lista os recursos das extensões de serviço que podem ser referenciados em restrições personalizadas.

Recurso	Campo
networkservices.googleapis.com/LbRouteExtension	resource.description
	resource.extensionChains.extensions.authority
	resource.extensionChains.extensions.failOpen
	resource.extensionChains.extensions.forwardHeaders
	resource.extensionChains.extensions.metadata
	resource.extensionChains.extensions.name
	resource.extensionChains.extensions.supportedEvents
	resource.extensionChains.extensions.timeout
	resource.extensionChains.name
	resource.loadBalancingScheme
	resource.metadata
	resource.name
networkservices.googleapis.com/LbTrafficExtension	resource.description
	resource.extensionChains.extensions.authority
	resource.extensionChains.extensions.failOpen
	resource.extensionChains.extensions.forwardHeaders
	resource.extensionChains.extensions.metadata
	resource.extensionChains.extensions.name
	resource.extensionChains.extensions.supportedEvents
	resource.extensionChains.extensions.timeout
	resource.extensionChains.name
	resource.loadBalancingScheme
	resource.metadata
	resource.name

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.