pxc is a client side application which communicates with Portworx, Kubernetes,
and other services to provide users with an integrated tool. It can be used as
a stand alone program or as a kubectl plugin.
pxc also support pluggable runtime components. See component/
for more information.
Please refer to the Releases page to download the latest build.
Please see documentation
Install kubectl-pxc binary anywhere in your PATH. You will
then be able to run it like this:
$ kubectl pxc cluster describe
$ kubectl pxc node list
$ kubectl pxc pvc list
If your Portworx Enterprise cluster is secured with PX-Security, then you must first use the following comand:
$ kubectl pxc login \
--k8s-secret-name=<Kubernetes secret holding the token> \
--k8s-secret-namespace=<Kubernetes namespace holding the secret>
When not configured, pxc defaults to using the local 127.0.0.1:9020 port on the host.
You will not need to do any configuration if you install pxc on a Portworx node where it
has setup the SDK gRPC server on port 9020.
Normally, you would run pxc from a client machine. Once you download the pxc binary,
you will need to configure it. Here is an example:
./pxc config cluster set --name=clusterone --endpoint=1.1.1.1:9020
./pxc config context set --cluster=clusterone --name=contextone
./pxc config context use --name=contextone
./pxc cluster describe
Please visit Development