Gerenciar recursos com 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 :

  • cloudresourcemanager.googleapis.com/Project
  • cloudresourcemanager.googleapis.com/Folder

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 da organização, de pastas ou de projetos.

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

As políticas da organização são herdadas por padrão 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 todos os projetos dessa pasta. Para saber mais sobre esse comportamento e como alterá-lo, consulte Regras de avaliação de hierarquia.

Vantagens

Para segurança, compliance e governança, é possível usar políticas personalizadas da organização das seguintes maneiras:

  • Governe os padrões de nomenclatura do projeto: é possível criar uma restrição personalizada no ID do projeto. Por exemplo, em uma pasta de recursos de staging, permita operações de criação e atualização em um projeto somente se o ID do projeto começar com staging-.
  • Restringir a mutação de projetos e pastas seguros: é possível criar uma restrição personalizada para negar atualizações de projetos e pastas se o pai for uma pasta ou organização segura.

Limitações

  • As operações de criação ou atualização em recursos do App Script, do Firebase ou da Contact Center Solution podem falhar se uma restrição personalizada tiver sido definida em pastas ou projetos. Nesses casos, verifique as condições nas restrições personalizadas que estão causando a falha. Verifique se essas restrições foram atualizadas e tente de novo.
  • Como ocorre com todas as restrições de política da organização, as alterações de política não se aplicam retroativamente às instâncias atuais.
  • A criação de projetos e pastas no console Google Cloud pode não fornecer o motivo específico da mensagem de erro PERMISSION_DENIED. Para confirmar detalhes sobre as restrições específicas que causaram a falha, verifique os registros de auditoria.

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.

    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.allowProjectForXDepartmentNameOnly. 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, cloudresourcemanager.googleapis.com/Project.

    • 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.projectId.startsWith(\"XDepartment\")".

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

    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 exige que todos os IDs de projeto comecem com dev_ na sua organização.

    Antes de começar, identifique o ID da sua organização.

    Crie a restrição.

    1. Para definir uma restrição que nega todas as criações e atualizações de projetos se a ID do projeto não começar com dev_, crie o constraint-allow-dev-projects.yaml com o seguinte conteúdo:

      name: organizations/ORGANIZATION_ID/customConstraints/custom.allowProjectForDevIdOnly
resourceTypes:
- cloudresourcemanager.googleapis.com/Project
methodTypes:
- CREATE
- UPDATE
condition: "resource.projectId.startsWith(\"dev_\")"
actionType: ALLOW
displayName: Allow dev_ projects
description: All projects in the org should start with dev_.

      SubstituaORGANIZATION_ID pelo ID da organização.

    2. Aplique a restrição:

      gcloud org-policies set-custom-constraint ~/constraint-allow-dev-projects.yaml

    3. Verifique se a restrição existe:

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

      O resultado será assim:

      CUSTOM_CONSTRAINT                ACTION_TYPE  METHOD_TYPES   RESOURCE_TYPES                                      DISPLAY_NAME
custom.allowProjectForDevIdOnly  ALLOW        CREATE,UPDATE  cloudresourcemanager.googleapis.com/Project   Allow dev_ projects
...

    Crie a política

    1. Crie o arquivo policy-enable-dev-projects.yaml com a seguinte política:

      Name: organizations/ORGANIZATION_ID/policies/custom.allowProjectForDevIdOnly
spec:
  rules:
  - enforce: true

      SubstituaORGANIZATION_ID pelo ID da organização.

    2. Aplique a política:

      gcloud org-policies set-policy ~/policy-enable-dev-projects.yaml

    3. Verifique se a política existe:

      gcloud org-policies list --organization=ORGANIZATION_ID

      O resultado será assim:

      CONSTRAINT                        LIST_POLICY    BOOLEAN_POLICY    ETAG
custom.allowProjectForDevIdOnly   -              SET               COCsm5QGENiXi2E=

    Depois de aplicar a política, Google Cloud leva cerca de dois minutos para começar a aplicá-la.

    Testar a política

    Crie um projeto com ID do projeto sampleDemoProject na organização:

    gcloud projects create sampleDemoProject \
    --organization=ORGANIZATION_ID

    A saída é esta:

    PERMISSION_DENIED: The caller does not have permission

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

    A seguinte tabela mostra a sintaxe de algumas restrições personalizadas para casos de uso comuns:

    Descrição Sintaxe da restrição
    Negar a criação de novos projetos na pasta 1234 (secure_admin_folder). 
          name: organizations/ORGANIZATION_ID/customConstraints/custom.disableNewProjectInSecureAdminFolder
      resourceTypes:
      - cloudresourcemanager.googleapis.com/Project
      methodTypes:
      - CREATE
      condition: "resource.parent == "organizations/1234""
      actionType: DENY
      displayName: Disable new project creation in the secure admin folder
      description: Do not allow creation of new projects in the secure folders.
    Desative a criação de uma pasta dentro de outra para controlar a profundidade da árvore de hierarquia de recursos. 
          name: organizations/ORGANIZATION_ID/customConstraints/custom.disableFolderCreation
      resourceTypes:
      - cloudresourcemanager.googleapis.com/Folder
      methodTypes:
      - CREATE
      condition: "resource.parent.startsWith("folders")"
      actionType: DENY
      displayName: Disable creation of a folder inside another folder
      description: Do not allow creation of a folder within another folder when
                   the resource hierarchy is set to a maximum value of 1.

    Recursos compatíveis com o Resource Manager

    A tabela a seguir lista os recursos do Resource Manager que podem ser referenciados em restrições personalizadas.

    Recurso Campo
    cloudresourcemanager.googleapis.com/Folder resource.displayName
    resource.parent
    cloudresourcemanager.googleapis.com/Project resource.parent
    resource.projectId

    A seguir