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 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 Organization Policy Service 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 aosGoogle Cloud recursos e aos descendentes deles na hierarquia de recursos doGoogle Cloud . É 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 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, Google 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.

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

Make sure that billing is enabled for your Google Cloud project.

Install the Google Cloud CLI.

If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

To initialize the gcloud CLI, run the following command:

gcloud init

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

Go to project selector

Make sure that billing is enabled for your Google Cloud project.

Install the Google Cloud CLI.

If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

To initialize the gcloud CLI, run the following command:

gcloud init

1. Certifique-se de conhecer o ID da organização.

Funções exigidas

Para receber as permissões necessárias para gerenciar políticas personalizadas 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 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.checkLogBucketDescription. O comprimento máximo desse campo é de 70 caracteres.

• RESOURCE_NAME: o nome totalmente qualificado do recursoGoogle 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 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, resource.description.contains('secret').

• 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 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 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 que faça referência a ela e aplique essa política a um recurso Google Cloud .

Console

1. No console 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. Clique em Testar mudanças 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 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 da 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 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 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 tabela a seguir mostra a sintaxe de algumas restrições personalizadas para casos de uso comuns:

Descrição	Sintaxe de 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ítica da organização.
• Saiba mais sobre como criar e gerenciar políticas da organização.
• Confira a lista completa de restrições da política da organização gerenciadas.