Install PX-Central on-premises

You can install PX-Central on any Kubernetes cluster using Helm charts as long as your cluster meets the prerequisites.


  • A Kubernetes cluster consisting of the following:

    • 3 worker nodes
    • 4 CPU cores
    • 8 GB 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-Central 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
  • For internet-connected clusters, the following ports must be open:

    Port Component Purpose Incoming/Outgoing
    31241 PX-Central-Keycloak Access user auth token Incoming
    7070 License server License validation Outgoing
  • For GKE clusters, only Ubuntu OS is supported.


  • You can install PX-Central on a Kubernetes cluster that is already running Portworx, or on a fresh Kubernetes cluster that does not have Portworx installed.
  • If you also wish to install the monitoring service component, you need at least 8 CPU cores and 16 GB of memory.

Prepare air-gapped environments

If your cluster is internet-connected, skip this section. If your cluster is air-gapped, you must pull the PX-Central and related Docker images to either your Docker registry or directly onto your nodes.

  1. Run the following command to create an environment variable called kube_version and assign your Kubernetes version to it:

    kube_version=`kubectl version --short | awk -Fv '/Server Version: / {print $3}'`
  2. Pull the following required Docker images onto your air-gapped environment:

  3. Pull the PX-Central and related Docker images. How you do this depends on your air-gapped cluster configuration:

    • If you have a company-wide docker-registry server, pull the PX-Central and related Docker images from Portworx:

      sudo docker pull <required-docker-images>
      sudo docker tag <required-docker-images> <company-registry-hostname>:5000<path-to-required-docker-images>
      sudo docker push <company-registry-hostname>:5000<path-to-required-docker-images>
    • If you do not have a company-wide docker-registry server, pull the PX-Central and related Docker images from Portworx onto a computer that can access the internet and send it to your air-gapped cluster. The following example sends the docker image to the air-gapped cluster over ssh:

      sudo docker pull <required-docker-images>
      sudo docker save <required-docker-images> | ssh root@<air-gapped-address> docker load

Install PX-Central on-premises

  1. If you’re installing PX-Central alone – without Portworx Enterprise – skip this step. If you do want to install PX-Central 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-Central installation, select the Use storage class checkbox under the Storage section of the Spec Details tab, and enter the name of the storage class you created in the previous step.

    If your cluster is air-gapped, select the Air Gapped checkbox, and enter the following information:

    • Custom Registry: The hostname of your custom registry
    • Image Repository: The path to the required Docker images
    • Image Pull Secret(s): A comma-separated list of your image pull secrets.
  3. Using Helm, add the Portworx Enterprise repo to your cluster and update it:

    helm repo add portworx && helm repo update
  4. Install PX-Central using either the --set flag or the values.yml file provided in the Step 2 section of the Complete tab of the spec generator.

  5. To monitor the status of the installation, enter the following kubectl get command:

    kubectl get po --namespace px-backup -ljob-name=pxcentral-post-install-hook  -o wide | awk '{print $1, $3}' | grep -iv error


    • PX-Central is installed with PX-Backup.
    • If you’re using your Kubernetes master IP as the Keycloak endpoint, you must run the following command on all worker nodes:

      sudo iptables -P FORWARD ACCEPT

      This enables port forwarding using iptables, making the NodePort service accessible through the master endpoint.

Configure external OIDC endpoints

If you enabled an external OIDC during PX-Central installation, you must manually configure the redirect URI in your OIDC provider. Refer to the Set up login redirects article for instructions on how to do this.

Last edited: Wednesday, Apr 28, 2021