Use políticas da organização 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 Cloud de Confiance by S3NS recursos:

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

    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 Cloud de Confiance 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 aCloud de Confiance recursos e descendentes desses recursos na Cloud de Confiance by S3NS hierarquia de recursos. Pode aplicar políticas de 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 Cloud de Confiance . 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, Cloud de Confiance 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.

    Antes de começar

    1. In the Cloud de Confiance console, on the project selector page, select or create a Cloud de Confiance 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

    2. Verify that billing is enabled for your Cloud de Confiance project.

    3. Install the Google Cloud CLI.

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

      Para mais informações, consulte o artigo Inicie sessão na CLI gcloud com a sua identidade federada.

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

      gcloud init
    6. Certifique-se de que sabe o seu ID da organização.
    7. 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.messageRetentionSet. 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.Cloud de Confiance Por exemplo, pubsub.googleapis.com/Topic.

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

      • 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 sua lista de Cloud de Confiance 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 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 Cloud de Confiance by S3NS recurso.

      Consola

      1. Na Cloud de Confiance 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.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 para o ficheiro YAML da política da 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 exigem que todos os novos tópicos num projeto específico apliquem garantias em trânsito para mensagens.

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

        Isto define uma restrição em que cada tópico tem de 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 é semelhante ao seguinte:

          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. Guarde o seguinte ficheiro como policy-require-message-retention.yaml:

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

          Substitua PROJECT_ID pelo 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 é semelhante ao seguinte:

          CONSTRAINT                         LIST_POLICY    BOOLEAN_POLICY    ETAG
          custom.messageRetentionSet         -              SET               COCsm5QGENiXi2E=
          

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

        Teste a política

        Experimente criar um tópico sem a retenção de mensagens ativada:

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

        O resultado é o seguinte:

        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 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
        Exigir tópicos para aplicar garantias em trânsito para mensagens e fornecer, 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.
          
        Exija tópicos para aplicar garantias em trânsito para mensagens e excluir 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.
          
        Exija uma duração mínima de retenção de mensagens para subscrições
          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 subscrições para ativar a devolução por não entrega
          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 envio de notificações push autenticadas para subscrições
          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.
          
        Exija tópicos para ativar as 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 suportados do Pub/Sub

        A tabela seguinte apresenta os recursos do Pub/Sub que pode referenciar 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.avroConfig.useTopicSchema
        resource.cloudStorageConfig.avroConfig.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.messageTransforms.disabled
        resource.messageTransforms.enabled
        resource.messageTransforms.javascriptUdf.code
        resource.messageTransforms.javascriptUdf.functionName
        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.ingestionDataSourceSettings.cloudStorage.bucket
        resource.ingestionDataSourceSettings.cloudStorage.matchGlob
        resource.ingestionDataSourceSettings.cloudStorage.minimumObjectCreateTime
        resource.ingestionDataSourceSettings.cloudStorage.textFormat.delimiter
        resource.ingestionDataSourceSettings.platformLogsSettings.severity
        resource.kmsKeyName
        resource.messageRetentionDuration
        resource.messageStoragePolicy.allowedPersistenceRegions
        resource.messageStoragePolicy.enforceInTransit
        resource.messageTransforms.disabled
        resource.messageTransforms.enabled
        resource.messageTransforms.javascriptUdf.code
        resource.messageTransforms.javascriptUdf.functionName
        resource.name
        resource.schemaSettings.encoding
        resource.schemaSettings.firstRevisionId
        resource.schemaSettings.lastRevisionId
        resource.schemaSettings.schema

        O que se segue?