Skip to content

Latest commit

 

History

History
120 lines (93 loc) · 6.17 KB

README.md

File metadata and controls

120 lines (93 loc) · 6.17 KB
Raw

Open-Toolchain related tasks

Tasks

WARNING: These tasks needs to run on Kubernetes cluster with minimal version 1.16. If you are using your own Delivery Pipeline Private Worker to run your tekton pipeline(s), ensure your cluster is updated to this version at least.

Install the Tasks

  • Add a github integration to your toolchain with the repository containing the tasks (https://github.com/open-toolchain/tekton-catalog)
  • Add this github integration to the Definitions tab of your Continuous Delivery tekton pipeline, with the Path set to toolchain

Usages

  • The sample-build sub-directory contains an EventListener definition that you can include in your CD tekton pipeline configuration to run an example showing a simple usage of the toolchain-build.

  • The sample-dm sub-directory contains an EventListener definition that you can include in your CD tekton pipeline configuration to run an example showing a simple usage of the toolchain-publish-deployable-mapping.

toolchain-build

This task perform build operation on the given workspace. Default build operations managed are maven build for instance.

Parameters

  • custom-script: (optional) The script (commands) to run the build in run-build step. It will override the default commands. Default to ``.
  • run-build-image: (optional) The name of the image used for the run-build step. Default to icr.io/continuous-delivery/pipeline/pipeline-base-ubi:3.11
  • pipeline-debug: (optional) Pipeline debug mode. Value can be 0 or 1. Default to 0

Workspaces

  • output: A workspace containing the source to operate build command(s) on.

toolchain-extract-value

This task is for extracting values from the desired config map with a given jq expression. You have to provide a jq expression and the targeted config map's details.

Parameters

  • config-map-name: (Default: toolchain) The name of the ConfigMap
  • config-map-key: (Default: toolchain.json) The key of the ConfigMap
  • expression: A valid jq expression which is used to search
  • extract-value-jq-step-image: (Default: icr.io/continuous-delivery/pipeline/pipeline-base-ubi:3.11) image to use for the extract-value-jq step
  • pipeline-debug: (Default: "0") enable pipeline debug mode

Usage

The toolchain-extract-value task will save the desired value into a tekton task result. Check out the example below, where we pass the result of the extract-value task to the use-result-task task. In addition, you have to add the extracted-value param to the use-result-task task itself.

apiVersion: tekton.dev/v1beta1
kind: Pipeline
metadata:
  name: example-pipeline
spec:
  params:
    - name: expression
      description: A valid jq expression which is used to search
  tasks:
    - name: extract-value
      taskRef:
        name: toolchain-extract-value
      params:
        - name: expression
          value: $(params.expression)
    - name: use-result-task
      runAfter: [extract-value]
      taskRef:
        name: use-result-task
      params:
        - name: extracted-value
          value: "$(tasks.extract-value.results.extracted-value)"
apiVersion: tekton.dev/v1beta1
kind: Task
metadata:
  name: use-result-task
spec:
  params:
    - name: extracted-value
      description: The extracted value from the extract-value task
  steps:
- name: use-result-task
  command: ["/bin/bash", "-c"]
  args:
    - |
      echo "$(params.extracted-value)"

toolchain-publish-deployable-mapping

This task helps to create or update mappings between Toolchains & Deployables.

Context - ConfigMap/Secret

The task may rely on the following kubernetes resources to be defined:

  • Secret secure-properties

    Secret containing:

    • toolchain-apikey: An IBM Cloud Api Key used to access to the IBM Cloud Toolchain (secret name and secret key can be configured using Task's params).

Parameters

  • deployable-type: Type of the deployable. Can be either app (for a CF application) or kubernetes_cluster (for K8S deployment)
  • deployable-region-id: IBM Cloud Region where the deployable is located. A fully qualified id is expected (such as ibm:yp:us-south). If not fully qualified, the ibmcloud production prefix is appended (ie 'ibm:yp:')
  • deployable-guid: GUID of the deployable (either cluster guid or cf app guid)
  • deployable-cf-org-id: CF organization id (only required when deployable-type is app)
  • deployable-cf-space-id: CF space id (only required when deployable-type is app)
  • deployable-rg-id: Resource Group id (only required when deployable-type is kubernetes_cluster)
  • deployable-url: (optional) an URL that represent the deployable, e.g. the application's URL.
  • ibmcloud-api: (optional) the ibmcloud api. Default to https://cloud.ibm.com
  • continuous-delivery-context-secret: (optional) Name of the secret containing the continuous delivery pipeline context secrets. Default to secure-properties
  • toolchain-apikey-secret-key: (optional) field in the secret that contains the api key used to access toolchain and DOI instance. Default to toolchain-apikey
  • publish-deployable-mapping-step-image: (optional) image to use for the publish-deployable-mapping step. Default to icr.io/continuous-delivery/pipeline/pipeline-base-ubi:3.11
  • pipeline-debug: (optional) Pipeline debug mode. Value can be 0 or 1. Default to 0