Interactive Tutorials

If you wish to get an overview of using Portworx on Kubernetes, start with these interactive tutorials. These serve as a playground for you to get an idea about the capabilities of Portworx without having to install it in your cluster.


Key-value store

Portworx uses a key-value store for it’s clustering metadata. Please have a clustered key-value database (etcd or consul) installed and ready. For etcd installation instructions please refer to this doc.


At least one of the Portworx nodes should have extra storage available, in a form of unformatted partition or a disk-drive.

Storage devices explicitly given to Portworx will be automatically formatted by PX.

Shared mounts

If you are running Docker v1.12, you must configure Docker to allow shared mounts propagation (see instructions). Higher versions of Docker do not need to be reconfigured.


Ensure ports 9001-9015 are open between the nodes that will run Portworx.


Ensure all nodes running Portworx are time-synchronized, and NTP service is configured and running.

Container runtimes

Kubernetes uses Container Runtime Interface (CRI) to work with various Container engines. Starting with Portworx v1.7, one can use either Docker or Containerd container runtimes. Portworx versions older than 1.7 support only the default Docker container runtime. .


Portworx gets deployed as a Kubernetes DaemonSet. Following sections describe how to generate the spec files and apply them.

Generating the spec

To generate the spec file, head on to the below URLs for the PX release you wish to use.

Alternately, you can use curl to generate the spec as described in Generating Portworx Kubernetes spec using curl.

Secure ETCD and Certificates

If using secure etcd provide “https” in the URL and make sure all the certificates are in the /etc/pwx/ directory on each host which is bind mounted inside PX container.

Using Kubernetes Secrets to Provision Certificates

Instead of manually copying the certificates on all the nodes, it is recommended to use Kubernetes Secrets to provide etcd certificates to Portworx. This way, the certificates will be automatically available to new nodes joining the cluster.

Installing behind the HTTP proxy

During the installation Portworx may require access to the Internet, to fetch kernel headers if they are not available locally on the host system. If your cluster runs behind the HTTP proxy, you will need to expose PX_HTTP_PROXY and/or PX_HTTPS_PROXY environment variables to point to your HTTP proxy when starting the DaemonSet.

Use e=PX_HTTP_PROXY=<http-proxy>,PX_HTTPS_PROXY=<https-proxy> query param when generating the DaemonSet spec.

Internal Kvdb (beta)

Portworx can be configured to run with internal kvdb by enabling it in the above spec generator.

Note: Internal Kvdb is in beta and available for PX version > 1.4

Applying the spec

Once you have generated the spec file, deploy Portworx.

$ kubectl apply -f px-spec.yaml

Monitor the portworx pods

kubectl get pods -o wide -n kube-system -l name=portworx

Monitor Portworx cluster status

PX_POD=$(kubectl get pods -l name=portworx -n kube-system -o jsonpath='{.items[0]}')
kubectl exec $PX_POD -n kube-system -- /opt/pwx/bin/pxctl status

If you are still experiencing issues, please refer to Troubleshooting PX on Kubernetes and General FAQs.

Deploy a sample application

Now that you have Portworx installed, checkout various examples of applications using Portworx on Kubernetes.