RHDEVDOCS 6239 changes for Tekton Results GA

Author: mramendi

install_config/installing-pipelines.adoc

@@ -40,11 +40,13 @@ include::modules/op-pipelines-operator-in-restricted-environment.adoc[leveloffse
 
 * You can learn more about installing Operators on {OCP} in the link:https://docs.openshift.com/container-platform/latest/operators/admin/olm-adding-operators-to-cluster.html[adding Operators to a cluster] section.
 
-* To install {tekton-chains} using the {pipelines-title} Operator, see xref:../secure/using-tekton-chains-for-openshift-pipelines-supply-chain-security.adoc#using-tekton-chains-for-openshift-pipelines-supply-chain-security[Using {tekton-chains} for {pipelines-title} supply chain security].
+* To configure {tekton-chains}, see xref:../secure/using-tekton-chains-for-openshift-pipelines-supply-chain-security.adoc#using-tekton-chains-for-openshift-pipelines-supply-chain-security[Using {tekton-chains} for {pipelines-title} supply chain security].
+
+* To configure {tekton-results}, see xref:../records/using-tekton-results-for-openshift-pipelines-observability.adoc#using-tekton-results-for-openshift-pipelines-observability[Using {tekton-results} for {pipelines-shortname} observability].
 
 * To install and deploy in-cluster {tekton-hub}, see xref:../hub/using-tekton-hub-with-openshift-pipelines.adoc#using-tekton-hub-with-openshift-pipelines[Using {tekton-hub} with {pipelines-title}].
 
-* For more information on using pipelines in a restricted environment, see:
+* For more information on using {pipelines-shortname} in a restricted environment, see:
 
 ** xref:../create/creating-applications-with-cicd-pipelines.adoc#op-mirroring-images-to-run-pipelines-in-restricted-environment_creating-applications-with-cicd-pipelines[Mirroring images to run pipelines in a restricted environment]
 

modules/op-configuring-results.adoc

@@ -0,0 +1,13 @@
+// This module is included in the following assembly:
+//
+// * records/using-tekton-results-for-openshift-pipelines-observability.adoc
+
+:_mod-docs-content-type: CONCEPT
+[id="configuring-results_{context}"]
+= Configuring {tekton-results}
+
+After you install {pipelines-shortname}, {tekton-results} is enabled by default.
+
+However, if you want to store and access logging information for your pipeline runs and task runs, you must configure forwarding this information to LokiStack. 
+
+You can optionally complete additional configuration for {tekton-results}.

modules/op-configuring-retention-policy-results.adoc

@@ -8,30 +8,33 @@
 
 By default, {tekton-results} stores pipeline runs, task runs, events, and logs indefinitely. This leads to an unnecesary use of storage resources and can affect your database performance.
 
-You can configure the retention policy for {tekton-results} at the cluster level to remove older results and their associated records and logs. You can achieve this by editing the `TektonResult` custom resource (CR).
-
-.Prerequisites
-
-* You installed {tekton-results}.
+You can configure the retention policy for {tekton-results} at the cluster level to remove older results and their associated records and logs.
 
 .Procedure
 
-* In the `TektonResult` CR, configure the retention policy for {tekton-results}, as shown in the following example:
+*  Edit the `TektonConfig` custom resource (CR) by using the following command:
++
+[source,terminal]
+----
+$ oc edit TektonConfig config
+----
++
+Make the following changes in the `result` spec:
 +
-.Example retention policy for {tekton-results}
 [source,yaml]
 ----
 apiVersion: operator.tekton.dev/v1alpha1
-kind: TektonResult
+kind: TektonConfig
 metadata:
-  name: result
+  name: config
 spec:
-  options:
-    configMaps:
-      config-results-retention-policy:
-        data:
-          runAt: "3 5 * * 0" #<1>
-          maxRetention: "30" #<2>
+  result:
+    options:
+      configMaps:
+        config-results-retention-policy:
+          data:
+            runAt: "3 5 * * 0" #<1>
+            maxRetention: "30" #<2>
 ----
 <1> Specify, in cron format, when to run the pruning job in the database. This example runs the job at 5:03 AM every Sunday.
 <2> Specify how many days to keep the data in the database. This example retains the data for 30 days.

modules/op-installing-pipelines-operator-in-web-console.adoc

@@ -20,9 +20,9 @@ If you manually changed your existing installation, such as, changing the target
 The {pipelines-title} Operator now provides the option to choose the components that you want to install by specifying profiles as part of the `TektonConfig` custom resource (CR). The `TektonConfig` CR is automatically installed when the Operator is installed.
 The supported profiles are:
 
-* Lite: This installs only Tekton Pipelines.
-* Basic: This installs Tekton Pipelines, Tekton Triggers, and Tekton Chains.
-* All: This is the default profile used when the `TektonConfig` CR is installed. This profile installs all of the Tekton components, including Tekton Pipelines, Tekton Triggers, Tekton Chains, {pac}, and Tekton Addons. Tekton Addons includes the `ClusterTriggerBindings`, `ConsoleCLIDownload`, `ConsoleQuickStart`, and `ConsoleYAMLSample` resources, as well as the tasks and step actions available using the cluster resolver from the `openshift-pipelines` namespace.
+* Lite: This profile installs only Tekton Pipelines.
+* Basic: This profile installs Tekton Pipelines, Tekton Triggers, {tekton-chains}, and {tekton-results}.
+* All: This is the default profile used when the `TektonConfig` CR is installed. This profile installs all of the Tekton components, including Tekton Pipelines, Tekton Triggers, {tekton-chains}, {tekton-results}, {pac}, and Tekton Addons. Tekton Addons includes the `ClusterTriggerBindings`, `ConsoleCLIDownload`, `ConsoleQuickStart`, and `ConsoleYAMLSample` resources, as well as the tasks and step action definitions available by using the cluster resolver from the `openshift-pipelines` namespace.
 
 [discrete]
 .Procedure

modules/op-installing-results.adoc

@@ -11,7 +11,6 @@ Before you can query {tekton-results}, you must prepare the environment for the
 
 .Prerequisites
 
-* You installed {tekton-results}.
 * You installed the `opc` utility.
 
 .Procedure

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

@@ -11,9 +11,9 @@ You can list and query results and records using their names.
 
 .Prerequisites
 
-* You installed {tekton-results}.
 * You installed the `opc` utility and prepared its environment to query {tekton-results}.
 * You installed the `jq` package.
+* If you want to query logging information, you configured log forwarding to LokiStack.
 
 .Procedure
 

modules/op-query-results-name.adoc

@@ -168,6 +168,6 @@ $ oc get pipelinerun <cr_name> -o yaml
   apiVersion: tekton.dev/v1
 ----
 
-{tekton-results} also creates a log record that contains the logging information of all the tools that ran as a part of a pipeline run or task run.
-
 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.

modules/op-results-cert.adoc

@@ -4,37 +4,43 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="results-db_{context}"]
-= Preparing a secret with the database credentials
+= Configuring an external database server
 
-{tekton-results} uses a PostgreSQL database to store data. You can configure the installation to use either a PostgreSQL server that is automatically installed with {tekton-results} or an external PostgreSQL server that already exists in your deployment. In both cases, provide a secret with the database credentials.
+{tekton-results} uses a PostgreSQL database to store data. By default, the installation includes an internal PostgreSQL instance.
+You can configure the installation to use an external PostgreSQL server that already exists in your deployment.
 
 .Procedure
 
-Complete one of the following steps:
-
-* If you do not need to use an external PostgreSQL server, create a secret with the database user named `result` and a random password in the `openshift-pipelines` namespace by entering the following command:
+. Create a secret with the credentials for connecting to your PostgreSQL server by entering the following command:
 +
 [source,terminal]
 ----
 $ oc create secret generic tekton-results-postgres \
   --namespace=openshift-pipelines \
-  --from-literal=POSTGRES_USER=result \
-  --from-literal=POSTGRES_PASSWORD=$(openssl rand -base64 20)
+  --from-literal=POSTGRES_USER=<user> \
+  --from-literal=POSTGRES_PASSWORD=<password>
 ----
-+
-[NOTE]
-====
-In this command and in subsequent commads, if you configured a custom target namespace for {pipelines-shortname}, use the name of this namespace instead of `openshift-pipelines`.
-====
 
-* If you want to use an external PostgreSQL database server to store {tekton-results} data, create a secret with the credentials for this server by entering the following command:
+. Edit the `TektonConfig` custom resource (CR) by using the following command:
 +
 [source,terminal]
 ----
-$ oc create secret generic tekton-results-postgres \
-  --namespace=openshift-pipelines \
-  --from-literal=POSTGRES_USER=<user> \ # <1>
-  --from-literal=POSTGRES_PASSWORD=<password> #<2>
+$ oc edit TektonConfig config
 ----
 +
-Replace `<user>` with the username for the PostgreSQL user that {tekton-results} must use. Replace `<password>` with the password for the same account.
+Make the following changes in the `result` spec:
++
+[source,yaml]
+----
+apiVersion: operator.tekton.dev/v1alpha1
+kind: TektonConfig
+metadata:
+  name: config
+spec:
+  result:
+    is_external_db: true
+    db_host: database.example.com # <1>
+    db_port: 5342 # <2>
+----
+<1> Provide the host name of your PostgreSQL server.
+<2> Provide the port number of your PostgreSQL server.