retryable-pipeline

README

Retryable Tekton Pipeline

Simple wrapper custom resource of Tekton PipelineRun for retry from the failed task.

Description

RetryablePipelineRun is a Kubernetes CRD and controller which enables you to retry Tekton PipelineRun from the failed task. RetryablePipelineRun acts as a factory of PipelineRun: the first run and all other retry runs consist of Tekton PipelineRun and are generated by RetryablePipelineRun.

You can use RetryablePipelineRun resource instead of PipelineRun with the same spec definition.

apiVersion: tekton.hrk091.dev/v1alpha1
kind: RetryablePipelineRun
metadata:
  generateName: sample-
spec:
  params:
  - name: msg
    value: Hello Tekton!
  pipelineRef:
    name: sample

When one or more grandchild TaskRuns failed, and you want to retry the PipelineRun from the failed tasks, you can do that by adding retry-key annotation.

apiVersion: tekton.hrk091.dev/v1alpha1
kind: RetryablePipelineRun
metadata:
  generateName: sample-
  annotations:
    tekton.hrk091.dev:retry-key: foo
spec:
  params:
  - name: msg
    value: Hello Tekton!
  pipelineRef:
    name: sample

When retry TaskRun failed again, you can retry again that by changing retry-key from the current value.

Getting Started

You’ll need a Kubernetes cluster to run against. You can use KIND to get a local cluster for testing, or run against a remote cluster. Note: Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster kubectl cluster-info shows).

Install Tekton Pipelines into the cluster

RetryablePipelineRun depends on Tekton Pipeline CRDs and controller, first you need to install them following official installation guide.

Running on the cluster

1. Install Instances of Custom Resources:

kubectl apply -f config/samples/

1. Build and push your image to the location specified by IMG:

make docker-build docker-push IMG=<some-registry>/retryable-pipeline:tag

1. Deploy the controller to the cluster with the image specified by IMG:

make deploy IMG=<some-registry>/retryable-pipeline:tag

Uninstall CRDs

To delete the CRDs from the cluster:

make uninstall

Undeploy controller

UnDeploy the controller to the cluster:

make undeploy

Contributing

How it works

This project aims to follow the Kubernetes Operator pattern

It uses Controllers which provides a reconcile function responsible for synchronizing resources untile the desired state is reached on the cluster

Test It Out

1. Install the CRDs into the cluster:

make install

1. Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):

make run

NOTE: You can also run this in one step by running: make install run

Modifying the API definitions

If you are editing the API definitions, generate the manifests such as CRs or CRDs using:

make manifests

NOTE: Run make --help for more information on all potential make targets

More information can be found via the Kubebuilder Documentation

License

Copyright 2022 Hiroki Okui.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.