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 Trusted Cloud by S3NS :

  • bigquerydatatransfer.googleapis.com/TransferConfig

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 Trusted 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 doTrusted Cloud e aos elementos que descendem dele na hierarquia de recursos doTrusted Cloud by S3NS . É 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 Trusted 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 Trusted 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

É possível usar uma política da organização personalizada para permitir ou negar operações específicas em 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 vai falhar, e um erro será retornado ao autor da chamada.

Limitações

  • Para especificar uma origem de dados na sua restrição personalizada, use o campo resource.dataSourceId com o valor da origem. Para uma lista de valores compatíveis com resource.dataSourceId, chame o método dataSources.list.

Antes de começar

  1. In the Trusted Cloud console, on the project selector page, select or create a Trusted Cloud project.

    Go to project selector

  2. Verify that billing is enabled for your Trusted Cloud project.

  3. Install the Google Cloud CLI.

  4. Configure a gcloud CLI para usar sua identidade federada.

    Para mais informações, consulte Fazer login na gcloud CLI com sua identidade federada.

  5. Para inicializar a gcloud CLI, execute o seguinte comando: 

    gcloud init
  6. Verifique qual é o ID da organização.

    7. Funções exigidas

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

    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 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.dtsEnableEmailNotification. Esse campo pode ter no máximo 70 caracteres.

    • RESOURCE_NAME: o nome totalmente qualificado do recurso doTrusted 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 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.emailPreferences.enableFailureEmail == true.

    • 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 Trusted Cloud by S3NS . 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 Trusted Cloud by S3NS .

    Console

    1. No console do Trusted 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.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 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 exigem 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 não estiverem ativadas, 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 Trusted 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 seguinte tabela mostra a sintaxe de algumas restrições personalizadas para casos de uso comuns:

    Descrição Sintaxe da restrição
    Não permitir 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 o agendamento automático 
        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 compatíveis com o 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