Skip to content

Latest commit

 

History

History
120 lines (91 loc) · 4.41 KB

README.md

File metadata and controls

120 lines (91 loc) · 4.41 KB
Raw

Tekton Operator

Tekton Operator is a Kubernetes extension that to install, upgrade and manage TektonCD Pipelines, Dashboard, Triggers (and other components) on any Kubernetes Cluster.

Tekton Operator entities

Tekton Operator defines the following entities:

Entity Description
TektonConfig Configure Tekton components to be installed and managed.
TektonPipeline Configure the Tekton Pipeline component to be installed and managed.
TektonTrigger Configure the Tekton Trigger component to be installed and managed.
TektonDashboard Configure the Tekton Dashboard component to be installed and managed.
TektonResult Configure the Tekton Result component to be installed and managed.
TektonChain Configure the Tekton Chain component to be installed and managed.
OpenShiftPipelinesAsCode Configure the Pipelines as Code component to be installed and managed.
TektonAddon Configure addons to be installed and managed.

Getting started

To install Operator there are multiple ways

  • Install from Operator Hub

    You can find the instruction here. The lifecycle will be managed by Operator Lifecycle Manager (OLM).

  • Install using release file

    You can find the release file for latest version here. In this case, you will have to manage the lifecycle for the Operator.

  • Install from code

    You can clone and repository and install the Operator. You can find the instruction in here

After installing the Operator, to install the required Tekton Component such as Tekton Pipeline, Tekton Triggers.

Create an instance of TektonConfig which will create the required components. You can find more details and the available configuration in TektonConfig.

NOTE: TektonResult and TektonChain are optional components and are not installed through TektonConfig currently. You can find the installation steps in their docs.

Understanding Tekton Operator

Each Tekton Component has a Custom Resource which installs the component and manages it.

TektonConfig is a top level Custom Resource which creates other components.

So, the user just need to create TektonConfig with the required configurations, and it will handle the installation of required components.

You can find more about the Resources and its available configurations in their docs

To understand how Tekton Operator works, you can find the details here

Tektoncd Operator Releases

Tektoncd Releases

Contributing to Tekton Operator

If you'd like to contribute to the Tekton Operator project, see the Tekton Operator Contributor's Guide.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License.