-
Bug
-
Resolution: Unresolved
-
Undefined
-
Pipelines 1.19
-
None
-
Pipelines 1.21 - 2, Pipelines 1.21 - 3
-
1
-
---
-
---
The release notes for Openshift Pipelines 1.19 include Tekton Results' new integration with Splunk, but the instructions for configuring are incomplete, and there is no additional documentation for this feature in the the general Pipelines documentation.
- The relevant environment variables are listed but malformed. Instead of being rendered as unicode SPLUNK_SEARCH_TOKEN they're incorrectly written as regular text with incorrect escaping: "SPLUNK_SEARCH_TOKEN"
- There is no mention of what values are required for the configured variables (the required values were mentioned at but not specified in the release notes supplied from the dev team)
- SPLUNK_SEARCH_TOKEN: (not described)
- LOGGING_PLUGIN_QUERY_PARAMS: "including index details such as index=konflux"
- LOGGING_PLUGIN_API_URL: "with the Splunk endpoint and port number"
- The "Example for retrieving forwarded logs by Openshift Logging" does *not include any of the required values* in the env field:
.Example for retrieving forwarded logs by OpenShift Logging [source,yaml] ---- apiVersion: operator.tekton.dev/v1alpha1 kind: TektonConfig metadata: name: config options: deployments: tekton-results-api: spec: template: spec: containers: - name: api env: ----
The example should be something closer to:
.Example for retrieving forwarded logs by OpenShift Logging [source,yaml] ---- apiVersion: operator.tekton.dev/v1alpha1 kind: TektonConfig metadata: name: config spec: # <-------- added options: deployments: tekton-results-api: spec: template: spec: containers: - name: api env: # <---------------------------- added missing items - name: SPLUNK_SEARCH_TOKEN value: <some value> - name: LOGGING_PLUGIN_QUERY_PARAMS value: <some value> - name: LOGGING_PLUGIN_API_URL value: <some value> ----
- The OSP 1.19 Configuration docs do not document configuring Tekton Results, pointing instead to Observability/Using Tekton Results for OSP observability. However the Configuring Tekton Results section has no mention of Splunk logging and in fact incorrectly states "If you want to use Tekton Results to query logging information for task runs, you must install LokiStack and OpenShift Logging on your OpenShift Container Platform cluster and configure forwarding of the logging information to LokiStack. "