TEP-0160 Enhance Tekton Results CLI #1179

divyansh42 · 2025-02-10T18:42:58Z

Proposing a TEP to enhance the existing functionalities of the Tekton Results CLI

Inspired by the kubectl plugin developed by @sayan-biswas ❤️

/kind tep

khrm · 2025-02-13T07:13:02Z

teps/0157-enhance-results-cli.md

+
+### Backward Compatibility
+
+Existing `tkn-results` CLI commands should not break. We should add a deprecation message to the old commands to inform users about the new structure and provide guidance on transitioning to the updated CLI.


We can probably hide these commands under debug or something. I found these to be helpful while debugging sometime.

Yes, we will not remove the existing commands, as users might be relying on those commands.

divyansh42 · 2025-02-13T07:25:36Z

@sayan-biswas could you please review the TEP once? Thank you.

anithapriyanatarajan · 2025-02-17T08:48:36Z

teps/0157-enhance-results-cli.md

+```sh
+tkn-results pr ls -n <namespace>  # Get list of PipelineRuns in a namespace  
+tkn-results tr ls -n <namespace>  # Get list of TaskRuns in a namespace  
+```


@divyansh42, we have seen frequent usage where as a Tekton admin, i may want to observe a pattern of failures for a specific group of pipeline runs. Can we include option to fetch pr/tr list based on some selectors(labels) ?

@anithapriyanatarajan thanks for taking a look. I am planning to add a filtering option in the next iteration.
But this sounds like a good filter to add. I will work further on this.

chmeliik · 2025-02-17T09:37:10Z

teps/0157-enhance-results-cli.md

+```sh
+tkn-results pr ls -n <namespace>  # Get list of PipelineRuns in a namespace  
+tkn-results tr ls -n <namespace>  # Get list of TaskRuns in a namespace  
+```
+
+#### Describing Runs
+
+```sh
+tkn-results pr describe <pr-name> -n <namespace>  # Get details of a specific PipelineRun  
+tkn-results tr describe <tr-name> -n <namespace>  # Get details of a specific TaskRun  
+```
+
+#### Fetching Logs
+
+```sh
+tkn-results pr logs <pr-name> -n <namespace>  # Fetch logs of a specific PipelineRun  
+tkn-results tr logs <tr-name> -n <namespace>  # Fetch logs of a specific TaskRun  
+```


I imagine these would be mostly equivalent to tkn pr ls, tkn pr describe, tkn pr logs?

It would be great if they supported (most of) the same CLI flags, so that I could just take a regular tkn ... command, change it to tkn results ... and have it work. But I wouldn't necessarily expect that to be the case in the first iteration.

Eventually, if the tkn-results commands become fully compatible with the equivalent tkn commands, maybe the the regular commands could become results-aware?

So I wouldn't need to try both tkn pr logs and tkn results pr logs -- tkn pr logs would "just work"?

I imagine these would be mostly equivalent to tkn pr ls, tkn pr describe, tkn pr logs?

Thanks for taking a look @chmeliik
Yes, that's what we have planned right now. I should eventually add those flags based on the requirements.

Eventually, if the tkn-results commands become fully compatible with the equivalent tkn commands, maybe the the regular commands could become results-aware?

So I wouldn't need to try both tkn pr logs and tkn results pr logs -- tkn pr logs would "just work"?

I agree with your point, I think that will be a part of long-term goals for the tkn

Would tkn results only look at the stored results or would it also be aware of the data in etcd? If the subcommand can work for either, then feature parity definitely makes sense.

I think as of now, tkn-results will look for data in the stored results but I think moving forward long term goal would be to have the functionality in tkn where it can look for data stored in etcd as well as the results.
cc @vdemeester

enarha

Is the code going to be maintained as part of the results repo (https://github.com/tektoncd/results) or as a separate repo?

divyansh42 · 2025-02-17T14:43:56Z

Is the code going to be maintained as part of the results repo (https://github.com/tektoncd/results) or as a separate repo?

Will be maintained as a part of results repo (https://github.com/tektoncd/results)

teps/0157-enhance-results-cli.md

afrittoli · 2025-02-26T11:34:24Z

The lint job fails because the TEP table has not been updated to match.

khrm · 2025-03-04T11:21:28Z

/lgtm

Signed-off-by: divyansh42 <[email protected]>

tekton-robot · 2025-03-05T08:36:15Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please ask for approval from khrm after the PR has been reviewed.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

teps/OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

divyansh42 · 2025-03-05T08:38:42Z

Added details related to the pagination support

khrm · 2025-03-05T08:47:59Z

/lgtm

vdemeester

Few comments, but otherwise Looks Good To Me 😉

vdemeester · 2025-03-05T13:58:20Z

teps/0160-enhance-results-cli.md

+
+## Summary
+
+`Tekton Results` provides a mechanism to store and query the execution history of `PipelineRuns` and `TaskRuns`. However, the [existing CLI](https://github.com/tektoncd/results/tree/main/pkg/cli) for interacting with Results was not user-friendly. This proposal introduces a dedicated `CLI tool` that simplifies querying and managing Tekton Results, allowing users to retrieve, inspect, and analyze results efficiently. Additionally, this new CLI can be used as a standalone tool or as a plugin to the `tkn` CLI, ensuring seamless integration with existing Tekton workflows.


nit: we could use present tense (was not user-friendly -> is not user-friendly)

vdemeester · 2025-03-05T13:59:00Z

teps/0160-enhance-results-cli.md

+
+### Non-Goals
+
+This proposal is not intended to modify the archived PipelineRuns and TaskRuns


I would also add another non-goal here about not integrating it with tkn (yet)

Like "This proposal doesn't explore possible deep integration with tkn (e.g. transparently query results when doing a tkn pr list), it would be another proposal later once we are happy with this cli".

vdemeester · 2025-03-05T14:01:26Z

teps/0160-enhance-results-cli.md

+#### Configuration
+
+The configuration will allow users to provide the following options:
+- **Host**: The host address for the client to connect.
+- **Token**: The authentication token for secure API access.
+- **API Path**: The specific API endpoint path.
+- **Skip TLS verification**: Skip TLS verification for the API access (default: false)
+
+These values can be automatically fetched and will have default values when possible.
+
+```sh
+tkn-results config set        # Set authentication and configuration parameters
+tkn-results config reset      # Reset the configuration to default values
+tkn-results config view       # View the current configuration
+```


I guess this is stored in a file. We need to make sure it's possible for users to have multiple configuration files and switch from one to the other using an environment variable (à-la KUBECONFIG) or a flag (--config ?)

There is an option to provide --kubeconfig flag which will allow users to use different config file instead of the default one.
If we want we can also include environment variable as well.

Isn't it the tkn-results configuration more than just the kubeconfig ?

No, it is all kubeconfig.
By default, it will fetch from kubeconfig (which will show by default in the config command) and the user provided data will also be stored in Extension in kubeconfig

Signed-off-by: divyansh42 <[email protected]>

tekton-robot · 2025-03-07T06:55:28Z

New changes are detected. LGTM label has been removed.

divyansh42 · 2025-03-07T06:57:38Z

Few comments, but otherwise Looks Good To Me 😉

Thanks for the suggestions, I have added a commit to address those.
For the last one, I will make the changes once we conclude the discussion.

I Will squash the commit before the merge.

tekton-robot added the kind/tep Categorizes issue or PR as related to a TEP (or needs a TEP). label Feb 10, 2025

tekton-robot requested review from afrittoli and ncskier February 10, 2025 18:43

tekton-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Feb 10, 2025

divyansh42 force-pushed the results-cli-tep branch 2 times, most recently from 7bdbe76 to c1f3a82 Compare February 11, 2025 08:31

khrm reviewed Feb 13, 2025

View reviewed changes

divyansh42 force-pushed the results-cli-tep branch from c1f3a82 to 11c2ff9 Compare February 13, 2025 07:24

divyansh42 force-pushed the results-cli-tep branch from 11c2ff9 to 593bf24 Compare February 13, 2025 07:28

anithapriyanatarajan reviewed Feb 17, 2025

View reviewed changes

chmeliik reviewed Feb 17, 2025

View reviewed changes

enarha reviewed Feb 17, 2025

View reviewed changes

khrm reviewed Feb 20, 2025

View reviewed changes

teps/0157-enhance-results-cli.md Outdated Show resolved Hide resolved

divyansh42 force-pushed the results-cli-tep branch from c933e7e to 9ce4a5c Compare February 20, 2025 10:13

divyansh42 changed the title ~~TEP-0157 Enhance Tekton Results CLI~~ TEP-0160 Enhance Tekton Results CLI Feb 20, 2025

divyansh42 force-pushed the results-cli-tep branch 3 times, most recently from 8264257 to efb89a4 Compare February 26, 2025 11:17

divyansh42 force-pushed the results-cli-tep branch from efb89a4 to 2cd1fb2 Compare February 26, 2025 11:41

tekton-robot assigned khrm Mar 4, 2025

tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Mar 4, 2025

TEP-0157 Enhance Tekton Results CLI

91850b4

Signed-off-by: divyansh42 <[email protected]>

divyansh42 force-pushed the results-cli-tep branch from 2cd1fb2 to 91850b4 Compare March 5, 2025 08:36

tekton-robot removed the lgtm Indicates that a PR is ready to be merged. label Mar 5, 2025

tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Mar 5, 2025

vdemeester reviewed Mar 5, 2025

View reviewed changes

Address reviews

472bd6c

Signed-off-by: divyansh42 <[email protected]>

tekton-robot removed the lgtm Indicates that a PR is ready to be merged. label Mar 7, 2025

divyansh42 mentioned this pull request Mar 7, 2025

[CLI enchancement] Refactor directory structure for the enhanced CLI tektoncd/results#980

Open

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

TEP-0160 Enhance Tekton Results CLI #1179

TEP-0160 Enhance Tekton Results CLI #1179

divyansh42 commented Feb 10, 2025 •

edited

Loading

khrm Feb 13, 2025

divyansh42 Feb 13, 2025

divyansh42 commented Feb 13, 2025

anithapriyanatarajan Feb 17, 2025

divyansh42 Feb 17, 2025

chmeliik Feb 17, 2025

chmeliik Feb 17, 2025

divyansh42 Feb 17, 2025

arewm Feb 27, 2025

divyansh42 Mar 5, 2025

enarha left a comment

divyansh42 commented Feb 17, 2025

afrittoli commented Feb 26, 2025

khrm commented Mar 4, 2025

tekton-robot commented Mar 5, 2025

divyansh42 commented Mar 5, 2025

khrm commented Mar 5, 2025

vdemeester left a comment

vdemeester Mar 5, 2025

vdemeester Mar 5, 2025

vdemeester Mar 5, 2025

vdemeester Mar 5, 2025

divyansh42 Mar 6, 2025 •

edited

Loading

vdemeester Mar 6, 2025

divyansh42 Mar 7, 2025

tekton-robot commented Mar 7, 2025

divyansh42 commented Mar 7, 2025


		### Backward Compatibility

		Existing `tkn-results` CLI commands should not break. We should add a deprecation message to the old commands to inform users about the new structure and provide guidance on transitioning to the updated CLI.


		## Summary

		`Tekton Results` provides a mechanism to store and query the execution history of `PipelineRuns` and `TaskRuns`. However, the [existing CLI](https://github.com/tektoncd/results/tree/main/pkg/cli) for interacting with Results was not user-friendly. This proposal introduces a dedicated `CLI tool` that simplifies querying and managing Tekton Results, allowing users to retrieve, inspect, and analyze results efficiently. Additionally, this new CLI can be used as a standalone tool or as a plugin to the `tkn` CLI, ensuring seamless integration with existing Tekton workflows.


		### Non-Goals

		This proposal is not intended to modify the archived PipelineRuns and TaskRuns

TEP-0160 Enhance Tekton Results CLI #1179

Are you sure you want to change the base?

TEP-0160 Enhance Tekton Results CLI #1179

Conversation

divyansh42 commented Feb 10, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

divyansh42 commented Feb 13, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

enarha left a comment

Choose a reason for hiding this comment

divyansh42 commented Feb 17, 2025

afrittoli commented Feb 26, 2025

khrm commented Mar 4, 2025

tekton-robot commented Mar 5, 2025

divyansh42 commented Mar 5, 2025

khrm commented Mar 5, 2025

vdemeester left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

divyansh42 Mar 6, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tekton-robot commented Mar 7, 2025

divyansh42 commented Mar 7, 2025

divyansh42 commented Feb 10, 2025 •

edited

Loading

divyansh42 Mar 6, 2025 •

edited

Loading