logo
Alauda DevOps Pipelines Docs
logo
Alauda DevOps Pipelines Docs
Navigation

Overview

Introduction
Architecture
Feature Overview
Lifecycle Policy
Quick Start
Release Notes

Concepts

TektonConfig
TektonPipeline
Install
Upgrade

Configure

Adjusting Optional Configuration Items of Subcomponents
Configuring Resource Quotas for Pipeline Components
Pod Template Configuration Guide
Regular Cleanup of TaskRun and PipelineRun Resources

How To

Deploying tekton-pipelines in a global cluster through TektonConfig

Pipelines

Introduction
Architecture

Concepts

Tasks
TaskRuns
Pipelines
PipelineRuns
StepActions
Resolvers
Workspaces
Pod Templates
Quick Start
permissions

how_to

Adjust Dockerfile for Building Task-Compatible Custom Images

trouble_shooting

Failed to create pod due to config error when using custom images in Tekton

Triggers

Introduction
Architecture

Core Concepts

Core Concepts
EventListener
Trigger
Interceptor
TriggerBinding
TriggerTemplate
Quick Start

How To

Setup EventListener
Use GitLab Event Triggers
Create TriggerTemplate

Troubleshooting

The Pipeline is not automatically triggered
Permission Description

Hub

Introduction
Architecture

Core Concepts

Concepts
Understanding Tekton Hub
Permission Description

Configure

Tekton Hub Configuration
Adding Custom Catalogs

Tutorials

Creating a Custom Catalog
Writing Tasks for Tekton Hub
Writing Pipelines for Tekton Hub

Results

Introduction
Architecture

Concepts

Core Concepts
Tekton Results
Quick Start
permissions

Configure

Database Configuration

Supply Chain Security

Introduction
Architecture

Concepts

Core Concepts
Understanding Tekton Chains
Quick Start

API Reference

Introduction

Kubernetes APIs

Pipelines

Pipeline [tekton.dev/v1]
Task [tekton.dev/v1]
PipelineRun [tekton.dev/v1]
TaskRun [tekton.dev/v1]
ClusterTask [tekton.dev/v1]
Run [tekton.dev/v1]
CustomRun [tekton.dev/v1]
StepAction [tekton.dev/v1]
VerificationPolicy [tekton.dev/v1alpha1]
ResolutionRequest [resolution.tekton.dev/v1beta1]

Triggers

Trigger [triggers.tekton.dev/v1beta1]
TriggerTemplate [triggers.tekton.dev/v1beta1]
EventListener [triggers.tekton.dev/v1beta1]
TriggerBinding [triggers.tekton.dev/v1beta1]
Interceptor [triggers.tekton.dev/v1alpha1]
ClusterTriggerBinding [triggers.tekton.dev/v1beta1]
ClusterInterceptor [triggers.tekton.dev/v1alpha1]

Operator

TektonConfig [operator.tekton.dev/v1alpha1]
TektonInstallerSet [operator.tekton.dev/v1alpha1]
TektonPipeline [operator.tekton.dev/v1alpha1]
TektonTrigger [operator.tekton.dev/v1alpha1]
TektonChain [operator.tekton.dev/v1alpha1]
TektonHub [operator.tekton.dev/v1alpha1]
TektonResult [operator.tekton.dev/v1alpha1]
TektonInstallerSet [operator.tekton.dev/v1alpha1]
OpenShift Pipelines as Code [operator.tekton.dev/v1alpha1]

Advanced APIs

Results

Introduction to API Usage
Results List
Results Details
Result records List
Result logs List
📝 Edit this page on GitHub
Previous PageResult records List

#Result logs List

/v1alpha2/parents/{parent}/results/{result_uid}/logs#

Common Parameters#

  • parent (in path): string required

    Parent name refers to the namespace name or workspace name.

  • result_uid (in path): string required

    Result UID is the server assigned identifier of the result.

  • filter (in query): string

    This query can be used to pass CEL Expressions to filter the response. See more details here.

  • page_size (in query): integer

    Number of response to fetch in one request. This query can be used for pagination.

  • page_token (in query): string

    It can be used to fetch the next set of responses when the response is paginated. It corresponds to NextPageToken in the response.

  • order_by (in query): string

    This query can be used to order the response based on parameters. More details can be found here. Note: Add %20 instead of space when adding an optional direction qualifier, e.g created_by%20asc.

getList Logs given the Result UID#

Logs can be read across Results by specifying - as the result_uid or across parents by specifying - as the parent. (e.g., default/results/- or -/results/-). This can be used to read and filter matching Logs without knowing the exact Result name.

Response#

  • 200object: List of Records with nextPageToken.
    Properties:
    • records: []Record
    • nextPageToken: string

Record#

Record belonging to a Result. Typically will be Tekton TaskRun/PipelineRun, but may also include other execution information e.g alternative configs, DSLs, input payloads, post-execution actions etc.

  • id: string

    DEPRECATED: use uid instead.

  • uid: string

    Server assigned identifier of the Record.

  • etag: string

    The etag for this record. If this is provided on update, it must match the server's etag.

  • name: string

    Resource name, must be rooted in parent result

  • createdTime: string

    DEPRECATED: use createTime instead.

  • createTime: string

    Server assigned timestamp for when the record was created.

  • updatedTime: string

    DEPRECATED: use updateTime instead.

  • updateTime: string

    Server assigned timestamp for when the record was updated.

  • data: object

    Any represents lossely typed data to be stored within a Record.

Any#

Any represents lossely typed data to be stored within a Record.

  • value: string

    JSON encoded data.

  • type: string

    It is unique identifier if the data type stored in the value. This is used as a type to hint to determine how to unmarshal values. Limited to 128 characters. Currently RecordType can be one of the following:

    • PipelineRun Record: tekton.dev/v1beta1.PipelineRun(older records) or tekton.dev/v1.PipelineRun
    • TaskRun Record: tekton.dev/v1beta1.TaskRun(older records) or tekton.dev/v1.TaskRun
    • Log Record: results.tekton.dev/v1alpha2.Log(older records) or results.tekton.dev/v1alpha3.Log

RecordType#

It is unique identifier if the data type stored in the value. This is used as a type to hint to determine how to unmarshal values. Limited to 128 characters. Currently RecordType can be one of the following:

  • PipelineRun Record: tekton.dev/v1beta1.PipelineRun(older records) or tekton.dev/v1.PipelineRun
  • TaskRun Record: tekton.dev/v1beta1.TaskRun(older records) or tekton.dev/v1.TaskRun
  • Log Record: results.tekton.dev/v1alpha2.Log(older records) or results.tekton.dev/v1alpha3.Log