Skip to content
This repository has been archived by the owner on Nov 5, 2024. It is now read-only.

Commit

Permalink
peer review feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
missmesss committed Sep 21, 2023
1 parent 3432fbc commit f3f9196
Showing 1 changed file with 17 additions and 16 deletions.
33 changes: 17 additions & 16 deletions docs/modules/ROOT/pages/how-to-guides/proc_viewing_logs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,51 +2,52 @@

{ProductName} generates logs when it builds, checks, and deploys components of your application. Reading logs can be your first step to understand why the build or checks failed.

You can access pod and Task logs using both the UI and CLI, you can also download any logs to your local machine. We store logs for the 10 most recent PipelineRuns executed in the namespace but you can start a new build pipeline and {ProductName} will generate a new set of logs for you.
You can access pod and Task logs with both the UI and CLI, and you can download these logs to your local machine. {ProductName} stores logs for the 10 most recent PipelineRuns that are executed in the namespace. However, you can also start a new build pipeline to generate a new set of logs.

== Types of logs

* *Pod logs* show health and status of a running Kubernetes pod within your application. {ProductName} creates pod logs when it starts your application in a pod on an OpenShift cluster so you can watch how it boots your application in real time.
* *Pod logs* show the health and status of a running Kubernetes pod within your application. {ProductName} creates pod logs when it starts your application in a pod on an OpenShift cluster so you can watch how it boots your application in real time.
* *Task logs* are generated for all Tasks of a build pipeline. Both default and custom build pipelines have PipelineRuns of types *Build* and *Test*.
+
Logs for *Test* PipelineRuns are the same for all pipelines, they log how a build is verified with an Enterprise Contract (EC). However logs for *Build* PipelineRuns differ for default and custom build pipelines:

** Logs for default build pipelines log how {ProductName} clones a Git repository with your code or our sample code, builds container images with your application, checks the images, and generates a SBOM.
** Logs for default build pipelines log how {ProductName} clones a Git repository with your code or our sample code, builds container images with your application, checks the images, and generates an SBOM.
** Custom build pipelines have PipelineRuns that run on opening pull requests and on push to the Git repository, and logs for different PipelineRuns differ. On-push PipelineRuns clone a Git repo and build a container image with a component. On-pull-request PipelineRuns also run several advanced checks.

== Viewing pod logs in the web UI

.Prerequisites

* You have created an application in {ProductName}.
You have created an application in {ProductName}.

.Procedure

To view pod logs for a component:

* Navigate to the *Components* tab > *View pod logs*.
** A pop-up window allows you to view pod logs in the UI or download them to your machine using the *Download* button.
* Navigate to *Components* > *View pod logs*.
* A pop-up window enables you to view pod logs in the UI or download them to your machine by selecting *Download*.

== Viewing Task logs in the web UI

In the UI you can view Task logs all together on one screen or choose to view each Task log separately, together with other Task details.
In the UI, you can either view all Task logs on one screen, or each Task log separately, with other Task details.

.Prerequisites

* You have created an application in {ProductName}.
You have created an application in {ProductName}.

.Procedure

To view all Task logs displayed together on one screen:

. Navigate to the *Activity* tab > *Pipeline runs*.
. Select a PipelineRun you need > Navigate to the *Logs* tab.
. Navigate to *Activity* > *Pipeline runs*.
. Select a PipelineRun.
. Navigate to *Logs*.

To view logs for a particular Task:

. Navigate to the *Activity* tab > *Pipeline runs*.
. Select a PipelineRun you need. You have 2 options from here:
.. Navigate to the *Details* tab. In a graphic representation of a pipeline called *Pipeline run details* select a Task you need. A side panel will open that includes the *Logs* tab.
. Navigate to *Activity* > *Pipeline runs*.
. Select a PipelineRun. You then have 2 options:
.. Navigate to *Details*. In a graphic representation of a pipeline called *Pipeline run details* select a Task you need. A side panel will open that includes the *Logs* tab.
+
OR
+
Expand All @@ -63,15 +64,15 @@ OR

To view Task logs with the Tekton CLI:

. List the existing PipelineRuns:
. List the existing PipelineRuns by running:
+
[source]
--
tkn pr list
--

. Copy a name of a PipelineRun you need logs for.
. Access logs for a particular PipelineRun:
. Access the logs for a particular PipelineRun by running:
+
[source]
--
Expand All @@ -85,7 +86,7 @@ In the Tekton CLI you can use `__pr__` as a shortcut for the PipelineRun command

== Troubleshooting

{ProductName} allows you to view logs for the 10 most recent PipelineRuns executed in the namespace. When logs aren't available any longer you see the following message instead of logs:
{ProductName} enables you to view logs for the 10 most recent PipelineRuns executed in the namespace. When logs aren't available any longer, you see the following message instead of logs:

[source]
--
Expand Down

0 comments on commit f3f9196

Please sign in to comment.