Skip to content

Commit

Permalink
Update cli docs
Browse files Browse the repository at this point in the history
Signed-off-by: Evans Mungai <evans@replicated.com>
  • Loading branch information
banjoh committed Sep 12, 2024
1 parent 6763541 commit db80cee
Show file tree
Hide file tree
Showing 7 changed files with 9 additions and 8 deletions.
3 changes: 2 additions & 1 deletion docs/preflight.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ preflight [url] [flags]
--no-uri When this flag is used, Preflight does not attempt to retrieve the spec referenced by the uri: field`
-o, --output string specify the output file path for the preflight checks
--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")
--save-bundle Save collected data to a bundle archive in the current directory. The file path will follow preflightbundle-YYYY-MM-DDTHH_MM_SS.tar.gz format
--selector string selector (label query) to filter remote collection nodes on.
-s, --server string The address and port of the Kubernetes API server
--since string force pod logs collectors to return logs newer than a relative duration like 5s, 2m, or 3h.
Expand All @@ -55,4 +56,4 @@ preflight [url] [flags]
* [preflight oci-fetch](preflight_oci-fetch.md) - Fetch a preflight from an OCI registry and print it to standard out
* [preflight version](preflight_version.md) - Print the current version and exit

###### Auto generated by spf13/cobra on 23-Aug-2024
###### Auto generated by spf13/cobra on 12-Sep-2024
2 changes: 1 addition & 1 deletion docs/preflight_oci-fetch.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@ preflight oci-fetch [URI] [flags]

* [preflight](preflight.md) - Run and retrieve preflight checks in a cluster

###### Auto generated by spf13/cobra on 23-Aug-2024
###### Auto generated by spf13/cobra on 12-Sep-2024
2 changes: 1 addition & 1 deletion docs/preflight_version.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ preflight version [flags]

* [preflight](preflight.md) - Run and retrieve preflight checks in a cluster

###### Auto generated by spf13/cobra on 23-Aug-2024
###### Auto generated by spf13/cobra on 12-Sep-2024
2 changes: 1 addition & 1 deletion docs/support-bundle.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,4 @@ support-bundle [urls...] [flags]
* [support-bundle redact](support-bundle_redact.md) - Redact information from a generated support bundle archive
* [support-bundle version](support-bundle_version.md) - Print the current version and exit

###### Auto generated by spf13/cobra on 23-Aug-2024
###### Auto generated by spf13/cobra on 12-Sep-2024
2 changes: 1 addition & 1 deletion docs/support-bundle_analyze.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ support-bundle analyze [url] [flags]

* [support-bundle](support-bundle.md) - Generate a support bundle from a Kubernetes cluster or specified sources

###### Auto generated by spf13/cobra on 23-Aug-2024
###### Auto generated by spf13/cobra on 12-Sep-2024
4 changes: 2 additions & 2 deletions docs/support-bundle_redact.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ be stored in the current directory in the path provided by the --output flag.
The [urls...] argument is a list of either oci://.., http://.., https://.. or local paths to yaml files.

For more information on redactors visit https://troubleshoot.sh/docs/redact/


```
support-bundle redact [urls...] [flags]
Expand All @@ -39,4 +39,4 @@ support-bundle redact [urls...] [flags]

* [support-bundle](support-bundle.md) - Generate a support bundle from a Kubernetes cluster or specified sources

###### Auto generated by spf13/cobra on 23-Aug-2024
###### Auto generated by spf13/cobra on 12-Sep-2024
2 changes: 1 addition & 1 deletion docs/support-bundle_version.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ support-bundle version [flags]

* [support-bundle](support-bundle.md) - Generate a support bundle from a Kubernetes cluster or specified sources

###### Auto generated by spf13/cobra on 23-Aug-2024
###### Auto generated by spf13/cobra on 12-Sep-2024

0 comments on commit db80cee

Please sign in to comment.