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:

  • bigquerydatatransfer.googleapis.com/TransferConfig

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 serviço de políticas da organização do Google Cloud 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 aos recursos do Google Cloud e aos descendentes desses recursos na Hierarquia de recursos do Google 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 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 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.

Vantagens

É possível usar uma política de organização personalizada para permitir ou negar operações específicas nas configurações de transferência do serviço de transferência de dados do BigQuery para atender aos requisitos de conformidade e segurança da sua organização. Se uma solicitação para criar ou atualizar uma configuração de transferência não atender às restrições personalizadas definidas pela política da organização, a solicitação falhará e um erro será retornado ao autor da chamada.

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. To initialize the gcloud CLI, run the following command: 

    gcloud init

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

    Go to project selector

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

  8. Install the Google Cloud CLI.

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

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

Funções exigidas

Para conseguir as permissões necessárias para gerenciar as políticas da organização, peça ao administrador para conceder a você os papéis do IAM a seguir:

Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

Esses papéis predefinidos contêm as permissões necessárias para gerenciar políticas da organizações. Para conferir as permissões exatas necessárias, expanda a seção Permissões necessárias:

Permissões necessárias

As permissões a seguir são necessárias para gerenciar as políticas da organização:

  • orgpolicy.* no recurso da organização
  • Crie ou atualize uma configuração de transferência do serviço de transferência de dados do BigQuery:
    • bigquery.transfers.get no recurso do projeto
    • bigquery.transfers.update no recurso do projeto

Essas permissões também podem ser concedidas com funções personalizadas 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 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.dtsEnableEmailNotification. O comprimento máximo desse campo é de 70 caracteres.

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

  • 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.emailPreferences.enableFailureEmail == 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 políticas da organização do Google Cloud. 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 depois aplique essa política da organização a um recurso do 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.dtsEnableEmailNotification.

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 as notificações por e-mail sejam ativadas para todas as novas configurações de transferência em um projeto específico.

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-dts-enable-email.yaml:

    name: organizations/ORGANIZATION_ID/customConstraints/custom.dtsEnableEmailNotification
resourceTypes:
- bigquerydatatransfer.googleapis.com/TransferConfig
methodTypes:
- CREATE
condition: resource.emailPreferences.enableFailureEmail == true
actionType: ALLOW
displayName: The BigQuery Data Transfer Service always enables email notications
description: The BigQuery Data Transfer Service always enables email notications on data transfer failures.

    Substitua ORGANIZATION_ID pelo ID da organização.

    Isso define uma restrição que verifica se as notificações por e-mail estão ativadas para uma nova configuração de transferência. Se eles não estiverem ativados, a operação será negada.

  2. Aplique a restrição:

    gcloud org-policies set-custom-constraint ~/constraint-dts-enable-email.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.dtsEnableEmailNotification  ALLOW        CREATE         bigquerydatatransfer.googleapis.com/TransferConfig  The BigQuery Data Transfer Service always enables email notications
...

Crie a política

  1. Salve o seguinte arquivo como policy-dts-enable-email.yaml:

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

    Substitua PROJECT_ID pela ID do seu projeto.

  2. Aplique a política:

    gcloud org-policies set-policy ~/policy-dts-enable-email.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.dtsEnableEmailNotification  -            SET                   CPyxlbgGENDL3tEC-

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

No projeto, tente criar uma configuração de transferência do serviço de transferência de dados do BigQuery com a notificação por e-mail desativada.

A saída é esta:

Operation denied by custom org policy: ["customConstraints/custom.dtsEnableEmailNotification": "The BigQuery Data Transfer Service always enables email notications on data transfer failures."].

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
Proibir transferências de dados do Azure Blob Storage 
    name: organizations/ORGANIZATION_ID/customConstraints/custom.denyDtsAzureTransfers
    resourceTypes:
    - bigquerydatatransfer.googleapis.com/TransferConfig
    methodTypes:
    - CREATE
    condition: resource.dataSourceId == "azure_blob_storage"
    actionType: DENY
    displayName: Deny data transfers from Azure Blob Storage to BigQuery
    description: Disallow creating data transfer configurations from Azure Blob Storage.
Sempre ativar a programação automática 
    name: organizations/ORGANIZATION_ID/customConstraints/custom.dtsNoManualSchedule
    resourceTypes:
    - bigquerydatatransfer.googleapis.com/TransferConfig
    methodTypes:
    - CREATE
    - UPDATE
    condition: resource.scheduleOptions.disableAutoScheduling == false
    actionType: ALLOW
    displayName: Transfer configurations always enable auto-scheduling
    description: Always enable auto-scheduling for BigQuery Data Transfer Service transfer configurations.
As transferências do Google Ads precisam ter uma janela de atualização de dados de mais de três dias 
    name: organizations/ORGANIZATION_ID/customConstraints/custom.dtsGoogleAdsConstraint
    resourceTypes:
    - bigquerydatatransfer.googleapis.com/TransferConfig
    methodTypes:
    - CREATE
    - UPDATE
    condition: resource.dataSourceId == "google_ads" && resource.dataRefreshWindowDays < 3
    actionType: DENY
    displayName: Google Ads transfers data refresh window must be greater than three days
    description: Disallow creating Google Ads data transfer configurations whose data refresh window is less than three days.

Recursos com suporte do serviço de transferência de dados do BigQuery

A tabela a seguir lista os recursos do serviço de transferência de dados do BigQuery que podem ser referenciados em restrições personalizadas.

Recurso Campo
bigquerydatatransfer.googleapis.com/TransferConfig resource.dataRefreshWindowDays
resource.dataSourceId
resource.destinationDatasetId
resource.disabled
resource.displayName
resource.emailPreferences.enableFailureEmail
resource.encryptionConfiguration.kmsKeyName
resource.name
resource.notificationPubsubTopic
resource.schedule
resource.scheduleOptions.disableAutoScheduling
resource.scheduleOptions.endTime
resource.scheduleOptions.startTime
resource.scheduleOptionsV2.eventDrivenSchedule.pubsubSubscription
resource.scheduleOptionsV2.timeBasedSchedule.endTime
resource.scheduleOptionsV2.timeBasedSchedule.schedule
resource.scheduleOptionsV2.timeBasedSchedule.startTime

A seguir