Prerequisites


Installation Prerequisites

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

Hardware
CPU 4 cores minimum, 8 cores recommended
RAM 4GB minimum, 8GB recommended
Disk
  • /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.
Network connectivity Bandwidth:
  • 10 Gbps recommended
  • 1 Gbps minimum

Latency requirements for synchronous replication: less than 10ms between nodes in the cluster
Network
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.
Software
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 or greater, 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.

Supported Kubernetes versions

Before you install Portworx on Kubernetes, ensure that you’re using a supported Kubernetes version:

Type Supported Kubernetes Version
On-prem Kubernetes
  • 1.19
  • 1.20
  • 1.21
  • 1.22
  • 1.23
Managed Kubernetes
  • KOPS: 1.21
  • GKE: 1.22
  • AKS: 1.21 & 1.22
  • EKS: 1.21
  • IKS: 1.19
  • PKS: 1.17
Distribution Kubernetes
  • Openshift 4.6: 1.19 (Openshift version verified up to 4.6.48)
  • Openshift 4.7: 1.20 (Openshift version verified up to 4.7.37)
  • Openshift 4.8: 1.21 (Openshift version verified up to 4.8.20)
  • Openshift 4.9: 1.22 (Openshift version verified up to 4.9.7)
  • Openshift 4.10: 1.23 (Openshift version verified up to 4.10.9)
vSphere with Tanzu (TKGs)
  • v1.19.14+vmware.1-tkg.1.8753786
  • v1.20.9+vmware.1-tkg.1.a4cee5b
Tanzu Kubernetes Grid Integrated (TKGI)
  • PKS Version: 1.9.6-build.7; k8s Version: 1.18.18
  • PKS Version: 1.10.7-build.6; k8s Version: 1.19.16
  • PKS Version: 1.12.1-build.10; k8s Version: 1.21.5
  • PKS Version: 1.13.2-build.16; k8s Version: 1.22.6
K3s users: You must use CSI integration to generate / use PVCs.

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.

Installation

Whether you’re using Portworx Enterprise or Essentials, you can install Portworx on the cloud or on-premises. Proceed to one of the following sections for Kubernetes and OpenShift install instructions.

For all other environments, continue to the following section:

Post-installation

If you have an existing Portworx cluster, continue to below sections for using and managing Portworx.


Last edited: Wednesday, Jun 8, 2022