Skip to main content
Version: 3.2

Prerequisites

Environment Prerequisites​

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

Hardware
CPU4 cores minimum, 8 cores recommended
RAM4GB minimum, 8GB recommended
Disk
  • /var
  • /opt
  • 2GB free
  • 3GB free
Backing drive8GB (minimum required)
128 GB (minimum recommended)
Operating system root partitionIf /opt and /var are created as separate disks then 64 GB is sufficient for root partition.
Otherwise a min of 128 GB is required
Storage drivesStorage drives must be unmounted block storage: raw disks, drive partitions, LVM, or cloud block storage.
Network connectivityBandwidth:
  • 10 Gbps recommended
  • 1 Gbps minimum

Latency requirements for synchronous replication: less than 10ms between nodes in the cluster
Node typeBare metal and virtual machine (VM)
Software
Linux kernel and distroKernel version 4.18 or greater.
To check if your Linux distro and kernel are supported, see Supported Kernels.
DockerVersion 1.13.1 or greater.
Key-value storePortworx needs a key-value store to perform its operations. As such, install a clustered key-value database (kvdb) with a three node cluster.

You can also 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 KVDB, refer to KVDB for Portworx for details on recommendations for installing and configuring a KVDB cluster.
Disable swapDisable swap on all nodes that will run the Portworx software. Ensure that the swap device is not automatically mounted on server reboot.
Network Time Protocol (NTP)All nodes in the cluster should be in sync with NTP time. Any time drift between nodes can cause unexpected behaviour, impacting services.

Portworx network requirements​

Portworx runs as a pod in a Kubernetes cluster and uses specific ports for communication, data transfer, and telemetry.

note

Portworx also requires the following ports:

  • An open KVDB port. For example, if you're using etcd externally, open port 2379.
  • An open UDP port at 17002.
OpenShiftDescription
17001Portworx management port [REST]
17002Portworx node-to-node port [gossip]/UDP
17003Portworx storage data port
17004Portworx namespace [RPC]
17009Portworx node-to-node communication port [gRPC]
17010Portworx namespace driver [gRPC]
17011Portworx diags server port [gRPC]
17015Portworx kvdb peer-to-peer port [gRPC]
17016Portworx kvdb client service [gRPC]
17018Portworx gRPC SDK gateway [REST]
17019Portworx health monitor [REST]
17021Telemetry log uploader
20002Telemetry phone home

Portworx Enterprise supported versions​

Before you install Portworx, ensure that you're using a supported OpenShift versions:

TypeSupported Versions
Kubernetes On-prem
  • Kubernetes:
    • 1.26
    • 1.27
    • 1.28
    • 1.29
    • 1.30
    • 1.31, starting from 1.31.6
Managed Kubernetes distribution
  • Google Kubernetes Engine (GKE): 1.28.14, 1.29.9, 1.30.9, 1.31.6
  • Azure Kubernetes Service (AKS): 1.28.14, 1.29.10, 1.30.6, 1.31.7
  • Amazon Elastic Kubernetes Service (EKS): 1.24.17, 1.25.16, 1.26.15, 1.27.16, 1.28.15, 1.29.13, 1.30.9, 1.31.7
  • IBM Cloud Kubernetes Service (IKS): 1.29.15 (Operator 23.10.4 or later is required), 1.30.13 (Operator 23.10.4 or later is required), 1.31.9 (Operator 24.2.3 or later is required)
  • OCI Kubernetes Engine (OKE): 1.28.10, 1.29.1, 1.30.1
  • KOPS: 1.28.6, 1.29.2, 1.30.1
  • SUSE Rancher Kubernetes Engine (RKE2): 1.28.15, 1.29.13, 1.30.11, 1.31.7

    Note: Portworx supports SUSE Rancher versions 2.9.x and 2.10.x.

  • Mirantis: 1.27.7 (MKE 3.7.3, MCR 23.0.8 ), 1.27.10 (MKE 3.7.6, MCR 23.0.10), 1.27.16 (MKE 3.7.16, MCR 23.0.15)
  • Charmed Kubernetes: Juju version: 3.3
Distribution Kubernetes
  • Red Hat OpenShift:
    • OpenShift version: 4.13, verified up to 4.13.52, Kubernetes version: 1.26
    • OpenShift version: 4.14, verified up to 4.14.50, Kubernetes version: 1.27
    • OpenShift version: 4.15, verified up to 4.15.48, Kubernetes version: 1.28
    • OpenShift version: 4.16, verified up to 4.16.39, Kubernetes version: 1.29
    • OpenShift version: 4.17, verified up to 4.17.27, Kubernetes version: 1.30
    • OpenShift version: 4.18, verified up to 4.18.11, Kubernetes version: 1.31

    Note: Supports both bare metal and VM

  • Red Hat OpenShift on IBM Cloud:
    • ROKS version: 4.13, verified up to 4.13.53
    • ROKS version: 4.14, verified up to 4.14.51
    • ROKS version: 4.15, verified up to 4.15.50
    • ROKS version: 4.16, verified up to 4.16.40
    • ROKS version: 4.17, verified up to 4.17.28
    • ROKS version: 4.18, verified up to 4.18.11
  • Red Hat OpenShift Service on AWS:
    • ROSA version: 4.13, verified up to 4.13.51
    • ROSA version: 4.14, verified up to 4.14.46
    • ROSA version: 4.15, verified up to 4.15.48
    • ROSA version: 4.16, verified up to 4.16.38
    • ROSA version: 4.17, verified up to 4.17.23
    • ROSA version: 4.18, verified up to 4.18.7
  • Azure Red Hat OpenShift:
    • ARO version: 4.13, verified up to 4.13.40
    • ARO version: 4.14, verified up to 4.14.16
    • ARO version: 4.15, verified up to 4.15.35
    • ARO version: 4.16, verified up to 4.16.30
Tanzu
  • Tanzu Kubernetes Grid Service (TKGS):
    • v1.24.11---vmware.1-fips.1-tkg.1
    • v1.25.13---vmware.1-fips.1-tkg.1
    • v1.26.13---vmware.1-fips.1-tkg.3
    • v1.27.11---vmware.1-fips.1-tkg.2
    • v1.28.8---vmware.1-fips.1-tkg.2 (supported from Portworx version 3.2.1)
    • v1.29.4---vmware.3-fips.1-tkg.1 (supported from Portworx version 3.2.1)
    • v1.30.1---vmware.1-fips-tkg.5 (supported from Portworx version 3.2.1)
  • VMware Tanzu Kubernetes Grid Integrated Edition (TKGI):
    • TKGI version: 1.18.2-build.18, Kubernetes version: 1.27.11
    • TKGI version: 1.19.2-build, Kubernetes version: 1.28.11
    • TKGI version: 1.20.0-build.52, Kubernetes version: 1.29.6
Google Anthos
  • Bare metal:
    • Anthos version: 1.28.500-gke.121, Kubernetes version: v1.28.8-gke.2000
    • Anthos version: 1.29.900-gke.180, Kubernetes version: v1.29.11-gke.300
    • Anthos version: 1.30.400-gke.133, Kubernetes version: v1.30.6-gke.300
    • Anthos version: 1.31.400-gke.110, Kubernetes version: v1.31.7-gke.800
  • VMware:
    • Anthos version: 1.28.200-gke.111, vSphere version: 8.0, Kubernetes version: v1.28.4-gke.1400
    • Anthos version: 1.29.100-gke.248, vSphere version: 7.0.3 & 8.0, Kubernetes version: v1.29.4-gke.200
    • Anthos version: 1.30.400-gke.133, vSphere version: 7.0.3 & 8.0, Kubernetes version: v1.30.6-gke.300
    • Anthos version: 1.31.400-gke.110, vSphere version: 7.0.3 & 8.0.3, Kubernetes version: v1.31.7-gke.800