Resource filtering

Filter objects by namespace, type, or labels.

Velero includes all objects in a backup or restore when no filtering options are used.

Includes

Only specific resources are included, excluding all others.

Wildcard takes precedence when both a wildcard and specific resource are included.

–include-namespaces

• Backup a namespace and it’s objects.

  velero backup create <backup-name> --include-namespaces <namespace>
  

• Restore two namespaces and their objects.

  velero restore create <restore-name> --include-namespaces <namespace1>,<namespace2> --from-backup <backup-name>
  

–include-resources

• Backup all deployments in the cluster.

  velero backup create <backup-name> --include-resources deployments
  

• Restore all deployments and configmaps in the cluster.

  velero restore create <restore-name> --include-resources deployments,configmaps --from-backup <backup-name>
  

• Backup the deployments in a namespace.

  velero backup create <backup-name> --include-resources deployments --include-namespaces <namespace>
  

–include-cluster-resources

This option can have three possible values:

• true: all cluster-scoped resources are included.

• false: no cluster-scoped resources are included.

• nil (“auto” or not supplied):

  • Cluster-scoped resources are included when backing up or restoring all namespaces. Default: true.

  • Cluster-scoped resources are not included when namespace filtering is used. Default: false.

    • Some related cluster-scoped resources may still be backed/restored up if triggered by a custom action (for example, PVC->PV) unless --include-cluster-resources=false.

• Backup entire cluster including cluster-scoped resources.

  velero backup create <backup-name>
  

• Restore only namespaced resources in the cluster.

  velero restore create <restore-name> --include-cluster-resources=false --from-backup <backup-name>
  

• Backup a namespace and include cluster-scoped resources.

  velero backup create <backup-name> --include-namespaces <namespace> --include-cluster-resources=true 
  

–selector

• Include resources matching the label selector.

  velero backup create <backup-name> --selector <key>=<value>
  

Excludes

Exclude specific resources from the backup.

Wildcard excludes are ignored.

–exclude-namespaces

• Exclude kube-system from the cluster backup.

  velero backup create <backup-name> --exclude-namespaces kube-system
  

• Exclude two namespaces during a restore.

  velero restore create <restore-name> --exclude-namespaces <namespace1>,<namespace2> --from-backup <backup-name>
  

–exclude-resources

• Exclude secrets from the backup.

  velero backup create <backup-name> --exclude-resources secrets
  

• Exclude secrets and rolebindings.

  velero backup create <backup-name> --exclude-resources secrets,rolebindings
  

velero.io/exclude-from-backup=true

• Resources with the label velero.io/exclude-from-backup=true are not included in backup, even if it contains a matching selector label.