-
Bug
-
Resolution: Done
-
Critical
-
Pipelines 1.19.0
-
1
-
False
-
-
False
-
Release Note Not Required
-
-
-
Pipelines Sprint Crookshank 31, Pipelines Sprint Crookshank 32
Description of problem:
The current documentation and examples from the opc CLI reference the tkn-results binary, but this binary is not included or available in the rpm CLI package. To avoid confusion and ensure usability, either the tkn-results binary should be bundled/provided, or all examples and documentation should be updated to consistently use opc results instead of tkn-results.
$ opc version OpenShift Pipelines Client: 1.19.0 Tekton CLI: 0.41.0 Pipelines as Code CLI: 0.35.1 Tekton Results CLI: 0.15.0 Manual Approval Gate CLI: 0.6.0
$ opc results tkn-results CLI tkn-results is a command-line interface (CLI) designed to interact with Tekton Results. This CLI provides tools to configure how you interact with the Tekton Results API server, query TaskRuns and PipelineRuns and their associated data.The following commands are supported: config Manage Tekton Results CLI configuration: - set: Configure the CLI to connect to a Tekton Results instance. - view: Display the current CLI configuration. - reset: Reset the CLI configuration to defaults. taskrun Query TaskRuns stored in Tekton Results: - list: List TaskRun with filtering options. - describe: Show detailed information about a specific TaskRun. - logs: Get logs for a TaskRun. pipelinerun Query PipelineRuns stored in Tekton Results: - list: List PipelineRuns with filtering options. - describe: Show detailed information about a specific PipelineRun. - logs: Get logs for a PipelineRun. Examples: tkn-results config set tkn-results config view tkn-results taskrun list -n default tkn-results pipelinerun describe my-pipelineRunUsage: opc results [command] Available Commands: logs [To be deprecated] Commands for finding and retrieving logs pipelinerun Query PipelineRuns records [To be deprecated] Command sub-group for querying Records result [To be deprecated] Query Results taskrun Query TaskRunsFlags: -a, --addr string [To be deprecated] Result API server address. If not specified, tkn-result would port-forward to service/tekton-results-api-service automatically -t, --authtoken string [To be deprecated] authorization bearer token to use for authenticated requests -h, --help help for results --insecure [To be deprecated] determines whether to run insecure GRPC tls request --portforward [To be deprecated] 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) --sa string [To be deprecated] ServiceAccount to use instead of token for authorization and authentication --sa-ns string [To be deprecated] ServiceAccount Namespace, if not given, it will be taken from current context --v1alpha2 [To be deprecated] use v1alpha2 API for get log commandUse "opc results [command] --help" for more information about a command.
$ opc results pipelinerun Query PipelineRuns stored in Tekton Results.This command allows you to list PipelineRuns stored in Tekton Results. You can filter results by namespace, labels and other criteria.Examples: # List PipelineRuns in a namespace tkn-results pipelinerun list -n default # List PipelineRuns with a specific label tkn-results pipelinerun list -L app=myapp # List PipelineRuns from all namespaces tkn-results pipelinerun list -A # List PipelineRuns with limit tkn-results pipelinerun list --limit=20Usage: opc results pipelinerun [command] Aliases: pipelinerun, pr, pipelinerunsAvailable Commands: describe Describe a PipelineRun list List PipelineRuns in a namespace logs Get logs for a PipelineRun
$ opc results taskrun Query TaskRuns stored in Tekton Results.This command allows you to list TaskRuns stored in Tekton Results. You can filter results by namespace, labels and other criteria.Examples: # List TaskRuns in a namespace tkn-results taskrun list -n default # List TaskRuns with a specific label tkn-results taskrun list -L app=myapp # List TaskRuns from all namespaces tkn-results taskrun list -A # List TaskRuns with limit tkn-results taskrun list --limit=20Usage: opc results taskrun [command] Aliases: taskrun, trAvailable Commands: describe Describe a TaskRun list List TaskRuns in a namespace logs Get logs for a TaskRun
Prerequisites (if any, like setup, operators/versions):
Steps to Reproduce
Actual results:
The current documentation and examples from the opc CLI reference the tkn-results binary, but this binary is not included or available in the rpm CLI package.
Expected results:
The current documentation and examples from the opc CLI should reference the opc binary
Reproducibility (Always/Intermittent/Only Once):
Acceptance criteria:
Definition of Done:
Build Details:
Additional info (Such as Logs, Screenshots, etc):