Chapter 1. Using Tekton Results for OpenShift Pipelines observability

Prerequisites

• The openssl command-line utility is installed.

• 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:

  $ oc create secret generic tekton-results-postgres \
    --namespace=openshift-pipelines \
    --from-literal=POSTGRES_USER=result \
    --from-literal=POSTGRES_PASSWORD=$(openssl rand -base64 20)

  Note

  In this command and in subsequent commads, if you configured a custom target namespace for OpenShift Pipelines, 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:

  $ oc create secret generic tekton-results-postgres \
    --namespace=openshift-pipelines \
    --from-literal=POSTGRES_USER=<user> \ 1
    --from-literal=POSTGRES_PASSWORD=<password> 2

  Replace <user> with the username for the PostgreSQL user that Tekton Results must use. Replace <password> with the password for the same account.

• Persistent volume claim (PVC) on your Red Hat OpenShift Pipelines cluster
• Google Cloud Storage
• S3 bucket storage

• To use a PVC, complete the following steps:

  1. Create a file named pvc.yaml with the following definition for the PVC:

       apiVersion: v1
       kind: PersistentVolumeClaim
       metadata:
         name: tekton-logs
       spec:
         accessModes:
         - ReadWriteOnce
         resources:
           requests:
             storage: 1Gi

  2. Apply the definition by entering the following command:

     $ oc apply -n openshift-pipelines -f pvc.yaml

• To use Google Cloud Storage, complete the following steps:

  1. Create an application credentials file by using the gcloud command. For instructions about providing application credentials in a file, see User credentials provided by using the gcloud CLI in the Google Cloud documentation.

  2. Create a secret from the application credentials file by entering the following command:

     $ oc create secret generic gcs-credentials \
       --from-file=$HOME/.config/gcloud/application_default_credentials.json \
       -n openshift-pipelines

     Adjust the path and filename of the application credentials file as necessary.

• To use S3 bucket storage, complete the following steps:

  1. Create a file named s3_secret.yaml with the following content:

       apiVersion: v1
       kind: Secret
       metadata:
         name: my_custom_secret
         namespace: tekton-pipelines
       type: Opaque
       stringData:
         S3_BUCKET_NAME: bucket1 1
         S3_ENDPOINT: https://example.localhost.com 2
         S3_HOSTNAME_IMMUTABLE: "false"
         S3_REGION: region-1 3
         S3_ACCESS_KEY_ID: "1234" 4
         S3_SECRET_ACCESS_KEY: secret_key 5
         S3_MULTI_PART_SIZE: "5242880"

     1 1

     The name of the S3 storage bucket

     2 2

     The S3 API endpoint URL

     3

     The S3 region

     4

     The S3 access key ID

     5

     The S3 secret access key

  2. Create a secret from the file by entering the following command:

     $ oc create secret generic s3-credentials \
       --from-file=s3_secret.yaml -n openshift-pipelines

• To configure LokiStack forwarding, complete the following steps:

  1. On your OpenShift Container Platform cluster, install LokiStack by using the Loki Operator and also install the OpenShift Logging Operator.

  2. 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

     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

     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 ]

  3. To create the ClusterLogForwarder CR in the openshift-logging namespace, log into your OpenShift Container Platform cluster with the OpenShift CLI (oc) as a cluster administrator user, and then enter the following command:

     $ oc apply -n openshift-logging ClusterLogForwarder.yaml

Prerequisites

• You installed Tekton Results.
• You installed the opc utility.

Prerequisites

• You installed Tekton Results.
• You installed the opc utility and prepared its environment to query Tekton Results.
• You installed the jq package.

Prerequisites

• You installed Tekton Results.
• You installed the opc utility and prepared its environment to query Tekton Results.

Procedure

• Search for results using a CEL query by entering the following command:

  $ opc results list --addr ${RESULTS_API} --filter="<cel_query>" <namespace-name>

Prerequisites

• You installed Tekton Results.
• You installed the opc utility and prepared its environment to query Tekton Results.

Procedure

• Search for records using a CEL query by entering the following command:

  $ opc results records list --addr ${RESULTS_API} --filter="<cel_query>" <namespace_name>/result/-

  Replace <namespace_name> with the namespace in which the pipeline runs or task runs were created. Alternatively, search for records within a single result by entering the following command:

  $ opc results records list --addr ${RESULTS_API} --filter="<cel_query>" <result_name>

  Replace <result_name> with the full name of the result.

• UNKNOWN
• SUCCESS
• FAILURE
• TIMEOUT
• CANCELLED