AtlasBackupSchedule
Recurso personalizado
Nesta página
O recurso personalizado do AtlasBackupSchedule
configura um agendamento de backup que você pode aplicar ao seu Recurso Personalizado doAtlasDeployment
. Quando você cria o recurso personalizado do AtlasBackupSchedule
, o Atlas Kubernetes Operator tenta criar ou atualizar um agendamento de cópia de segurança.
Importante
Os Recursos Personalizados Não Excluem Mais Objetos por Padrão
O Atlas Kubernetes Operator utiliza arquivos de configuração de recurso personalizado para gerenciar sua configuração do Atlas, mas a partir do Atlas Kubernetes Operator 2.0, os recursos personalizados que você exclui no Kubernetes não são mais excluídos no Atlas. Em vez disso, o Atlas Kubernetes Operator simplesmente para de gerenciar estes recursos. Por exemplo, se você excluir um AtlasProject
Recurso Personalizado do no Kubernetes, o Atlas Kubernetes Operator não excluirá mais automaticamente o projeto correspondente do Atlas, evitando exclusões acidentais ou inesperadas. Para saber mais, incluindo como reverter este comportamento para o padrão anterior ao Atlas Kubernetes Operator 2.0, consulte Novo padrão: Proteção de exclusão no Atlas Kubernetes Operator 2.0.
O Atlas Kubernetes Operator realiza uma das seguintes ações usando oRecurso de API de Agendamento de Backup em Nuvemdo Atlas :
Cria um novo agendamento de backup.
Atualiza um agendamento de backup existente.
Se você remover o recurso AtlasBackupSchedule
do seu cluster Kubernetes, o Atlas parará de criar cópias de segurança do seu cluster.
Observação
Você deve fazer todos os seguintes para fazer backup de um cluster:
Criar uma política de backup
Crie um agendamento de backup e defina o campo
spec.policy.name
para o nome da política de backup configurada.Defina o campo
spec.backupRef.name
no Recurso PersonalizadoAtlasDeployment
para o nome do agendamento de backup configurado.
Para saber mais, consulte Fazer backup do seu cluster do Atlas.
Você pode especificar um agendamento de backup por cluster, mas pode usar o mesmo agendamento de backup para vários clusters.
Exemplo
O exemplo a seguir mostra um recurso personalizado AtlasBackupSchedule
configurado para tirar snapshots às 10:10 UTC e restaurar em até dois dias:
apiVersion: atlas.mongodb.com/v1 kind: AtlasBackupSchedule metadata: name: atlas-default-backupschedule spec: autoExportExabled: true copySettings: - cloudProvider: AWS frequencies: - HOURLY regionName: US_EAST_1 shouldCopyOplogs: true referenceHourOfDay: 10 referenceMinuteOfHour: 10 restoreWindowDays: 2 policy: name: atlas-default-backuppolicy namespace: mongodb-atlas-system
Parâmetros
Esta seção descreve alguns dos principais parâmetros de recursos personalizados AtlasBackupSchedule
disponíveis. Para obter uma lista completa dos parâmetros disponíveis, consulte a API da Política de Backup do Atlas Modify Cloud Backup. Consulte estas descrições, os exemplos disponíveis e a documentação daAPI do para personalizar suas especificações.
spec.autoExportEnabled
Tipo: booleano
Opcional
Sinalizador que especifica se o Atlas exporta snapshots de backup em cloud automaticamente para seu backup da Amazon Web Services . Especifique
true
para habilitar a exportação automática de snapshots de backup em cloud para o bucket Amazon Web Services . Especifiquefalse
para desabilitar a exportação automática.
spec.copySetting
Tipo: array
Obrigatório
Lista que contém um documento para cada item de configuração de cópia na política de backup desejada. Cada item de configuração de cópia define uma política de distribuição de snapshot .
spec.export.exportBucketId
Tipo: string
Opcional
String exclusiva de 24 caracteres hexadecimais que identifica o bucket da Amazon Web Services .
spec.export.frequencyType
Tipo: string
Opcional
Etiqueta legível por humanos que indica a taxa na qual o item da política de exportação ocorre.
spec.referenceHourOfDay
Tipo: número
Opcional
Número que indica a hora do dia UTC entre
0
e23
, inclusive, representando a hora do dia em que o Atlas tira snapshots para itens da política de backup.
spec.referenceMinuteOfHour
Tipo: número
Opcional
Número que indica os minutos após
spec.referenceHourOfDay
em que o Atlas tira snapshots para itens de política de backup. O valor deve estar entre0
59
inclusive.
spec.restoreWindowDays
Tipo: número
Opcional
Número que indica os dias de retorno no tempo para os quais você pode restaurar com precisão contínua do backup em cloud. O valor deve ser um número inteiro positivo, diferente de zero.
Essa configuração se aplica somente aos backups contínuos na cloud.
spec.policy
Tipo: array
Obrigatório
Lista que contém os detalhes da política de backup a ser aplicada.
spec.policy.name
Tipo: string
Obrigatório
metadata.name
valor dentro do Recurso PersonalizadoAtlasBackupPolicy
para a política de backup que você deseja aplicar. Você pode especificar apenas uma política de backup por agendamento de backup. Você não pode usar a mesma política de backup em vários agendamentos de backup.
spec.policy.namespace
Tipo: string
Obrigatório
String que indica o namespace que contém o Recurso Personalizado
AtlasBackupPolicy
para a política de backup que você deseja aplicar.