Version: 3.1

Prerequisites for Rancher

Deprecation notice

Support for K3s is being discontinued; migrate to a supported Kubernetes platform.

Environment 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)
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	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
Node type	Bare metal and virtual machine (VM)

Software
Linux kernel and distro	Kernel version 3.10 or greater. To check if your Linux distro and kernel are supported, see Supported Kernels.
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 (`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 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.

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 9002.
For telemetry, open ports 9024, 12001, and 12002. Ensure you are running Portworx Operator version 23.7.0 or higher to configure the telemetry port:
- Portworx Versions 2.13.7 and Older: Open port 9024 specifically for telemetry.
- Portworx Versions 2.13.8 and Newer: Use port 9029 for telemetry.

Kubernetes	Description
9001	Portworx management port [REST]
9002	Portworx node-to-node port [gossip]/UDP
9003	Portworx storage data port
9004	Portworx namespace [RPC]
9012	Portworx node-to-node communication port [gRPC]
9013	Portworx namespace driver [gRPC]
9014	Portworx diags server port [gRPC]
9018	Portworx kvdb peer-to-peer port [gRPC]
9019	Portworx kvdb client service [gRPC]
9021	Portworx gRPC SDK gateway [REST]
9022	Portworx health monitor [REST]
9029	Telemetry log uploader
12002	Telemetry phone home

Cloud provider	Disk types
AWS	GP2 GP3 IO1
Azure	Standard_LRS StandardSSD_LRS Premium_LRS PremiumV2_LRS UltraSSD_LRS
GKE	pd-balanced pd-ssd pd-standard

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

note

RKE2 supports multiple Linux distributions and kernel versions. Refer to the Supported kernels page to ensure that your environment is supported.

Type	Supported Versions
RKE2	1.28.8 1.29.3 For Mirantis support, Operator 23.10.2 or newer is required.

Type	Supported Versions
Kubernetes	1.24 1.25 1.26 1.27 1.28 1.29 1.30 (Supported starting from Portworx version 3.1.4)