Criar restrições personalizadas para o Backup for GKE

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:

• gkebackup.googleapis.com/BackupPlan
• gkebackup.googleapis.com/Backup
• gkebackup.googleapis.com/RestorePlan
• gkebackup.googleapis.com/Restore

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 de 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.retentionPolicyEnforced. 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, gkebackup.googleapis.com/Backup.

• 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.retainDays > 30".

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

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 organização. A política demora até 15 minutos a entrar em vigor.

Teste a política da organização personalizada

Os passos seguintes mostram como criar uma restrição e uma política personalizadas que permitem aos utilizadores criar uma cópia de segurança para a cópia de segurança do GKE se o campo retainDays estiver definido para um valor superior a 30.

Antes de começar, prepare o seguinte:

• O ID da sua organização
• O ID do seu projeto

Crie a restrição

1. Guarde o seguinte ficheiro como CONSTRAINT_FILE_NAME.yaml:

   name: organizations/ORGANIZATION_ID/customConstraints/custom.retentionPolicyEnforced
   resourceTypes:
   - gkebackup.googleapis.com/Backup
   methodTypes:
   - CREATE
   condition: "resource.retainDays > 30"
   actionType: ALLOW
   displayName: Enforce retention policy
   description: Enforce backup creation with a retention policy greater than 30 days.
   

   Substitua ORGANIZATION_ID pelo ID da sua organização.

   Este ficheiro define uma restrição em que o campo retainDays tem de ser superior a 30 no método CREATE.

2. Aplique a restrição através do comando gcloud org-policies set-custom-constraint:

   gcloud org-policies set-custom-constraint CONSTRAINT_FILE_NAME.yaml
   

3. Verifique se a restrição existe através do comando gcloud org-policies list-custom-constraints:

   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.retentionPolicyEnforced   DENY         CREATE,UPDATE  gkebackup.googleapis.com/Backup   Enforce retention policy
   ...
   

Crie a política

1. Guarde o seguinte ficheiro como POLICY_FILE_NAME.yaml:

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

   Substitua PROJECT_ID pelo ID do seu projeto.

2. Aplique a política através do comando gcloud org-policies set-policy:

   gcloud org-policies set-policy POLICY_FILE_NAME.yaml
   

3. Verifique se a política existe através do comando gcloud org-policies list:

   gcloud org-policies list --project=PROJECT_ID
   

   O resultado é semelhante ao seguinte:

   CONSTRAINT                         LIST_POLICY  BOOLEAN_POLICY  ETAG
   custom.retentionPolicyEnforced     -            SET             CPiLkMMGEKDFq6IB-
   

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

1. Crie uma cópia de segurança sem definir o campo retainDays para um valor superior a 30:

   gcloud beta container backup-restore backups create test-backup --backup-plan=test-backup-plan --location=us-central1
   

   O resultado é semelhante ao seguinte:

   ERROR: (gcloud.beta.container.backup-restore.backups.create) FAILED_PRECONDITION: Operation denied by org policy on resource 'pprojects/test-project/locations/us-central1/backupPlans/autopilot-cluster-1-backup-1/backups/test-backup-1': ["customConstraints/custom.retentionPolicyEnforced": "Enforce backup creation with a retention policy greater than 30 days."].
   - '@type': type.googleapis.com/google.rpc.DebugInfo
     detail: "generic::failed_precondition: Operation denied by org policy on resource\
       \ 'projects/test-project/locations/us-central1/backupPlans/autopilot-cluster-1-backup-1/backups/test-backup-1':\
       \ [\"customConstraints/custom.retentionPolicyEnforced\": \"Enforce backup creation with a retention \
       \ policy greater than 30 days.\"]."
     .
     .
     .
   - '@type': type.googleapis.com/google.rpc.DebugInfo
   - '@type': type.googleapis.com/google.rpc.ErrorInfo
     domain: gkebackup.googleapis.com
     metadata:
       customConstraints: customConstraints/custom.backupRetainDays
       resource: projects/test-project/locations/us-central1/backupPlans/autopilot-cluster-1-backup-1/backups/test-backup-1
     reason: CUSTOM_ORG_POLICY_VIOLATION
   

Exemplos de políticas da organização personalizadas para exemplos de utilização comuns

A tabela seguinte apresenta políticas de organização personalizadas que podem ser úteis:

Descrição	Sintaxe de restrição
Permitir a criação de cópias de segurança apenas se tiverem um período de retenção superior a 20 dias	name: organizations/ORGANIZATION_ID/customConstraints/custom.retainDaysLimit resourceTypes: - gkebackup.googleapis.com/Backup methodTypes: - CREATE - UPDATE condition: resource.retainDays > 20 actionType: ALLOW displayName: Minimum Backup Retention period description: Minimum Backup Retention period of 20 days is required
Desative a criação de planos de backup com um cronSchedule diferente do pretendido	name: organizations/ORGANIZATION_ID/customConstraints/custom.disableInvalidScheduleBackupPlan resourceTypes: - gkebackup.googleapis.com/BackupPlan methodTypes: - CREATE - UPDATE condition: resource.backupSchedule.cronSchedule != "5 20 * * *" actionType: DENY displayName: Backup plan cron schedule constraint description: Deny Backup plan creation or update if cron schedule is not set to 5 20 * * *.

Recursos suportados pela Cópia de segurança do GKE

A tabela seguinte apresenta os recursos do Backup for GKE que pode referenciar em restrições personalizadas.

Recurso	Campo
gkebackup.googleapis.com/Backup	resource.deleteLockDays
	resource.description
	resource.retainDays
gkebackup.googleapis.com/BackupPlan	resource.backupConfig.allNamespaces
	resource.backupConfig.encryptionKey.gcpKmsEncryptionKey
	resource.backupConfig.includeSecrets
	resource.backupConfig.includeVolumeData
	resource.backupConfig.permissiveMode
	resource.backupConfig.selectedApplications.namespacedNames.name
	resource.backupConfig.selectedApplications.namespacedNames.namespace
	resource.backupConfig.selectedNamespaces.namespaces
	resource.backupSchedule.cronSchedule
	resource.backupSchedule.paused
	resource.backupSchedule.rpoConfig.exclusionWindows.daily
	resource.backupSchedule.rpoConfig.exclusionWindows.daysOfWeek.daysOfWeek
	resource.backupSchedule.rpoConfig.exclusionWindows.duration
	resource.backupSchedule.rpoConfig.targetRpoMinutes
	resource.cluster
	resource.deactivated
	resource.description
	resource.retentionPolicy.backupDeleteLockDays
	resource.retentionPolicy.backupRetainDays
	resource.retentionPolicy.locked
gkebackup.googleapis.com/Restore	resource.backup
	resource.description
	resource.filter.exclusionFilters.groupKind.resourceGroup
	resource.filter.exclusionFilters.groupKind.resourceKind
	resource.filter.exclusionFilters.name
	resource.filter.exclusionFilters.namespace
	resource.filter.inclusionFilters.groupKind.resourceGroup
	resource.filter.inclusionFilters.groupKind.resourceKind
	resource.filter.inclusionFilters.name
	resource.filter.inclusionFilters.namespace
	resource.volumeDataRestorePolicyOverrides.policy
	resource.volumeDataRestorePolicyOverrides.selectedPvcs.namespacedNames.name
	resource.volumeDataRestorePolicyOverrides.selectedPvcs.namespacedNames.namespace
gkebackup.googleapis.com/RestorePlan	resource.backupPlan
	resource.cluster
	resource.description
	resource.restoreConfig.allNamespaces
	resource.restoreConfig.clusterResourceConflictPolicy
	resource.restoreConfig.clusterResourceRestoreScope.allGroupKinds
	resource.restoreConfig.clusterResourceRestoreScope.excludedGroupKinds.resourceGroup
	resource.restoreConfig.clusterResourceRestoreScope.excludedGroupKinds.resourceKind
	resource.restoreConfig.clusterResourceRestoreScope.noGroupKinds
	resource.restoreConfig.clusterResourceRestoreScope.selectedGroupKinds.resourceGroup
	resource.restoreConfig.clusterResourceRestoreScope.selectedGroupKinds.resourceKind
	resource.restoreConfig.excludedNamespaces.namespaces
	resource.restoreConfig.namespacedResourceRestoreMode
	resource.restoreConfig.noNamespaces
	resource.restoreConfig.restoreOrder.groupKindDependencies.requiring.resourceGroup
	resource.restoreConfig.restoreOrder.groupKindDependencies.requiring.resourceKind
	resource.restoreConfig.restoreOrder.groupKindDependencies.satisfying.resourceGroup
	resource.restoreConfig.restoreOrder.groupKindDependencies.satisfying.resourceKind
	resource.restoreConfig.selectedApplications.namespacedNames.name
	resource.restoreConfig.selectedApplications.namespacedNames.namespace
	resource.restoreConfig.selectedNamespaces.namespaces
	resource.restoreConfig.substitutionRules.newValue
	resource.restoreConfig.substitutionRules.originalValuePattern
	resource.restoreConfig.substitutionRules.targetGroupKinds.resourceGroup
	resource.restoreConfig.substitutionRules.targetGroupKinds.resourceKind
	resource.restoreConfig.substitutionRules.targetJsonPath
	resource.restoreConfig.substitutionRules.targetNamespaces
	resource.restoreConfig.transformationRules.description
	resource.restoreConfig.transformationRules.fieldActions.fromPath
	resource.restoreConfig.transformationRules.fieldActions.op
	resource.restoreConfig.transformationRules.fieldActions.path
	resource.restoreConfig.transformationRules.fieldActions.value
	resource.restoreConfig.transformationRules.resourceFilter.groupKinds.resourceGroup
	resource.restoreConfig.transformationRules.resourceFilter.groupKinds.resourceKind
	resource.restoreConfig.transformationRules.resourceFilter.jsonPath
	resource.restoreConfig.transformationRules.resourceFilter.namespaces
	resource.restoreConfig.volumeDataRestorePolicy
	resource.restoreConfig.volumeDataRestorePolicyBindings.policy
	resource.restoreConfig.volumeDataRestorePolicyBindings.volumeType

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 da organização geridas.