Overview

pxc is a client side application which communicates with Portworx, Kubernetes, and other services to provide users with an integrated tool.

Status: Pre-alpha

This tool is under heavy development.

Downloads

Please refer to the Releases page to download the latest build.

Usage

pxc is a tool that communicates with Portworx as well as Container Orchestration systems like Kubernetes. To use this tool you must first create a context with the appropriate information. pxc uses the context to connect to the appropriate Portworx cluster to execute the requested command.

Creating a context

You can create a context using the following command:

$ pxc context create mycluster --endpoint=<ip of cluster>:9020 --kubeconfig=/path/to/kubeconfig

NOTE: The default gRPC SDK port for Portworx is 9020

Connecting to Portworx running on a Kuberentes Cloud

If you are running Portworx installed on a Kubernetes Cloud like GKE, EKS, etc, you may need to use the workaround in issue #40 to access the Portworx gRPC endpoint through the Kubernetes API.

What if you don't have a Portworx cluster?

pxc uses the OpenStorage SDK to communicate with Portworx, therefore it is fully compatible with OpenStorage's mock-sdk-server. If you do not have a Portworx cluster, you can run the following to start the mock-sdk-server:

$ docker run --rm --name sdk -d -p 9100:9100 -p 9110:9110 openstorage/mock-sdk-server
$ pxc context create --name=mycluster --endpoint=localhost:9100

Installing as a kubectl plugin

Install pxc binary anywhere in your PATH and name it kubectl-pxc. You will then be able to run it like this:

$ kubectl pxc get nodes
$ kubectl pxc get pvc

pxc sample commands

Now that pxc has been setup with a context, you can do the following commands:

$ pxc describe cluster
$ pxc get volume
$ pxc get volume -o wide
$ pxc get nodes
$ pxc get nodes -o wide

Development

Please visit Development