Install PX-Backup on-premise

PX-Backup can be installed on any Kubernetes cluster using Helm charts as long as the pre-requisites are met. This can be one of your application clusters or a dedicated cluster. Since it’s a multi-cluster backup solution, PX-Backup does not need to be installed on every cluster that will be backed-up. Instead, other clusters are simply added through the PX-Backup user interface.


  • A Kubernetes cluster consisting of the following:

    • 3 worker nodes
    • 4 CPU cores
    • 8GB of memory
    • A minimum of 1 disk with 100 GB, ideally 2 disks on each node with at least 100 GB each
    • Kubernetes version 1.20.x and below
    • If you wish to use Portworx for the PX-Backup installation and your Kubernetes cluster does not have Portworx installed, verify that you have at least 50GB of available disk space on the /root file system.
    • If you’re using an external OIDC provider, you must use certificates signed by a trusted certificate authority.
    • Helm
  • If you want to install PX-Backup on OpenShift using the restricted SCC, then you must add the service accounts used by PX-Backup to the restricted SCC. Execute the following oc adm policy add-scc-to-user commands, replacing <YOUR_NAMESPACE> with your namespace:

    oc adm policy add-scc-to-user restricted system:serviceaccount:<YOUR_NAMESPACE>:default
    oc adm policy add-scc-to-user restricted system:serviceaccount:<YOUR_NAMESPACE>:pxcentral-apiserver
    oc adm policy add-scc-to-user restricted system:serviceaccount:<YOUR_NAMESPACE>:px-keycloak-account
    oc adm policy add-scc-to-user restricted system:serviceaccount:<YOUR_NAMESPACE>:px-backup-account
NOTE: PX-Backup does not support the following Portworx features:

  • PX-Security
  • Portworx Essentials

Prepare air-gapped environments

If your cluster is internet-connected, skip this section. If your cluster is air-gapped, you must pull the following Docker images to either your docker registry, or your server:


Install PX-Backup

  1. If you’re installing PX-Backup alone – without Portworx Enterprise – skip this step. If you do want to install PX-Backup with Portworx Enterprise , you must first install Portworx, then create the following storage class on your Kubernetes cluster:

    kind: StorageClass
        name: portworx-sc
        repl: "3"
  2. Generate the install spec through the PX-Backup spec generator.

    If you’re using Portworx for the PX-Backup installation, select the Use storage class checkbox under the Storage section of the Spec Details tab of the spec generator and enter the name of the storageclass you created in step 1 above.

  3. Using Helm, add the Portworx Enterprise repo to your cluster and update it:

    helm repo add portworx && helm repo update
  4. Install PX-Backup using either the helm set command or the values.yml file provided in the output of the Complete tab of the spec generator.

    You can find more information about the PX-Backup Helm chart in the reference article.

Configure external OIDC endpoints

If you enabled an external OIDC during the PX-Backup installation, you must must manually configure the redirect URI in your OIDC provider.

Refer to the Set up login redirects section of the Portworx Enterprise documentation for instructions.

Last edited: Thursday, May 27, 2021