You can use Portworx to provide storage for your Kubernetes pods. Portworx pools your servers capacity and turns your servers or cloud instances into converged, highly available compute and storage nodes. This section describes how to deploy PX within a Kubernetes cluster and have PX provide highly available volumes to any application deployed via Kubernetes.

Deploy PX with Kubernetes

You can run PX with Kubernetes using the PX native driver (preferred) or FlexVol.

Kubernetes with the PX native driver

Use these instructions to run Kubernetes with the PX native driver.

Kubernetes with FlexVol

Use these instructions to run Kubernetes with FlexVol.

Enabling scheduler convergence

You can configure PX to influence where Kubernetes schedules a container based on the container volume’s data location. When this mode is enabled, PX will communicate with Kubernetes and place host labels. These labels will be used in influencing Kubernetes scheduling decisions. To enable this mode, you must add a scheduler directive to the PX configuration as documented below.

Provide access to kubernetes

A kubernetes.yaml file is needed for allowing PX to communicate with Kubernetes. This configuration file primarily consists of the kubernetes cluster information and the kubernetes master node’s IP and port where the kube-apiserver is running. This file needs to be located at


# cat /etc/pwx/kubernetes.yaml
apiVersion: v1
kind: Config
- cluster:
    api-version: v1
    server: http://<master-node-ip>:<api-server-port>
    certificate-authority: /etc/pwx/my_cafile
  colors: true

Configure PX

Instruct PX to enable the Kubernetes scheduler hooks. To do this, the PX configuration file needs to specify Kubernetes in the scheduler hook section. Here is a sample section of PX config.json that has this directive:

# cat /etc/pwx/config.json
    "clusterid": "4420f99f-a068-11e6-8688-0242ac110004",
    "kvdb": [
    "scheduler": "kubernetes",
    "storage": {
        "devices": [

Note the specific directive: "scheduler": "kubernetes"

Alternatively, you can also pass in the scheduler directive via the PX command line as follows:

# sudo docker run --restart=always --name px -d --net=host  \
    --privileged=true                                       \
    -v /run/docker/plugins:/run/docker/plugins              \
    -v /var/lib/osd:/var/lib/osd:shared                     \
    -v /dev:/dev                                            \
    -v /etc/pwx:/etc/pwx                                    \
    -v /opt/pwx/bin:/export_bin                             \
    -v /usr/libexec/kubernetes/kubelet-plugins/volume/exec/px~flexvolume:/export_flexvolume:shared \
    -v /var/run/docker.sock:/var/run/docker.sock            \
    -v /var/cores:/var/cores                                \
    -v /var/lib/kubelet:/var/lib/kubelet:shared             \
    -v /usr/src:/usr/src                                    \
    -v /lib/modules:/lib/modules                            \
    portworx/px-dev:latest -daemon -k etcd:// -c MY_CLUSTER_ID -s /dev/sdb -x kubernetes

Note the flag -x kubernetes

At this point, when you create a volume, PX will communicate with Kubernetes to place host labels on the nodes that contain a volume’s data blocks. For example:

[root@localhost porx]# kubectl --kubeconfig="/root/kube-config.json" get nodes --show-labels

NAME         STATUS    AGE       LABELS   Ready     13d,vol2=true,vol3=true   Ready     12d,vol1=true,vol2=true

The label vol1=true implies that the node hosts volume vol1’s data.

You can now use these labels as nodeSelector fields in your Kubernetes pod spec as explained here.

For example, your pod may look like:

apiVersion: v1
kind: Pod
  name: nginx
    env: test
  - name: nginx
    image: nginx
    imagePullPolicy: IfNotPresent
    <vol-id>: "true"
  - name: test
      driver: "px/flexvolume"
      fsType: "ext4"
        volumeID: "<vol-id>"
        size: "<vol-size>"
        osdDriver: "pxd"

Note the new section called nodeSelector

Run with PX-Kube

px-kube is an experimental converged container that has Kubernetes and Portworx integrated into one, easy-to-deploy container. Follow these to deploy px-kube.

Bill of Materials on Public Cloud Providers

Use this guide to calculate the BOM for a complete Kubernetes with Portworx compute and storage environment for running stateful applications.

Edit this page