Custom pipelines

Custom pipelines can be used to modify the regular pipelines to release or deploy projects. They can have additional steps along with the existing deployment steps. Custom pipelines do not have any UI but can be edited within the OpenShift Web Console.

Prerequisites

  • Access to the OpenShift Admin Console

  • Clear understanding of Tekton pipelines, pipeline runs, tasks, task runs, also experience in writing pipelines/tasks using YAML

  • A backup of the pipeline resources (yaml files) mentioned below. Otherwise, the default configurations can not be restored!

Edit pipeline template

There are pipeline templates/tasks available for deploying Java and Node projects. Based on the project type choose a pipeline template/task and make the required changes:

Navigate to pipeline template/tasks in k5-project

  1. Login to the OpenShift Admin Console

  2. Choose the namespace where the Solution Hub is installed

  3. Navigate to Pipelines → Pipelines/Tasks

Pipeline template

  • k5-template-java → for projects in Java

  • k5-template-node → for projects in Node

Task template

  • k5-release-java → for projects in Java (release and deploy)

  • k5-release-node → for projects in Node (release and deploy)

  • k5-undeploy → for undeploying any project

Update and save the pipeline template/task as per requirements. Once after saving the changes, the new pipelines created will use the new custom pipelines.

Note: FSW will not validate Custom Pipelines/Tasks, it's the user's responsibility to take care of it. In case of task template, FSW maintains the same edited steps order. While creating new tasks, do not use additional parameters or resources apart from the default parameters/resources. Currently, those are not being supported. Also declare only those params/resources which are being used in the new task otherwise the pipeline may not work properly.

Migrating existing pipelines to new custom pipelines

Migration of existing pipelines to new custom pipelines is not possible at the moment. You need to create new pipelines and perhaps delete the old pipelines.

Disable custom pipelines

Apply the yaml files of your previously created backup. Pipelines with a custom configuration may not work anymore and perhaps have to be recreated.