Faça a gestão de recursos do Dataplex Universal Catalog com restrições personalizadas

Esta página mostra como usar restrições personalizadas do serviço de políticas da organização para restringir operações específicas nos seguintes Google Cloud recursos:

  • dataplex.googleapis.com/AspectType
  • dataplex.googleapis.com/EntryType
  • dataplex.googleapis.com/EntryGroup
  • dataplex.googleapis.com/DataScan
  • dataplex.googleapis.com/MetadataJob

Para saber mais sobre a política de organização, consulte o artigo Políticas de organização personalizadas.

Acerca das políticas e restrições da organização

O Google Cloud serviço de políticas da organização dá-lhe um controlo centralizado e programático sobre os recursos da sua organização. Enquanto administrador de políticas da organização, pode definir uma política da organização, que é um conjunto de restrições denominadas restrições que se aplicam aGoogle Cloud recursos e descendentes desses recursos na Google Cloud hierarquia de recursos. Pode aplicar políticas da organização ao nível da organização, da pasta ou do projeto.

A política da organização oferece restrições geridas incorporadas para vários serviços Google Cloud . No entanto, se quiser um controlo mais detalhado e personalizável sobre os campos específicos que estão restritos nas políticas da sua organização, também pode criar restrições personalizadas e usar essas restrições personalizadas numa política da organização.

Herança de políticas

Por predefinição, as políticas da organização são herdadas pelos descendentes dos recursos nos quais aplica a política. Por exemplo, se aplicar uma política a uma pasta, Google Cloud aplica a política a todos os projetos na pasta. Para saber mais acerca deste comportamento e como o alterar, consulte as regras de avaliação da hierarquia.

Limitações

As restrições personalizadas e as políticas da organização não são suportadas nos seguintes recursos:

  • dataplex.googleapis.com/Lake
  • dataplex.googleapis.com/Zone
  • dataplex.googleapis.com/Task
  • dataplex.googleapis.com/Asset
  • dataplex.googleapis.com/Environment

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.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. Install the Google Cloud CLI.

  5. Se estiver a usar um fornecedor de identidade (IdP) externo, tem primeiro de iniciar sessão na CLI gcloud com a sua identidade federada.

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

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

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  8. Verify that billing is enabled for your Google Cloud project.

  9. Install the Google Cloud CLI.

  10. Se estiver a usar um fornecedor de identidade (IdP) externo, tem primeiro de iniciar sessão na CLI gcloud com a sua identidade federada.

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

    gcloud init
  12. Certifique-se de que sabe o seu ID da organização.
  13. Funções necessárias

    Para receber as autorizações de que precisa para gerir políticas da organização personalizadas, peça ao seu administrador que lhe conceda a função de IAM de administrador de políticas da organização (roles/orgpolicy.policyAdmin) no recurso da organização. Para mais informações sobre a atribuição de funções, consulte o artigo Faça a gestão do acesso a projetos, pastas e organizações.

    Também pode conseguir as autorizações necessárias através de funções personalizadas ou outras funções predefinidas.

    Crie uma restrição personalizada

    Uma restrição personalizada é definida num ficheiro YAML pelos recursos, métodos, condições e ações suportados pelo serviço no qual está a aplicar a política da organização. As condições para as restrições personalizadas são definidas através do Idioma de expressão comum (IEC). Para mais informações sobre como criar condições em restrições personalizadas através da CEL, consulte a secção CEL do artigo Criar e gerir restrições personalizadas.

    Para criar uma restrição personalizada, crie um ficheiro 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 o seguinte:

    • ORGANIZATION_ID: o ID da sua organização, como 123456789.

    • CONSTRAINT_NAME: o nome que quer para a nova restrição personalizada. Uma restrição personalizada tem de começar com custom. e só pode incluir letras maiúsculas, letras minúsculas ou números. Por exemplo, custom.denyDataplexEntryGroup. O comprimento máximo deste campo é de 70 carateres.

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

    • CONDITION: uma condição CEL escrita em função de uma representação de um recurso de serviço suportado. Este campo tem um comprimento máximo de 1000 carateres. Consulte o artigo Recursos suportados para mais informações sobre os recursos disponíveis para escrever condições. Por exemplo, "resource.description.contains('invalid_name')".

    • ACTION: a ação a tomar se a condição condition for cumprida. Os valores possíveis são ALLOW e DENY.

    • DISPLAY_NAME: um nome simples para a restrição. Este campo tem um comprimento máximo de 200 carateres.

    • DESCRIPTION: uma descrição acessível da restrição a apresentar como uma mensagem de erro quando a política é violada. Este campo tem um comprimento máximo de 2000 carateres.

    Para mais informações sobre como criar uma restrição personalizada, consulte o artigo Definir restrições personalizadas.

    Configure uma restrição personalizada

    Depois de criar o ficheiro YAML para uma nova restrição personalizada, tem de o configurar para o disponibilizar para as políticas da organização na sua 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 seu ficheiro de restrições personalizado. Por exemplo, /home/user/customconstraint.yaml. Após a conclusão, as restrições personalizadas ficam disponíveis como políticas da organização na 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 sua organização. Para mais informações, consulte o artigo Ver políticas da organização.

    Aplique uma política da organização personalizada

    Pode aplicar uma restrição criando uma política da organização que a referencie e, em seguida, aplicando essa política da organização a um Google Cloud recurso.

    Consola

    1. Na Google Cloud consola, aceda à página Políticas de organização.

      Aceda às políticas da organização

    2. No seletor de projetos, selecione o projeto para o qual quer definir a política de organização.
    3. Na lista da página Políticas da organização, selecione a restrição para ver a página Detalhes da política dessa restrição.
    4. Para configurar a política da organização para este recurso, clique em Gerir política.
    5. Na página Editar política, selecione Substituir política do elemento principal.
    6. Clique em Adicionar regra.
    7. Na secção Aplicação, selecione se a aplicação desta política organizacional está ativada ou desativada.
    8. Opcional: para tornar a política de organização condicional a uma etiqueta, clique em Adicionar condição. Tenha em atenção que, se adicionar uma regra condicional a uma política da organização, tem de adicionar, pelo menos, uma regra incondicional. Caso contrário, não é possível guardar a política. Para mais informações, consulte o artigo Definir uma política de organização com etiquetas.
    9. Clique em Testar alterações para simular o efeito da política da organização. A simulação de políticas não está disponível para restrições geridas antigas. Para mais informações, consulte o artigo Teste as alterações à política da organização com o simulador de políticas.
    10. Para concluir e aplicar a política da organização, clique em Definir política. A política demora até 15 minutos a entrar em vigor.

    gcloud

    Para criar uma política da organização com regras booleanas, crie um ficheiro YAML de política que faça referência à restrição:

          name: projects/PROJECT_ID/policies/CONSTRAINT_NAME
          spec:
            rules:
            - enforce: true
        

    Substitua o seguinte:

    • PROJECT_ID: o projeto no qual quer aplicar a restrição.
    • CONSTRAINT_NAME: o nome que definiu para a restrição personalizada. Por exemplo, custom.denyDataplexEntryGroup.

    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 ficheiro YAML da política da sua organização. A política demora até 15 minutos a entrar em vigor.

    Teste a política da organização personalizada

    O exemplo seguinte cria uma restrição e uma política personalizadas que impedem os utilizadores de criar grupos de entradas num projeto específico em que a descrição do grupo de entradas contém o texto invalid_name.

    Antes de começar, tem de saber o seguinte:

    • O ID da sua organização
    • Um ID do projeto

    Crie a restrição

    1. Guarde o seguinte ficheiro como constraint-valid-entry-groups.yaml:

      name: organizations/ORGANIZATION_ID/customConstraints/custom.denyDataplexEntryGroup
      resourceTypes:
      - dataplex.googleapis.com/EntryGroup
      methodTypes:
      - CREATE
      condition: "resource.description.contains('invalid_name')"
      actionType: DENY
      displayName: Validate entry group description
      description: All new entry groups have valid descriptions.
      

      Isto define uma restrição em que, para cada novo grupo de entradas, se a descrição contiver o texto invalid_name, a operação é recusada.

    2. Aplique a restrição:

      gcloud org-policies set-custom-constraint ~/constraint-valid-entry-groups.yaml
      
    3. Verifique se a restrição existe:

      gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID
      

      O resultado é semelhante ao seguinte:

      CUSTOM_CONSTRAINT                           ACTION_TYPE  METHOD_TYPES   RESOURCE_TYPES                       DISPLAY_NAME
      custom.denyDataplexEntryGroup               DENY         CREATE         dataplex.googleapis.com/EntryGroup   Validate Entry Group description
      ...
      

    Crie a política

    1. Guarde o seguinte ficheiro como policy-deny-entry-group.yaml:

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

      Substitua PROJECT_ID pelo ID do seu projeto.

    2. Aplique a política:

      gcloud org-policies set-policy ~/policy-deny-entry-group.yaml
      
    3. Verifique se a política existe:

      gcloud org-policies list --project=PROJECT_ID
      

      O resultado é semelhante ao seguinte:

      CONSTRAINT                      LIST_POLICY    BOOLEAN_POLICY    ETAG
      custom.denyDataplexEntryGroup   -              SET               COCsm5QGENiXi2E=
      

    Depois de aplicar a política, aguarde cerca de 15 minutos para que Google Cloud comece a aplicar a política.

    Teste a política

    Experimente criar um grupo de entradas no projeto:

    gcloud dataplex entry-groups create org-policy-test \
        --project=PROJECT_ID \
        --location=LOCATION \
        --display-name=DISPLAY_NAME \
        --description='invalid_name'
    

    A operação é recusada. O resultado é o seguinte:

    Operation denied by custom org policy on resource 'projects/PROJECT_ID/locations/LOCATION/entryGroups/org-policy-test': ["customConstraints/custom.denyDataplexEntryGroup"]
    

    Exemplos de políticas da organização personalizadas para exemplos de utilização comuns

    Esta tabela fornece exemplos de sintaxe para algumas restrições personalizadas comuns.

    Descrição Sintaxe de restrição
    Exija um tipo de aspeto específico para os tipos de entradas
        name: organizations/ORGANIZATION_ID/customConstraints/custom.requireAspectTypeForEntryType
        resourceTypes:
        - dataplex.googleapis.com/EntryType
        methodTypes:
        - CREATE
        - UPDATE
        condition: "resource.requiredAspects.exists(value, value.type =="projects/PROJECT_ID/locations/LOCATION/aspectTypes/exampleAspectType")
        actionType: DENY
        displayName: All entry types require aspect type exampleAspectType
        description: All entry types require the aspect type exampleAspectType
        
    Exija uma taxa de amostragem mínima para análises de criação de perfis de dados
        name: organizations/ORGANIZATION_ID/customConstraints/custom.minimumSamplingDataScans
        resourceTypes:
        - dataplex.googleapis.com/DataScan
        methodTypes:
        - CREATE
        - UPDATE
        condition: "resource.dataProfileSpec.samplingPercent >= 20.0"
        actionType: ALLOW
        displayName: Require minimum sampling for data profiling scans
        description: All data profiling scans need at least 20% sampling rate
        

    Recursos suportados do Dataplex Universal Catalog

    A tabela seguinte apresenta os recursos do catálogo universal do Dataplex que pode referenciar em restrições personalizadas.

    Recurso Campo
    dataplex.googleapis.com/AspectType resource.authorization.alternateUsePermission
    resource.description
    resource.displayName
    resource.metadataTemplate.annotations.deprecated
    resource.metadataTemplate.annotations.description
    resource.metadataTemplate.annotations.displayName
    resource.metadataTemplate.annotations.displayOrder
    resource.metadataTemplate.annotations.stringType
    resource.metadataTemplate.annotations.stringValues
    resource.metadataTemplate.constraints.required
    resource.metadataTemplate.enumValues.deprecated
    resource.metadataTemplate.enumValues.index
    resource.metadataTemplate.enumValues.name
    resource.metadataTemplate.index
    resource.metadataTemplate.name
    resource.metadataTemplate.type
    resource.metadataTemplate.typeId
    resource.metadataTemplate.typeRef
    dataplex.googleapis.com/DataScan resource.data.entity
    resource.data.resource
    resource.dataDiscoverySpec.bigqueryPublishingConfig.connection
    resource.dataDiscoverySpec.bigqueryPublishingConfig.location
    resource.dataDiscoverySpec.bigqueryPublishingConfig.tableType
    resource.dataDiscoverySpec.storageConfig.csvOptions.delimiter
    resource.dataDiscoverySpec.storageConfig.csvOptions.encoding
    resource.dataDiscoverySpec.storageConfig.csvOptions.headerRows
    resource.dataDiscoverySpec.storageConfig.csvOptions.quote
    resource.dataDiscoverySpec.storageConfig.csvOptions.typeInferenceDisabled
    resource.dataDiscoverySpec.storageConfig.excludePatterns
    resource.dataDiscoverySpec.storageConfig.includePatterns
    resource.dataDiscoverySpec.storageConfig.jsonOptions.encoding
    resource.dataDiscoverySpec.storageConfig.jsonOptions.typeInferenceDisabled
    resource.dataProfileSpec.excludeFields.fieldNames
    resource.dataProfileSpec.includeFields.fieldNames
    resource.dataProfileSpec.postScanActions.bigqueryExport.resultsTable
    resource.dataProfileSpec.rowFilter
    resource.dataProfileSpec.samplingPercent
    resource.dataQualitySpec.postScanActions.bigqueryExport.resultsTable
    resource.dataQualitySpec.postScanActions.notificationReport.recipients.emails
    resource.dataQualitySpec.postScanActions.notificationReport.scoreThresholdTrigger.scoreThreshold
    resource.dataQualitySpec.rowFilter
    resource.dataQualitySpec.rules.column
    resource.dataQualitySpec.rules.description
    resource.dataQualitySpec.rules.dimension
    resource.dataQualitySpec.rules.ignoreNull
    resource.dataQualitySpec.rules.name
    resource.dataQualitySpec.rules.rangeExpectation.maxValue
    resource.dataQualitySpec.rules.rangeExpectation.minValue
    resource.dataQualitySpec.rules.rangeExpectation.strictMaxEnabled
    resource.dataQualitySpec.rules.rangeExpectation.strictMinEnabled
    resource.dataQualitySpec.rules.regexExpectation.regex
    resource.dataQualitySpec.rules.rowConditionExpectation.sqlExpression
    resource.dataQualitySpec.rules.setExpectation.values
    resource.dataQualitySpec.rules.sqlAssertion.sqlStatement
    resource.dataQualitySpec.rules.statisticRangeExpectation.maxValue
    resource.dataQualitySpec.rules.statisticRangeExpectation.minValue
    resource.dataQualitySpec.rules.statisticRangeExpectation.statistic
    resource.dataQualitySpec.rules.statisticRangeExpectation.strictMaxEnabled
    resource.dataQualitySpec.rules.statisticRangeExpectation.strictMinEnabled
    resource.dataQualitySpec.rules.suspended
    resource.dataQualitySpec.rules.tableConditionExpectation.sqlExpression
    resource.dataQualitySpec.rules.threshold
    resource.dataQualitySpec.samplingPercent
    resource.description
    resource.displayName
    resource.executionSpec.field
    resource.executionSpec.trigger.schedule.cron
    dataplex.googleapis.com/EntryGroup resource.description
    resource.displayName
    dataplex.googleapis.com/EntryType resource.authorization.alternateUsePermission
    resource.description
    resource.displayName
    resource.platform
    resource.requiredAspects.type
    resource.system
    resource.typeAliases
    dataplex.googleapis.com/MetadataJob resource.exportSpec.outputPath
    resource.exportSpec.scope.aspectTypes
    resource.exportSpec.scope.entryGroups
    resource.exportSpec.scope.entryTypes
    resource.exportSpec.scope.organizationLevel
    resource.exportSpec.scope.projects
    resource.importSpec.aspectSyncMode
    resource.importSpec.entrySyncMode
    resource.importSpec.logLevel
    resource.importSpec.scope.aspectTypes
    resource.importSpec.scope.entryGroups
    resource.importSpec.scope.entryTypes
    resource.importSpec.sourceCreateTime
    resource.importSpec.sourceStorageUri
    resource.type

    O que se segue?