Skip to content

Commit 27288b0

Browse files
committed
update docs
Signed-off-by: Luis Pabón <[email protected]>
1 parent da70c5a commit 27288b0

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+101
-249
lines changed

docs/usage/pxc.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ pxc [flags]
1919
-h, --help help for pxc
2020
--options Show global options for all commands
2121
--pxc.config string Config file (default is $HOME/.pxc/config.yml)
22-
--pxc.config-dir string Config directory (default "/home/lpabon/.pxc")
22+
--pxc.config-dir string Config directory (default "/home2/lpabon/.pxc")
2323
--pxc.context string Force context name for the command
2424
--pxc.token string Portworx authentication token
2525
--pxc.v int32 [0-3] Log level verbosity
@@ -29,7 +29,7 @@ pxc [flags]
2929

3030
* [pxc auth](pxc_auth.md) - Manage Portworx authentication
3131
* [pxc cluster](pxc_cluster.md) - Manage Portworx cluster
32-
* [pxc component](pxc_component.md) - Provides utilities for interacting with components
32+
* [pxc component](pxc_component.md) - Configure components
3333
* [pxc config](pxc_config.md) - Setup pxc configuration
3434
* [pxc context](pxc_context.md) - Manage connections to Portworx and other systems
3535
* [pxc node](pxc_node.md) - Portworx node management
@@ -38,4 +38,4 @@ pxc [flags]
3838
* [pxc version](pxc_version.md) - Show pxc version information
3939
* [pxc volume](pxc_volume.md) - Volume life cycle management
4040

41-
###### Auto generated by spf13/cobra on 18-Sep-2020
41+
###### Auto generated by spf13/cobra on 24-Mar-2021

docs/usage/pxc_auth.md

+2-6
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22

33
Manage Portworx authentication
44

5-
### Synopsis
6-
7-
Manage Portworx authentication
8-
95
```
106
pxc auth [flags]
117
```
@@ -20,7 +16,7 @@ pxc auth [flags]
2016

2117
```
2218
--pxc.config string Config file (default is $HOME/.pxc/config.yml)
23-
--pxc.config-dir string Config directory (default "/home/lpabon/.pxc")
19+
--pxc.config-dir string Config directory (default "/home2/lpabon/.pxc")
2420
--pxc.context string Force context name for the command
2521
--pxc.token string Portworx authentication token
2622
--pxc.v int32 [0-3] Log level verbosity
@@ -31,4 +27,4 @@ pxc auth [flags]
3127
* [pxc](pxc.md) - Portworx client
3228
* [pxc auth guest-access](pxc_auth_guest-access.md) - Manage guest access on a Portworx cluster
3329

34-
###### Auto generated by spf13/cobra on 18-Sep-2020
30+
###### Auto generated by spf13/cobra on 24-Mar-2021

docs/usage/pxc_auth_guest-access.md

+2-6
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22

33
Manage guest access on a Portworx cluster
44

5-
### Synopsis
6-
7-
Manage guest access on a Portworx cluster
8-
95
```
106
pxc auth guest-access [flags]
117
```
@@ -20,7 +16,7 @@ pxc auth guest-access [flags]
2016

2117
```
2218
--pxc.config string Config file (default is $HOME/.pxc/config.yml)
23-
--pxc.config-dir string Config directory (default "/home/lpabon/.pxc")
19+
--pxc.config-dir string Config directory (default "/home2/lpabon/.pxc")
2420
--pxc.context string Force context name for the command
2521
--pxc.token string Portworx authentication token
2622
--pxc.v int32 [0-3] Log level verbosity
@@ -33,4 +29,4 @@ pxc auth guest-access [flags]
3329
* [pxc auth guest-access enable](pxc_auth_guest-access_enable.md) - enable guest access role
3430
* [pxc auth guest-access show](pxc_auth_guest-access_show.md) - show guest access role
3531

36-
###### Auto generated by spf13/cobra on 18-Sep-2020
32+
###### Auto generated by spf13/cobra on 24-Mar-2021

docs/usage/pxc_auth_guest-access_disable.md

+2-6
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22

33
Disable guest access role
44

5-
### Synopsis
6-
7-
Disable guest access role
8-
95
```
106
pxc auth guest-access disable [flags]
117
```
@@ -20,7 +16,7 @@ pxc auth guest-access disable [flags]
2016

2117
```
2218
--pxc.config string Config file (default is $HOME/.pxc/config.yml)
23-
--pxc.config-dir string Config directory (default "/home/lpabon/.pxc")
19+
--pxc.config-dir string Config directory (default "/home2/lpabon/.pxc")
2420
--pxc.context string Force context name for the command
2521
--pxc.token string Portworx authentication token
2622
--pxc.v int32 [0-3] Log level verbosity
@@ -30,4 +26,4 @@ pxc auth guest-access disable [flags]
3026

3127
* [pxc auth guest-access](pxc_auth_guest-access.md) - Manage guest access on a Portworx cluster
3228

33-
###### Auto generated by spf13/cobra on 18-Sep-2020
29+
###### Auto generated by spf13/cobra on 24-Mar-2021

docs/usage/pxc_auth_guest-access_enable.md

+2-6
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22

33
enable guest access role
44

5-
### Synopsis
6-
7-
enable guest access role
8-
95
```
106
pxc auth guest-access enable [flags]
117
```
@@ -20,7 +16,7 @@ pxc auth guest-access enable [flags]
2016

2117
```
2218
--pxc.config string Config file (default is $HOME/.pxc/config.yml)
23-
--pxc.config-dir string Config directory (default "/home/lpabon/.pxc")
19+
--pxc.config-dir string Config directory (default "/home2/lpabon/.pxc")
2420
--pxc.context string Force context name for the command
2521
--pxc.token string Portworx authentication token
2622
--pxc.v int32 [0-3] Log level verbosity
@@ -30,4 +26,4 @@ pxc auth guest-access enable [flags]
3026

3127
* [pxc auth guest-access](pxc_auth_guest-access.md) - Manage guest access on a Portworx cluster
3228

33-
###### Auto generated by spf13/cobra on 18-Sep-2020
29+
###### Auto generated by spf13/cobra on 24-Mar-2021

docs/usage/pxc_auth_guest-access_show.md

+2-6
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22

33
show guest access role
44

5-
### Synopsis
6-
7-
show guest access role
8-
95
```
106
pxc auth guest-access show [flags]
117
```
@@ -21,7 +17,7 @@ pxc auth guest-access show [flags]
2117

2218
```
2319
--pxc.config string Config file (default is $HOME/.pxc/config.yml)
24-
--pxc.config-dir string Config directory (default "/home/lpabon/.pxc")
20+
--pxc.config-dir string Config directory (default "/home2/lpabon/.pxc")
2521
--pxc.context string Force context name for the command
2622
--pxc.token string Portworx authentication token
2723
--pxc.v int32 [0-3] Log level verbosity
@@ -31,4 +27,4 @@ pxc auth guest-access show [flags]
3127

3228
* [pxc auth guest-access](pxc_auth_guest-access.md) - Manage guest access on a Portworx cluster
3329

34-
###### Auto generated by spf13/cobra on 18-Sep-2020
30+
###### Auto generated by spf13/cobra on 24-Mar-2021

docs/usage/pxc_cluster.md

+2-6
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22

33
Manage Portworx cluster
44

5-
### Synopsis
6-
7-
Manage Portworx cluster
8-
95
```
106
pxc cluster [flags]
117
```
@@ -20,7 +16,7 @@ pxc cluster [flags]
2016

2117
```
2218
--pxc.config string Config file (default is $HOME/.pxc/config.yml)
23-
--pxc.config-dir string Config directory (default "/home/lpabon/.pxc")
19+
--pxc.config-dir string Config directory (default "/home2/lpabon/.pxc")
2420
--pxc.context string Force context name for the command
2521
--pxc.token string Portworx authentication token
2622
--pxc.v int32 [0-3] Log level verbosity
@@ -33,4 +29,4 @@ pxc cluster [flags]
3329
* [pxc cluster describe](pxc_cluster_describe.md) - Describe a Portworx cluster
3430
* [pxc cluster list-by-context](pxc_cluster_list-by-context.md) - Show Portworx and Kubernetes information for every context in your kubeconfig
3531

36-
###### Auto generated by spf13/cobra on 18-Sep-2020
32+
###### Auto generated by spf13/cobra on 24-Mar-2021

docs/usage/pxc_cluster_alert.md

+2-6
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22

33
Manage alerts on a Portworx cluster
44

5-
### Synopsis
6-
7-
Manage alerts on a Portworx cluster
8-
95
```
106
pxc cluster alert [flags]
117
```
@@ -20,7 +16,7 @@ pxc cluster alert [flags]
2016

2117
```
2218
--pxc.config string Config file (default is $HOME/.pxc/config.yml)
23-
--pxc.config-dir string Config directory (default "/home/lpabon/.pxc")
19+
--pxc.config-dir string Config directory (default "/home2/lpabon/.pxc")
2420
--pxc.context string Force context name for the command
2521
--pxc.token string Portworx authentication token
2622
--pxc.v int32 [0-3] Log level verbosity
@@ -32,4 +28,4 @@ pxc cluster alert [flags]
3228
* [pxc cluster alert delete](pxc_cluster_alert_delete.md) - Delete Portworx alerts
3329
* [pxc cluster alert list](pxc_cluster_alert_list.md) - List and get information about Portworx alerts
3430

35-
###### Auto generated by spf13/cobra on 18-Sep-2020
31+
###### Auto generated by spf13/cobra on 24-Mar-2021

docs/usage/pxc_cluster_alert_delete.md

+2-6
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22

33
Delete Portworx alerts
44

5-
### Synopsis
6-
7-
Delete Portworx alerts
8-
95
```
106
pxc cluster alert delete [flags]
117
```
@@ -32,7 +28,7 @@ pxc cluster alert delete [flags]
3228

3329
```
3430
--pxc.config string Config file (default is $HOME/.pxc/config.yml)
35-
--pxc.config-dir string Config directory (default "/home/lpabon/.pxc")
31+
--pxc.config-dir string Config directory (default "/home2/lpabon/.pxc")
3632
--pxc.context string Force context name for the command
3733
--pxc.token string Portworx authentication token
3834
--pxc.v int32 [0-3] Log level verbosity
@@ -42,4 +38,4 @@ pxc cluster alert delete [flags]
4238

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

45-
###### Auto generated by spf13/cobra on 18-Sep-2020
41+
###### Auto generated by spf13/cobra on 24-Mar-2021

docs/usage/pxc_cluster_alert_list.md

+2-6
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22

33
List and get information about Portworx alerts
44

5-
### Synopsis
6-
7-
List and get information about Portworx alerts
8-
95
```
106
pxc cluster alert list [flags]
117
```
@@ -50,7 +46,7 @@ pxc cluster alert list [flags]
5046

5147
```
5248
--pxc.config string Config file (default is $HOME/.pxc/config.yml)
53-
--pxc.config-dir string Config directory (default "/home/lpabon/.pxc")
49+
--pxc.config-dir string Config directory (default "/home2/lpabon/.pxc")
5450
--pxc.context string Force context name for the command
5551
--pxc.token string Portworx authentication token
5652
--pxc.v int32 [0-3] Log level verbosity
@@ -60,4 +56,4 @@ pxc cluster alert list [flags]
6056

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

63-
###### Auto generated by spf13/cobra on 18-Sep-2020
59+
###### Auto generated by spf13/cobra on 24-Mar-2021

docs/usage/pxc_cluster_describe.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ pxc cluster describe [NAME] [flags]
2020

2121
```
2222
--pxc.config string Config file (default is $HOME/.pxc/config.yml)
23-
--pxc.config-dir string Config directory (default "/home/lpabon/.pxc")
23+
--pxc.config-dir string Config directory (default "/home2/lpabon/.pxc")
2424
--pxc.context string Force context name for the command
2525
--pxc.token string Portworx authentication token
2626
--pxc.v int32 [0-3] Log level verbosity
@@ -30,4 +30,4 @@ pxc cluster describe [NAME] [flags]
3030

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

33-
###### Auto generated by spf13/cobra on 18-Sep-2020
33+
###### Auto generated by spf13/cobra on 24-Mar-2021

docs/usage/pxc_cluster_list-by-context.md

+2-6
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22

33
Show Portworx and Kubernetes information for every context in your kubeconfig
44

5-
### Synopsis
6-
7-
Show Portworx and Kubernetes information for every context in your kubeconfig
8-
95
```
106
pxc cluster list-by-context [flags]
117
```
@@ -36,7 +32,7 @@ pxc cluster list-by-context [flags]
3632

3733
```
3834
--pxc.config string Config file (default is $HOME/.pxc/config.yml)
39-
--pxc.config-dir string Config directory (default "/home/lpabon/.pxc")
35+
--pxc.config-dir string Config directory (default "/home2/lpabon/.pxc")
4036
--pxc.context string Force context name for the command
4137
--pxc.token string Portworx authentication token
4238
--pxc.v int32 [0-3] Log level verbosity
@@ -46,4 +42,4 @@ pxc cluster list-by-context [flags]
4642

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

49-
###### Auto generated by spf13/cobra on 18-Sep-2020
45+
###### Auto generated by spf13/cobra on 24-Mar-2021

docs/usage/pxc_component.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
## pxc component
22

3-
Provides utilities for interacting with components
3+
Configure components
44

55
### Synopsis
66

77

8-
Provides utilities for interacting with components.
8+
Configure components
99

10-
Plugins provide extended functionality that is not part of the major command-line distribution.
11-
Please refer to the documentation and examples for more information about how write your own components.
10+
Components provide extended functionality that is not part of the major command-line
11+
distribution. Please refer to the documentation and examples for more information
12+
about how write your own components.
1213

1314
```
1415
pxc component
@@ -24,7 +25,7 @@ pxc component
2425

2526
```
2627
--pxc.config string Config file (default is $HOME/.pxc/config.yml)
27-
--pxc.config-dir string Config directory (default "/home/lpabon/.pxc")
28+
--pxc.config-dir string Config directory (default "/home2/lpabon/.pxc")
2829
--pxc.context string Force context name for the command
2930
--pxc.token string Portworx authentication token
3031
--pxc.v int32 [0-3] Log level verbosity
@@ -35,4 +36,4 @@ pxc component
3536
* [pxc](pxc.md) - Portworx client
3637
* [pxc component list](pxc_component_list.md) - List all visible component executables
3738

38-
###### Auto generated by spf13/cobra on 18-Sep-2020
39+
###### Auto generated by spf13/cobra on 24-Mar-2021

docs/usage/pxc_component_list.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,14 @@ pxc component list [flags]
2727

2828
```
2929
--pxc.config string Config file (default is $HOME/.pxc/config.yml)
30-
--pxc.config-dir string Config directory (default "/home/lpabon/.pxc")
30+
--pxc.config-dir string Config directory (default "/home2/lpabon/.pxc")
3131
--pxc.context string Force context name for the command
3232
--pxc.token string Portworx authentication token
3333
--pxc.v int32 [0-3] Log level verbosity
3434
```
3535

3636
### SEE ALSO
3737

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

40-
###### Auto generated by spf13/cobra on 18-Sep-2020
40+
###### Auto generated by spf13/cobra on 24-Mar-2021

docs/usage/pxc_config.md

+2-6
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22

33
Setup pxc configuration
44

5-
### Synopsis
6-
7-
Setup pxc configuration
8-
95
```
106
pxc config [flags]
117
```
@@ -20,7 +16,7 @@ pxc config [flags]
2016

2117
```
2218
--pxc.config string Config file (default is $HOME/.pxc/config.yml)
23-
--pxc.config-dir string Config directory (default "/home/lpabon/.pxc")
19+
--pxc.config-dir string Config directory (default "/home2/lpabon/.pxc")
2420
--pxc.context string Force context name for the command
2521
--pxc.token string Portworx authentication token
2622
--pxc.v int32 [0-3] Log level verbosity
@@ -35,4 +31,4 @@ pxc config [flags]
3531
* [pxc config current-context](pxc_config_current-context.md) - Display the current context
3632
* [pxc config view](pxc_config_view.md) - Show pxc configuration
3733

38-
###### Auto generated by spf13/cobra on 18-Sep-2020
34+
###### Auto generated by spf13/cobra on 24-Mar-2021

0 commit comments

Comments
 (0)