diff --git a/docs/usage/pxc.md b/docs/usage/pxc.md index 05e08f61..f7779af1 100644 --- 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 new file mode 100644 index 00000000..3a8bc8cb --- /dev/null +++ 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 new file mode 100644 index 00000000..25b967dc --- /dev/null +++ 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 new file mode 100644 index 00000000..ce18e0ae --- /dev/null +++ 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 new file mode 100644 index 00000000..3e66d735 --- /dev/null +++ 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 new file mode 100644 index 00000000..f4a0e686 --- /dev/null +++ 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 index 0b00e282..89f0d414 100644 --- 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 index 02a1254f..c46e5691 100644 --- 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 index 10b9893d..d8d48b31 100644 --- 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 index af648e62..6c3f8620 100644 --- 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 index 45544e50..398373ae 100644 --- 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 new file mode 100644 index 00000000..3617f5f6 --- /dev/null +++ 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 index 50f73b3a..a1551663 100644 --- 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 index 2e6b3d77..d2d751e5 100644 --- 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 index 06a5f0b9..7c196d2f 100644 --- 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 index 724c9507..5a504139 100644 --- 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 index f50d559d..4955e111 100644 --- 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 index 68f88398..209c0f52 100644 --- 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 index a29f96a1..d941dc1b 100644 --- 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 index 89c36c7d..b61b8df8 100644 --- 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 index da91f200..4813d39a 100644 --- 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 index 35b7ded8..1ff13dd7 100644 --- 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 index dc327557..56206386 100644 --- 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 index 2b706876..8c4195f8 100644 --- 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 index a7106c86..fa7595ac 100644 --- 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 index 4aefc051..09883e6c 100644 --- 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 index 72b2f9ba..8c3510df 100644 --- 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 index 68e43604..b9216c56 100644 --- 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 index ad8ec7bc..e5814bb1 100644 --- 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 index 15fc9b3e..a99e2d4c 100644 --- 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 index d80d87d4..4062c76f 100644 --- 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 index 869780bb..2776e691 100644 --- 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 index e772094e..c8f96ab0 100644 --- 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 diff --git a/docs/usage/pxc_script.md b/docs/usage/pxc_script.md index 2425cd18..d9524bd6 100644 --- a/docs/usage/pxc_script.md +++ b/docs/usage/pxc_script.md @@ -75,4 +75,4 @@ pxc script [NAME] [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_utilities.md b/docs/usage/pxc_utilities.md index 1347deec..6564e4ae 100644 --- a/docs/usage/pxc_utilities.md +++ b/docs/usage/pxc_utilities.md @@ -31,4 +31,4 @@ pxc utilities [flags] * [pxc](pxc.md) - Portworx client * [pxc utilities token-generate](pxc_utilities_token-generate.md) - Generate a Portworx token -###### Auto generated by spf13/cobra on 2-Jul-2020 +###### Auto generated by spf13/cobra on 18-Sep-2020 diff --git a/docs/usage/pxc_utilities_token-generate.md b/docs/usage/pxc_utilities_token-generate.md index e9b56956..89a9e934 100644 --- a/docs/usage/pxc_utilities_token-generate.md +++ b/docs/usage/pxc_utilities_token-generate.md @@ -15,12 +15,13 @@ pxc utilities token-generate [flags] ``` # Login to portworx using a secret in Kubernetes - pxc utilities token-generate pxc util token-generate \ + pxc utilities token-generate \ --token-email=example.user@example.com \ --token-name="Example User" \ --token-roles=system.user \ --token-groups=exampleGroup \ --token-duration=7d \ + --token-issuer=myissuer \ --token-subject="exampleCompany/example.user@example.com" \ --shared-secret=mysecret ``` @@ -55,4 +56,4 @@ pxc utilities token-generate [flags] * [pxc utilities](pxc_utilities.md) - pxc utility commands -###### Auto generated by spf13/cobra on 2-Jul-2020 +###### Auto generated by spf13/cobra on 18-Sep-2020 diff --git a/docs/usage/pxc_version.md b/docs/usage/pxc_version.md index c3ff96ff..b34f5329 100644 --- a/docs/usage/pxc_version.md +++ b/docs/usage/pxc_version.md @@ -30,4 +30,4 @@ pxc version [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_volume.md b/docs/usage/pxc_volume.md index e8a2b1d6..3c0b3fad 100644 --- a/docs/usage/pxc_volume.md +++ b/docs/usage/pxc_volume.md @@ -39,4 +39,4 @@ pxc volume [flags] * [pxc volume stats](pxc_volume_stats.md) - Get stats of Portworx volumes * [pxc volume update](pxc_volume_update.md) - Update field(s) of a portworx volume -###### Auto generated by spf13/cobra on 2-Jul-2020 +###### Auto generated by spf13/cobra on 18-Sep-2020 diff --git a/docs/usage/pxc_volume_clone.md b/docs/usage/pxc_volume_clone.md index 70f80662..0227d8db 100644 --- a/docs/usage/pxc_volume_clone.md +++ b/docs/usage/pxc_volume_clone.md @@ -38,4 +38,4 @@ pxc volume clone [VOLUME] [NAME] [flags] * [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_volume_create.md b/docs/usage/pxc_volume_create.md index 93955093..9ca8ae59 100644 --- a/docs/usage/pxc_volume_create.md +++ b/docs/usage/pxc_volume_create.md @@ -44,10 +44,10 @@ pxc volume create [NAME] [flags] --encryption encrypt this volume --aggregation-level uint32 aggregation level (Valid Values: [1, 2, 3] (default 1) --nodes strings Replica set nodes for this volume - --ioprofile string IO Profile (Valid Values: [sequential cms db db_remote sync_shared]) (default sequential) + --io-profile string IO Profile (Valid Values: [sequential cms db db_remote sync_shared]) (default "sequential") --groups string list of group with volume access details, 'group1:r, group2:w' --collaborators string list of collaborators with volume access details, 'user1:r, user2:w' - --queue-depth uint32 block device queue depth (Valid Range: [1 256]) (default 128) (default 128) + --queue-depth uint32 block device queue depth (Valid Range: [1 256]) (default 128) --early-ack Reply to async write requests after it is copied to shared memory --async-io Enable async IO to backing storage --nodiscard Disable discard support for this volume @@ -76,4 +76,4 @@ pxc volume create [NAME] [flags] * [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_volume_delete.md b/docs/usage/pxc_volume_delete.md index d0a85cda..061a8700 100644 --- a/docs/usage/pxc_volume_delete.md +++ b/docs/usage/pxc_volume_delete.md @@ -38,4 +38,4 @@ pxc volume delete [NAME] [flags] * [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_volume_inspect.md b/docs/usage/pxc_volume_inspect.md index c55d1b82..6713301c 100644 --- a/docs/usage/pxc_volume_inspect.md +++ b/docs/usage/pxc_volume_inspect.md @@ -47,4 +47,4 @@ pxc volume inspect [NAME] [flags] * [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_volume_list.md b/docs/usage/pxc_volume_list.md index 2799050b..440d2ed3 100644 --- a/docs/usage/pxc_volume_list.md +++ b/docs/usage/pxc_volume_list.md @@ -45,4 +45,4 @@ pxc volume list [NAME] [flags] * [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_volume_logs.md b/docs/usage/pxc_volume_logs.md index 83d1016b..ee9a0866 100644 --- a/docs/usage/pxc_volume_logs.md +++ b/docs/usage/pxc_volume_logs.md @@ -64,4 +64,4 @@ pxc volume logs [NAME] [flags] * [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_volume_snapshot.md b/docs/usage/pxc_volume_snapshot.md index 4e3cbddd..41b5a53c 100644 --- a/docs/usage/pxc_volume_snapshot.md +++ b/docs/usage/pxc_volume_snapshot.md @@ -39,4 +39,4 @@ pxc volume snapshot [VOLUME] [NAME] [flags] * [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_volume_stats.md b/docs/usage/pxc_volume_stats.md index f081f64b..d88d9802 100644 --- a/docs/usage/pxc_volume_stats.md +++ b/docs/usage/pxc_volume_stats.md @@ -36,4 +36,4 @@ pxc volume stats [NAME] [flags] * [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_volume_update.md b/docs/usage/pxc_volume_update.md index b15dfcee..fa6e8ea7 100644 --- a/docs/usage/pxc_volume_update.md +++ b/docs/usage/pxc_volume_update.md @@ -14,27 +14,19 @@ pxc volume update [NAME] [flags] ``` - # Set the High Availability Level (HA Level) of the volume xyz to 3 - pxc volume update xyz --halevel 3 + #### Update Volume Spec #### # Update the size of the volume to 2GiB pxc volume update xyz --size 2 - # Set the sticky flag of the volume xyz - pxc volume update xyz --sticky - # Set the shared flag of the volume xyz - pxc volume update xyz --shared + pxc volume update xyz --shared=on + + #### Update Volume Access Controls #### # Update collaborators and groups of the volume access list pxc volume update xyz --add-collaborators user1:r,user2:w,user3:a --add-groups group1:r,group2:w,group3:a - # Remove collaborators and groups from exisiting volume access list - pxc volume update xyz --remove-collaborators user1:r, --remove-groups group1:r - - # Remove all the collaborators and groups from exisiting volume access list - pxc volume update xyz --remove-all-collaborators --remove-all-groups - # Update collaborators and remove few groups from the volume access list pxc volume update xyz --add-collaborators user4:r,user5:w, --remove-groups group1:r @@ -45,7 +37,7 @@ pxc volume update [NAME] [flags] ### Options ``` - --halevel int New replication factor (Valid Range: [1, 3]) (default 1) + --replicas int New replication factor (Valid Range: [1, 3]) (default 1) --nodes strings Desired set of nodes for the volume data --size uint New size for the volume (GiB) (default 1) --shared string set shared setting (Valid Values: [on off]) (default "off") @@ -78,4 +70,4 @@ pxc volume update [NAME] [flags] * [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