Annotationen aufrufen

Sie können Annotationen über die Tasks in der YAML-Datei Ihrer Pipelinedefinition aufrufen. Das folgende Beispiel veranschaulicht das Aufrufen der Annotation devops.cloud.ibm.com/build-number. Um diese Anmerkung als Umgebungsvariable bereitzustellen, ersetzen Sie sie durch eine der Ausführungsanmerkungen aus Tabelle 1. Anmerkungen PipelineRun.

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

Einzelne Werte aufrufen

Sie können einzelne Schlüsselwerte innerhalb einer Task aufrufen. Der folgende Codeausschnitt verwendet den Beispieldatennamen property apikey name (mit sicheren Eigenschaften) und den Beispieldatennamen property environment name (mit Texteigenschaften). Diese Eigenschaftsnamen werden auf der Seite Eigenschaften der Bereitstellungspipeline festgelegt.

apiVersion: tekton.dev/v1beta1
kind: Task
metadata:
  name: cm-echo-props
spec:
  steps:
    - name: cm-show-props
      image: icr.io/continuous-delivery/pipeline/pipeline-base-image:2.69
      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

Alle Werte aufrufen

Sie können alle Schlüssel-Wert-Paare aus der ConfigMap und der Secret zu Ihrer Task Umgebung hinzufügen. Im folgenden Beispiel wird das ebenfalls als event-parameters``ConfigMap Volume eingebunden, um auf den Header und den Body des Trigger-Ereignisses zugreifen zu können. Da nur bei und scm generic Triggern vorhanden event-parameters ist, wird das Volumen als optional markiert, damit die Aufgabe bei durch oder manual ausgelösten timer Durchläufen nicht fehlschlägt.

apiVersion: tekton.dev/v1beta1
kind: Task
metadata:
  name: cm-secrets-props
spec:
  steps:
    - name: cm-show-full-env
      image: icr.io/continuous-delivery/pipeline/pipeline-base-image:2.69
      envFrom:
        - configMapRef:
            name: environment-properties
        - secretRef:
            name: secure-properties
      volumeMounts:
        - mountPath: /event-parameters
          name: event-parameters
      command: ["/bin/bash", "-c"]
      args:
        - echo -e "The environment for this Step is ";
          env;
          echo "";
          echo -e "Event header is >>";
          cat /event-parameters/eventHeader || echo "No event header available";
          echo "";
          echo -e "Event body is >>";
          cat /event-parameters/eventBody || echo "No event body available"
  volumes:
    - name: event-parameters
      configMap:
        name: event-parameters
        optional: true

Grundlegende Funktionen

Der Protokoll-Viewer unterstützt ANSI-Farbcodes und Textstile und erkennt automatisch URLs im Protokollinhalt und stellt sie als anklickbare Links dar, die sich in einem neuen Fenster öffnen.

Symbolleiste

Die im Protokoll-Viewer angezeigte Symbolleiste enthält eine Reihe zusätzlicher Funktionen, darunter:

• maximierung: Vergrößerung des für die Protokollanzeige verfügbaren Bereichs durch Ausblenden des Aufgabenplans und des Laufkopfs. So kann der Benutzer Ablenkungen durch andere Teile der App ausschalten und sich auf den Inhalt des Protokolls konzentrieren.
• benutzereinstellungen: Diese werden lokal im Browser gespeichert und auf alle Protokolle in der Anwendung angewendet. Weitere Details finden Sie in den folgenden Abschnitten.

Zeitmarken

IBM-verwaltete Worker und private Worker mit der Agentenversion 0.20.5 oder höher erzeugen standardmäßig Protokollzeilen mit vorangestelltem Zeitstempel. Der Benutzer kann diese Zeitstempel in der Protokollanzeige ein- oder ausblenden, indem er die Option im Einstellungsmenü in der Symbolleiste der Protokollanzeige umschaltet.

Die angezeigten Zeitstempel werden auf der Grundlage der Browsereinstellungen des Benutzers lokalisiert, wobei der vom Worker empfangene Rohwert des Zeitstempels als Tooltip beim Hovern angezeigt wird.

Protokollebenen

Der Protokoll-Viewer analysiert die Protokollzeilen, um die zugehörige Protokollstufe zu erkennen, und dekoriert sie entsprechend, um den Protokollverbrauch zu erleichtern. Das unterstützte Format lautet wie folgt.

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

• timestamp wird vom Arbeitnehmer bereitgestellt
• level ist einer von error, warning, notice, info, debug, trace
  • debug und trace Protokolle sind standardmäßig ausgeblendet
  • jede Protokollzeile ohne explizites level wird als info betrachtet, zeigt aber nicht den Loglevel-Badge an, um Redundanz in der Benutzeroberfläche zu vermeiden, wenn die Benutzer nicht das unterstützte Protokollformat verwenden
• message ist jeder andere Inhalt in der Zeile und kann ANSI-Codes für die Formatierung usw. enthalten.

Der folgende Ausschnitt würde zum Beispiel eine Protokollzeile auf der Ebene warning ausgeben:

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

Die angezeigten Protokollebenen können über das Einstellungsmenü in der Symbolleiste des Protokoll-Viewers geändert werden.

Log-Gruppen

Zusätzlich zu den Protokollebenen unterstützt der Protokoll-Viewer auch klappbare Gruppen innerhalb der Protokolle. Das unterstützte Format lautet wie folgt.

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

Der Befehl group markiert den Beginn der Gruppe. Der Inhalt von message wird als Titel/Zusammenfassung der Gruppe zusammen mit einem Indikator für den aktuellen Zustand der Gruppe (d.h. erweitert oder reduziert) angezeigt. Wenn Sie auf die Zusammenfassung klicken, wird der Status der Gruppe umgeschaltet.

Gruppen werden standardmäßig im zusammengeklappten Zustand dargestellt, es sei denn, der Schritt ist noch im Gange, wenn die Protokolle angezeigt werden. Der Benutzer kann die Gruppen nach Belieben erweitern oder reduzieren, und ihr Zustand wird beibehalten, bis der Benutzer zu einer anderen Ansicht navigiert.

Log-Gruppen können nicht mit Log-Levels in derselben Zeile gemischt werden, die Befehle group, endgroup und Log-Levels schließen sich gegenseitig aus. Die in einer Gruppe enthaltenen Protokolle können jedoch wie üblich die Protokollebenen verwenden.

Die Verschachtelung von Gruppen wird nicht unterstützt. Ein group-Befehl beendet implizit jede zuvor nicht beendete Gruppe.

Der folgende Ausschnitt würde zum Beispiel eine Protokollgruppe mit der Zusammenfassung "Additional config" ausgeben, die eine Reihe von Meldungen auf der Ebene info enthält:

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