Gerenciar recursos do BigQuery usando 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 Trusted Cloud by S3NS :

  • bigquery.googleapis.com/Dataset

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 Trusted 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 recursosTrusted Cloud e aos descendentes desses recursos na hierarquia de recursosTrusted Cloud by S3NS . É 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 Trusted 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, Trusted 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

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. Make sure that billing is enabled for your Trusted Cloud project.

  3. Install the Google Cloud CLI.

  4. Configure the gcloud CLI to use your federated identity.

    For more information, see Sign in to the gcloud CLI with your federated identity.

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

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

    7. 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 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
    • Para criar ou atualizar um conjunto de dados do BigQuery:
      • bigquery.datasets.create no recurso do projeto
      • bigquery.datasets.get no recurso do projeto
      • bigquery.datasets.list no recurso do projeto
      • bigquery.datasets.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.enforceDatasetId. O comprimento máximo desse campo é de 70 caracteres.

    • RESOURCE_NAME: o nome totalmente qualificado do recursoTrusted Cloud que contém o objeto e o campo que você quer restringir. Por exemplo, bigquery.googleapis.com/Dataset.

    • 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, "datasetReference.datasetId.startsWith('test')".

    • 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 Trusted Cloud by S3NS 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 com referência a ela e, em seguida, aplique essa política da organização a um recurso Trusted Cloud by S3NS .

    Console

    1. No console Trusted 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 alterações 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 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 com regras booleanas, crie um arquivo YAML de 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.enforceDatasetId.

    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 proíbe todos os novos IDs de conjunto de dados em um projeto específico de começar com test.

    Antes de começar, você precisa ter:

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

    Crie a restrição.

    Para criar uma restrição personalizada, siga estas etapas:

    1. Crie o seguinte arquivo YAML e salve-o como constraint-enforce-datasetId.yaml:

      name: organizations/ORGANIZATION_ID/customConstraints/custom.enforceDatasetId
resourceTypes:
- bigquery.googleapis.com/Dataset
methodTypes:
- CREATE
condition: "datasetReference.datasetId.startsWith('test')"
actionType: DENY
displayName: Reject test datasets
description: All new datasets can't begin with 'test'.

      SubstituaORGANIZATION_ID pelo ID da organização.

      Isso define uma restrição em que, para cada novo conjunto de dados, se o ID do conjunto de dados começar com test, a operação será negada.

    2. Aplique a restrição:

      gcloud org-policies set-custom-constraint ~/constraint-enforce-datasetId

    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.enforceDatasetId                 DENY         CREATE         bigquery.googleapis.com/Dataset    Reject test datasets
...

    Crie a política

    Agora crie uma política e aplique à restrição personalizada que você criou.

    1. Salve o seguinte arquivo como policy-enforce-datasetId.yaml:

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

      Substitua PROJECT_ID pela ID do seu projeto.

    2. Aplique a política:

      gcloud org-policies set-policy ~/policy-enforce-datasetId.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.enforceDatasetId     -              SET               COCsm5QGENiXi2E=

    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

    Tente criar um conjunto de dados do BigQuery no projeto:

    bq --location=US mk -d \
    --default_table_expiration 3600 \
    --description "This is my dataset." \
    testdataset

    A saída é esta:

    Operation denied by custom org policies: ["customConstraints/custom.enforceDatasetId": "All new datasets can't begin with 'test'."]

    Recursos com suporte do BigQuery

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

    Recurso Campo
    bigquery.googleapis.com/Dataset resource.datasetReference.datasetId
    resource.defaultCollation
    resource.defaultEncryptionConfiguration.kmsKeyName
    resource.defaultPartitionExpirationMs
    resource.defaultRoundingMode
    resource.defaultTableExpirationMs
    resource.description
    resource.externalCatalogDatasetOptions.defaultStorageLocationUri
    resource.externalCatalogDatasetOptions.parameters
    resource.externalDatasetReference.connection
    resource.externalDatasetReference.externalSource
    resource.friendlyName
    resource.isCaseInsensitive
    resource.linkedDatasetSource.sourceDataset.datasetId
    resource.location
    resource.maxTimeTravelHours
    resource.storageBillingModel

    A seguir