Skip to content

Commit fc2d7e6

Browse files
lpabonlpabon
committed
updated docs
1 parent 3392344 commit fc2d7e6

Some content is hidden

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

70 files changed

+1444
-1926
lines changed

‎docs/usage/pxc.md

+18-29
Original file line numberDiff line numberDiff line change
@@ -6,43 +6,32 @@ Portworx client
66

77
Portworx client
88

9+
```
10+
pxc [flags]
11+
```
12+
913
### Options
1014

1115
```
12-
--as string Username to impersonate for the operation
13-
--as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
14-
--cache-dir string Default HTTP cache directory (default "/home/lpabon/.kube/http-cache")
15-
--certificate-authority string Path to a cert file for the certificate authority
16-
--client-certificate string Path to a client certificate file for TLS
17-
--client-key string Path to a client key file for TLS
18-
--cluster string The name of the kubeconfig cluster to use
19-
--context string The name of the kubeconfig context to use
20-
-h, --help help for pxc
21-
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
22-
--kubeconfig string Path to the kubeconfig file to use for CLI requests.
23-
-n, --namespace string If present, the namespace scope for this CLI request
24-
--pxc.config string Config file (default is $HOME/.pxc/config.yml)
25-
--pxc.secret-name string Kubernetes secret name containing authentication token
26-
--pxc.secret-namespace string Kubernetes namespace where secret contains token
27-
--pxc.token string Portworx authentication token
28-
--pxc.v int32 [0-3] Log level verbosity
29-
--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")
30-
-s, --server string The address and port of the Kubernetes API server
31-
--token string Bearer token for authentication to the API server
32-
--user string The name of the kubeconfig user to use
16+
-h, --help help for pxc
17+
--options Show global options for all commands
18+
--pxc.config string Config file (default is $HOME/.pxc/config.yml)
19+
--pxc.config-dir string Config directory (default "/home/lpabon/.pxc")
20+
--pxc.context string Force context name for the command
21+
--pxc.token string Portworx authentication token
22+
--pxc.v int32 [0-3] Log level verbosity
3323
```
3424

3525
### SEE ALSO
3626

27+
* [pxc alert](pxc_alert.md) - Manage alerts on a Portworx cluster
28+
* [pxc cluster](pxc_cluster.md) - Manage Portworx cluster
3729
* [pxc config](pxc_config.md) - Setup pxc configuration
38-
* [pxc create](pxc_create.md) - Create an object in Portworx
39-
* [pxc delete](pxc_delete.md) - Delete an object in Portworx
40-
* [pxc describe](pxc_describe.md) - Show detailed information of Portworx resources
41-
* [pxc get](pxc_get.md) - Get information from Portworx
42-
* [pxc login](pxc_login.md) - Set authentication information for Portworx cluster
43-
* [pxc logs](pxc_logs.md) - Print Portworx logs
44-
* [pxc patch](pxc_patch.md) - Update field(s) of a Portworx resource
30+
* [pxc context](pxc_context.md) - Manage connections to Portworx and other systems
31+
* [pxc node](pxc_node.md) - Portworx node management
32+
* [pxc plugin](pxc_plugin.md) - Provides utilities for interacting with plugins
4533
* [pxc script](pxc_script.md) - Run a script against the current cluster
4634
* [pxc version](pxc_version.md) - Show pxc version information
35+
* [pxc volume](pxc_volume.md) - Volume life cycle management
4736

48-
###### Auto generated by spf13/cobra on 3-Feb-2020
37+
###### Auto generated by spf13/cobra on 5-Mar-2020

‎docs/usage/pxc_alert.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
## pxc alert
2+
3+
Manage alerts on a Portworx cluster
4+
5+
### Synopsis
6+
7+
Manage alerts on a Portworx cluster
8+
9+
```
10+
pxc alert [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help help for alert
17+
```
18+
19+
### Options inherited from parent commands
20+
21+
```
22+
--pxc.config string Config file (default is $HOME/.pxc/config.yml)
23+
--pxc.config-dir string Config directory (default "/home/lpabon/.pxc")
24+
--pxc.context string Force context name for the command
25+
--pxc.token string Portworx authentication token
26+
--pxc.v int32 [0-3] Log level verbosity
27+
```
28+
29+
### SEE ALSO
30+
31+
* [pxc](pxc.md) - Portworx client
32+
* [pxc alert delete](pxc_alert_delete.md) - Delete Portworx alerts
33+
* [pxc alert list](pxc_alert_list.md) - List and get information about Portworx alerts
34+
35+
###### Auto generated by spf13/cobra on 5-Mar-2020

‎docs/usage/pxc_alert_delete.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
## pxc alert delete
2+
3+
Delete Portworx alerts
4+
5+
### Synopsis
6+
7+
Delete Portworx alerts
8+
9+
```
10+
pxc alert delete [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
17+
# Delete portworx related alerts
18+
pxc alert delete
19+
20+
# Delete alerts based on particular alert type. Delete all alerts related to "volume"
21+
pxc alert delete -t "volume"
22+
```
23+
24+
### Options
25+
26+
```
27+
-h, --help help for delete
28+
-t, --type string alert type (Valid Values: [volume node cluster drive all]) (default "all")
29+
```
30+
31+
### Options inherited from parent commands
32+
33+
```
34+
--pxc.config string Config file (default is $HOME/.pxc/config.yml)
35+
--pxc.config-dir string Config directory (default "/home/lpabon/.pxc")
36+
--pxc.context string Force context name for the command
37+
--pxc.token string Portworx authentication token
38+
--pxc.v int32 [0-3] Log level verbosity
39+
```
40+
41+
### SEE ALSO
42+
43+
* [pxc alert](pxc_alert.md) - Manage alerts on a Portworx cluster
44+
45+
###### Auto generated by spf13/cobra on 5-Mar-2020

‎docs/usage/pxc_alert_list.md

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
## pxc alert list
2+
3+
List and get information about Portworx alerts
4+
5+
### Synopsis
6+
7+
List and get information about Portworx alerts
8+
9+
```
10+
pxc alert list [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
17+
# Get portworx related alerts
18+
pxc alert list
19+
20+
# Fetch alerts based on particular alert id. Fetch all alerts based on "VolumeCreateSuccess" id
21+
pxc alert list --id "VolumeCreateSuccess"
22+
23+
# Fetch alerts between a time window
24+
pxctl alerts show --start-time "2019-09-19T09:40:26.371Z" --end-time "2019-09-19T09:43:59.371Z"
25+
26+
# Fetch alerts with min severity level
27+
pxc alert list --severity "alarm"
28+
29+
# Fetch alerts based on resource type. Here we fetch all "volume" related alerts
30+
pxc alert list -t "volume"
31+
32+
# Fetch alerts based on resource id. Here we fetch alerts related to "cluster"
33+
pxc alert list --id "1f95a5e7-6a38-41f9-9cb2-8bb4f8ab72c5"
34+
```
35+
36+
### Options
37+
38+
```
39+
-e, --end-time string end time span (RFC 3339)
40+
-h, --help help for list
41+
-i, --id string Alert id
42+
-o, --output string Output in yaml|json|wide
43+
-v, --severity string Min severity value (Valid Values: [notify warn warning alarm]) (default "notify") (default "notify")
44+
-a, --start-time string start time span (RFC 3339)
45+
-t, --type string alert type (Valid Values: [volume node cluster drive all]) (default "all")
46+
```
47+
48+
### Options inherited from parent commands
49+
50+
```
51+
--pxc.config string Config file (default is $HOME/.pxc/config.yml)
52+
--pxc.config-dir string Config directory (default "/home/lpabon/.pxc")
53+
--pxc.context string Force context name for the command
54+
--pxc.token string Portworx authentication token
55+
--pxc.v int32 [0-3] Log level verbosity
56+
```
57+
58+
### SEE ALSO
59+
60+
* [pxc alert](pxc_alert.md) - Manage alerts on a Portworx cluster
61+
62+
###### Auto generated by spf13/cobra on 5-Mar-2020

‎docs/usage/pxc_cluster.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
## pxc cluster
2+
3+
Manage Portworx cluster
4+
5+
### Synopsis
6+
7+
Manage Portworx cluster
8+
9+
```
10+
pxc cluster [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help help for cluster
17+
```
18+
19+
### Options inherited from parent commands
20+
21+
```
22+
--pxc.config string Config file (default is $HOME/.pxc/config.yml)
23+
--pxc.config-dir string Config directory (default "/home/lpabon/.pxc")
24+
--pxc.context string Force context name for the command
25+
--pxc.token string Portworx authentication token
26+
--pxc.v int32 [0-3] Log level verbosity
27+
```
28+
29+
### SEE ALSO
30+
31+
* [pxc](pxc.md) - Portworx client
32+
* [pxc cluster describe](pxc_cluster_describe.md) - Describe a Portworx cluster
33+
34+
###### Auto generated by spf13/cobra on 5-Mar-2020

‎docs/usage/pxc_cluster_describe.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
## pxc cluster describe
2+
3+
Describe a Portworx cluster
4+
5+
### Synopsis
6+
7+
Show detailed information of Portworx cluster
8+
9+
```
10+
pxc cluster describe [NAME] [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
17+
# Display detailed information about Portworx cluster
18+
pxc cluster describe
19+
```
20+
21+
### Options
22+
23+
```
24+
-h, --help help for describe
25+
```
26+
27+
### Options inherited from parent commands
28+
29+
```
30+
--pxc.config string Config file (default is $HOME/.pxc/config.yml)
31+
--pxc.config-dir string Config directory (default "/home/lpabon/.pxc")
32+
--pxc.context string Force context name for the command
33+
--pxc.token string Portworx authentication token
34+
--pxc.v int32 [0-3] Log level verbosity
35+
```
36+
37+
### SEE ALSO
38+
39+
* [pxc cluster](pxc_cluster.md) - Manage Portworx cluster
40+
41+
###### Auto generated by spf13/cobra on 5-Mar-2020

‎docs/usage/pxc_config.md

+11-23
Original file line numberDiff line numberDiff line change
@@ -19,32 +19,20 @@ pxc config [flags]
1919
### Options inherited from parent commands
2020

2121
```
22-
--as string Username to impersonate for the operation
23-
--as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
24-
--cache-dir string Default HTTP cache directory (default "/home/lpabon/.kube/http-cache")
25-
--certificate-authority string Path to a cert file for the certificate authority
26-
--client-certificate string Path to a client certificate file for TLS
27-
--client-key string Path to a client key file for TLS
28-
--cluster string The name of the kubeconfig cluster to use
29-
--context string The name of the kubeconfig context to use
30-
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
31-
--kubeconfig string Path to the kubeconfig file to use for CLI requests.
32-
-n, --namespace string If present, the namespace scope for this CLI request
33-
--pxc.config string Config file (default is $HOME/.pxc/config.yml)
34-
--pxc.secret-name string Kubernetes secret name containing authentication token
35-
--pxc.secret-namespace string Kubernetes namespace where secret contains token
36-
--pxc.token string Portworx authentication token
37-
--pxc.v int32 [0-3] Log level verbosity
38-
--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")
39-
-s, --server string The address and port of the Kubernetes API server
40-
--token string Bearer token for authentication to the API server
41-
--user string The name of the kubeconfig user to use
22+
--pxc.config string Config file (default is $HOME/.pxc/config.yml)
23+
--pxc.config-dir string Config directory (default "/home/lpabon/.pxc")
24+
--pxc.context string Force context name for the command
25+
--pxc.token string Portworx authentication token
26+
--pxc.v int32 [0-3] Log level verbosity
4227
```
4328

4429
### SEE ALSO
4530

4631
* [pxc](pxc.md) - Portworx client
47-
* [pxc config delete-cluster](pxc_config_delete-cluster.md) - Delete pxc cluster configuration
48-
* [pxc config set-cluster](pxc_config_set-cluster.md) - Setup pxc cluster configuration
32+
* [pxc config cluster](pxc_config_cluster.md) - Setup pxc cluster configuration
33+
* [pxc config context](pxc_config_context.md) - Setup pxc contexts
34+
* [pxc config credentials](pxc_config_credentials.md) - Setup pxc authentication
35+
* [pxc config current-context](pxc_config_current-context.md) - Display the current context
36+
* [pxc config view](pxc_config_view.md) - Show pxc configuration
4937

50-
###### Auto generated by spf13/cobra on 3-Feb-2020
38+
###### Auto generated by spf13/cobra on 5-Mar-2020

‎docs/usage/pxc_config_cluster.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
## pxc config cluster
2+
3+
Setup pxc cluster configuration
4+
5+
### Synopsis
6+
7+
Setup pxc cluster configuration
8+
9+
```
10+
pxc config cluster [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help help for cluster
17+
```
18+
19+
### Options inherited from parent commands
20+
21+
```
22+
--pxc.config string Config file (default is $HOME/.pxc/config.yml)
23+
--pxc.config-dir string Config directory (default "/home/lpabon/.pxc")
24+
--pxc.context string Force context name for the command
25+
--pxc.token string Portworx authentication token
26+
--pxc.v int32 [0-3] Log level verbosity
27+
```
28+
29+
### SEE ALSO
30+
31+
* [pxc config](pxc_config.md) - Setup pxc configuration
32+
* [pxc config cluster delete](pxc_config_cluster_delete.md) - Delete pxc cluster configuration
33+
* [pxc config cluster set](pxc_config_cluster_set.md) - Setup pxc cluster configuration
34+
35+
###### Auto generated by spf13/cobra on 5-Mar-2020

‎docs/usage/pxc_config_cluster_delete.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
## pxc config cluster delete
2+
3+
Delete pxc cluster configuration
4+
5+
### Synopsis
6+
7+
Delete pxc cluster configuration
8+
9+
```
10+
pxc config cluster delete [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help help for delete
17+
--name string Name for Portworx cluster (ignored when used as a kubectl plugin)
18+
```
19+
20+
### Options inherited from parent commands
21+
22+
```
23+
--pxc.config string Config file (default is $HOME/.pxc/config.yml)
24+
--pxc.config-dir string Config directory (default "/home/lpabon/.pxc")
25+
--pxc.context string Force context name for the command
26+
--pxc.token string Portworx authentication token
27+
--pxc.v int32 [0-3] Log level verbosity
28+
```
29+
30+
### SEE ALSO
31+
32+
* [pxc config cluster](pxc_config_cluster.md) - Setup pxc cluster configuration
33+
34+
###### Auto generated by spf13/cobra on 5-Mar-2020

0 commit comments

Comments
 (0)