`AtlasBackupCompliancePolicy` Recurso personalizado

Nesta página

Exemplo

Parâmetros

O recurso personalizado AtlasBackupCompliancePolicy configura umaPolítica de Conformidade de Backup que se aplica ao recurso personalizado AtlasProject para proteger seus dados de backup. Quando você cria o recurso personalizado AtlasBackupCompliancePolicy , o Atlas Kubernetes Operator tenta criar ou atualizar uma Política de Conformidade de Backup.

O Atlas Kubernetes Operator realiza uma das seguintes ações usando o recurso API da Política de compliance de backupdo Atlas :

Cria uma nova Política de Conformidade de Backup.
Atualiza uma Política de Conformidade de Backup existente.

Importante

Consulte as Ações proibidas e as Considerações. Uma Política de Conformidade de Backup se aplica como a política de backup mínima para todos os clusters no projeto. Ela protege todos os snapshots existentes. Além disso, impede que qualquer usuário, independentemente da função, modifique ou exclua snapshots existentes antes da expiração. As alterações feitas nessa política se aplicam apenas a snapshots futuros. Se você habilitar a Política de Compliance de Backup, ela limitará sua capacidade de reduzir os custos de armazenamento de backup. Não é possível ajustar a retenção ou excluir um backup para reduzir os custos de armazenamento de backup.

Exemplo

O exemplo a seguir mostra um recurso personalizado do BackupCompliancePolicy . Para saber mais, consulte Configurar uma Política de compliance de backup.

apiVersion: atlas.mongodb.com/v1
kind: AtlasBackupCompliancePolicy
metadata:
  name: my-backup-compliance-policy
  namespace: mongodb-atlas-system
spec:
  authorizedEmail: john.doe@example.com
  authorizedUserFirstName: John
  authorizedUserLastName: Doe
  copyProtectionEnabled: false
  encryptionAtRestEnabled: false
  onDemandPolicy:
    retentionUnit: weeks
    retentionValue: 3
  overwriteBackupPolicies: false
  pointInTimeEnabled: true
  restoreWindowDays: 42
  scheduledPolicyItems:
  - frequencyInterval: 2
    frequencyType: daily
    retentionUnit: days
    retentionValue: 7

Parâmetros

Esta seção descreve alguns dos principais parâmetros de recursos personalizados BackupCompliancePolicy disponíveis. Para obter uma lista completa dos parâmetros disponíveis, consulte a API de configurações Atualizar do Atlas ou Habilitar a Política de Compliance de Backup. Consulte estas descrições, os exemplos disponíveis e a documentação daAPI do para personalizar suas especificações.

spec.authorizedEmail

Tipo: string

Obrigatório

Endereço de e-mail de um representante legal ou de segurança autorizado.

Importante

Um endereço de e-mail inválido ou incorreto impede que você modifique ou habilite esta Política de Compliance de Backup até que a corrija com o Suporte MongoDB.

spec.authorizedUserFirstName

Tipo: string

Obrigatório

Nome de um representante legal ou de segurança autorizado.

spec.authorizedUserLastName

Tipo: string

Obrigatório

Sobrenome de um representante legal ou de segurança autorizado.

spec.copyProtectionEnabled

Tipo: booleano

Opcional

Sinalizador que indica se todos os snapshots devem ser mantidos ao remover regiões adicionais de snapshots. Este parâmetro é padronizado como false.

Observação

Você pode impedir que os usuários do cluster excluam backups copiados para outras regiões, mesmo se você alterar este parâmetro para false. Para saber mais, consulte Configurar o Atlas para Copiar Automaticamente os Snapshots para Outras Regiões.

spec.encryptionAtRestEnabled

Tipo: booleano

Opcional

Sinalizador que indica se é necessário Encryption at Rest usando o Gerenciamento de Chaves do Cliente para todos os clusters. Este parâmetro é padronizado como false.

Observação

Para habilitar essa opção, você deve habilitar a encryption at rest para todos os clusters atuais. Não é possível habilitar essa opção em clusters pausados que não tenham a encryption at rest habilitada.

spec.onDemandPolicy

Tipo: objeto

Opcional

Objeto que contém as configurações do item de política de snapshot on-demand.

spec.onDemandPolicy.frequencyInterval

Tipo: número

Obrigatório

Número que indica a frequência desejada do item da política especificado por spec.onDemandPolicy.frequencyType. Um valor de 1 especifica a primeira instância do spec.onDemandPolicy.frequencyType correspondente.

Exemplo

Em uma Política de Conformidade de Backup mensal, o 1 indica que o snapshot mensal ocorre no primeiro dia do mês.
Em uma Política de Conformidade de Backup semanal, 1 indica que o snapshot semanal ocorre na segunda-feira.

Esta configuração aceita os seguintes valores de frequência:

Por hora: 1, 2, 4, 6, 8 e 12.
Diariamente: 1.
Semanalmente: 1 a 7, onde 1 é segunda-feira e 7 é domingo.
Por mês: 1 a 28 e 40, onde 1 é o primeiro dia do mês e 40 é o último dia do mês.

spec.onDemandPolicy.frequencyType

Tipo: string

Obrigatório

string que indica a frequência associada ao item da política. Os valores aceitos são: hourly, daily, weekly ou monthly.

Observação

Você não pode especificar várias políticas de backup do hourly e daily onDemandPolicy.

spec.onDemandPolicy.retentionUnit

Tipo: string

Obrigatório

string que indica o escopo do item da política. Juntamente com spec.onDemandPolicy.retentionValue, essas configurações definem o período de tempo para reter snapshots. Os valores aceitos são: days, weeks ou months.

spec.onDemandPolicy.retentionValue

Tipo: string

Obrigatório

string que indica o valor a ser associado a spec.onDemandPolicy.retentionUnit. Juntamente com spec.onDemandPolicy.retentionUnit, essas configurações definem o período de tempo para reter snapshots.

spec.overwriteBackupPolicies

Tipo: booleano

Obrigatório

Sinalizador que indica se todas as políticas de backup devem ser atualizadas no projeto, independentemente do que for especificado no AtlasBackupPolicy Recurso Personalizado.

Importante

Se você definir esse parâmetro como true, o Atlas atualizará todas as políticas de backup no projeto, independentemente do que for especificado no AtlasBackupPolicy Recurso personalizado. O Atlas substitui o AtlasBackupPolicy Recurso Personalizado e o status desse recurso personalizado é atualizado para Ready: False. Você deve atualizar manualmente o recurso personalizadoAtlasBackupPolicy para se alinhar com a política de compliance de backup.

Se você definir esse parâmetro como false, a criação da Política de Conformidade de Backup falhará se as políticas de backup existentes não atenderem à Política de Conformidade de Backup.

spec.pitEnabled

Tipo: booleano

Opcional

Sinalizador que indica se é necessário um restore ponto -in-time para todos os clusters. Este parâmetro é padronizado como false.

spec.restoreWindowDays

Tipo: número

Condicional

Número de dias na janela de restauração para restauração ponto -in-time. Se você definir spec.pitEnabled como true, deverá especificar este parâmetro.

Importante

Você não pode configurar uma janela de restauração que seja maior do que o tempo de retenção de snapshots por hora. Depois de salvar a Política de Compliance de Backup, você não poderá alterar essa configuração sem o suporte do MongoDB . Para alterar essa configuração, o representante legal ou de segurança especificado na política deverá solicitar suporte e passar por um extenso processo de verificação.

spec.scheduledPolicyItems

Tipo: objeto

Opcional

Objeto que contém as configurações dos itens da política de snapshots.

spec.scheduledPolicyItems.frequencyInterval

Tipo: número

Obrigatório

Número que indica a frequência desejada do item da política especificado por spec.scheduledPolicyItems.frequencyType. Um valor de 1 especifica a primeira instância do spec.scheduledPolicyItems.frequencyType correspondente.

Exemplo

Em uma Política de Conformidade de Backup mensal, o 1 indica que o snapshot mensal ocorre no primeiro dia do mês.
Em uma Política de Conformidade de Backup semanal, 1 indica que o snapshot semanal ocorre na segunda-feira.

Esta configuração aceita os seguintes valores de frequência:

Por hora: 1, 2, 4, 6, 8 e 12.
Diariamente: 1.
Semanalmente: 1 a 7, onde 1 é segunda-feira e 7 é domingo.
Por mês: 1 a 28 e 40, onde 1 é o primeiro dia do mês e 40 é o último dia do mês.

spec.scheduledPolicyItems.frequencyType

Tipo: string

Obrigatório

string que indica a frequência associada ao item da política. Os valores aceitos são: hourly, daily, weekly ou monthly.

Observação

Você não pode especificar vários scheduledPolicyItems da política de backup do hourly e daily .

spec.scheduledPolicyItems.retentionUnit

Tipo: string

Obrigatório

string que indica o escopo do item da política. Juntamente com spec.scheduledPolicyItems.retentionValue, essas configurações definem o período de tempo para reter snapshots. Os valores aceitos são: days, weeks ou months.

spec.scheduledPolicyItems.retentionValue

Tipo: string

Obrigatório

string que indica o valor a ser associado a spec.scheduledPolicyItems.retentionUnit. Juntamente com spec.scheduledPolicyItems.retentionUnit, essas configurações definem o período de tempo para reter snapshots.

Voltar

AtlasBackupSchedule

AtlasTeam