Merge pull request #82943 from mramendi/RHDEVDOCS-6195

RHDEVDOCS 6195 configure LokiStack log forwarding when installing Results

Author: adellape

modules/op-installing-results.adoc

@@ -42,7 +42,7 @@ To install {tekton-results}, you must provide the required resources and then cr
     prometheus_port: 9090
 ----
 
-. Add configuration for the storage for logging information to this file:
+. Add storage or forwarding configuration for logging information to this file:
 ** If you configured a persistent volume claim (PVC), add the following line to provide the name of the PVC:
 +
 [source,yaml]
@@ -65,6 +65,15 @@ To install {tekton-results}, you must provide the required resources and then cr
 ----
     secret_name: s3-credentials
 ----
+** If you configured LokiStack forwarding, add the following lines to enable forwarding logging information to LokiStack:
++
+[source,yaml]
+----
+    loki_stack_name: logging-loki # <1>
+    loki_stack_namespace: openshift-logging # <2>
+----
+<1> The name of the `LokiStack` CR, typically `logging-loki`.
+<2> The name of the namespace where LokiStack is deployed, typically `openshift-logging`.
 
 . Optional: If you want to use an external PostgreSQL database server to store {tekton-results} information, add the following lines to the file:
 +

modules/op-results-storage.adoc

@@ -4,14 +4,23 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="results-storage_{context}"]
-= Preparing storage for logging information
+= Preparing storage or LokiStack forwarding for logging information
 
 {tekton-results} uses separate storage for logging information related to pipeline runs and task runs. You can configure any one of the following types of storage:
 
 * Persistent volume claim (PVC) on your {product-title} cluster
 * Google Cloud Storage
 * S3 bucket storage
 
+Alternatively, you can install LokiStack and OpenShift Logging on your {OCP} cluster and configure forwarding of the logging information to LokiStack. This option provides better scalability for higher loads.
+
+[NOTE]
+====
+In OpenShift Pipelines 1.16, the {tekton-results} ability to natively store logging information on a PVC, in Google Cloud Storage, and in S3 bucket storage is deprecated and is planned to be removed in a future release.
+====
+
+Logging information is available using the {tekton-results} command-line interface and API, irrespective of the type of logging information storage or LokiStack forwarding that you configure.
+
 .Procedure
 
 Complete one of the following procedures:
@@ -85,3 +94,85 @@ Adjust the path and filename of the application credentials file as necessary.
 $ oc create secret generic s3-credentials \
   --from-file=s3_secret.yaml -n openshift-pipelines
 ----
+
+. To configure LokiStack forwarding, complete the following steps:
+
+.. On your {OCP} cluster, install LokiStack by using the Loki Operator and also install the OpenShift Logging Operator.
+
+.. Create a `ClusterLogForwarder.yaml` manifest file for the `ClusterLogForwarder` custom resource (CR) with one of the following YAML manifests, dependings on whether you installed OpenShift Logging version 6 or version 5:
++
+.YAML manifest for the `ClusterLogForwarder` CR if you installed OpenShift Logging version 6
+[source,yaml]
+----
+apiVersion: observability.openshift.io/v1
+kind: ClusterLogForwarder
+metadata:
+  name: collector
+  namespace: openshift-logging
+spec:
+  inputs:
+  - application:
+      selector:
+        matchLabels:
+          app.kubernetes.io/managed-by: tekton-pipelines
+    name: only-tekton
+    type: application
+  managementState: Managed
+  outputs:
+  - lokiStack:
+      labelKeys:
+        application:
+          ignoreGlobal: true
+          labelKeys:
+          - log_type
+          - kubernetes.namespace_name
+          - openshift_cluster_id
+      authentication:
+        token:
+          from: serviceAccount
+      target:
+        name: logging-loki
+        namespace: openshift-logging
+    name: default-lokistack
+    tls:
+      ca:
+        configMapName: openshift-service-ca.crt
+        key: service-ca.crt
+    type: lokiStack
+  pipelines:
+  - inputRefs:
+    - only-tekton
+    name: default-logstore
+    outputRefs:
+    - default-lokistack
+  serviceAccount:
+    name: collector
+----
++
+.YAML manifest for the `ClusterLogForwarder` CR if you installed OpenShift Logging version 5
+[source,yaml]
+----
+apiVersion: "logging.openshift.io/v1"
+kind: ClusterLogForwarder
+metadata:
+  name: instance
+  namespace: openshift-logging
+spec:
+  inputs:
+  - name: only-tekton
+    application:
+      selector:
+        matchLabels:
+          app.kubernetes.io/managed-by: tekton-pipelines
+  pipelines:
+    - name: enable-default-log-store
+      inputRefs: [ only-tekton ]
+      outputRefs: [ default ]
+----
+
+.. To create the `ClusterLogForwarder` CR in the `openshift-logging` namespace, log into your {OCP} cluster with the {oc-first} as a cluster administrator user, and then enter the following command:
++
+[source, terminal]
+----
+$ oc apply -n openshift-logging ClusterLogForwarder.yaml
+----