Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Nesta página, descrevemos como criar e gerenciar planos de backup para cargas de trabalho de cluster no Google Distributed Cloud (GDC) isolado.
Os planos de backup oferecem as funções de configuração, local e gerenciamento para
uma sequência de backups. Um plano de backup contém uma configuração de backup, incluindo
o cluster de origem e a seleção de cargas de trabalho para fazer backup. O Google recomenda
fornecer a cada cluster pelo menos um plano de backup.
É possível criar um ou mais planos de backup para cada cluster. Talvez você queira particionar os backups do cluster por um dos seguintes motivos:
Em vez de um backup muito grande feito em uma única hora do dia, é preciso ter vários backups menores distribuídos ao longo do dia.
Você quer fazer backup de algumas partes do cluster com mais frequência do que de outras,
como backups diários para alguns namespaces e backups por hora para outros.
Um único cluster ou máquina virtual (VM) pode pertencer a um ou mais planos de backup. Um plano de backup não pode abranger mais de um cluster. No entanto, um único plano de backup pode capturar várias VMs se elas estiverem no mesmo cluster. Todos os recursos de backup e restauração precisam ser associados a um nome de projeto.
Antes de começar
Para criar um plano de backup, você precisa ter o seguinte:
O papel necessário de identidade e acesso:
Administrador de backup de cluster de usuário: gerencia recursos de backup, como planos de backup e restauração em clusters de usuário. Peça ao administrador do IAM da organização para conceder a você o papel de
administrador de backup de cluster de usuário (user-cluster-backup-admin). Para mais informações, consulte Definições de papéis.
Se você for um operador de aplicativos, peça ao administrador com privilégios de administrador de backup do cluster de usuário para criar um plano de backup.
Criar um plano de backup
Recomendamos que você defina uma programação cron para o plano de backup. Assim, os backups serão criados automaticamente de acordo com essa programação. Também é possível fazer backup manual das suas cargas de trabalho. Para mais informações, consulte Criar um backup manual.
Crie planos de backup usando o console do GDC ou a API.
Console
Faça login no console do GDC.
No menu de navegação, clique em Backup para clusters.
Clique em Criar plano de backup.
Na seção Detalhes do plano, conclua as etapas a seguir e clique em
Continuar:
Na lista Cluster, selecione o cluster para fazer backup.
Na lista Projeto, selecione o projeto.
No campo Nome do plano de backup, insira o nome escolhido.
(Opcional) Em Descrição do plano de backup, insira uma descrição para o plano.
No campo Repositório de backup, selecione um repositório de backup. Os repositórios de backup são um conjunto de implementações de armazenamento de objetos.
Clique em Próxima.
Na seção Escopo e criptografia, conclua as etapas a seguir e clique em Continuar:
Selecione um dos seguintes escopos para o plano de backup:
Clique em Cluster inteiro para fazer backup de todos os recursos de namespace
no backup.
Clique em Namespaces selecionados no cluster para escolher os
namespaces no backup a serem restaurados.
Clique em Editar namespace do cluster e em Adicionar namespace do cluster para inserir um Namespace.
Clique em Aplicativos protegidos selecionados neste cluster para
adicionar recursos especificando o namespace e o nome do aplicativo.
Clique em Editar aplicativos protegidos e depois em Adicionar
aplicativo protegido para inserir um Namespace e um
Aplicativo protegido.
Clique em Incluir secrets para incluir recursos do Kubernetes Secret.
Clique em Incluir dados do volume permanente se quiser armazenar os dados de volume
no backup. Desmarque essa caixa de seleção se quiser criar volumes vazios durante a restauração.
Na seção Programação e retenção, siga estas etapas
e clique em Continuar:
Para definir uma programação, insira uma expressão usando a sintaxe cron padrão
no campo String CRON. Por exemplo, a expressão 10 3 * *
* cria um backup às 3h10 todos os dias. Todos os horários são interpretados como UTC. O intervalo mínimo entre
backups programados é de 10 minutos.
No campo Excluir backups após, defina o número de dias em que o backup será mantido. Quando o número de dias é atingido, o<br>backup é excluído automaticamente.
Defina por quantos dias os backups não podem ser excluídos.
Para bloquear a política de retenção, clique no ícone de bloqueio para mudar o status de
Desativado para Ativado.
Confira os detalhes do plano de backup e clique em Criar plano.
API
Crie um recurso personalizado ClusterBackupPlan no cluster para programar backups. Um plano de backup programa backups periodicamente com base no backupSchedule.
Os recursos ClusterBackupPlan são recursos de namespace. Confira um exemplo de ClusterBackupPlan:
Substitua PROJECT_NAME pelo nome do projeto do GDC.
Este exemplo inclui os seguintes valores:
Valor
Descrição
targetClusterName
O nome do cluster a ser armazenado em backup.
targetClusterType
O tipo de cluster a ser armazenado em backup. Por exemplo, "UserCluster" e "ManagementAPI".
backupSchedule
A programação que indica com que frequência o backup deve ser realizado.
cronSchedule: uma programação crontab que indica quando programar backups.
paused: Se true, os backups periódicos não serão programados.
clusterBackupConfig
Detalhes da configuração dos backups:
backupScope: Indica quais recursos são armazenados em backup. Especifique uma destas opções:
O allNamespaces: captura todos os recursos em todos os namespaces.
selectedNamespaces: captura recursos na lista de namespaces especificados.
selectedApplication: captura recursos definidos por
protectedApplications.
clusterBackupRepositoryName: o repositório de destino que armazena os
backups. Ele precisa ser importado como ReadWrite..
retentionPolicy
Determina por quanto tempo os backups persistem no
backupRepository.
backupDeleteLockDays: impede a exclusão do backup
pelo número de dias especificado após a criação.
backupRetainDays: exclui backups após o número de dias especificado após a criação do backup.
As políticas de retenção não substituem as políticas do
local de armazenamento nem podem exceder 90 dias.
description
A descrição do plano de backup.
Depois que um plano de backup é criado, os backups são criados automaticamente com a
configuração especificada com base na programação de backup.
Ver um plano de backup
Para ver um plano de backup usando o console do GDC:
Faça login no console do GDC.
No menu de navegação, clique em Backup para clusters.
Clique em Selecionar projeto e escolha uma organização ou um projeto, dependendo da sua função:
Administrador de backup de cluster de usuário: selecione uma organização para ver todos os planos de backup ou um projeto para ver todos os planos de backup em um projeto.
Criador de backup: selecione um projeto para ver todos os planos de backup nele.
Clique na guia Planos de backup.
Clique em um plano de backup na lista para conferir os detalhes. Os usuários com privilégios de administrador de backup do cluster de usuário podem ver todos os planos de backup na organização. Os usuários
com a função "Criador de backup" podem ver todos os planos de backup no projeto
selecionado.
Editar um plano de backup
Edite um plano de backup usando o console do GDC:
Faça login no console do GDC.
No menu de navegação, clique em Backup para clusters.
Clique em Selecionar projeto e escolha uma organização ou um projeto, dependendo da sua função:
Administrador de backup de cluster de usuário: selecione uma organização para ver todos os planos de backup nela ou selecione um projeto para ver todos os planos de backup em um projeto.
Criador de backup: selecione um projeto para conferir todos os planos de backup dele.
Clique na guia Planos de backup.
Clique no nome do plano de backup que você quer editar.
Clique na guia Configuração do plano para ver os campos que podem ser modificados.
Clique no ícone edit Editar em Programação e retenção para editar esse recurso:
Para atualizar uma programação, insira uma expressão usando a sintaxe cron padrão
no campo String CRON. Por exemplo, a expressão 10 3 * * * cria um backup às 3h10 todos os dias. Todos os horários são interpretados como UTC. O intervalo mínimo entre
backups programados é de 10 minutos.
No campo Excluir backups após, defina o número de dias em que o backup será mantido. Quando o número de dias é atingido, o<br>backup é excluído automaticamente.
No campo Impedir exclusão por, defina o número de dias em que os backups não podem ser excluídos.
Para bloquear a política de retenção, clique no ícone de bloqueio
de Desativado para Ativado.
Clique no botão Salvar para confirmar as mudanças.
Desativar um plano de backup
Desative um plano de backup usando o console do GDC:
Faça login no console do GDC.
No menu de navegação, clique em Backup para clusters.
Clique em Selecionar projeto e escolha uma organização ou um projeto, dependendo da sua função:
Administrador de backup de cluster de usuário: selecione uma organização para ver todos os planos de backup ou um projeto para ver todos os planos de backup em um projeto.
Criador de backup: selecione um projeto para ver todos os planos de backup nele.
Clique na guia Planos de backup.
Clique no nome do plano de backup que você quer desativar.
Clique no botão Desativar plano.
Insira o nome do plano de backup que você está desativando no campo.
Clique no botão Desativar para concluir a desativação do plano de backup.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Informações incorretas ou exemplo de código","incorrectInformationOrSampleCode","thumb-down"],["Não contém as informações/amostras de que eu preciso","missingTheInformationSamplesINeed","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2025-09-04 UTC."],[[["\u003cp\u003eBackup plans in Google Distributed Cloud (GDC) air-gapped define the configuration, location, and management for a series of backups, allowing for multiple smaller backups throughout the day or differing backup frequencies for different parts of a cluster.\u003c/p\u003e\n"],["\u003cp\u003eEach cluster should have at least one backup plan, and a single cluster or virtual machine (VM) can be part of multiple backup plans, although a plan cannot span across multiple clusters.\u003c/p\u003e\n"],["\u003cp\u003eBackup plans can be created and managed through the GDC console or the API, with options to back up the entire cluster, specific namespaces, or selected applications, and the ability to include secrets and persistent volume data.\u003c/p\u003e\n"],["\u003cp\u003eBackup plans can be scheduled using cron syntax, and users can set retention policies for backups, including how long to keep backups and for how many days they are prevented from being deleted.\u003c/p\u003e\n"],["\u003cp\u003eBackup plans can be viewed, edited, and deactivated through the GDC console by users with the appropriate roles, with deactivation preventing future backups without deleting existing ones.\u003c/p\u003e\n"]]],[],null,["# Plan a set of backups\n\nThis page describes how to create and manage backup plans for cluster workloads in Google Distributed Cloud (GDC) air-gapped.\n\n*Backup plans* provide the configuration, location, and management functions for\na sequence of backups. A backup plan contains a backup configuration, including\nthe source cluster and the selection of workloads to back up. Google recommends\nproviding every cluster with at least one backup plan.\n\nYou can create one or more backup plans for each cluster. You might want to\npartition the backups of your cluster for one of the following reasons:\n\n- Instead of having one very large backup taken at a single time of the day, you want multiple smaller backups distributed throughout the day.\n- You want to back up some portions of your cluster more often than others, such as daily backups for some namespaces and hourly backups for others.\n\nA single cluster or virtual machine (VM) can belong to one or more backup plans.\nA backup plan cannot span more than one cluster; however, a single backup plan\ncan capture multiple VMs if they exist in the same cluster. All backup\nand restore resources must be associated with a project name.\n\nBefore you begin\n----------------\n\nTo create a backup plan, you must have the following:\n\n- The necessary identity and access role:\n - User Cluster Backup Admin: manages backup resources such as backup and restore plans in user clusters. Ask your Organization IAM Admin to grant you the User Cluster Backup Admin (`user-cluster-backup-admin`) role. For more information, see [Role definitions](/distributed-cloud/hosted/docs/latest/gdch/platform/pa-user/iam/role-definitions).\n- If you are an Application Operator, ask your administrator that has User Cluster Backup Admin privileges to create a backup plan for you.\n\nCreate a backup plan\n--------------------\n\nWe recommend that you define a cron schedule for the backup plan, so that\nbackups are automatically created according to that schedule. You can also\nmanually back up your workloads. For more information, see [Create a manual backup](/distributed-cloud/hosted/docs/latest/gdch/platform-application/pa-ao-operations/back-up-workloads#create-manual-backup).\n\nCreate backup plans using the GDC console or the API. \n\n### Console\n\n1. Sign in to the GDC console.\n2. In the navigation menu, click **Backup for Clusters**.\n3. Click **Create Backup Plan**.\n4. In the **Plan details** section, complete the following steps and click **Continue** :\n 1. In the **Cluster** list, select the cluster to back up.\n 2. In the **Project** list, select the project.\n 3. In the **Backup plan name** field, enter your chosen backup plan name.\n 4. (Optional) In **Backup plan description** enter a description for the backup plan.\n 5. In the **Backup repo** field, select a backup repository. Backup repositories are a set of object storage implementations.\n 6. Click **Next**.\n5. In the **Scope and encryption** section, complete the following steps\n and click **Continue**:\n\n 1. Select one of the following scopes for the backup plan:\n\n 1. Click **Entire cluster** to back up all namespace resources in the backup.\n 2. Click **Selected namespaces within the cluster** to choose the namespaces in the backup to restore.\n 1. Click **Edit Cluster Namespace** and then **Add Cluster\n Namespace** to enter a **Namespace**.\n 3. Click **Selected protected applications within this cluster** to add resources by specifying the namespace and the application name.\n 1. Click **Edit Protected Applications** and then **Add\n Protected Application** to enter a **Namespace** and **Protected Application**.\n 2. Click **Include Secrets** to include Kubernetes `Secret` resources.\n\n 3. Click **Include persistent volume data** if you want the volume data\n in your backup. Clear this checkbox if you want to create empty\n volumes during the restore.\n\n6. In the **Schedule and retention** section, complete the following steps\n and click **Continue**:\n\n 1. To define a schedule, enter an expression using standard cron syntax in the **CRON string** field. For example, the expression `10 3 * *\n *` creates a backup at 0310 every day. All times are interpreted as UTC. The minimum interval between scheduled backups is 10 minutes.\n 2. In the **Delete backups after** field, set the number of days for which to retain the backup. Once the number of days is reached, the backup is automatically deleted.\n 3. Set the number of days during which backups cannot be deleted.\n 4. To lock the retention policy, click the lock icon to turn the lock from **Off** to **On**.\n7. Review the backup plan details and click **Create Plan**.\n\n### API\n\nCreate a `ClusterBackupPlan` custom resource in the cluster to schedule backups. A\nbackup plan periodically schedules backups based on the `backupSchedule`.\n`ClusterBackupPlan` resources are namespace resources. Here's an example of a `ClusterBackupPlan`: \n\n apiVersion: backup.gdc.goog/v1\n kind: ClusterBackupPlan\n metadata:\n name: backup-plan\n namespace: \u003cvar translate=\"no\"\u003e\u003cspan class=\"devsite-syntax-l devsite-syntax-l-Scalar devsite-syntax-l-Scalar-Plain\"\u003ePROJECT_NAME\u003c/span\u003e\u003c/var\u003e\n spec:\n targetCluster:\n targetClusterType: UserCluster\n targetClusterName:\n kind: \"Cluster\"\n name: \"cluster-sample\"\n backupSchedule:\n cronSchedule: \"*/30 * * * *\"\n paused: false\n clusterBackupConfig:\n backupScope:\n selectedNamespaces:\n namespaces: [\"nginx\"]\n clusterBackupRepositoryName: backup-repository\n retentionPolicy:\n backupDeleteLockDays: 10\n backupRetainDays: 10\n\nReplace \u003cvar translate=\"no\"\u003ePROJECT_NAME\u003c/var\u003e with the name of your GDC project.\n\nThis example includes the following values:\n\nAfter a backup plan is created, backups are automatically created with the\nspecified backup configuration based on the backup schedule.\n\nView a backup plan\n------------------\n\nView a backup plan using the GDC console:\n\n1. Sign in to the GDC console.\n2. In the navigation menu, click **Backup for Clusters**.\n3. Click **Select project** and select an organization or project depending on your role:\n - User Cluster Backup Admin: Select an organization to see all backup plans in an organization or select a project to see all backup plans in a project.\n - Backup Creator: Select a project to see all backup plans in a project.\n4. Click the **Backup Plans** tab.\n5. Click a backup plan in the list to view its details. Users with User Cluster Backup Admin privileges can view all backup plans in the organization. Users with the Backup Creator role can view all backup plans in the selected project.\n\nEdit a backup plan\n------------------\n\nEdit a backup plan using the GDC console:\n\n1. Sign in to the GDC console.\n2. In the navigation menu, click **Backup for Clusters**.\n3. Click **Select project** , and select an organization or project depending on your role:\n - User Cluster Backup Admin: Select an organization to see all backup plans in an organization, or select a project to see all of the backup plans in a project.\n - Backup Creator: Select a project to see all of the backup plans in a project.\n4. Click the **Backup Plans** tab.\n5. Click the name of the backup plan that you want to edit.\n6. Click the **Plan Configuration** tab to view the fields that can be modified.\n7. Click the *edit* Edit icon for **Schedule and retention** to edit that resource:\n\n 1. To update a schedule, enter an expression using standard cron syntax in the **CRON string** field. For example, the expression `10 3 * * *` creates a backup at 0310 every day. All times are interpreted as UTC. The minimum interval between scheduled backups is 10 minutes.\n 2. In the **Delete backups after** field, set the number of days for which to retain the backup. Once the number of days is reached, the backup is automatically deleted.\n 3. In the **Prevent deletion for** field, set the number of days during which backups cannot be deleted.\n\n | **Note:** If both fields are enabled, the value of the **Prevent deletion for** field must be less than the value of the **Delete backups after** field.\n 4. To lock the retention policy, click the lock icon\n from **Off** to **On**.\n\n | **Note:** Once the retention policy is locked, you won't be able to edit the retention policy of this backup plan again. You can only update the schedule.\n 5. Click the **Save** button to confirm your changes.\n\nDeactivate a backup plan\n------------------------\n\nDeactivate a backup plan using the GDC console:\n\n1. Sign in to the GDC console.\n2. In the navigation menu, click **Backup for Clusters**.\n3. Click **Select project** , and select an organization or project depending on your role:\n - User Cluster Backup Admin: Select an organization to see all backup plans in an organization or select a project to see all backup plans in a project.\n - Backup Creator: Select a project to see all backup plans in a project.\n4. Click the **Backup Plans** tab.\n5. Click the name of the backup plan you want to deactivate.\n6. Click the **Deactivate Plan** button.\n7. Enter the name of the backup plan you are deactivating into the field.\n8. Click the **Deactivate** button to complete the deactivation of this backup plan.\n\n | **Note:** This operation cannot be undone. Deactivating the backup plan does not delete the backups contained within it, but no new backups can be created automatically or manually.\n\nWhat's next\n-----------\n\n- [Back up your workloads](/distributed-cloud/hosted/docs/latest/gdch/platform-application/pa-ao-operations/cluster-backup/back-up-workloads)"]]
