-
Notifications
You must be signed in to change notification settings - Fork 76
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[CLI] Update Documentation for all cmds
- Loading branch information
Showing
6 changed files
with
124 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
## tkn-results logs | ||
|
||
Commands for finding and retrieving logs | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for logs | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
-a, --addr string Result API server address. If not specified, tkn-result would port-forward to service/tekton-results-api-service automatically | ||
-t, --authtoken string authorization bearer token to use for authenticated requests | ||
--insecure determines whether to run insecure GRPC tls request | ||
--portforward enable auto portforwarding to tekton-results-api-service, when addr is set and portforward is true, tkn-results will portforward tekton-results-api-service automatically (default true) | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [tkn-results](tkn-results.md) - tkn CLI plugin for Tekton Results API | ||
* [tkn-results logs get](tkn-results_logs_get.md) - Get Log | ||
* [tkn-results logs list](tkn-results_logs_list.md) - List Logs | ||
|
||
###### Auto generated by spf13/cobra on 31-Aug-2023 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
## tkn-results logs get | ||
|
||
Get Log | ||
|
||
``` | ||
tkn-results logs get [flags] <log> | ||
<log path>: Log full name to query. This is typically "<namespace>/results/<result name>/logs/<log name>". | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for get | ||
-o, --output string output format. Valid values: textproto|json (default "json") | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
-a, --addr string Result API server address. If not specified, tkn-result would port-forward to service/tekton-results-api-service automatically | ||
-t, --authtoken string authorization bearer token to use for authenticated requests | ||
--insecure determines whether to run insecure GRPC tls request | ||
--portforward enable auto portforwarding to tekton-results-api-service, when addr is set and portforward is true, tkn-results will portforward tekton-results-api-service automatically (default true) | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [tkn-results logs](tkn-results_logs.md) - Commands for finding and retrieving logs | ||
|
||
###### Auto generated by spf13/cobra on 31-Aug-2023 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
## tkn-results logs list | ||
|
||
List Logs | ||
|
||
``` | ||
tkn-results logs list [flags] <result parent> | ||
<result parent>: Result parent name to query. This is typically "<namespace>/results/<result name>", but may vary depending on the API Server. "-" may be used as <result name> to query all Logs for a given parent. | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-f, --filter string CEL Filter | ||
-h, --help help for list | ||
-l, --limit int32 number of items to return. Response may be truncated due to server limits. | ||
-o, --output string output format. Valid values: tab|textproto|json (default "tab") | ||
-p, --page string pagination token to use for next page | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
-a, --addr string Result API server address. If not specified, tkn-result would port-forward to service/tekton-results-api-service automatically | ||
-t, --authtoken string authorization bearer token to use for authenticated requests | ||
--insecure determines whether to run insecure GRPC tls request | ||
--portforward enable auto portforwarding to tekton-results-api-service, when addr is set and portforward is true, tkn-results will portforward tekton-results-api-service automatically (default true) | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [tkn-results logs](tkn-results_logs.md) - Commands for finding and retrieving logs | ||
|
||
###### Auto generated by spf13/cobra on 31-Aug-2023 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
## tkn-results records get | ||
|
||
Get Record | ||
|
||
``` | ||
tkn-results records get [flags] <record_path> | ||
<record name>: Fully qualified name of the record. This is typically "<namespace>/results/<result name>/records/<record uid>". | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for get | ||
-o, --output string output format. Valid values: textproto|json (default "json") | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
-a, --addr string Result API server address. If not specified, tkn-result would port-forward to service/tekton-results-api-service automatically | ||
-t, --authtoken string authorization bearer token to use for authenticated requests | ||
--insecure determines whether to run insecure GRPC tls request | ||
--portforward enable auto portforwarding to tekton-results-api-service, when addr is set and portforward is true, tkn-results will portforward tekton-results-api-service automatically (default true) | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [tkn-results records](tkn-results_records.md) - Command sub-group for querying Records | ||
|
||
###### Auto generated by spf13/cobra on 31-Aug-2023 |