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.

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 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 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 restrições chamado restrições que se aplicam aos recursosGoogle Cloud e aos descendentes desses recursos na hierarquia de recursosGoogle 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 fornece restrições predefinidas para vários serviços 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 dessa 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. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

6. To initialize the gcloud CLI, run the following command:

   gcloud init

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

   Go to project selector

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

9. Install the Google Cloud CLI.

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

11. To initialize the gcloud CLI, run the following command:

    gcloud init

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

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

Aplicar uma política da organização personalizada

      name: projects/PROJECT_ID/policies/CONSTRAINT_NAME
      spec:
        rules:
        - enforce: true
    

    gcloud org-policies set-policy POLICY_PATH
    

Testar a política personalizada da organização

O exemplo a seguir cria uma restrição e uma 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 saber 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-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 que uma política de alerta seja criada ou atualizada se o nome do projeto de recurso estiver ausente na documentação da política de alerta.

2. Aplique a restrição:

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

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

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

2. Aplique a política:

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

3. 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 de recursos.

  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:

    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
    

    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
    

    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
    

    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

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.
• Veja a lista completa de restrições da política da organização predefinidas.