Skip to main content
Version: 3.0

Create a Cross Cloud Backup

Applicable to Classic mode only

note

Cross-cloud backup using the KDMP driver is not available in Federated mode. In Federated mode, only object store backup locations are supported and backup operations are handled locally by Stork on each application cluster.

Portworx Backup uses the KDMP driver to trigger a cross-cloud backup.

Prerequisites

  • An application cluster added to Portworx Backup
  • A configured backup location (object store or NFS)
  • If you are using Linkerd with mTLS enabled: the namespace being backed up must have the following annotations:
    kubectl annotate namespace <namespace> config.alpha.linkerd.io/proxy-enable-native-sidecar="true" linkerd.io/inject=enabled

To create cross cloud backup (also referred to as direct KDMP backup) of your namespace:

  1. Log in to the Portworx Backup web console.

  2. From the home page, click the Clusters icon in the left navigation pane. The cluster page lists all the application clusters you have associated with Portworx Backup.

  1. Choose the application cluster that contains the namespace or VM to be backed up.
  1. Navigate to Applications tab and choose NS or VM tab (based on the namespace(s)/VMs you want to back up) and select the namespace(s)/VM(s) you want to back up.
  1. You can create a namespace or VM backup in this page.

    • For a namespace backup, you will see the following options:

      • Search by namespace name: this search field allows you to filter the namespaces by their names

      • All resources: this drop-down allows you to select the required resources or all the resources along with a search option to traverse the list with the resource name. After selection of resources, you can select individual resources of a resource group by navigating to Vertical ellipsis > Select Resources (gets enabled after you select one or more resources) under Resources column provided at the end of each namespace in the Portworx Backup web console.

      note

      Portworx Backup web console displays selected resource count under RESOURCES column.

    • Add namespace label: allows you to add labels for the namespaces to search them with the applied labels at later point in time. For more information, see Backup using namespace labels.

    • Add resource label: allows you to add labels for the resources to search them with the applied labels at later point in time. For more information, see Backup using resource labels.

    • NAME: allows you to back up all namespaces in the current page you are in

      note

      Portworx Backup allows you to select multiple namespaces of a cluster from different pages and then back up the chosen namespaces in a single click.

  • For a VM backup, you will see the following options:

    • Search by VM name: allows you to search the VM by its name

    • Filter by namespace: allows you to filter the VM by the namespace where the VM resides. In addition, it also provides a Select All option to select all the namespaces (where the VMs that you want to back up reside)

    • Add namespace label: takes the search string you provide in this field, displays VMs with the specified Namespace labels, and includes them in the backup. It also includes future VMs created with these Namespace labels if a backup schedule is associated when creating the backup. For more information, see Backup using namespace labels.

  1. Click Backup.

  2. In the Create Backup window, specify the following:

    • Enter name for Backup: provide a relevant name for your backup

    • Backup location: choose the backup location (object store or NFS) from the drop-down where you want to store your backups.

      note

      Backup location drop-down displays only the successfully validated object store or NFS backup locations.

    • Cross Cloud Backup/Restore: this option is disabled by default. Enable this toggle if you want to create a backup in one cloud environment and restore it in another. After you enable this option, Portworx Backup triggers a direct KDMP backup and disables the Snapshot Class Mapping option.

      note

      If you’re using the Linkerd service mesh with mTLS enabled for Portworx Backup, add the annotation config.alpha.linkerd.io/proxy-enable-native-sidecar: "true" to the Namespace you’re backing up. See the following Namespace output for reference:

      kubectl get namespace mysql-px -oyaml
      apiVersion: v1
      kind: Namespace
      metadata:
      annotations:
      config.alpha.linkerd.io/proxy-enable-native-sidecar: "true"
      linkerd.io/inject: enabled
      creationTimestamp: "2025-10-09T05:30:33Z"
      labels:
      kubernetes.io/metadata.name: mysql-px
      name: mysql-px
      resourceVersion: "521810"
      uid: d138XXX-da88-4d8f-87f9-fa1f44XXXXXX
      spec:
      finalizers:
      - kubernetes
      status:
      phase: Active

      For more information on how Portworx Backup behaves based on the options you select in the Create Backup window, see Backup type matrix.

      note

      Portworx Backup does not support restore operation for static PV/PVCs.

      For more information on backup types supported by Portworx Backup based on the drivers involved during backup creation, see Backup types by driver.

    • Backup type: allows you to choose the type of backup required (manual or scheduled backup)

      • On a schedule: creates a manual or scheduled backup

        • Enabled: creates a manual backup immediately after you click Create

        • Disabled: displays the Choose a Schedule Policy option

      For more information on schedule policies, see Scheduled Backup.

    • Choose a Schedule Policy: associate a schedule policy with your backup to automate the process of backup creation. Portworx Backup supports hourly, weekly, and monthly scheduled backup runs or allows you to run the backup at the specified time.

    • Allow parallel backup: select this option to enable Portworx Backup to trigger a new scheduled backup even when the previous scheduled backup is still in progress (uploading snapshots to the cloud). See Parallel backup schedules for more information on how this feature works in the backend.

    note

    The parallel backup option works only for backup objects with Portworx volumes.

    • Pre-exec rule: select a rule from the drop-down to execute before the backup is created

    • Post-exec rule: select a post rule you want to execute after the backup is created

    • Backup Labels: any labels that you want to add to the backup you are going to create

    • NAMESPACES LIST: lists all the namespaces selected for backup creation

      note

      Fields vary for a VM backup in the Create Backup window. For more information on how to create a VM backup, see Create VM backup.

  3. Click Create.

You can view the namespace backup you have created in the Clusters > Backups tab of your application cluster.

note

Object store (S3 and others) and NFS-based backup targets support cross-cloud or generic (direct KDMP backup), manual, and scheduled backups.