Merge pull request #172 from lpabon/update-docs

Update docs to 0.31.1
portworx · Sep 18, 2020 · 26d651e · 26d651e
2 parents 8b6dcdd + 0e4bba8
commit 26d651e
Show file tree

Hide file tree

Showing 47 changed files with 271 additions and 57 deletions.
diff --git a/docs/usage/pxc.md b/docs/usage/pxc.md
@@ -27,6 +27,7 @@ pxc [flags]
 
 ### SEE ALSO
 
+* [pxc auth](pxc_auth.md)	 - Manage Portworx authentication
 * [pxc cluster](pxc_cluster.md)	 - Manage Portworx cluster
 * [pxc component](pxc_component.md)	 - Provides utilities for interacting with components
 * [pxc config](pxc_config.md)	 - Setup pxc configuration
@@ -37,4 +38,4 @@ pxc [flags]
 * [pxc version](pxc_version.md)	 - Show pxc version information
 * [pxc volume](pxc_volume.md)	 - Volume life cycle management
 
-###### Auto generated by spf13/cobra on 2-Jul-2020
+###### Auto generated by spf13/cobra on 18-Sep-2020
diff --git a/docs/usage/pxc_auth.md b/docs/usage/pxc_auth.md
@@ -0,0 +1,34 @@
+## pxc auth
+
+Manage Portworx authentication
+
+### Synopsis
+
+Manage Portworx authentication
+
+```
+pxc auth [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for auth
+```
+
+### Options inherited from parent commands
+
+```
+      --pxc.config string       Config file (default is $HOME/.pxc/config.yml)
+      --pxc.config-dir string   Config directory (default "/home/lpabon/.pxc")
+      --pxc.context string      Force context name for the command
+      --pxc.token string        Portworx authentication token
+      --pxc.v int32             [0-3] Log level verbosity
+```
+
+### SEE ALSO
+
+* [pxc](pxc.md)	 - Portworx client
+* [pxc auth guest-access](pxc_auth_guest-access.md)	 - Manage guest access on a Portworx cluster
+
+###### Auto generated by spf13/cobra on 18-Sep-2020
diff --git a/docs/usage/pxc_auth_guest-access.md b/docs/usage/pxc_auth_guest-access.md
@@ -0,0 +1,36 @@
+## pxc auth guest-access
+
+Manage guest access on a Portworx cluster
+
+### Synopsis
+
+Manage guest access on a Portworx cluster
+
+```
+pxc auth guest-access [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for guest-access
+```
+
+### Options inherited from parent commands
+
+```
+      --pxc.config string       Config file (default is $HOME/.pxc/config.yml)
+      --pxc.config-dir string   Config directory (default "/home/lpabon/.pxc")
+      --pxc.context string      Force context name for the command
+      --pxc.token string        Portworx authentication token
+      --pxc.v int32             [0-3] Log level verbosity
+```
+
+### SEE ALSO
+
+* [pxc auth](pxc_auth.md)	 - Manage Portworx authentication
+* [pxc auth guest-access disable](pxc_auth_guest-access_disable.md)	 - Disable guest access role
+* [pxc auth guest-access enable](pxc_auth_guest-access_enable.md)	 - enable guest access role
+* [pxc auth guest-access show](pxc_auth_guest-access_show.md)	 - show guest access role
+
+###### Auto generated by spf13/cobra on 18-Sep-2020
diff --git a/docs/usage/pxc_auth_guest-access_disable.md b/docs/usage/pxc_auth_guest-access_disable.md
@@ -0,0 +1,33 @@
+## pxc auth guest-access disable
+
+Disable guest access role
+
+### Synopsis
+
+Disable guest access role
+
+```
+pxc auth guest-access disable [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for disable
+```
+
+### Options inherited from parent commands
+
+```
+      --pxc.config string       Config file (default is $HOME/.pxc/config.yml)
+      --pxc.config-dir string   Config directory (default "/home/lpabon/.pxc")
+      --pxc.context string      Force context name for the command
+      --pxc.token string        Portworx authentication token
+      --pxc.v int32             [0-3] Log level verbosity
+```
+
+### SEE ALSO
+
+* [pxc auth guest-access](pxc_auth_guest-access.md)	 - Manage guest access on a Portworx cluster
+
+###### Auto generated by spf13/cobra on 18-Sep-2020
diff --git a/docs/usage/pxc_auth_guest-access_enable.md b/docs/usage/pxc_auth_guest-access_enable.md
@@ -0,0 +1,33 @@
+## pxc auth guest-access enable
+
+enable guest access role
+
+### Synopsis
+
+enable guest access role
+
+```
+pxc auth guest-access enable [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for enable
+```
+
+### Options inherited from parent commands
+
+```
+      --pxc.config string       Config file (default is $HOME/.pxc/config.yml)
+      --pxc.config-dir string   Config directory (default "/home/lpabon/.pxc")
+      --pxc.context string      Force context name for the command
+      --pxc.token string        Portworx authentication token
+      --pxc.v int32             [0-3] Log level verbosity
+```
+
+### SEE ALSO
+
+* [pxc auth guest-access](pxc_auth_guest-access.md)	 - Manage guest access on a Portworx cluster
+
+###### Auto generated by spf13/cobra on 18-Sep-2020
diff --git a/docs/usage/pxc_auth_guest-access_show.md b/docs/usage/pxc_auth_guest-access_show.md
@@ -0,0 +1,34 @@
+## pxc auth guest-access show
+
+show guest access role
+
+### Synopsis
+
+show guest access role
+
+```
+pxc auth guest-access show [flags]
+```
+
+### Options
+
+```
+  -h, --help            help for show
+  -o, --output string   Output in yaml|json|wide
+```
+
+### Options inherited from parent commands
+
+```
+      --pxc.config string       Config file (default is $HOME/.pxc/config.yml)
+      --pxc.config-dir string   Config directory (default "/home/lpabon/.pxc")
+      --pxc.context string      Force context name for the command
+      --pxc.token string        Portworx authentication token
+      --pxc.v int32             [0-3] Log level verbosity
+```
+
+### SEE ALSO
+
+* [pxc auth guest-access](pxc_auth_guest-access.md)	 - Manage guest access on a Portworx cluster
+
+###### Auto generated by spf13/cobra on 18-Sep-2020
diff --git a/docs/usage/pxc_cluster.md b/docs/usage/pxc_cluster.md
@@ -31,5 +31,6 @@ pxc cluster [flags]
 * [pxc](pxc.md)	 - Portworx client
 * [pxc cluster alert](pxc_cluster_alert.md)	 - Manage alerts on a Portworx cluster
 * [pxc cluster describe](pxc_cluster_describe.md)	 - Describe a Portworx cluster
+* [pxc cluster list-by-context](pxc_cluster_list-by-context.md)	 - Show Portworx and Kubernetes information for every context in your kubeconfig
 
-###### Auto generated by spf13/cobra on 2-Jul-2020
+###### Auto generated by spf13/cobra on 18-Sep-2020
diff --git a/docs/usage/pxc_cluster_alert.md b/docs/usage/pxc_cluster_alert.md
@@ -32,4 +32,4 @@ pxc cluster alert [flags]
 * [pxc cluster alert delete](pxc_cluster_alert_delete.md)	 - Delete Portworx alerts
 * [pxc cluster alert list](pxc_cluster_alert_list.md)	 - List and get information about Portworx alerts
 
-###### Auto generated by spf13/cobra on 2-Jul-2020
+###### Auto generated by spf13/cobra on 18-Sep-2020
diff --git a/docs/usage/pxc_cluster_alert_delete.md b/docs/usage/pxc_cluster_alert_delete.md
@@ -42,4 +42,4 @@ pxc cluster alert delete [flags]
 
 * [pxc cluster alert](pxc_cluster_alert.md)	 - Manage alerts on a Portworx cluster
 
-###### Auto generated by spf13/cobra on 2-Jul-2020
+###### Auto generated by spf13/cobra on 18-Sep-2020
diff --git a/docs/usage/pxc_cluster_alert_list.md b/docs/usage/pxc_cluster_alert_list.md
@@ -60,4 +60,4 @@ pxc cluster alert list [flags]
 
 * [pxc cluster alert](pxc_cluster_alert.md)	 - Manage alerts on a Portworx cluster
 
-###### Auto generated by spf13/cobra on 2-Jul-2020
+###### Auto generated by spf13/cobra on 18-Sep-2020
diff --git a/docs/usage/pxc_cluster_describe.md b/docs/usage/pxc_cluster_describe.md
@@ -30,4 +30,4 @@ pxc cluster describe [NAME] [flags]
 
 * [pxc cluster](pxc_cluster.md)	 - Manage Portworx cluster
 
-###### Auto generated by spf13/cobra on 2-Jul-2020
+###### Auto generated by spf13/cobra on 18-Sep-2020
diff --git a/docs/usage/pxc_cluster_list-by-context.md b/docs/usage/pxc_cluster_list-by-context.md
@@ -0,0 +1,49 @@
+## pxc cluster list-by-context
+
+Show Portworx and Kubernetes information for every context in your kubeconfig
+
+### Synopsis
+
+Show Portworx and Kubernetes information for every context in your kubeconfig
+
+```
+pxc cluster list-by-context [flags]
+```
+
+### Examples
+
+```
+
+  # Scan through all the contexts in your kubeconfig and display cluster information
+  pxc cluster list-by-context
+
+  # Show cluster information for contexts that match contain 'east-coast' in the name
+  pxc cluster list-by-context --context-match='*east-coast*,*south*'
+
+  # Output all Kubernetes and Portworx cluster information as json for your contexts that match '*on-prem*'
+  pxc cluster list-by-context -o json --context-match='*on-prem*'
+```
+
+### Options
+
+```
+      --context-match string   Comma separated list of expressions match the appropriate context
+  -h, --help                   help for list-by-context
+  -o, --output string          Output in yaml|json|wide
+```
+
+### Options inherited from parent commands
+
+```
+      --pxc.config string       Config file (default is $HOME/.pxc/config.yml)
+      --pxc.config-dir string   Config directory (default "/home/lpabon/.pxc")
+      --pxc.context string      Force context name for the command
+      --pxc.token string        Portworx authentication token
+      --pxc.v int32             [0-3] Log level verbosity
+```
+
+### SEE ALSO
+
+* [pxc cluster](pxc_cluster.md)	 - Manage Portworx cluster
+
+###### Auto generated by spf13/cobra on 18-Sep-2020
diff --git a/docs/usage/pxc_component.md b/docs/usage/pxc_component.md
@@ -35,4 +35,4 @@ pxc component
 * [pxc](pxc.md)	 - Portworx client
 * [pxc component list](pxc_component_list.md)	 - List all visible component executables
 
-###### Auto generated by spf13/cobra on 2-Jul-2020
+###### Auto generated by spf13/cobra on 18-Sep-2020
diff --git a/docs/usage/pxc_component_list.md b/docs/usage/pxc_component_list.md
@@ -37,4 +37,4 @@ pxc component list [flags]
 
 * [pxc component](pxc_component.md)	 - Provides utilities for interacting with components
 
-###### Auto generated by spf13/cobra on 2-Jul-2020
+###### Auto generated by spf13/cobra on 18-Sep-2020
diff --git a/docs/usage/pxc_config.md b/docs/usage/pxc_config.md
@@ -35,4 +35,4 @@ pxc config [flags]
 * [pxc config current-context](pxc_config_current-context.md)	 - Display the current context
 * [pxc config view](pxc_config_view.md)	 - Show pxc configuration
 
-###### Auto generated by spf13/cobra on 2-Jul-2020
+###### Auto generated by spf13/cobra on 18-Sep-2020
diff --git a/docs/usage/pxc_config_cluster.md b/docs/usage/pxc_config_cluster.md
@@ -32,4 +32,4 @@ pxc config cluster [flags]
 * [pxc config cluster delete](pxc_config_cluster_delete.md)	 - Delete pxc cluster configuration
 * [pxc config cluster set](pxc_config_cluster_set.md)	 - Configure pxc to communicate with your cluster
 
-###### Auto generated by spf13/cobra on 2-Jul-2020
+###### Auto generated by spf13/cobra on 18-Sep-2020
diff --git a/docs/usage/pxc_config_cluster_delete.md b/docs/usage/pxc_config_cluster_delete.md
@@ -31,4 +31,4 @@ pxc config cluster delete [flags]
 
 * [pxc config cluster](pxc_config_cluster.md)	 - Setup pxc cluster configuration
 
-###### Auto generated by spf13/cobra on 2-Jul-2020
+###### Auto generated by spf13/cobra on 18-Sep-2020
diff --git a/docs/usage/pxc_config_cluster_set.md b/docs/usage/pxc_config_cluster_set.md
@@ -45,4 +45,4 @@ pxc config cluster set [flags]
 
 * [pxc config cluster](pxc_config_cluster.md)	 - Setup pxc cluster configuration
 
-###### Auto generated by spf13/cobra on 2-Jul-2020
+###### Auto generated by spf13/cobra on 18-Sep-2020
diff --git a/docs/usage/pxc_config_context.md b/docs/usage/pxc_config_context.md
@@ -33,4 +33,4 @@ pxc config context [flags]
 * [pxc config context set](pxc_config_context_set.md)	 - Set context information for which cluster and credentials to uset
 * [pxc config context use](pxc_config_context_use.md)	 - Sets the context to use
 
-###### Auto generated by spf13/cobra on 2-Jul-2020
+###### Auto generated by spf13/cobra on 18-Sep-2020
diff --git a/docs/usage/pxc_config_context_delete.md b/docs/usage/pxc_config_context_delete.md
@@ -31,4 +31,4 @@ pxc config context delete [flags]
 
 * [pxc config context](pxc_config_context.md)	 - Setup pxc contexts
 
-###### Auto generated by spf13/cobra on 2-Jul-2020
+###### Auto generated by spf13/cobra on 18-Sep-2020
diff --git a/docs/usage/pxc_config_context_set.md b/docs/usage/pxc_config_context_set.md
@@ -41,4 +41,4 @@ pxc config context set [flags]
 
 * [pxc config context](pxc_config_context.md)	 - Setup pxc contexts
 
-###### Auto generated by spf13/cobra on 2-Jul-2020
+###### Auto generated by spf13/cobra on 18-Sep-2020
diff --git a/docs/usage/pxc_config_context_use.md b/docs/usage/pxc_config_context_use.md
@@ -31,4 +31,4 @@ pxc config context use [flags]
 
 * [pxc config context](pxc_config_context.md)	 - Setup pxc contexts
 
-###### Auto generated by spf13/cobra on 2-Jul-2020
+###### Auto generated by spf13/cobra on 18-Sep-2020
diff --git a/docs/usage/pxc_config_credentials.md b/docs/usage/pxc_config_credentials.md
@@ -33,4 +33,4 @@ pxc config credentials [flags]
 * [pxc config credentials set](pxc_config_credentials_set.md)	 - Set authentication information for Portworx cluster
 * [pxc config credentials whoami](pxc_config_credentials_whoami.md)	 - Shows current authentication information
 
-###### Auto generated by spf13/cobra on 2-Jul-2020
+###### Auto generated by spf13/cobra on 18-Sep-2020
diff --git a/docs/usage/pxc_config_credentials_delete.md b/docs/usage/pxc_config_credentials_delete.md
@@ -31,4 +31,4 @@ pxc config credentials delete [flags]
 
 * [pxc config credentials](pxc_config_credentials.md)	 - Setup pxc authentication
 
-###### Auto generated by spf13/cobra on 2-Jul-2020
+###### Auto generated by spf13/cobra on 18-Sep-2020
diff --git a/docs/usage/pxc_config_credentials_set.md b/docs/usage/pxc_config_credentials_set.md
@@ -47,4 +47,4 @@ pxc config credentials set [flags]
 
 * [pxc config credentials](pxc_config_credentials.md)	 - Setup pxc authentication
 
-###### Auto generated by spf13/cobra on 2-Jul-2020
+###### Auto generated by spf13/cobra on 18-Sep-2020
diff --git a/docs/usage/pxc_config_credentials_whoami.md b/docs/usage/pxc_config_credentials_whoami.md
@@ -31,4 +31,4 @@ pxc config credentials whoami [flags]
 
 * [pxc config credentials](pxc_config_credentials.md)	 - Setup pxc authentication
 
-###### Auto generated by spf13/cobra on 2-Jul-2020
+###### Auto generated by spf13/cobra on 18-Sep-2020
diff --git a/docs/usage/pxc_config_current-context.md b/docs/usage/pxc_config_current-context.md
@@ -30,4 +30,4 @@ pxc config current-context [flags]
 
 * [pxc config](pxc_config.md)	 - Setup pxc configuration
 
-###### Auto generated by spf13/cobra on 2-Jul-2020
+###### Auto generated by spf13/cobra on 18-Sep-2020
diff --git a/docs/usage/pxc_config_view.md b/docs/usage/pxc_config_view.md
@@ -30,4 +30,4 @@ pxc config view [flags]
 
 * [pxc config](pxc_config.md)	 - Setup pxc configuration
 
-###### Auto generated by spf13/cobra on 2-Jul-2020
+###### Auto generated by spf13/cobra on 18-Sep-2020
diff --git a/docs/usage/pxc_context.md b/docs/usage/pxc_context.md
@@ -30,4 +30,4 @@ pxc context [flags]
 
 * [pxc](pxc.md)	 - Portworx client
 
-###### Auto generated by spf13/cobra on 2-Jul-2020
+###### Auto generated by spf13/cobra on 18-Sep-2020
diff --git a/docs/usage/pxc_node.md b/docs/usage/pxc_node.md
@@ -33,4 +33,4 @@ pxc node [flags]
 * [pxc node list](pxc_node_list.md)	 - List Portworx nodes information
 * [pxc node logs](pxc_node_logs.md)	 - Print Portworx logs for specified nodes
 
-###### Auto generated by spf13/cobra on 2-Jul-2020
+###### Auto generated by spf13/cobra on 18-Sep-2020
diff --git a/docs/usage/pxc_node_describe.md b/docs/usage/pxc_node_describe.md
@@ -38,4 +38,4 @@ pxc node describe [NAME] [flags]
 
 * [pxc node](pxc_node.md)	 - Portworx node management
 
-###### Auto generated by spf13/cobra on 2-Jul-2020
+###### Auto generated by spf13/cobra on 18-Sep-2020
diff --git a/docs/usage/pxc_node_list.md b/docs/usage/pxc_node_list.md
@@ -32,4 +32,4 @@ pxc node list [flags]
 
 * [pxc node](pxc_node.md)	 - Portworx node management
 
-###### Auto generated by spf13/cobra on 2-Jul-2020
+###### Auto generated by spf13/cobra on 18-Sep-2020
diff --git a/docs/usage/pxc_node_logs.md b/docs/usage/pxc_node_logs.md
@@ -66,4 +66,4 @@ pxc node logs [NAME] [flags]
 
 * [pxc node](pxc_node.md)	 - Portworx node management
 
-###### Auto generated by spf13/cobra on 2-Jul-2020
+###### Auto generated by spf13/cobra on 18-Sep-2020
Original file line number	Diff line number	Diff line change
Expand Up		@@ -42,4 +42,4 @@ pxc cluster alert delete [flags]

		* [pxc cluster alert](pxc_cluster_alert.md) - Manage alerts on a Portworx cluster

		###### Auto generated by spf13/cobra on 2-Jul-2020
		###### Auto generated by spf13/cobra on 18-Sep-2020
Original file line number	Diff line number	Diff line change
Expand Up		@@ -60,4 +60,4 @@ pxc cluster alert list [flags]

		* [pxc cluster alert](pxc_cluster_alert.md) - Manage alerts on a Portworx cluster

		###### Auto generated by spf13/cobra on 2-Jul-2020
		###### Auto generated by spf13/cobra on 18-Sep-2020
Original file line number	Diff line number	Diff line change
Expand Up		@@ -30,4 +30,4 @@ pxc cluster describe [NAME] [flags]

		* [pxc cluster](pxc_cluster.md) - Manage Portworx cluster

		###### Auto generated by spf13/cobra on 2-Jul-2020
		###### Auto generated by spf13/cobra on 18-Sep-2020
Original file line number	Diff line number	Diff line change
Expand Up		@@ -37,4 +37,4 @@ pxc component list [flags]

		* [pxc component](pxc_component.md) - Provides utilities for interacting with components

		###### Auto generated by spf13/cobra on 2-Jul-2020
		###### Auto generated by spf13/cobra on 18-Sep-2020
Original file line number	Diff line number	Diff line change
Expand Up		@@ -31,4 +31,4 @@ pxc config cluster delete [flags]

		* [pxc config cluster](pxc_config_cluster.md) - Setup pxc cluster configuration

		###### Auto generated by spf13/cobra on 2-Jul-2020
		###### Auto generated by spf13/cobra on 18-Sep-2020
Original file line number	Diff line number	Diff line change
Expand Up		@@ -45,4 +45,4 @@ pxc config cluster set [flags]

		* [pxc config cluster](pxc_config_cluster.md) - Setup pxc cluster configuration

		###### Auto generated by spf13/cobra on 2-Jul-2020
		###### Auto generated by spf13/cobra on 18-Sep-2020
Original file line number	Diff line number	Diff line change
Expand Up		@@ -31,4 +31,4 @@ pxc config context delete [flags]

		* [pxc config context](pxc_config_context.md) - Setup pxc contexts

		###### Auto generated by spf13/cobra on 2-Jul-2020
		###### Auto generated by spf13/cobra on 18-Sep-2020
Original file line number	Diff line number	Diff line change
Expand Up		@@ -41,4 +41,4 @@ pxc config context set [flags]

		* [pxc config context](pxc_config_context.md) - Setup pxc contexts

		###### Auto generated by spf13/cobra on 2-Jul-2020
		###### Auto generated by spf13/cobra on 18-Sep-2020
Original file line number	Diff line number	Diff line change
Expand Up		@@ -31,4 +31,4 @@ pxc config context use [flags]

		* [pxc config context](pxc_config_context.md) - Setup pxc contexts

		###### Auto generated by spf13/cobra on 2-Jul-2020
		###### Auto generated by spf13/cobra on 18-Sep-2020
Original file line number	Diff line number	Diff line change
Expand Up		@@ -31,4 +31,4 @@ pxc config credentials delete [flags]

		* [pxc config credentials](pxc_config_credentials.md) - Setup pxc authentication

		###### Auto generated by spf13/cobra on 2-Jul-2020
		###### Auto generated by spf13/cobra on 18-Sep-2020