Tekton pipelines environment properties and resources

Accessing annotations

You can access annotations from the tasks within your pipeline definition YAML file. The following example shows how to access the devops.cloud.ibm.com/build-number annotation. To provide that annotation as an environment variable, replace it with one of the run annotations from Table 1. PipelineRun annotations.

apiVersion: tekton.dev/v1beta1
kind: Task
metadata:
  name: simple-task
spec:
  steps:
    - name: simple-step
      image: ubuntu
      env:
        - name: BUILD_NUMBER
          valueFrom:
            fieldRef:
              fieldPath: metadata.annotations['devops.cloud.ibm.com/build-number']
      command: ["bash", "-c"]
      args:
        - echo $BUILD_NUMBER;
          echo "COMPLETED"

Accessing individual values

You can access individual key-values within a Task. The following code snippet uses the sample apikey property name (with secure properties) and the environment property name (with text properties). These property names are set in the delivery pipeline Properties page.

apiVersion: tekton.dev/v1beta1
kind: Task
metadata:
  name: cm-echo-props
spec:
  steps:
    - name: cm-show-props
      image: ubuntu
      env:
        - name: SECURE_VALUE
          valueFrom:
            secretKeyRef:
              name: secure-properties
              key: apikey
        - name: ENVIRONMENT
          valueFrom:
            configMapKeyRef:
              name: environment-properties
              key: environment
      command: ["/bin/bash", "-c"]
      args:
        - echo -e "environment from ConfigMap is >>";
          echo $ENVIRONMENT;
          echo "";
          echo -e "apikey from Secrets is >>";
          echo $SECURE_VALUE

Accessing all values

You can add all of the key-value pairs from the ConfigMap and Secret to your Task environment:

apiVersion: tekton.dev/v1beta1
kind: Task
metadata:
  name: cm-secrets-props
spec:
  steps:
    - name: cm-show-full-env
      image: ubuntu
      envFrom:
        - configMapRef:
            name: environment-properties
        - secretRef:
            name: secure-properties
      command: ["/bin/bash", "-c"]
      args:
        - echo -e "The environment for this Step is ";
          env

Basic functionality

The log viewer supports ANSI colour codes and text styles, and will automatically detect URLs in log content and render them as clickable links opening in a new window.

Toolbar

The toolbar displayed in the log viewer includes a number of additional features, including:

• maximize: increase the area available to the log viewer by hiding the task list and run header. This allows the user to eliminate distractions from other parts of the app and focus on the log content.
• user preferences: these are persisted locally in the browser and applied to all logs in the app. See the following sections for more details.

Timestamps

IBM-managed workers, and private workers with agent version 0.20.5 or later, produce log lines prefixed with timestamps by default. The user may show or hide these timestamps in the log viewer by toggling the option in the settings menu in the toolbar at the top of the log viewer.

The displayed timestamps are localised based on the user's browser settings, with the raw timestamp value received from the worker provided as a tooltip on hover.

Log levels

The log viewer parses log lines to detect the associated log level and decorate them accordingly to help with log consumability. The format supported is described below.

<timestamp> ::<level>::<message>

• timestamp is provided by the worker
• level is one of error, warning, notice, info, debug
  • debug logs are hidden by default
  • any log line without an explicit level is considered as info, but will not display the log level badge to avoid redundancy in the UI where users are not using the supported log format
• message is any other content on the line, and may contain ANSI codes for formatting, etc.

For example, the following snippet would output a log line at the warning level:

echo '::warning::Something that may require attention but is non-blocking…'

The displayed log levels can be changed via the settings menu in the toolbar at the top of the log viewer.

Log groups

In addition to log levels, the log viewer also supports collapsible groups within the logs. The supported format is described below.

<timestamp> ::group::<message>
…
<timestamp> ::endgroup::

A group command marks the beginning of the group. The content of message is displayed as the title / summary of the group along with an indicator of the group's current state (i.e. expanded or collapsed). Clicking the summary will toggle the state of the group.

Groups are rendered in the collapsed state by default unless the step is still in progress when the logs are viewed. The user can expand or collapse groups as desired and their state will be maintained until the user navigates to a different view.

Log groups cannot be mixed with log levels on the same line, the group, endgroup, and log level commands are mutually exclusive. However, logs contained within a group can use log levels as normal.

Nesting groups is not supported. A group command will implicitly terminate any prior unterminated group.

For example, the following snippet would output a log group with the summary 'Additional config' containing a number of messages at the info level:

echo '::group::Additional config'
echo 'This extends the base config'
echo '::info:: More info about the config…'
echo '::endgroup::'