Usar políticas da organização 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 :

  • bigtableadmin.googleapis.com/AppProfile
  • bigtableadmin.googleapis.com/Backup
  • bigtableadmin.googleapis.com/Cluster
  • bigtableadmin.googleapis.com/Instance
  • bigtableadmin.googleapis.com/Table

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,o 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.

Limitações

As políticas personalizadas da organização ainda não são aplicadas em:

Antes de começar

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

  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Make sure that billing is enabled for your Google Cloud project.

  4. Install the Google Cloud CLI.

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

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

    gcloud init

  7. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  8. Make sure that billing is enabled for your Google Cloud project.

  9. Install the Google Cloud CLI.

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

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

    gcloud init
  12. Certifique-se de conhecer o ID da organização.

    13. Funções exigidas

    Para receber as permissões necessárias para 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.requireDeletionProtectionOnTable. 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, bigtableadmin.googleapis.com/bigtableadmin.googleapis.com/Table.

    • 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.deletionProtection == true.

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

    1. No console 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. 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.
    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 da 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.requireDeletionProtectionOnTable.

    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 todas as novas tabelas em um projeto específico tenham a proteção contra exclusão ativada.

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

    • O código da sua organização.
    • Um ID do projeto

    Crie a restrição.

    1. Salve o seguinte arquivo como constraint-require-table-deletion-protection.yaml:

      name: organizations/ORGANIZATION_ID/customConstraints/custom.requireDeletionProtectionOnTable
resourceTypes:
- bigtableadmin.googleapis.com/Table
methodTypes:
- CREATE
condition: "resource.deletionProtection == true"
actionType: ALLOW
displayName: Only allow tables with deletion_protection set to true.
description: All tables must have deletion_protection set to true.

      Isso define uma restrição em que cada tabela precisa ter deletion_protection definido como "true".

    2. Aplique a restrição:

      gcloud org-policies set-custom-constraint constraint-require-table-deletion-protection.yaml

    3. Verifique se a restrição existe:

      gcloud org-policies describe-custom-constraint custom.requireDeletionProtectionOnTable  --organization=ORGANIZATION_ID

      A saída vai mostrar a restrição que você acabou de estabelecer.

    Crie a política

    1. Defina PROJECT_ID como o ID do projeto e salve o arquivo a seguir como policy-require-table-deletion-protection.yaml:

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

    2. Aplique a política:

      
gcloud org-policies set-policy policy-require-table-deletion-protection.yaml

    3. Verifique se a política existe:

      gcloud org-policies describe custom.requireDeletionProtectionOnTable --project=PROJECT_ID

      A saída vai mostrar a política que você acabou de estabelecer.

    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

    gcloud bigtable tables create TABLE_ID --instance=INSTANCE_NAME --column-families="my-family" --no-deletion-protection

    A criação da tabela falha devido à restrição que exige a ativação da proteção contra exclusão para todas as novas tabelas.

    O resultado será assim:

    Operation denied by custom org policy: ["customConstraints/custom.requireDeletionProtectionOnTable": All tables must have deletion_protection set to true.]

    Para corrigir o erro anterior, crie a tabela com a proteção contra exclusão ativada. Confira o exemplo a seguir:

    gcloud bigtable tables create TABLE_ID --instance=INSTANCE_NAME --column-families="my-family" --deletion-protection

    A tabela é criada com a proteção contra exclusão ativada.

    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 perfis de app que não têm transações de linha única ativadas 
    name: organizations/ORGANIZATION_ID/customConstraints/custom.denyAppProfilesWithoutTransactionalWrites
resourceTypes:
- bigtableadmin.googleapis.com/AppProfile
methodTypes:
- CREATE
- UPDATE
condition: "resource.singleClusterRouting.allowTransactionalWrites != true"
actionType: DENY
displayName: Deny app profiles where AllowTransactionalWrites is not enabled.
        description: All app profiles must have AllowTransactionalWrites enabled.
    Forçar a criação de clusters somente nos Estados Unidos 
      name: organizations/ORGANIZATION_ID/customConstraints/custom.requireClustersToBeInUS
  resourceTypes:
  - bigtableadmin.googleapis.com/Cluster
  methodTypes:
  - CREATE
  condition: "resource.location.contains('/locations/us-')"
  actionType: ALLOW
  displayName: Require all clusters to be in the US.
  description: Clusters must be in the US.

    Recursos compatíveis com o Bigtable

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

    Recurso Campo
    bigtableadmin.googleapis.com/AppProfile resource.dataBoostIsolationReadOnly.computeBillingOwner
    resource.description
    resource.multiClusterRoutingUseAny.clusterIds
    resource.name
    resource.singleClusterRouting.allowTransactionalWrites
    resource.singleClusterRouting.clusterId
    resource.standardIsolation.priority
    bigtableadmin.googleapis.com/Backup resource.backupType
    resource.expireTime
    resource.hotToStandardTime
    resource.name
    resource.sourceTable
    bigtableadmin.googleapis.com/Cluster resource.clusterConfig.clusterAutoscalingConfig.autoscalingLimits.maxServeNodes
    resource.clusterConfig.clusterAutoscalingConfig.autoscalingLimits.minServeNodes
    resource.clusterConfig.clusterAutoscalingConfig.autoscalingTargets.cpuUtilizationPercent
    resource.clusterConfig.clusterAutoscalingConfig.autoscalingTargets.storageUtilizationGibPerNode
    resource.defaultStorageType
    resource.encryptionConfig.kmsKeyName
    resource.location
    resource.name
    resource.nodeScalingFactor
    resource.serveNodes
    bigtableadmin.googleapis.com/Instance resource.displayName
    resource.name
    bigtableadmin.googleapis.com/Table resource.automatedBackupPolicy.frequency
    resource.automatedBackupPolicy.retentionPeriod
    resource.changeStreamConfig.retentionPeriod
    resource.columnFamilies[*].gcRule.maxAge
    resource.columnFamilies[*].gcRule.maxNumVersions
    resource.columnFamilies[*].valueType.bytesType.encoding.raw.escapeNulls
    resource.columnFamilies[*].valueType.int64Type.encoding.bigEndianBytes.bytesType.encoding.raw.escapeNulls
    resource.columnFamilies[*].valueType.stringType.encoding.utf8Bytes.nullEscapeChar
    resource.columnFamilies[*].valueType.structType.encoding.delimitedBytes.delimiter
    resource.columnFamilies[*].valueType.structType.fields.fieldName
    resource.columnFamilies[*].valueType.timestampType.encoding.unixMicrosInt64.bigEndianBytes.bytesType.encoding.raw.escapeNulls
    resource.deletionProtection
    resource.name

    A seguir