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:

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

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

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.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

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, custom.checkLogBucketDescription. 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, logging.googleapis.com/LogBucket.

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

• 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

Depois de criar o ficheiro YAML para uma nova restrição personalizada, tem de o configurar para o disponibilizar para as políticas da organização na sua 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 seu ficheiro de restrições personalizado. Por exemplo, /home/user/customconstraint.yaml. Após a conclusão, as restrições personalizadas ficam disponíveis como políticas da organização na 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 sua organização. Para mais informações, consulte o artigo Ver políticas da organização.

Aplique uma política da organização personalizada

Pode aplicar uma restrição criando uma política da organização que a referencie e, em seguida, aplicando essa política da organização a um Google Cloud recurso.

Consola

1. Na Google Cloud consola, aceda à página Políticas de organização.

   Aceda às políticas da organização

2. No seletor de projetos, selecione o projeto para o qual quer definir a política de organização.
3. Na lista da página Políticas da organização, selecione a restrição para ver a página Detalhes da política dessa restrição.
4. Para configurar a política da organização para este recurso, clique em Gerir política.
5. Na página Editar política, selecione Substituir política do elemento principal.
6. Clique em Adicionar regra.
7. Na secção Aplicação, selecione se a aplicação desta política organizacional está ativada ou desativada.
8. Opcional: para tornar a política de organização condicional a uma etiqueta, clique em Adicionar condição. Tenha em atenção que, se adicionar uma regra condicional a uma política da organização, tem de adicionar, pelo menos, uma regra incondicional. Caso contrário, não é possível guardar a política. Para mais informações, consulte o artigo Definir uma política de organização com etiquetas.
9. Clique em Testar alterações para simular o efeito da política da organização. A simulação de políticas não está disponível para restrições geridas antigas. Para mais informações, consulte o artigo Teste as alterações à política da organização com o simulador de políticas.
10. Para concluir e aplicar a política da organização, clique em Definir política. A política demora até 15 minutos a entrar em vigor.

gcloud

Para criar uma política da organização com regras booleanas, crie um ficheiro YAML de política que faça referência à restrição:

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

Substitua o seguinte:

• PROJECT_ID: o projeto no qual quer aplicar a restrição.
• CONSTRAINT_NAME: o nome que definiu 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 ficheiro YAML da política da sua organização. A política demora até 15 minutos a entrar em vigor.

Teste a política da organização personalizada

O exemplo seguinte cria uma restrição e uma política personalizadas que verificam se todos os contentores de registos num projeto específico não contêm a palavra secret na descrição do contentor de registos.

Antes de começar, tem de saber 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-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"
   

   Esta restrição impede a criação ou a atualização de um contentor de registos se a descrição do contentor de registos 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 é semelhante ao seguinte:

   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. Guarde o seguinte ficheiro como policy-check-bucket-description.yaml:

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

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

   CONSTRAINT                      LIST_POLICY    BOOLEAN_POLICY    ETAG
   custom.noSecretsInDescription   -              SET               COCsm5QGENiXi2E=
   

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

Crie um contentor de registos:

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

O resultado é semelhante ao seguinte:

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 exemplos de utilização comuns

Esta tabela fornece exemplos de sintaxe para algumas restrições personalizadas comuns.

Descrição	Sintaxe de restrição
Exigir que todos os novos contentores de registos tenham o Log Analytics ativado	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.
Impeça a criação de destinos 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 suportados do Cloud Logging

A tabela seguinte apresenta os recursos do Cloud Logging que pode referenciar 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

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.