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 :

• logging.googleapis.com/LogBucket
• logging.googleapis.com/Link
• logging.googleapis.com/LogMetric
• logging.googleapis.com/LogSink
• logging.googleapis.com/LogView
• logging.googleapis.com/SavedQuery

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 Google 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 doGoogle Cloud e aos elementos que descendem dele na hierarquia de recursos doGoogle Cloud . É 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 Google 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 Google 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.

Antes de começar

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.

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

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Install the Google Cloud CLI.

Ao usar um provedor de identidade (IdP) externo, primeiro faça login na gcloud CLI com sua identidade federada.

Para inicializar a gcloud CLI, execute o seguinte comando:

gcloud init

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

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Install the Google Cloud CLI.

Ao usar um provedor de identidade (IdP) externo, primeiro faça login na gcloud CLI com sua identidade federada.

Para inicializar a gcloud CLI, execute o seguinte comando:

gcloud init

1. Verifique qual é o ID da organização.

Papéis necessários

Para receber as permissões necessárias a fim de gerenciar as políticas da organização, 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 usando papéis personalizados 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.checkLogBucketDescription. Esse campo pode ter no máximo 70 caracteres.

• RESOURCE_NAME: o nome totalmente qualificado do recurso doGoogle Cloud que contém o objeto e o campo que você quer restringir. Por exemplo, logging.googleapis.com/LogBucket.

• 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.description.contains('secret').

• 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 Google Cloud . 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 Google Cloud .

Console

1. No console do Google 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.checkLogBucketDescription.

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 verifica se todos os buckets de registros em um projeto específico não contêm a palavra secret na descrição do bucket de registros.

Antes de começar, você precisa saber o seguinte:

• ORGANIZATION_ID: o identificador numérico exclusivo da organização. Para informações sobre como conseguir esse identificador, consulte Como conseguir o ID da organização.
• PROJECT_ID: o identificador do projeto.

Crie a restrição.

1. Salve o seguinte arquivo como constraint-check-bucket-description.yaml:

   name: organizations/ORGANIZATION_ID}/customConstraints/custom.checkLogBucketDescription
   resourceTypes:
   - LogBucket
   methodTypes:
   - CREATE
   - UPDATE
   condition: resource.description.contains('secret')
   actionType: DENY
   displayName: Check log bucket description for "secret"
   description: The log bucket's description can't contain the word "secret"
   

   Essa restrição impede a criação ou atualização de um bucket de registros se a descrição dele contiver a palavra secret.

2. Aplique a restrição:

   gcloud org-policies set-custom-constraint ~/constraint-check-bucket-description.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.noSecretsInDescription               DENY         CREATE,UPDATE         logging.googleapis.com/LogBucket   Check log bucket description for "secret"
   ...
   

Crie a política

1. Salve o seguinte arquivo como policy-check-bucket-description.yaml:

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

   Substitua PROJECT_ID pela ID do seu projeto.

2. Aplique a política:

   gcloud org-policies set-policy ~/policy-check-bucket-description.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.noSecretsInDescription   -              SET               COCsm5QGENiXi2E=
   

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

Testar a política

Crie um bucket de registros:

gcloud logging buckets create org-policy-test \
    --location=global
    --project=PROJECT_ID \
    --description='This contains a secret'

O resultado será assim:

Operation denied by custom org policies: ["customConstraints/custom.checkLogBucketDescription": "The log bucket's description can't contain the word "secret""]

Exemplos de políticas da organização personalizadas 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
Exigir que todos os novos buckets de registros tenham a Análise de dados de registros ativada	name: organizations/ORGANIZATION_ID/customConstraints/custom.forceAnaltyicsEnabled resourceTypes: - logging.googleapis.com/LogBucket methodTypes: - CREATE condition: "resource.analyticsEnabled == true" actionType: ALLOW displayName: Force Log Analytics-enabled buckets description: Only log buckets that have Log Analytics enabled can be created.
Impedir a criação de gravadores que filtram instâncias do Compute Engine	name: organizations/ORGANIZATION_ID/customConstraints/custom.denyGCEInstanceFilter: - logging.googleapis.com/LogSink methodTypes: - CREATE - UPDATE condition: "resource.filter.contains('gce_instance')" actionType: DENY displayName: No filtering by Compute Engine description: Log sinks can't filter by gce_instance.

Recursos compatíveis com o Cloud Logging

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

Recurso	Campo
logging.googleapis.com/Link	resource.description
logging.googleapis.com/LogBucket	resource.analyticsEnabled
	resource.cmekSettings.kmsKeyName
	resource.description
	resource.indexConfigs.fieldPath
	resource.indexConfigs.type
	resource.locked
	resource.restrictedFields
	resource.retentionDays
logging.googleapis.com/LogMetric	resource.bucketName
	resource.description
	resource.disabled
	resource.filter
	resource.labelExtractors
	resource.metricDescriptor.description
	resource.metricDescriptor.displayName
	resource.metricDescriptor.launchStage
	resource.metricDescriptor.metadata.ingestDelay
	resource.metricDescriptor.metadata.samplePeriod
	resource.metricDescriptor.metadata.timeSeriesResourceHierarchyLevel
	resource.metricDescriptor.metricKind
	resource.metricDescriptor.monitoredResourceTypes
	resource.metricDescriptor.name
	resource.metricDescriptor.type
	resource.metricDescriptor.unit
	resource.metricDescriptor.valueType
	resource.name
	resource.valueExtractor
logging.googleapis.com/LogSink	resource.bigqueryOptions.usePartitionedTables
	resource.description
	resource.destination
	resource.disabled
	resource.exclusions.description
	resource.exclusions.disabled
	resource.exclusions.filter
	resource.filter
	resource.includeChildren
	resource.interceptChildren
logging.googleapis.com/LogView	resource.description
	resource.filter
logging.googleapis.com/SavedQuery	resource.description
	resource.displayName
	resource.loggingQuery.filter
	resource.loggingQuery.summaryFieldEnd
	resource.loggingQuery.summaryFields.field
	resource.loggingQuery.summaryFieldStart
	resource.opsAnalyticsQuery.sqlQueryText
	resource.visibility

A seguir

• Saiba mais sobre o Serviço de políticas da organização.
• Saiba como criar e gerenciar políticas da organização.
• Confira a lista completa de restrições de política da organização gerenciadas.