AtlasBackupPolicy
Recurso personalizado
Nesta página
O recurso personalizado AtlasBackupPolicy
configura uma política de backup que se aplica ao AtlasBackupSchedule
Recurso personalizado que você pode aplicar ao seu AtlasDeployment
Recurso personalizado. Quando você cria o AtlasBackupPolicy
recurso personalizado, o Atlas Kubernetes Operator tenta criar ou atualizar uma política de backup.
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 uma nova política de backup.
Atualiza uma política de backup existente.
Se você remover o recurso AtlasBackupPolicy
do seu cluster Kubernetes, o Atlas parará de criar cópias de segurança do seu cluster.
Observação
Você deve executar todas as seguintes tarefas para fazer backup de um cluster:
Crie 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.
Exemplo
O exemplo a seguir mostra um recurso personalizado AtlasBackupPolicy
configurado para tirar snapshots semanalmente e reter os snapshots por sete dias:
apiVersion: atlas.mongodb.com/v1 kind: AtlasBackupPolicy metadata: name: "atlas-default-backuppolicy" spec: items: - frequencyType: "weekly" frequencyInterval: 1 retentionUnit: "days" retentionValue: 7
Parâmetros
Esta seção descreve alguns dos principais parâmetros de recursos personalizados AtlasBackupPolicy
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.items
Tipo: array
Condicional
Lista que contém os parâmetros do item da política da API. Para obter uma lista completa dos parâmetros disponíveis, consulte a API da Política de Backup do Atlas Modify Cloud Backup.
spec.items.frequencyInterval
Tipo: número
Obrigatório
Número que indica a frequência desejada do novo item da política de backup especificado pelo
spec.items.frequencyType
. Um valor de1
especifica a primeira instância dospec.items.frequencyType
correspondente.Exemplo
Em um item da política mensal,
1
indica que o snapshot mensal ocorre no primeiro dia do mês.Em um item da política 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
e12
.Diariamente:
1
.Semanalmente:
1
a7
, onde1
é segunda-feira e7
é domingo.Por mês:
1
a28
e40
, onde1
é o primeiro dia do mês e40
é o último dia do mês.Anual:
1
a12
, onde1
é o primeiro dia de janeiro e12
é o primeiro dia de dezembro.
spec.items.frequencyType
Tipo: string
Obrigatório
string que indica a frequência associada ao item da política de backup. Os valores aceitos são:
hourly
,daily
,weekly
,monthly
ouyearly
.Observação
Você não pode especificar vários itens da política de backup
hourly
edaily
.
spec.items.retentionUnit
Tipo: string
Obrigatório
string que indica o escopo do item da política de backup. Juntamente com
spec.items.retentionValue
, essas configurações definem o período de tempo para reter snapshots. Os valores aceitos são:days
,weeks
,months
ouyears
.
spec.items.retentionValue
Tipo: string
Obrigatório
string que indica o valor a ser associado a
spec.items.retentionUnit
. Juntamente comspec.items.retentionUnit
, essas configurações definem o período de tempo para reter snapshots.