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 Google Cloud recursos:

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

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 Google Cloud 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 aGoogle Cloud recursos e descendentes desses recursos na Google Cloud hierarquia de recursos. Pode aplicar políticas da 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 Google Cloud . 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, Google Cloud 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

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.

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

Verify that billing is enabled for your Google Cloud project.

Install the Google Cloud CLI.

Se estiver a usar um fornecedor de identidade (IdP) externo, tem primeiro de iniciar sessão na CLI gcloud com a sua identidade federada.

Para inicializar a CLI gcloud, execute o seguinte comando:

gcloud init

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

Verify that billing is enabled for your Google Cloud project.

Install the Google Cloud CLI.

Se estiver a usar um fornecedor de identidade (IdP) externo, tem primeiro de iniciar sessão na CLI gcloud com a sua identidade federada.

Para inicializar a CLI gcloud, execute o seguinte comando:

gcloud init

1. Certifique-se de que sabe o seu ID da organização.

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, alertDocHasProject. 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.Google Cloud Por exemplo, monitoring.googleapis.com/AlertPolicy.

• 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, resource.documentation.content.contains('${resource.project}').

• 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

gcloud org-policies set-custom-constraint CONSTRAINT_PATH

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

Aplique 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     

Teste a política da organização personalizada

O exemplo seguinte cria uma restrição e uma política personalizadas que verificam se a documentação de uma política de alerta menciona o nome do projeto.

Antes de começar, substitua o seguinte:

• ORGANIZATION_ID: o identificador numérico exclusivo da organização. Para obter informações sobre como receber este identificador, consulte o artigo Receber o ID da sua organização.
• PROJECT_ID: o identificador do projeto.

Crie a restrição

1. Guarde o seguinte ficheiro 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 

   Substitua ORGANIZATION_ID pelo ID da sua organização.

   Esta restrição impede a criação ou a atualização de uma política de alerta se o nome do projeto de recursos estiver em falta 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 é semelhante ao seguinte:

   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. Guarde o seguinte ficheiro como policy-alert-doc-has-project.yaml:

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

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

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

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

Teste a política

Tente criar uma política de alerta 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 pelo ID do seu projeto.

O resultado é o seguinte:

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

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.

    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 suportados pelo Cloud Monitoring

O que se segue?

• Saiba mais sobre o serviço de políticas da organização.
• Saiba como criar e gerir políticas de organização.
• Veja a lista completa de restrições de políticas organizacionais geridas.