Usar políticas personalizadas da organização

    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 :

    • pubsub.googleapis.com/Schema
    • pubsub.googleapis.com/Snapshot
    • pubsub.googleapis.com/Subscription
    • pubsub.googleapis.com/Topic

    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 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 limites chamado restrições que se aplicam aos Google Cloud recursos e aos descendentes desses recursos na Google Cloud hierarquia de recursos. É 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 vai aplicar a política a todos os projetos na pasta. Para saber mais sobre esse comportamento e como alterá-lo, consulte Regras de avaliação de hierarquia.

    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 receber as permissões necessárias a fim de gerenciar políticas da organização personalizadas, 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.messageRetentionSet. 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. Exemplo: pubsub.googleapis.com/Topic.

    • 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, "has(resource.messageRetentionDuration)".

    • 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.messageRetentionSet.

    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 todos os novos tópicos em um projeto específico apliquem garantias em trânsito para mensagens.

    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-message-retention.yaml:

      name: organizations/ORGANIZATION_ID/customConstraints/custom.messageRetentionSet
resourceTypes:
- Topic
methodTypes:
- CREATE
- UPDATE
condition: "has(resource.messageRetentionDuration)"
actionType: ALLOW
displayName: Require message retention
description: All topics must set a message retention duration.

      Isso define uma restrição em que cada tópico precisa definir uma duração de retenção de mensagens.

      1. Aplique a restrição:

        gcloud org-policies set-custom-constraint constraint-require-message-retention.yaml

      2. 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.messageRetentionSet              ALLOW         CREATE,UPDATE    pubsub.googleapis.com/Topic        Require message retention
...

      Crie a política

      1. Salve o seguinte arquivo como policy-require-message-retention.yaml:

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

        Substitua PROJECT_ID pela ID do seu projeto.

      2. Aplique a política:

        gcloud org-policies set-policy policy-`policy-require-message-retention.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.messageRetentionSet         -              SET               COCsm5QGENiXi2E=

      Depois de aplicar a política, aguarde cerca de dois minutos para que o Google Cloud começe a aplicar a política.

      Testar a política

      Tente criar um tópico sem ativar a retenção de mensagens:

      gcloud pubsub topics create org-policy-test \
  --project=PROJECT_ID \

      A saída é esta:

      Operation denied by custom org policies: ["customConstraints/custom.messageRetentionSet": "All topics must set a message retention duration."].

ERROR: Failed to create topic [projects/PROJECT_ID/topics/org-policy-test]: Operation denied by org policy: ["customConstraints/custom.messageRetentionSet": "All topics must set a message retention duration."].
ERROR: (gcloud.pubsub.topics.create) Failed to create the following: [org-policy-test].

      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
      Exigir que os tópicos apliquem garantias em trânsito para mensagens e forneçam pelo menos uma região de persistência permitida 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.enforceInTransitWithRegions
  resourceTypes:
  - pubsub.googleapis.com/Topic
  methodTypes:
  - CREATE
  - UPDATE
  condition: "resource.messageStoragePolicy.enforceInTransit == true && resource.messageStoragePolicy.allowedPersistenceRegions.size() >= 1"
  actionType: ALLOW
  displayName: Require in-transit enforcement and regions
  description: All topics must enable in-transit message storage policy enforcement and contain a non-empty list of allowed persistence regions.
      Exigir que os tópicos apliquem garantias em trânsito para mensagens e excluam uma região específica 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.enforceInTransitWithoutUsEast1
  resourceTypes:
  - pubsub.googleapis.com/Topic
  methodTypes:
  - CREATE
  - UPDATE
  condition: "resource.messageStoragePolicy.enforceInTransit && !resource.messageStoragePolicy.allowedPersistenceRegions.exists(r, r == 'us-east1')"
  actionType: ALLOW
  displayName: Require in-transit enforcement and restrict regions
  description: All topics must enable in-transit message storage policy enforcement, and exclude us-east1 from the allowed persistence regions.
      Exigir uma duração mínima de retenção de mensagens para assinaturas 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.minMessageRetentionDuration
  resourceTypes:
  - pubsub.googleapis.com/Subscription
  methodTypes:
  - CREATE
  - UPDATE
  condition: "resource.messageRetentionDuration < duration('30m')"
  actionType: DENY
  displayName: Minimum message retention duration
  description: All subscriptions must retain unacked messages for at least 30 minutes.
      Exigir assinaturas para ativar mensagens mortas 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.requireDeadLetterPolicy
  resourceTypes:
  - pubsub.googleapis.com/Subscription
  methodTypes:
  - CREATE
  - UPDATE
  condition: "has(resource.deadLetterPolicy)"
  actionType: ALLOW
  displayName: Require dead letter policy
  description: All subscriptions must set a dead letter policy.
      Exigir que os esquemas sejam do tipo Avro 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.schemaIsAvro
  resourceTypes:
  - pubsub.googleapis.com/Schema
  methodTypes:
  - CREATE
  - UPDATE
  condition: "resource.type == 'AVRO'"
  actionType: ALLOW
  displayName: Schema is Avro
  description: All schemas must be of type Avro.
      Exigir push autenticado para assinaturas 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.authenticatedPush
  resourceTypes:
  - pubsub.googleapis.com/Subscription
  methodTypes:
  - CREATE
  - UPDATE
  condition: "has(resource.pushConfig.pushEndpoint) && has(resource.pushConfig.oidcToken.serviceAccountEmail) && has(resource.pushConfig.oidcToken.audience)"
  actionType: ALLOW
  displayName: Subscription uses authenticated push
  description: All subscriptions must enable push authentication.
      Exigir que os tópicos ativem o CMEK 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.topicHasCmek
  resourceTypes:
  - pubsub.googleapis.com/Topic
  methodTypes:
  - CREATE
  - UPDATE
  condition: "has(resource.kmsKeyName)"
  actionType: ALLOW
  displayName: Topic has CMEK
  description: All topics must use a Cloud KMS CryptoKey.

      Recursos com suporte do Pub/Sub

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

      Recurso Campo
      pubsub.googleapis.com/Schema resource.definition
      resource.name
      resource.type
      pubsub.googleapis.com/Snapshot resource.expireTime
      resource.name
      resource.topic
      pubsub.googleapis.com/Subscription resource.ackDeadlineSeconds
      resource.bigqueryConfig.dropUnknownFields
      resource.bigqueryConfig.serviceAccountEmail
      resource.bigqueryConfig.table
      resource.bigqueryConfig.useTableSchema
      resource.bigqueryConfig.useTopicSchema
      resource.bigqueryConfig.writeMetadata
      resource.cloudStorageConfig.bucket
      resource.cloudStorageConfig.filenameDatetimeFormat
      resource.cloudStorageConfig.filenamePrefix
      resource.cloudStorageConfig.filenameSuffix
      resource.cloudStorageConfig.maxBytes
      resource.cloudStorageConfig.maxDuration
      resource.cloudStorageConfig.maxMessages
      resource.cloudStorageConfig.serviceAccountEmail
      resource.deadLetterPolicy.deadLetterTopic
      resource.deadLetterPolicy.maxDeliveryAttempts
      resource.enableExactlyOnceDelivery
      resource.enableMessageOrdering
      resource.expirationPolicy.ttl
      resource.filter
      resource.messageRetentionDuration
      resource.name
      resource.pushConfig.attributes
      resource.pushConfig.noWrapper.writeMetadata
      resource.pushConfig.oidcToken.audience
      resource.pushConfig.oidcToken.serviceAccountEmail
      resource.pushConfig.pushEndpoint
      resource.retainAckedMessages
      resource.retryPolicy.maximumBackoff
      resource.retryPolicy.minimumBackoff
      resource.topic
      pubsub.googleapis.com/Topic resource.ingestionDataSourceSettings.awsKinesis.awsRoleArn
      resource.ingestionDataSourceSettings.awsKinesis.consumerArn
      resource.ingestionDataSourceSettings.awsKinesis.gcpServiceAccount
      resource.ingestionDataSourceSettings.awsKinesis.streamArn
      resource.kmsKeyName
      resource.messageRetentionDuration
      resource.messageStoragePolicy.allowedPersistenceRegions
      resource.messageStoragePolicy.enforceInTransit
      resource.name
      resource.schemaSettings.encoding
      resource.schemaSettings.firstRevisionId
      resource.schemaSettings.lastRevisionId
      resource.schemaSettings.schema

      A seguir