Esta página foi traduzida pela API Cloud Translation.

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 :

monitoring.googleapis.com/AlertPolicy
monitoring.googleapis.com/NotificationChannel
monitoring.googleapis.com/Snooze

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

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, alertDocHasProject. 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, monitoring.googleapis.com/AlertPolicy.
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.documentation.content.contains('${resource.project}').
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

gcloud org-policies set-custom-constraint

gcloud org-policies set-custom-constraint CONSTRAINT_PATH

CONSTRAINT_PATH

/home/user/customconstraint.yaml

gcloud org-policies list-custom-constraints

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

ORGANIZATION_ID

Como visualizar as políticas da organização

Aplicar uma política da organização personalizada

Console

No console Google Cloud , acesse a página Políticas da organização.
Acessar as políticas da organização
No seletor de projetos, selecione o projeto em que você quer definir a política da organização.
Na lista da página Políticas da organização, selecione a restrição para acessar a página Detalhes da política dela.
Para personalizar a política da organização nesse recurso, clique em Gerenciar política.
Na página Editar política, selecione Substituir a política do editor principal.
Clique em Adicionar uma regra.
Na seção Aplicação, selecione se a aplicação dessa política da organização está ativada ou desativada.
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.
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.
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 da restrição que você quer aplicar. Por exemplo, alertDocHasProject.

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 a documentação de uma política de alertas menciona o nome do projeto.

Antes de começar, substitua 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.

Salve o seguinte arquivo como constraint-alert-doc-has-project.yaml:

    actionType: DENY
    condition: resource.documentation.content.contains('${resource.project}')
    description: Requires documentation to include the project name.
    displayName: Alerting policy documentation must include project name.
    methodTypes:
      - CREATE
      - UPDATE
    name: organizations/ORGANIZATION_ID/customConstraints/custom.alertDocHasProject
    resourceTypes:
      - monitoring.googleapis.com/AlertPolicy

SubstituaORGANIZATION_ID pelo ID da organização.

Essa restrição impede a criação ou atualização de uma política de alertas se o nome do projeto de recurso não estiver na documentação da política de alertas.

Aplique a restrição:

gcloud org-policies set-custom-constraint ~/constraint-alert-doc-has-project.yaml

Verifique se a restrição existe:

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

O resultado será assim:

CUSTOM_CONSTRAINT: custom.alertDocHasProject
ACTION_TYPE: DENY
METHOD_TYPES: CREATE,UPDATE
RESOURCE_TYPES: monitoring.googleapis.com/AlertPolicy
DISPLAY_NAME: Alerting policy documentation must include the project name.

Crie a política

Salve o seguinte arquivo como policy-alert-doc-has-project.yaml:

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

Substitua PROJECT_ID pela ID do seu projeto.

Aplique a política:

gcloud org-policies set-policy ~/policy-alert-doc-has-project.yaml

Verifique se a política existe:

gcloud org-policies list --project=PROJECT_ID

O resultado será assim:

CONSTRAINT: custom.alertDocHasProject
LIST_POLICY: -
BOOLEAN_POLICY: SET
ETAG: CKSx5LwGEPjBuKwD-

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

Tente criar uma política de alertas com documentação que exclua o nome do projeto do recurso.

  gcloud alpha monitoring policies create \
    --display-name="CPU Utilization - 5% Threshold" \
    --project=PROJECT_ID \
    --condition-display-name="Condition 1" \
    --condition-filter='resource.type="gce_instance" AND metric.type="compute.googleapis.com/instance/cpu/utilization"' \
    --duration='60s' \
    --if='>5' \
    --combiner='AND' \
    --documentation='The ${metric.display_name} of the ${resource.type} ${resource.label.instance_id} has exceeded 5% for over 60 seconds.' \

Substitua PROJECT_ID pela ID do seu projeto.

A saída é esta:

  Operation denied by custom org policies: ["customConstraints/alertDocHasProject": "Alerting policy documentation must include project name."]

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
As políticas de alertas precisam ter apenas uma condição	actionType: DENY condition: "resource.conditions.size() > 1" description: Requires alerting policies to have only one condition. displayName: Alerting policies must have only one condition methodTypes: - CREATE - UPDATE name: organizations/`ORGANIZATION_ID`/customConstraints/custom.oneCondition resourceTypes: - monitoring.googleapis.com/AlertPolicy
As políticas de alertas precisam usar pelo menos dois canais de notificação	actionType: DENY condition: "resource.notificationChannels.size() < 2" description: Alerting policies must use at least two notification channels. displayName: Policies must have a backup notification channel methodTypes: - CREATE - UPDATE name: organizations/`ORGANIZATION_ID`/customConstraints/custom.alertOnTwoChannels resourceTypes: - monitoring.googleapis.com/AlertPolicy
Permitir apenas canais de notificação por e-mail	actionType: DENY condition: "resource.type != 'email'" description: Requires notification channels to use only the email channel type. displayName: Always use email for notification channels methodTypes: - CREATE - UPDATE name: organizations/`ORGANIZATION_ID`/customConstraints/custom.emailChannelsOnly resourceTypes: - monitoring.googleapis.com/NotificationChannel
As sonecas precisam durar menos de uma hora	actionType: DENY condition: "int(resource.interval.endTime) > int(resource.interval.startTime) + 3600" description: Requires snoozes to be under 1 hour. displayName: Snooze must be less than 1 hour methodTypes: - CREATE - UPDATE name: organizations/`ORGANIZATION_ID`/customConstraints/custom.setMaxSnooze resourceTypes: - monitoring.googleapis.com/Snooze

Recursos compatíveis com o Cloud Monitoring

Recurso	Campo
monitoring.googleapis.com/AlertPolicy	`resource.alertStrategy.autoClose`
	`resource.alertStrategy.notificationChannelStrategy.notificationChannelNames`
	`resource.alertStrategy.notificationChannelStrategy.renotifyInterval`
	`resource.alertStrategy.notificationRateLimit.period`
	`resource.combiner`
	`resource.conditions.conditionAbsent.aggregations.alignmentPeriod`
	`resource.conditions.conditionAbsent.aggregations.crossSeriesReducer`
	`resource.conditions.conditionAbsent.aggregations.groupByFields`
	`resource.conditions.conditionAbsent.aggregations.perSeriesAligner`
	`resource.conditions.conditionAbsent.duration`
	`resource.conditions.conditionAbsent.filter`
	`resource.conditions.conditionAbsent.trigger.count`
	`resource.conditions.conditionAbsent.trigger.percent`
	`resource.conditions.conditionMatchedLog.filter`
	`resource.conditions.conditionMatchedLog.labelExtractors`
	`resource.conditions.conditionMonitoringQueryLanguage.duration`
	`resource.conditions.conditionMonitoringQueryLanguage.evaluationMissingData`
	`resource.conditions.conditionMonitoringQueryLanguage.query`
	`resource.conditions.conditionMonitoringQueryLanguage.trigger.count`
	`resource.conditions.conditionMonitoringQueryLanguage.trigger.percent`
	`resource.conditions.conditionPrometheusQueryLanguage.alertRule`
	`resource.conditions.conditionPrometheusQueryLanguage.duration`
	`resource.conditions.conditionPrometheusQueryLanguage.evaluationInterval`
	`resource.conditions.conditionPrometheusQueryLanguage.labels`
	`resource.conditions.conditionPrometheusQueryLanguage.query`
	`resource.conditions.conditionPrometheusQueryLanguage.ruleGroup`
	`resource.conditions.conditionSql.booleanTest.column`
	`resource.conditions.conditionSql.daily.periodicity`
	`resource.conditions.conditionSql.hourly.minuteOffset`
	`resource.conditions.conditionSql.hourly.periodicity`
	`resource.conditions.conditionSql.minutes.periodicity`
	`resource.conditions.conditionSql.query`
	`resource.conditions.conditionSql.rowCountTest.comparison`
	`resource.conditions.conditionSql.rowCountTest.threshold`
	`resource.conditions.conditionThreshold.aggregations.alignmentPeriod`
	`resource.conditions.conditionThreshold.aggregations.crossSeriesReducer`
	`resource.conditions.conditionThreshold.aggregations.groupByFields`
	`resource.conditions.conditionThreshold.aggregations.perSeriesAligner`
	`resource.conditions.conditionThreshold.comparison`
	`resource.conditions.conditionThreshold.denominatorAggregations.alignmentPeriod`
	`resource.conditions.conditionThreshold.denominatorAggregations.crossSeriesReducer`
	`resource.conditions.conditionThreshold.denominatorAggregations.groupByFields`
	`resource.conditions.conditionThreshold.denominatorAggregations.perSeriesAligner`
	`resource.conditions.conditionThreshold.denominatorFilter`
	`resource.conditions.conditionThreshold.duration`
	`resource.conditions.conditionThreshold.evaluationMissingData`
	`resource.conditions.conditionThreshold.filter`
	`resource.conditions.conditionThreshold.forecastOptions.forecastHorizon`
	`resource.conditions.conditionThreshold.thresholdValue`
	`resource.conditions.conditionThreshold.trigger.count`
	`resource.conditions.conditionThreshold.trigger.percent`
	`resource.conditions.displayName`
	`resource.conditions.name`
	`resource.displayName`
	`resource.documentation.content`
	`resource.documentation.links.displayName`
	`resource.documentation.links.url`
	`resource.documentation.mimeType`
	`resource.documentation.subject`
	`resource.enabled`
	`resource.name`
	`resource.notificationChannels`
	`resource.severity`
monitoring.googleapis.com/NotificationChannel	`resource.description`
	`resource.displayName`
	`resource.enabled`
	`resource.type`
monitoring.googleapis.com/Snooze	`resource.criteria.policies`
	`resource.displayName`
	`resource.interval.endTime`
	`resource.interval.startTime`

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.

Usar políticas personalizadas da organização Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

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

Herança de políticas

Antes de começar

Funções exigidas

Criar uma restrição personalizada

Configurar uma restrição personalizada

Aplicar uma política da organização personalizada

Console

gcloud

Testar a política personalizada da organização

Crie a restrição.

Crie a política

Testar a política

Exemplos de políticas personalizadas da organização para casos de uso comuns

Recursos compatíveis com o Cloud Monitoring

A seguir

Usar políticas personalizadas da organização