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 Google Cloud :

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

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 Serviço de políticas da organização 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 restrições chamado restrições que se aplicam aos recursosGoogle Cloud e aos descendentes desses recursos na hierarquia de recursosGoogle 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 fornece restrições predefinidas para vários serviços 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 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:

  • Governar 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 preparação, 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 seguras: é possível criar uma restrição personalizada para negar atualizações de projetos e pastas se a pasta mãe for uma pasta ou organização segura.

Limitações

  • As operações de criação ou atualização nos recursos do App Script, do Firebase ou da solução de contact center 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 novamente a operação com falha.
  • Como todas as restrições de política da organização, as mudanças na política não são aplicadas 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 causam a falha, confira os registros de auditoria.

Antes de começar

  • Certifique-se de conhecer o ID da organização.
  • Instale e inicialize a CLI do Google Cloud.
    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 políticas personalizadas 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 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
    - 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 precisa começar com custom. e só pode incluir letras maiúsculas, minúsculas ou números. Por exemplo, custom.allowProjectForXDepartmentNameOnly. 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, 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 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.projectId.startsWith(\"XDepartment\")".

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

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

    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 comando gcloud org-policies set-custom-constraint:
    gcloud org-policies set-custom-constraint CONSTRAINT_PATH
    Substitua 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
    Substitua 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 booleana, crie uma política da organização com referência a ela e aplique essa política da organização a um recurso Google Cloud .

    Console

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

      Acessar as 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 a restrição para acessar a página Detalhes da política dela.
    4. Para personalizar 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 editor principal.
    6. Clique em Adicionar uma regra.
    7. Na seção Aplicação, selecione se a aplicação dessa política da organização está ativada ou desativada.
    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. 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.
    9. Se essa for uma restrição personalizada, clique em Testar alterações para simular o efeito da política da organização. Para mais informações, consulte Testar alterações 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 que aplica uma restrição booleana, crie um arquivo YAML da política com 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 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 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 negue todas as criações e atualizações de projetos se o 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 o ID 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 tabela a seguir mostra a sintaxe de algumas restrições personalizadas para casos de uso comuns:

    Descrição Sintaxe de 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 com suporte do 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