4
4
` pxc ` is a client side application which communicates with Portworx, Kubernetes,
5
5
and other services to provide users with an integrated tool.
6
6
7
- # Status: Pre-alpha
8
- This tool is under heavy development.
9
-
10
7
# Downloads
11
8
Please refer to the [ Releases] ( https://github.com/portworx/pxc/releases ) page to
12
9
download the latest build.
13
10
14
11
# Usage
15
12
` pxc ` is a tool that communicates with Portworx as well as Container
16
- Orchestration systems like Kubernetes. To use this tool you must first create a
17
- context with the appropriate information. ` pxc ` uses the context to connect to
13
+ Orchestration systems like Kubernetes. It can be run standalone or as a plugin
14
+ to kubectl.
15
+
16
+ ## Kubectl Plugin
17
+ Install ` pxc ` binary anywhere in your PATH and name it ` kubectl-pxc ` . You will
18
+ then be able to run it like this:
19
+
20
+ ```
21
+ $ kubectl pxc get nodes
22
+ $ kubectl pxc get pvc
23
+ $ kubectl pxc get pvc --kubeconfig=/path/to/kubeconfig.conf
24
+ ```
25
+
26
+ ` pxc ` will automatically discover how to communicate with Portworx. No need for
27
+ any prior setup.
28
+
29
+ ## Standalone
30
+
31
+ You must first create a context with the appropriate information. ` pxc ` uses the context to connect to
18
32
the appropriate Portworx cluster to execute the requested command.
19
33
20
- ## Creating a context
34
+ ### Creating a context
21
35
You can create a context using the following command:
22
36
23
37
```
@@ -26,13 +40,13 @@ $ pxc context create mycluster --endpoint=<ip of cluster>:9020 --kubeconfig=/pat
26
40
27
41
> NOTE: The default gRPC SDK port for Portworx is 9020
28
42
29
- ### Connecting to Portworx running on a Kuberentes Cloud
43
+ #### Connecting to Portworx running on a Kuberentes Cloud
30
44
If you are running Portworx installed on a Kubernetes Cloud like GKE, EKS, etc,
31
45
you may need to use the workaround in issue
32
46
[ #40 ] ( https://github.com/portworx/pxc/issues/40 ) to access the Portworx gRPC
33
47
endpoint through the Kubernetes API.
34
48
35
- ### What if you don't have a Portworx cluster?
49
+ #### What if you don't have a Portworx cluster?
36
50
` pxc ` uses the [ OpenStorage SDK] ( https://libopenstorage.github.io ) to communicate
37
51
with Portworx, therefore it is fully compatible with OpenStorage's
38
52
` mock-sdk-server ` . If you do not have a Portworx cluster, you can run the
@@ -43,16 +57,7 @@ $ docker run --rm --name sdk -d -p 9100:9100 -p 9110:9110 openstorage/mock-sdk-s
43
57
$ pxc context create --name=mycluster --endpoint=localhost:9100
44
58
```
45
59
46
- ## Installing as a kubectl plugin
47
- Install ` pxc ` binary anywhere in your PATH and name it ` kubectl-pxc ` . You will
48
- then be able to run it like this:
49
-
50
- ```
51
- $ kubectl pxc get nodes
52
- $ kubectl pxc get pvc
53
- ```
54
-
55
- ## pxc sample commands
60
+ ### pxc sample commands
56
61
Now that ` pxc ` has been setup with a context, you can do the following commands:
57
62
58
63
```
0 commit comments