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 | |
Backing drive | 8GB (minimum required) 128 GB (minimum recommended) |
Operating system root partition | If /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 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 4.18 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 | Disable 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.
- East-to-west
- Inbound
- Outbound
- 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 |
Kubernetes | Description |
---|
9001 | Portworx management port [REST] |
9021 | Portworx gRPC SDK gateway [REST] |
Supported disk types
Cloud Provider | Disk Types |
---|
vSphere | - eagerzeroedthick
- lazyzeroedthick
- thin
|
Supported Kubernetes versions
Before you install Portworx on Kubernetes, ensure that you're using a supported Kubernetes version:
Type | Supported Versions |
---|
VMware vSphere Kubernetes Service (VKS) (formerly Tanzu Kubernetes Grid Service (TKGS) | - 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)
- v1.30.8---vmware.1-fips-vkr.1 (supported from Portworx version 3.3.0)
- VKS version : 3.3.3, v1.31.7---vmware.1-fips-vkr.2 (supported from Portworx version 3.4.0)
- VKS version : 3.3.3, v1.32.3---vmware.1-fips-vkr.2 (supported from Portworx version 3.4.0)
|
VMware Tanzu Kubernetes Grid Integrated Edition (TKGI) | - TKGI version: 1.19.2-build, Kubernetes version: 1.28.11
- TKGI version: 1.20.0-build.52, Kubernetes version: 1.29.6
- TKGI version: 1.21.0-build32, Kubernetes version: 1.30.7
- TKGI version: 1.22.1-build.4, Kubernetes version: 1.31.5
|
Type | Supported Versions |
---|
Tanzu Kubernetes Grid Service (TKGS) | - 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)
- v1.30.8---vmware.1-fips-vkr.1 (supported from Portworx version 3.3.0)
|
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
|
Type | Supported Versions |
---|
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
|
Type | Supported Versions |
---|
Tanzu Kubernetes Grid Service (TKGS) | - v1.24.11---vmware.1-fips.1-tkg.1
- v1.25.7---vmware.3-fips.1-tkg.1
- v1.26.13---vmware.1-fips.1-tkg.3
|
VMware Tanzu Kubernetes Grid Integrated Edition (TKGI) | - TKGI version: 1.18.2-build.18, Kubernetes version: 1.27.11
- TKGI version: 1.16.3-build.11, Kubernetes version: 1.25.15
- TKGI version: 1.17.2-build.15, Kubernetes version: 1.26.10
- TKGI version: 1.18.0-build.46, Kubernetes version: 1.27.5
|
Type | Supported Kubernetes Version |
---|
vSphere with Tanzu (TKGs) | - 1.22.9+vmware.1-tkg.1.cc71bc8
- 1.23.8+vmware.3
|
Tanzu Kubernetes Grid Integrated (TKGI) | - PKS version: 1.13.10-build.10; Kubernetes version: 1.22.16
- PKS version: 1.14.6-build.12; Kubernetes version: 1.23.17
- PKS version: 1.15.4-build.14; Kubernetes version: 1.24.13+vmware.1
- PKS version: 1.16.0-build.57; Kubernetes version: 1.25.4
|