RHDEVDOCS 6414 new Results CLI #95134

mramendi · 2025-06-24T03:56:39Z

Version(s):

please cp to pipelines-docs-1.19
Issue:

RHDEVDOCS 6414

Link to docs preview:

https://95134--ocpdocs-pr.netlify.app/openshift-pipelines/latest/records/using-tekton-results-for-openshift-pipelines-observability.html#querying-pipelinerun-tasktun_using-tekton-results-for-openshift-pipelines-observability

QE review:

QE has approved this change.

Additional information:

mramendi · 2025-06-24T03:58:22Z

https://issues.redhat.com/browse/RHDEVDOCS-6414

ocpdocs-previewbot · 2025-06-24T04:05:43Z

🤖 Fri Jul 11 19:35:08 - Prow CI generated the docs preview:

https://95134--ocpdocs-pr.netlify.app/openshift-pipelines/latest/records/using-tekton-results-for-openshift-pipelines-observability.html

divyansh42

@mramendi I have added a few comments which are mostly related to the changes in the functionality and also a few wrong flags getting used.
There were a few minor things as well, I have added those in the code suggestions. Please take a look and let me know if any of the comments need further clarification

modules/op-results-opc-config.adoc

modules/op-results-opc-pipelinerunlist.adoc

modules/op-results-opc-pipelinerunresults.adoc

modules/op-results-opc-taskrunlist.adoc

modules/op-results-opc-taskrunresults.adoc

divyansh42

Thanks for doing the required changes.
I have added a few more minor nitpicks, Could you please take a look?

Also, I was thinking if we can also mention that if the user doesn't provide -n flag then the current namespace will be used. Although it is obvious for any k8s CLI, but if we just want to mention to be more clear.

modules/op-results-opc-pipelinerunlist.adoc

modules/op-results-opc-pipelinerunresults.adoc

modules/op-results-opc-taskrunlist.adoc

modules/op-results-opc-taskrunresults.adoc

divyansh42

/lgtm

manthinasai · 2025-06-26T10:55:04Z

LGTM

mramendi · 2025-07-03T01:14:38Z

/label peer-review-needed

maxwelldb

Let some suggestions, questions, and comments as part of peer review. Re-label when ready!

modules/op-prepare-opc-for-results.adoc

maxwelldb · 2025-07-03T14:33:10Z

modules/op-prepare-opc-for-results.adoc

@@ -29,6 +30,8 @@ $ export RESULTS_API=$(oc get route tekton-results-api-service -n openshift-pipe
 $ oc create token <service_account>
 ----
 +
+Replace `<service_account>` with the name of an {OCP} service account that has read access to the namespaces where {pipelines-shortname} ran the pipeline runs and task runs.


This looks like a good place to use a description list to me.

DLs are not used elsewhere in this particular docset (Pipelines), so this would break consistency

maxwelldb · 2025-07-03T14:37:12Z

modules/op-results-concepts.adoc

+:FeatureName: Querying results and logs by the names of pipeline runs and task runs
+include::snippets/technology-preview.adoc[]


This is a little unusual, but I don't see a rule against it. 🤷
Typically, the TP snippet is used atop the module or assembly for a TP feature.

Changed to this approach upon review, thanks (except it's "part of an assembly" this time)

maxwelldb · 2025-07-03T14:38:23Z

modules/op-results-concepts.adoc

@@ -170,4 +170,9 @@ $ oc get pipelinerun <cr_name> -o yaml

 You can access every result and record by its name. You can also use Common Expression Language (CEL) queries to search for results and records by the information they contain, including the YAML manifest.

-You can also configure {tekton-results} to facilitate forwarding the logging information of all the tools that ran as a part of a pipeline or task to LokiStack. You can then query {tekton-results} for logging information of the task run associated with a {tekton-results} record.
+You can configure {tekton-results} to facilitate forwarding the logging information of all the tools that ran as a part of a pipeline or task to LokiStack. You can then query {tekton-results} for logging information of the task run associated with a {tekton-results} record.


Maybe out of scope, but consider:

You can configure {tekton-results} to forward logs from all tools that ran as part of a pipeline or task to LokiStack. You can then query {tekton-results} for the logs of the task run that is associated with a given record.

Out of scope and would require SME discussion

records/using-tekton-results-for-openshift-pipelines-observability.adoc

maxwelldb · 2025-07-03T14:52:23Z

modules/op-results-opc-pipelinerunresults.adoc

+Alternatively, you can use the pipeline run UUID instead of the name:
+
+[source,terminal]
+----
+$ opc results pipelinerun describe -n <namespace_name> --uid <pipelinerun_uuid>
+----


This is nice to include, but I worry over whether the expansiveness threatens conciseness.

Sometimes many names are VERY similar and easy to mix up, so in those cases people prefer UUIDs

maxwelldb · 2025-07-03T14:52:41Z

modules/op-results-opc-pipelinerunresults.adoc

+$ opc results pipelinerun describe -n <namespace_name> --output yaml <pipelinerun_name>
+----
+
+Alternatively, you can use the pipeline run UUID instead of the name:


Same comment as before.

same answer

maxwelldb · 2025-07-03T14:53:35Z

modules/op-results-opc-pipelinerunresults.adoc

+[IMPORTANT]
+====
+Logs that the `opc results pipelinerun logs` displays do not include logs of task runs that completed within this pipeline runs. To view these logs, find the names of the task runs in this pipeline run using the `opc results taskrun list --pipelinerun` command and specify the name of the pipeline run. Then use the `opc results taskrun log` command to view the logs for the task runs.
+====
+
+[NOTE]
+====
+If you do not specify the `-n` option, the `opc` command applies to the current namespace, To set the current namespace, use the `oc project` command.
+====
+
+[NOTE]
+====
+You can use the short form `opc results pr desc` instead of `opc results pipelinerun describe`.
+
+You can use the short form `opc results pr logs` instead of `opc results pipelinerun logs`.
+====


How much of this needs to be here vs. either in the tool's guidance or organically in documented task flows? I'd try to avoid stacking admonitions unless necessary.

The flows get tremendously overfilled if this is squeezed in. Faced with this issue I added a reference module for short names and just dropped the information about not specifying the namespace.

modules/op-results-opc-taskrunlist.adoc

modules/op-results-opc-taskrunresults.adoc

maxwelldb · 2025-07-03T14:59:36Z

/cherry-pick pipelines-docs-1.19

openshift-cherrypick-robot · 2025-07-03T14:59:41Z

@maxwelldb: once the present PR merges, I will cherry-pick it on top of pipelines-docs-1.19 in a new PR and assign it to you.

In response to this:

/cherry-pick pipelines-docs-1.19

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

openshift-ci · 2025-07-10T20:14:41Z

New changes are detected. LGTM label has been removed.

mramendi · 2025-07-10T23:02:50Z

/label peer-review-needed

xenolinux

A few nits; LGTM

modules/op-results-opc-config.adoc

modules/op-results-opc-shortnames.adoc

modules/op-results-opc-taskrunlist.adoc

modules/op-results-opc-taskrunresults.adoc

modules/op-results-opc-taskrunlist.adoc

openshift-ci · 2025-07-11T19:35:59Z

@mramendi: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

mramendi · 2025-07-12T03:57:54Z

/label merge-review-needed

openshift-ci bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jun 24, 2025

mramendi changed the title ~~RHDEVDOCS 6144 new Results CLI~~ RHDEVDOCS 6414 new Results CLI Jun 24, 2025

mramendi force-pushed the RHDEVDOCS-6414 branch from 6bba74c to 4813a97 Compare June 24, 2025 03:57

divyansh42 reviewed Jun 24, 2025

View reviewed changes

divyansh42 suggested changes Jun 24, 2025

View reviewed changes

divyansh42 approved these changes Jun 24, 2025

View reviewed changes

openshift-ci bot assigned divyansh42 Jun 24, 2025

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jun 24, 2025

openshift-ci bot added the peer-review-needed Signifies that the peer review team needs to review this PR label Jul 3, 2025

maxwelldb added the peer-review-in-progress Signifies that the peer review team is reviewing this PR label Jul 3, 2025

maxwelldb reviewed Jul 3, 2025

View reviewed changes

maxwelldb removed peer-review-in-progress Signifies that the peer review team is reviewing this PR peer-review-needed Signifies that the peer review team needs to review this PR labels Jul 3, 2025

openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Jul 10, 2025

openshift-ci bot added the peer-review-needed Signifies that the peer review team needs to review this PR label Jul 10, 2025

xenolinux added peer-review-in-progress Signifies that the peer review team is reviewing this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Jul 11, 2025

xenolinux reviewed Jul 11, 2025

View reviewed changes

xenolinux added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR labels Jul 11, 2025

RHDEVDOCS 6414 new Results CLI

7ba2be1

mramendi force-pushed the RHDEVDOCS-6414 branch from d5ef650 to 7ba2be1 Compare July 11, 2025 19:25

openshift-ci bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Jul 12, 2025

		:FeatureName: Querying results and logs by the names of pipeline runs and task runs
		include::snippets/technology-preview.adoc[]

RHDEVDOCS 6414 new Results CLI #95134

Are you sure you want to change the base?

RHDEVDOCS 6414 new Results CLI #95134

Conversation

mramendi commented Jun 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mramendi commented Jun 24, 2025

Uh oh!

ocpdocs-previewbot commented Jun 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

divyansh42 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

divyansh42 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

divyansh42 left a comment

Choose a reason for hiding this comment

Uh oh!

manthinasai commented Jun 26, 2025

Uh oh!

mramendi commented Jul 3, 2025

Uh oh!

maxwelldb left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mramendi Jul 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

maxwelldb commented Jul 3, 2025

Uh oh!

openshift-cherrypick-robot commented Jul 3, 2025

Uh oh!

openshift-ci bot commented Jul 10, 2025

Uh oh!

mramendi commented Jun 24, 2025 •

edited

Loading

ocpdocs-previewbot commented Jun 24, 2025 •

edited

Loading

mramendi Jul 10, 2025 •

edited

Loading