Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Nesta página, detalhamos como criar backups manuais, ver backups atuais e excluir backups atuais para cargas de trabalho de cluster no Google Distributed Cloud (GDC) isolado por air-gap.
Antes de começar
Para criar, visualizar e excluir backups, você precisa ter o seguinte:
O papel necessário de identidade e acesso:
Para usuários administradores da plataforma (PA, na sigla em inglês):
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 usuários do operador de aplicativos (AO, na sigla em inglês):
Criador de backup: cria backups e restaurações manuais. Peça ao administrador do IAM do projeto para conceder a você o papel de criador de backup (backup-creator).
Os usuários do AO só podem fazer backups manuais de um plano de backup
existente.
Crie um backup manual
Se o plano de backup definir uma programação para o backup, eles serão
criados automaticamente de acordo com essa programação. Também é possível criar um backup manualmente
fora do escopo da programação do plano de backup. Por exemplo, convém fazer backup das cargas de trabalho antes de fazer upgrade dos aplicativos. Um backup não
inclui informações de configuração do cluster, como configurações de nós, pools de
nós, tamanho inicial do cluster ou quais recursos estão ativados.
Duas formas de dados são capturadas em um backup:
Backup de configuração: um conjunto de descrições de recursos do Kubernetes extraídas do
servidor de API do cluster que está passando pelo backup.
Backup de volume: um backup de PersistentVolumeClaims.
Console
Faça login no console do GDC.
No menu de navegação, clique em Backup para clusters.
Clique na guia Planos de backup.
Clique no plano que você quer usar para o backup.
Clique em Iniciar um backup.
Insira um nome e uma descrição opcional para o backup.
Defina o número de dias para reter o backup. Quando esse número de dias é atingido, o backup é
excluído automaticamente.
Defina por quantos dias os backups não podem ser excluídos.
Clique em Iniciar.
API
O backup manual precisa referenciar um plano de backup existente para a configuração de backup, e ele precisa ser criado emitindo um ManualClusterBackupRequest.
Substitua PROJECT_NAME pelo nome do projeto do GDC.
Este exemplo inclui os seguintes valores:
Valor
Descrição
clusterBackupName
O nome do backup a ser criado.
clusterBackupPlanRef
O nome do ClusterBackupPlan a ser usado para a configuração do
backup. O plano de backup precisa estar no mesmo namespace que o
ManualClusterBackupRequest.
deleteLockDays
Impede a exclusão do backup pelo número de dias especificado após a criação. Isso substitui o retentionPolicy no
ClusterBackupPlan.
retainDays
Exclui os backups quando o número de dias especificado é atingido após a criação do backup. Esse valor substitui o retentionPolicy no ClusterBackupPlan.
As políticas de retenção não substituem as políticas de retenção do local de armazenamento e não podem exceder 90 dias.
Ver um backup
Os usuários com a função "Administrador de backup do cluster de usuários" (user-cluster-backup-admin) podem ver todos os backups na organização.
Os usuários com a função "Criador de backup" (backup-creator) podem ver todos os backups em um projeto.
Console
Faça login no console do GDC.
No menu de navegação, clique em Backup para clusters.
Clique em Selecionar projeto para escolher 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 backups
em uma organização ou selecione um projeto para ver todos os backups em um
projeto.
Criador de backup: selecione um projeto para ver todos os backups dele.
Clique na guia Backups.
Clique em um backup na lista para conferir os detalhes.
kubectl
Confira uma lista dos seus backups:
kubectlgetclusterBackups
Exemplo de saída:
NAME STATE
backup-test Succeeded
Excluir um backup
Não é possível excluir backups com uma interação normal com o servidor da API
do Kubernetes. Para excluir um backup, use o console do GDC ou execute um DeleteClusterBackupRequest.
Console
Exclua o backup na guia Backups:
Faça login no console do GDC.
No menu de navegação, clique em Backup para clusters.
Clique em Selecionar projeto para escolher 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 backups
em uma organização ou selecione um projeto para ver todos os backups em um
projeto.
Criador de backup: selecione um projeto para ver todos os backups dele.
Clique na guia Backups.
Clique no ícone do menu de três pontos do backup que você quer excluir.
Digite o nome do backup na caixa de texto.
Clique no botão Excluir backup para concluir a exclusão.
Como alternativa, exclua o backup clicando no nome dele ao visualizar um plano de backup:
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 conferir todos os planos de backup dela ou um projeto para conferir todos os planos de backup dele.
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 contém o backup que você quer excluir.
Clique na guia Backups.
Clique no nome do backup que você quer excluir.
Clique no botão Excluir backup.
Insira o nome do backup no campo de texto.
Clique no botão Excluir para concluir a exclusão do backup.
Substitua PROJECT_NAME pelo nome do projeto do GDC.
Este exemplo inclui os seguintes valores:
backupName: o nome do backup que está sendo excluído. O backup precisa estar no mesmo namespace que o DeleteClusterBackupRequest.
DeleteClusterBackupRequest: o recurso que exclui o recurso personalizado de backup do cluster
e remove todos os artefatos associados a esse backup do local de armazenamento
do backup, incluindo dados de volume.
[[["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\u003eThis page guides users on managing cluster workload backups in Google Distributed Cloud (GDC) air-gapped environments, covering the creation, viewing, and deletion of backups.\u003c/p\u003e\n"],["\u003cp\u003eCreating manual backups can be done through the GDC console or API, referencing an existing backup plan, and users must have appropriate roles, either User Cluster Backup Admin or Backup Creator.\u003c/p\u003e\n"],["\u003cp\u003eUsers can view backups through the GDC console or \u003ccode\u003ekubectl\u003c/code\u003e, with visibility determined by their assigned role: User Cluster Backup Admins can view all backups, while Backup Creators can only see backups within their project.\u003c/p\u003e\n"],["\u003cp\u003eDeleting backups requires using the GDC console or a \u003ccode\u003eDeleteClusterBackupRequest\u003c/code\u003e via API, and it is important to note that deleting backups is an irreversible action.\u003c/p\u003e\n"],["\u003cp\u003eBackups consist of config backup, a set of kubernetes resource descriptions, and volume backup, a backup of PersistentVolumeClaims, but it does not include cluster configurations.\u003c/p\u003e\n"]]],[],null,["# Back up your workloads\n\nThis page details how to create manual backups, view existing backups, and delete existing backups for cluster workloads in Google Distributed Cloud (GDC) air-gapped.\n\nBefore you begin\n----------------\n\nTo create, view, and delete backups, you must have the following:\n\n- The necessary identity and access role:\n\n - For Platform Administrator (PA) users:\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.\n - For Application Operator (AO) users:\n - Backup Creator: creates manual backups and restores. Ask your Project IAM Admin to grant you the Backup Creator (`backup-creator`) role.\n - For more information, see [Role definitions](/distributed-cloud/hosted/docs/latest/gdch/platform/pa-user/iam/role-definitions).\n- AO users can only perform manual backups from an existing backup\n plan.\n\nCreate a manual backup\n----------------------\n\nIf your backup plan defines a schedule for the backup, the backups are\nautomatically created according to that schedule. You can also manually create a backup\noutside the scope of your backup plan schedule. For example, you might want to back\nup your workloads before you upgrade your applications. A backup does not\ninclude cluster configuration information, such as node configurations, node\npools, initial cluster size, or what features are enabled.\n\nTwo forms of data are captured in a backup:\n\n- **Config backup**: A set of Kubernetes resource descriptions extracted from the API server of the cluster undergoing backup.\n- **Volume backup** : A backup of `PersistentVolumeClaims`.\n\n### Console\n\n1. Sign in to the GDC console.\n2. In the navigation menu, click **Backup for Clusters**.\n3. Click the **Backup Plans** tab.\n4. Click the plan that you want to use for the backup.\n5. Click **Start a backup**.\n6. Enter a backup name and an optional description.\n7. Set the number of days to retain the backup. Once this number of days is reached, the backup is automatically deleted.\n8. Set the number of days during which backups cannot be deleted.\n9. Click **Start**.\n\n### API\n\nThe manual backup must reference an existing backup plan for the backup\nconfiguration and the backup must be created by issuing a\n`ManualClusterBackupRequest`.\n\nHere's an example of a `ManualClusterBackupRequest`: \n\n apiVersion: backup.gdc.goog/v1\n kind: ManualClusterBackupRequest\n metadata:\n name: manualbackuprequest-test\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 clusterBackupName: \"backup-test\"\n clusterBackupPlanRef: \"backupplan-test\"\n deleteLockDays: 5\n retainDays: 6\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\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\nView a backup\n-------------\n\nUsers with the User Cluster Backup Admin (`user-cluster-backup-admin`) role can see all backups in the organization.\nUsers with the Backup Creator (`backup-creator`) role can see all of the backups in a project. \n\n### Console\n\n1. Sign in to the GDC console.\n2. In the navigation menu, click **Backup for Clusters**.\n3. Click **Select project** to select an organization or project depending on your role:\n - User Cluster Backup Admin: Select an organization to see all backups in an organization or select a project to see all backups in a project.\n - Backup Creator: Select a project to see all backups in a project.\n4. Click the **Backups** tab.\n5. Click a backup in the list to view its details.\n\n### kubectl\n\nView a list of your backups: \n\n kubectl get clusterBackups\n\nAn example of the output: \n\n NAME STATE\n backup-test Succeeded\n\nDelete a backup\n---------------\n\nBackups can't be deleted by a regular interaction with the Kubernetes API\nserver. To delete a backup, use the GDC console or issue a `DeleteClusterBackupRequest`. \n\n### Console\n\nDelete the backup from the **Backups** tab:\n\n1. Sign in to the GDC console.\n2. In the navigation menu, click **Backup for Clusters**.\n3. Click **Select project** to select an organization or project depending on your role:\n - User Cluster Backup Admin: Select an organization to see all backups in an organization, or select a project to see all backups in a project.\n - Backup Creator: Select a project to see all backups in a project.\n4. Click the **Backups** tab.\n5. Click the three-dot menu icon for the backup you want to delete.\n6. Type the name of the backup into the text box.\n7. Click the **Delete Backup** button to complete the deletion of this backup.\n\n | **Note:** This operation can't be undone.\n\nAlternatively, delete the backup by clicking on the backup name when viewing a backup plan:\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 of the 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 containing the backup you want to delete.\n6. Click the **Backups** tab.\n7. Click the name of the backup you want to delete.\n8. Click the **Delete Backup** button.\n9. Enter the name of the backup into the text field.\n10. Click the **Delete** button to complete the deletion of this backup.\n\n | **Note:** This operation can't be undone.\n\n### kubectl\n\nSend a `DeleteClusterBackupRequest` request: \n\n apiVersion: backup.gdc.goog/v1\n kind: DeleteClusterBackupRequest\n metadata:\n name: deletebackuprequest-test\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 clusterBackupRef: \"backup-test\"\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\n- `backupName`: the name of the backup being deleted. This backup must exist in the same namespace as the `DeleteClusterBackupRequest`.\n- `DeleteClusterBackupRequest`: the resource that deletes the backup custom resource from the cluster and removes all artifacts associated with that backup from the storage location of the backup, including volume data.\n\n| **Note:** Attempting to delete a `ClusterBackup` resource without applying a `DeleteClusterBackupRequest` resource doesn't clean object storage artifacts and might result in undefined behavior.\n\nWhat's next\n-----------\n\n- [Plan a set of restores](/distributed-cloud/hosted/docs/latest/gdch/platform-application/pa-ao-operations/cluster-backup/plan-restores)"]]
