Skip to main content
Version: 3.2

Prerequisites

This section includes detailed system requirements to ensure a seamless deployment and optimal performance of Portworx CSI in your Spectro Cloud environment.

Portworx requires a minimum of three nodes cluster. All node must meet the following specifications:

Hardware requirements

CategoryRequirement
CPU4 cores minimum, 8 cores recommended
RAM4GB minimum, 8GB recommended
Disk
  • /var
  • /opt
  • 20GB free
  • 3GB free
Backing drive8GB (minimum required)
128 GB (minimum recommended)
Operating system root partition64 GB is the minimum required size for the root filesystem which contains the operating system
128 GB minimum recommended
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 requirements

CategoryRequirement
Linux kernel and distroKernel version 3.10 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.

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 9002 for Kubernetes.
  • Telemetry components require the following open ports: 9024, 12001, and 12002. Ensure you are running Portworx Operator version 23.7.0 and higher to configure this port for Telemetry.
    • If you are on Portworx version 2.13.7 and older, open port 9024 for telemetry.
    • If you are on Portworx version 2.13.8 and newer, use port 9029 for telemetry.
KubernetesDescription
9001Portworx management port [REST]
9002Portworx node-to-node port [gossip]/UDP
9003Portworx storage data port
9004Portworx namespace [RPC]
9012Portworx node-to-node communication port [gRPC]
9013Portworx namespace driver [gRPC]
9014Portworx diags server port [gRPC]
9018Portworx kvdb peer-to-peer port [gRPC]
9019Portworx kvdb client service [gRPC]
9021Portworx gRPC SDK gateway [REST]
9022Portworx health monitor [REST]
9029Telemetry log uploader
12002Telemetry phone home

Supported Kubernetes versions

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

TypeSupported Versions
Kubernetes
  • 1.26
  • 1.27
  • 1.28
  • 1.29
  • 1.30
  • 1.31, starting from 1.31.6