Installation Prerequisites

The minimum supported size for a Portworx cluster is three nodes. Each node must meet the following hardware, software, and network requirements:

CPU 4 cores
  • /var
  • /opt
  • 2GB free
  • 3GB free
Backing drive 8GB (minimum required)
128 GB (minimum recommended)
Storage drives Storage drives must be unmounted block storage: raw disks, drive partitions, LVM, or cloud block storage.
Ethernet NIC card 10 GB (recommended)
Open needed ports Portworx requires different open ports depending on how it’s installed:
  • Spec-based installations require all Portworx nodes to have open TCP ports at 9001-9022 and an open UDP port at 9002.
  • Portworx on OpenShift 4+ requires open TCP ports at 17001-17020 and an open UDP port at 17002.
Portworx also requires an open KVDB port. For example, if you’re using etcd externally, open port 2379.

If you intend to use Portworx with sharedv4 volumes, you may need to open your NFS ports.
Lighthouse If installing the Portworx Lighthouse management UI please open ports 32678 and 32679
Linux kernel Version 3.10 or greater.
Docker Version 1.13.1 or greater.
Key-value store Portworx needs a key-value store to perform its operations. As such, install a clustered key-value database (etcd or consul) with a three node cluster.

With Portworx 2.0, you can use Internal KVDB during installation. In this mode, Portworx will create and manage an internal key-value store (kvdb) cluster.

If you plan of using your own etcd, refer to Etcd for Portworx for details on recommendations for installing and tuning etcd.
Disable swap Please disable swap on all nodes that will run the Portworx software. Ensure that the swap device is not automatically mounted on server reboot.

Air-gapped prerequisites

If you intend to use the sharedv4 feature, your host systems must be running the NFS service. For more information on options for installing the NFS service, refer to the installation article for air-gapped clusters.


For Kubernetes, continue below,

For all other environments, continue below,

Last edited: Tuesday, Jan 26, 2021