The AtlasBackupCompliancePolicy custom resource configures a Backup Compliance Policy that applies to the AtlasProject Custom Resource to protect your backup data. When you create the AtlasBackupCompliancePolicy custom resource, Atlas Kubernetes Operator tries to create or update a Backup Compliance Policy.
Atlas Kubernetes Operator does one of the following actions using the Atlas Backup Compliance Policy API Resource:
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 da API para personalizar suas especificações.
spec.authorizedEmailTipo: 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.authorizedUserFirstNameTipo: string
Obrigatório
Nome de um representante legal ou de segurança autorizado.
spec.authorizedUserLastNameTipo: string
Obrigatório
Sobrenome de um representante legal ou de segurança autorizado.
spec.copyProtectionEnabledTipo: booleano
Opcional
Flag that indicates whether to keep all snapshots when removing additional snapshot regions. This parameter defaults to
false.Observação
You can prevent cluster users from deleting backups copied to other regions even if you change this parameter to
false. To learn more, see Copy Snapshots to Additional Regions.
spec.encryptionAtRestEnabledTipo: 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
To enable this option, you must Enable Encryption at Rest for all current clusters. You can't enable this option on paused clusters that don't have Encryption at Rest enabled.
spec.onDemandPolicyTipo: objeto
Opcional
Objeto que contém as configurações do item de polÃtica de snapshot on-demand.
spec.onDemandPolicy.frequencyIntervalTipo: número
Obrigatório
Number that indicates the desired frequency of the policy item specified by
spec.onDemandPolicy.frequencyType. A value of1specifies the first instance of the correspondingspec.onDemandPolicy.frequencyType.Exemplo
Em uma PolÃtica de Conformidade de Backup mensal, o
1indica que o snapshot mensal ocorre no primeiro dia do mês.Em uma PolÃtica de Conformidade de Backup semanal,
1indica que o snapshot semanal ocorre na segunda-feira.
Esta configuração aceita os seguintes valores de frequência:
Por hora:
1,2,4,6,8e12.Diariamente:
1.Semanalmente:
1a7, onde1é segunda-feira e7é domingo.Por mês:
1a28e40, onde1é o primeiro dia do mês e40é o último dia do mês.
spec.onDemandPolicy.frequencyTypeTipo: string
Obrigatório
string que indica a frequência associada ao item da polÃtica. Os valores aceitos são:
hourly,daily,weeklyoumonthly.Observação
Você não pode especificar várias polÃticas de backup do
hourlyedailyonDemandPolicy.
spec.onDemandPolicy.retentionUnitTipo: string
Obrigatório
String that indicates the scope of the policy item. Together with
spec.onDemandPolicy.retentionValue, these settings define the length of time to retain snapshots. Accepted values are:days,weeks, ormonths.
spec.onDemandPolicy.retentionValueTipo: string
Obrigatório
String that indicates the value to associate with
spec.onDemandPolicy.retentionUnit. Together withspec.onDemandPolicy.retentionUnit, these settings define the length of time to retain snapshots.
spec.overwriteBackupPoliciesTipo: booleano
Obrigatório
Sinalizador que indica se todas as polÃticas de backup devem ser atualizadas no projeto, independentemente do que for especificado no
AtlasBackupPolicyRecurso 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 noAtlasBackupPolicyRecurso personalizado. O Atlas substitui oAtlasBackupPolicyRecurso Personalizado e o status desse recurso personalizado é atualizado paraReady: False. Você deve atualizar manualmente o recurso personalizadoAtlasBackupPolicypara 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.pitEnabledTipo: booleano
Opcional
Sinalizador que indica se é necessário um restore ponto -in-time para todos os clusters. Este parâmetro é padronizado como
false.
spec.restoreWindowDaysTipo: número
Condicional
Number of days in the restore window for point in time restore. If you set
spec.pitEnabledtotrue, you must specify this parameter.Importante
You can't configure a restore window that is longer than the Hourly Snapshot Retention Time. After you save this Backup Compliance Policy, you can't change this setting without MongoDB support. To change this setting, the security or legal representative specified for the Backup Compliance Policy must request support and complete an extensive verification process.
spec.scheduledPolicyItemsTipo: objeto
Opcional
Objeto que contém as configurações dos itens da polÃtica de snapshots.
spec.scheduledPolicyItems.frequencyIntervalTipo: número
Obrigatório
Number that indicates the desired frequency of the policy item specified by
spec.scheduledPolicyItems.frequencyType. A value of1specifies the first instance of the correspondingspec.scheduledPolicyItems.frequencyType.Exemplo
Em uma PolÃtica de Conformidade de Backup mensal, o
1indica que o snapshot mensal ocorre no primeiro dia do mês.Em uma PolÃtica de Conformidade de Backup semanal,
1indica que o snapshot semanal ocorre na segunda-feira.
Esta configuração aceita os seguintes valores de frequência:
Por hora:
1,2,4,6,8e12.Diariamente:
1.Semanalmente:
1a7, onde1é segunda-feira e7é domingo.Por mês:
1a28e40, onde1é o primeiro dia do mês e40é o último dia do mês.
spec.scheduledPolicyItems.frequencyTypeTipo: string
Obrigatório
string que indica a frequência associada ao item da polÃtica. Os valores aceitos são:
hourly,daily,weeklyoumonthly.Observação
Você não pode especificar vários scheduledPolicyItems da polÃtica de backup do
hourlyedaily.
spec.scheduledPolicyItems.retentionUnitTipo: string
Obrigatório
String that indicates the scope of the policy item. Together with
spec.scheduledPolicyItems.retentionValue, these settings define the length of time to retain snapshots. Accepted values are:days,weeks, ormonths.
spec.scheduledPolicyItems.retentionValueTipo: string
Obrigatório
String that indicates the value to associate with
spec.scheduledPolicyItems.retentionUnit. Together withspec.scheduledPolicyItems.retentionUnit, these settings define the length of time to retain snapshots.