Merge pull request #106 from lpabon/args-conflicts

Update docs and arguments

Author: lpabon

.gitignore

@@ -1,5 +1,10 @@
 pxc
+pxc.exe
+*.code-workspace
+kubectl-pxc
+kubectl-pxc.exe
 .*.swp
 *.px
 *.zip
 .code-workspace*
+dist/

.travis.yml

@@ -8,3 +8,4 @@ script:
   - go vet $(go list ./... | grep -v vendor)
   - make install
   - make test
+  - make docs

Makefile

@@ -1,4 +1,5 @@
-CLINAME := kubectl-pxc
+CLINAME := pxc
+KUBECTL_PLUGIN := kubectl-$(CLINAME)
 SHA := $(shell git rev-parse --short HEAD)
 BRANCH := $(subst /,-,$(shell git rev-parse --abbrev-ref HEAD))
 VER := $(shell git describe --tags)
@@ -19,18 +20,20 @@ LDFLAGS :=-ldflags "-X github.com/portworx/pxc/cmd.PxVersion=$(VERSION)"
 
 ifneq (windows,$(GOOS))
 PKG_NAME = $(CLINAME)
+PLUGIN_PKG_NAME = $(KUBECTL_PLUGIN)
 else
 PKG_NAME = $(CLINAME).exe
+PLUGIN_PKG_NAME = $(KUBECTL_PLUGIN).exe
 endif
 
 ZIPPACKAGE := $(CLINAME)-$(VERSION).$(GOOS).$(ARCH).zip
 TGZPACKAGE := $(CLINAME)-$(VERSION).$(GOOS).$(ARCH).tar.gz
 
-all: pxc
+all: pxc $(PLUGIN_PKG_NAME)
 
 install: all
 	cp $(PKG_NAME) $(GOPATH)/bin
-
+	cp $(PKG_NAME) $(GOPATH)/bin/$(PLUGIN_PKG_NAME)
 
 imports:
 	goimports -w ./cmd
@@ -61,29 +64,36 @@ distzip: $(ZIPPACKAGE)
 
 dist: $(TGZPACKAGE)
 
+# This also tests for any conflicts
+docs: all
+	./pxc gendocs --output-dir=docs/usage
+
 test:
 	./hack/test.sh
 
 verify: all test
 	go fmt $(go list ./... | grep -v vendor) | wc -l | grep 0
 	go vet $(go list ./... | grep -v vendor)
 
+$(PLUGIN_PKG_NAME): pxc
+	cp pxc $(PLUGIN_PKG_NAME)
+
 $(ZIPPACKAGE): all
 	@echo Packaging pxc ...
 	@mkdir -p dist
-	@zip dist/$@ $(PKG_NAME)
+	@zip dist/$@ $(PLUGIN_PKG_NAME)
 	@rm -f $(PKG_NAME)
 
 $(TGZPACKAGE): all
 	@echo Packaging Binaries...
 	@mkdir -p tmp/$(PKG_NAME)
-	@cp $(PKG_NAME) tmp/$(PKG_NAME)/
+	@cp $(PLUGIN_PKG_NAME) tmp/$(PKG_NAME)/
 	@mkdir -p $(DIR)/dist/
 	tar -czf $(DIR)/dist/$@ -C tmp $(PKG_NAME)
 	@rm -rf tmp
 
 clean:
-	rm -f $(PKG_NAME)
+	rm -f $(PKG_NAME) $(PLUGIN_PKG_NAME)
 	rm -rf dist
 
 .PHONY: dist all clean darwin_amd64_dist windows_amd64_dist linux_amd64_dist \

README.md

@@ -4,6 +4,8 @@
 `pxc` is a client side application which communicates with Portworx, Kubernetes,
 and other services to provide users with an integrated tool.
 
+The first release of pxc is focused on being a kubectl plugin.
+
 # Downloads
 Please refer to the [Releases](https://github.com/portworx/pxc/releases) page to
 download the latest build.
@@ -13,12 +15,12 @@ download the latest build.
 Please see [documentation](docs/usage/pxc.md)
 
 # Usage
-`pxc` is a tool that communicates with Portworx as well as Container
+`pxc` is a command line client that communicates with Portworx as well as Container
 Orchestration systems like Kubernetes. It can be run standalone or as a plugin
 to kubectl.
 
 ## Kubectl Plugin
-Install `pxc` binary anywhere in your PATH and name it `kubectl-pxc`. You will
+Install `kubectl-pxc` binary anywhere in your PATH. You will
 then be able to run it like this:
 
 ```
@@ -27,48 +29,6 @@ $ kubectl pxc get pvc
 $ kubectl pxc get pvc --kubeconfig=/path/to/kubeconfig.conf
 ```
 
-If you are running Portworx installed on a Kubernetes Cloud like GKE, EKS, etc,
-please use this model.
-
-`pxc` will automatically discover how to communicate with Portworx. No need for
-any prior setup.
-
-## Standalone 
-
-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
-
-#### What if you don't have a Portworx cluster?
-`pxc` uses the [OpenStorage SDK](https://libopenstorage.github.io) 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
-```
-
-### 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](docs/devel.md)
 

cmd/gendoc.go

@@ -16,6 +16,7 @@ limitations under the License.
 package cmd
 
 import (
+	"fmt"
 	"os"
 
 	"github.com/portworx/pxc/pkg/commander"
@@ -24,12 +25,18 @@ import (
 	"github.com/spf13/cobra/doc"
 )
 
+type gendocCmdArgs struct {
+	outputDir string
+	format    string
+}
+
 var (
-	gendocCmd       *cobra.Command
-	gendocOutputDir string
+	gendocCmd  *cobra.Command
+	gendocArgs *gendocCmdArgs
 )
 
 var _ = commander.RegisterCommandVar(func() {
+	gendocArgs = &gendocCmdArgs{}
 	gendocCmd = &cobra.Command{
 		Use:     "gendoc",
 		Aliases: []string{"gendocs"},
@@ -43,16 +50,32 @@ var _ = commander.RegisterCommandVar(func() {
 var _ = commander.RegisterCommandInit(func() {
 	RootAddCommand(gendocCmd)
 
-	gendocCmd.Flags().StringVar(&gendocOutputDir, "output-dir", "pxdocs", "Output directory")
+	gendocCmd.Flags().StringVar(&gendocArgs.format, "format", "md", "Output formats: md, man")
+	gendocCmd.Flags().StringVar(&gendocArgs.outputDir, "output-dir", "pxdocs", "Output directory")
 })
 
 func GenDocAddCommand(cmd *cobra.Command) {
 	gendocCmd.AddCommand(cmd)
 }
 
 func gendocExec(cmd *cobra.Command, args []string) error {
-	util.Printf("Creating docs in %s...\n", gendocOutputDir)
+	switch gendocArgs.format {
+	case "md":
+		util.Printf("Creating markdown docs in %s...\n", gendocArgs.outputDir)
+
+		os.MkdirAll(gendocArgs.outputDir, 0755)
+		return doc.GenMarkdownTree(rootCmd, gendocArgs.outputDir)
+	case "man":
+		util.Printf("Creating man pages in %s...\n", gendocArgs.outputDir)
+
+		os.MkdirAll(gendocArgs.outputDir, 0755)
+		manHeader := &doc.GenManHeader{
+			Title: "pxc Portworx client",
+		}
+		return doc.GenManTree(rootCmd, manHeader, gendocArgs.outputDir)
+
+	default:
+		return fmt.Errorf("Unknown format: %s", gendocArgs.format)
+	}
 
-	os.MkdirAll(gendocOutputDir, 0755)
-	return doc.GenMarkdownTree(rootCmd, gendocOutputDir)
 }

docs/usage/pxc.md

@@ -1,29 +1,48 @@
 ## pxc
 
-Portworx command line tool
+Portworx client
 
 ### Synopsis
 
-Portworx command line tool
+Portworx client
 
 ### Options
 
 ```
-      --config string    Config file (default is $HOME/.pxc/config.yml)
-      --context string   Force context name for the command
-      --v int32          [0-4] Log level verbosity
-  -h, --help             help for pxc
+      --as string                      Username to impersonate for the operation
+      --as-group stringArray           Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
+      --cache-dir string               Default HTTP cache directory (default "/home/lpabon/.kube/http-cache")
+      --certificate-authority string   Path to a cert file for the certificate authority
+      --client-certificate string      Path to a client certificate file for TLS
+      --client-key string              Path to a client key file for TLS
+      --cluster string                 The name of the kubeconfig cluster to use
+      --context string                 The name of the kubeconfig context to use
+  -h, --help                           help for pxc
+      --insecure-skip-tls-verify       If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+      --kubeconfig string              Path to the kubeconfig file to use for CLI requests.
+  -n, --namespace string               If present, the namespace scope for this CLI request
+      --pxc.config string              Config file (default is $HOME/.pxc/config.yml)
+      --pxc.secret-name string         Kubernetes secret name containing authentication token
+      --pxc.secret-namespace string    Kubernetes namespace where secret contains token
+      --pxc.token string               Portworx authentication token
+      --pxc.v int32                    [0-3] Log level verbosity
+      --request-timeout string         The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+  -s, --server string                  The address and port of the Kubernetes API server
+      --token string                   Bearer token for authentication to the API server
+      --user string                    The name of the kubeconfig user to use
 ```
 
 ### SEE ALSO
 
-* [pxc context](pxc_context.md)	 - Manage connections to Portworx and other systems
+* [pxc config](pxc_config.md)	 - Setup pxc configuration
 * [pxc create](pxc_create.md)	 - Create an object in Portworx
 * [pxc delete](pxc_delete.md)	 - Delete an object in Portworx
 * [pxc describe](pxc_describe.md)	 - Show detailed information of Portworx resources
 * [pxc get](pxc_get.md)	 - Get information from Portworx
+* [pxc login](pxc_login.md)	 - Set authentication information for Portworx cluster
 * [pxc logs](pxc_logs.md)	 - Print Portworx logs
 * [pxc patch](pxc_patch.md)	 - Update field(s) of a Portworx resource
+* [pxc script](pxc_script.md)	 - Run a script against the current cluster
 * [pxc version](pxc_version.md)	 - Show pxc version information
 
-###### Auto generated by spf13/cobra on 6-Nov-2019
+###### Auto generated by spf13/cobra on 3-Feb-2020

docs/usage/pxc_config.md

@@ -0,0 +1,50 @@
+## pxc config
+
+Setup pxc configuration
+
+### Synopsis
+
+Setup pxc configuration
+
+```
+pxc config [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for config
+```
+
+### Options inherited from parent commands
+
+```
+      --as string                      Username to impersonate for the operation
+      --as-group stringArray           Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
+      --cache-dir string               Default HTTP cache directory (default "/home/lpabon/.kube/http-cache")
+      --certificate-authority string   Path to a cert file for the certificate authority
+      --client-certificate string      Path to a client certificate file for TLS
+      --client-key string              Path to a client key file for TLS
+      --cluster string                 The name of the kubeconfig cluster to use
+      --context string                 The name of the kubeconfig context to use
+      --insecure-skip-tls-verify       If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+      --kubeconfig string              Path to the kubeconfig file to use for CLI requests.
+  -n, --namespace string               If present, the namespace scope for this CLI request
+      --pxc.config string              Config file (default is $HOME/.pxc/config.yml)
+      --pxc.secret-name string         Kubernetes secret name containing authentication token
+      --pxc.secret-namespace string    Kubernetes namespace where secret contains token
+      --pxc.token string               Portworx authentication token
+      --pxc.v int32                    [0-3] Log level verbosity
+      --request-timeout string         The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+  -s, --server string                  The address and port of the Kubernetes API server
+      --token string                   Bearer token for authentication to the API server
+      --user string                    The name of the kubeconfig user to use
+```
+
+### SEE ALSO
+
+* [pxc](pxc.md)	 - Portworx client
+* [pxc config delete-cluster](pxc_config_delete-cluster.md)	 - Delete pxc cluster configuration
+* [pxc config set-cluster](pxc_config_set-cluster.md)	 - Setup pxc cluster configuration
+
+###### Auto generated by spf13/cobra on 3-Feb-2020

docs/usage/pxc_config_delete-cluster.md

@@ -0,0 +1,48 @@
+## pxc config delete-cluster
+
+Delete pxc cluster configuration
+
+### Synopsis
+
+Delete pxc cluster configuration
+
+```
+pxc config delete-cluster [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for delete-cluster
+```
+
+### Options inherited from parent commands
+
+```
+      --as string                      Username to impersonate for the operation
+      --as-group stringArray           Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
+      --cache-dir string               Default HTTP cache directory (default "/home/lpabon/.kube/http-cache")
+      --certificate-authority string   Path to a cert file for the certificate authority
+      --client-certificate string      Path to a client certificate file for TLS
+      --client-key string              Path to a client key file for TLS
+      --cluster string                 The name of the kubeconfig cluster to use
+      --context string                 The name of the kubeconfig context to use
+      --insecure-skip-tls-verify       If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+      --kubeconfig string              Path to the kubeconfig file to use for CLI requests.
+  -n, --namespace string               If present, the namespace scope for this CLI request
+      --pxc.config string              Config file (default is $HOME/.pxc/config.yml)
+      --pxc.secret-name string         Kubernetes secret name containing authentication token
+      --pxc.secret-namespace string    Kubernetes namespace where secret contains token
+      --pxc.token string               Portworx authentication token
+      --pxc.v int32                    [0-3] Log level verbosity
+      --request-timeout string         The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+  -s, --server string                  The address and port of the Kubernetes API server
+      --token string                   Bearer token for authentication to the API server
+      --user string                    The name of the kubeconfig user to use
+```
+
+### SEE ALSO
+
+* [pxc config](pxc_config.md)	 - Setup pxc configuration
+
+###### Auto generated by spf13/cobra on 3-Feb-2020