pxc

README

pxc - Portworx Client

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.

Downloads

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

Documentation

Please see documentation

Usage

Kubectl Plugin

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>

Standalone

On a Portworx node

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.

From a client machine

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

Development

Please visit Development

Documentation

Overview

Copyright © 2019 Portworx

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.