The minimum supported size for a Portworx cluster is three nodes. Each node must meet the following hardware, software, and network requirements:
|4 cores minimum, 8 cores recommended
|4GB minimum, 8GB recommended
|8GB (minimum required)
128 GB (minimum recommended)
|Operating system root partition
|64 GB is the minimum required size for the root filesystem which contains the operating system
128 GB minimum recommended
|Storage drives must be unmounted block storage: raw disks, drive partitions, LVM, or cloud block storage.
Latency requirements for synchronous replication: less than 10ms between nodes in the cluster
|Bare metal and virtual machine (VM)
|Open needed ports
|Portworx requires different open ports depending on how it’s installed:
etcd externally, open port 2379.
If you intend to use Portworx with sharedv4 volumes, you may need to open your NFS ports.
|Linux kernel and distro
|Kernel version 3.10 or greater.
To check if your Linux distro and kernel are supported, see Supported Kernels.
|Version 1.13.1 or greater.
|Portworx needs a key-value store to perform its operations. As such, install a clustered key-value database (
etcd) 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.
|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:
|Supported Kubernetes Version
|Red Hat OpenShift:
NOTE: Supports both bare metal and VM.
|vSphere with Tanzu (TKGs)
|Tanzu Kubernetes Grid Integrated (TKGI)
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.
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.
Install on Kubernetes
Learn how to install Portworx with Kubernetes clusters on Kubernetes in the cloud and on-premises
Install Portworx on OpenShift
How to install Portworx with OpenShift
For all other environments, continue to the following section:
If you have an existing Portworx cluster, continue to below sections for using and managing Portworx.
Operations guide for running Portworx in Production with Kubernetes
Learn how to perform various storage operations using Portworx on Kubernetes
Stateful applications on Kubernetes
Learn how to install various applications with Portworx on Kubernetes