Common Prerequisites
Support for K3s is being discontinued; migrate to a supported Kubernetes platform.
This page lists common prerequisites for Portworx Enterprise. For prerequisites specific to your platform, visit the Before you begin page of your platform guide.
Installation Prerequisites
The minimum supported size for a Portworx cluster is three nodes. Each node must meet the following hardware and software 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 | 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:
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 | 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. |
Hypervisor | |
---|---|
VMware vSphere |
|
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 Kubernetes and 17002 for OpenShift 4+
- 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.
Kubernetes | OpenShift | Description |
---|---|---|
9001 | 17001 | Portworx management port [REST] |
9002 | 17002 | Portworx node-to-node port [gossip]/UDP |
9003 | 17003 | Portworx storage data port |
9004 | 17004 | Portworx namespace [RPC] |
9012 | 17009 | Portworx node-to-node communication port [gRPC] |
9013 | 17010 | Portworx namespace driver [gRPC] |
9014 | 17011 | Portworx diags server port [gRPC] |
9018 | 17015 | Portworx kvdb peer-to-peer port [gRPC] |
9019 | 17016 | Portworx kvdb client service [gRPC] |
9021 | 17018 | Portworx gRPC SDK gateway [REST] |
9022 | 17019 | Portworx health monitor [REST] |
9029 | 17021 | Telemetry log uploader |
12002 | 20002 | Telemetry phone home |
Kubernetes | OpenShift | Description |
---|---|---|
9001 | 17001 | Portworx management port [REST] |
9021 | 17018 | Portworx gRPC SDK gateway [REST] |
Supported Kubernetes versions
Before you install Portworx on Kubernetes, ensure that you're using a supported Kubernetes version:
Portworx Enterprise supported Kubernetes versions
If your Kubernetes distribution supports multiple Linux distributions and kernel versions, refer to the Supported kernels page to ensure that your kernel version is supported.
- 3.1
- 3.0
- 2.13
Type | Supported Versions |
---|---|
Kubernetes On-prem |
|
Managed Kubernetes distribution |
|
Distribution Kubernetes |
|
Tanzu |
|
Google Anthos |
|
Type | Supported Kubernetes Version |
---|---|
On-prem Kubernetes |
|
Managed Kubernetes |
|
Distribution Kubernetes | Red Hat OpenShift:
NOTE: Supports both bare metal and VM. |
vSphere with Tanzu (TKGs) |
|
Tanzu Kubernetes Grid Integrated (TKGI) |
|
Anthos | Bare metal
|
Type | Supported Kubernetes Version |
---|---|
On-prem Kubernetes |
|
Managed Kubernetes |
|
Distribution Kubernetes | Red Hat OpenShift:
NOTE: Supports both bare metal and VM. |
vSphere with Tanzu (TKGs) |
|
Tanzu Kubernetes Grid Integrated (TKGI) |
|
Anthos | Bare metal
|
Installation
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
Learn how to install Portworx with OpenShift
For all other environments, continue to the following section:
Portworx on other orchestratorsPost-installation
If you have an existing Portworx cluster, continue to below sections for using and managing Portworx.
📄 Kubernetes operations
Operations guide for running Portworx in Production with Kubernetes
📄 Storage operations
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