Pipelines

Procedure

1. In the Administrator perspective of the web console, navigate to Operators → OperatorHub.

2. Use the Filter by keyword box to search for Red Hat OpenShift Pipelines Operator in the catalog. Click the OpenShift Pipelines Operator tile.

   Note

   Ensure that you do not select the Community version of the OpenShift Pipelines Operator.

3. Read the brief description about the Operator on the Red Hat OpenShift Pipelines Operator page. Click Install.

4. On the Install Operator page:

   1. Select All namespaces on the cluster (default) for the Installation Mode. This mode installs the Operator in the default openshift-operators namespace, which enables the Operator to watch and be made available to all namespaces in the cluster.
   2. Select Automatic for the Approval Strategy. This ensures that the future upgrades to the Operator are handled automatically by the Operator Lifecycle Manager (OLM). If you select the Manual approval strategy, OLM creates an update request. As a cluster administrator, you must then manually approve the OLM update request to update the Operator to the new version.

   3. Select an Update Channel.

      • The ocp-<4.x> channel enables installation of the latest stable release of the Red Hat OpenShift Pipelines Operator.
      • The preview channel enables installation of the latest preview version of the Red Hat OpenShift Pipelines Operator, which may contain features that are not yet available from the 4.x update channel.

5. Click Install. You will see the Operator listed on the Installed Operators page.

   Note

   The Operator is installed automatically into the openshift-operators namespace.

6. Verify that the Status is set to Succeeded Up to date to confirm successful installation of Red Hat OpenShift Pipelines Operator.

Procedure

1. Create a Subscription object YAML file to subscribe a namespace to the Red Hat OpenShift Pipelines Operator, for example, sub.yaml:

   Example Subscription

   apiVersion: operators.coreos.com/v1alpha1
   kind: Subscription
   metadata:
     name: openshift-pipelines-operator
     namespace: openshift-operators
   spec:
     channel:  <channel name> 1
     name: openshift-pipelines-operator-rh 2
     source: redhat-operators 3
     sourceNamespace: openshift-marketplace 4

   1

   Specify the channel name from where you want to subscribe the Operator

   2

   Name of the Operator to subscribe to.

   3

   Name of the CatalogSource that provides the Operator.

   4

   Namespace of the CatalogSource. Use openshift-marketplace for the default OperatorHub CatalogSources.

2. Create the Subscription object:

   $ oc apply -f sub.yaml

   The Red Hat OpenShift Pipelines Operator is now installed in the default target namespace openshift-operators.

Procedure

1. In the Administrator perspective of the web console, navigate to Administration → Custom Resource Definition.
2. Type config.operator.tekton.dev in the Filter by name box to search for the Red Hat OpenShift Pipelines Operator CRs.
3. Click CRD Config to see the Custom Resource Definition Details page.

4. Click the Actions drop-down menu and select Delete Custom Resource Definition.

   Note

   Deleting the CRs will delete the Red Hat OpenShift Pipelines components, and all the Tasks and Pipelines on the cluster will be lost.

5. Click Delete to confirm the deletion of the CRs.

Procedure

1. From the Operators → OperatorHub page, use the Filter by keyword box to search for Red Hat OpenShift Pipelines Operator.
2. Click the OpenShift Pipelines Operator tile. The Operator tile indicates it is installed.
3. In the OpenShift Pipelines Operator descriptor page, click Uninstall.

Procedure

1. Log in to your OpenShift Container Platform cluster:

   $ oc login -u <login> -p <password> https://openshift.example.com:6443

2. Create a project for the sample application. For this example workflow, create the pipelines-tutorial project:

   $ oc new-project pipelines-tutorial

   Note

   If you create a project with a different name, be sure to update the resource URLs used in the example with your project name.

3. View the pipeline ServiceAccount:

   Red Hat OpenShift Pipelines Operator adds and configures a ServiceAccount named pipeline that has sufficient permissions to build and push an image. This ServiceAccount is used by PipelineRun.

   $ oc get serviceaccount pipeline

Procedure

1. Install the apply-manifests and update-deployment Task resources from the pipelines-tutorial repository, which contains a list of reusable tasks for pipelines:

   $ oc create -f https://raw.githubusercontent.com/openshift/pipelines-tutorial/release-tech-preview-3/01_pipeline/01_apply_manifest_task.yaml
   $ oc create -f https://raw.githubusercontent.com/openshift/pipelines-tutorial/release-tech-preview-3/01_pipeline/02_update_deployment_task.yaml

2. Use the tkn task list command to list the tasks you created:

   $ tkn task list

   The output verifies that the apply-manifests and update-deployment Task resources were created:

   NAME                DESCRIPTION   AGE
   apply-manifests                   1 minute ago
   update-deployment                 48 seconds ago

3. Use the tkn clustertasks list command to list the Operator-installed additional ClusterTask resources, for example --buildah and s2i-python-3:

   Note

   You must use a privileged pod container to run the buildah ClusterTask resource because it requires a privileged security context. To learn more about security context constraints (SCC) for pods, see the Additional resources section.

   $ tkn clustertasks list

   The output lists the Operator-installed ClusterTask resources:

   NAME                       DESCRIPTION   AGE
   buildah                                  1 day ago
   git-clone                                1 day ago
   s2i-php                                  1 day ago
   tkn                                      1 day ago

Procedure

1. Copy the contents of the following sample Pipeline YAML file and save it:

   apiVersion: tekton.dev/v1beta1
   kind: Pipeline
   metadata:
     name: build-and-deploy
   spec:
     workspaces:
     - name: shared-workspace
     params:
     - name: deployment-name
       type: string
       description: name of the deployment to be patched
     - name: git-url
       type: string
       description: url of the git repo for the code of deployment
     - name: git-revision
       type: string
       description: revision to be used from repo of the code for deployment
       default: "release-tech-preview-3"
     - name: IMAGE
       type: string
       description: image to be built from the code
     tasks:
     - name: fetch-repository
       taskRef:
         name: git-clone
         kind: ClusterTask
       workspaces:
       - name: output
         workspace: shared-workspace
       params:
       - name: url
         value: $(params.git-url)
       - name: subdirectory
         value: ""
       - name: deleteExisting
         value: "true"
       - name: revision
         value: $(params.git-revision)
     - name: build-image
       taskRef:
         name: buildah
         kind: ClusterTask
       params:
       - name: TLSVERIFY
         value: "false"
       - name: IMAGE
         value: $(params.IMAGE)
       workspaces:
       - name: source
         workspace: shared-workspace
       runAfter:
       - fetch-repository
     - name: apply-manifests
       taskRef:
         name: apply-manifests
       workspaces:
       - name: source
         workspace: shared-workspace
       runAfter:
       - build-image
     - name: update-deployment
       taskRef:
         name: update-deployment
       workspaces:
       - name: source
         workspace: shared-workspace
       params:
       - name: deployment
         value: $(params.deployment-name)
       - name: IMAGE
         value: $(params.IMAGE)
       runAfter:
       - apply-manifests

   The Pipeline definition abstracts away the specifics of the Git source repository and image registries. These details are added as params when a Pipeline is triggered and executed.

2. Create the Pipeline:

   $ oc create -f <pipeline-yaml-file-name.yaml>

   Alternatively, you can also execute the YAML file directly from the Git repository:

   $ oc create -f https://raw.githubusercontent.com/openshift/pipelines-tutorial/release-tech-preview-3/01_pipeline/04_pipeline.yaml

3. Use the tkn pipeline list command to verify that the Pipeline is added to the application:

   $ tkn pipeline list

   The output verifies that the build-and-deploy Pipeline was created:

   NAME               AGE            LAST RUN   STARTED   DURATION   STATUS
   build-and-deploy   1 minute ago   ---        ---       ---        ---

Procedure

1. Start the pipeline for the back-end application:

   $ tkn pipeline start build-and-deploy \
       -w name=shared-workspace,volumeClaimTemplateFile=https://raw.githubusercontent.com/openshift/pipelines-tutorial/release-tech-preview-3/01_pipeline/03_persistent_volume_claim.yaml \
       -p deployment-name=vote-api \
       -p git-url=http://github.com/openshift-pipelines/vote-api.git \
       -p IMAGE=image-registry.openshift-image-registry.svc:5000/pipelines-tutorial/vote-api \

   The previous command uses a volume claim template, which creates a persistent volume claim for the pipeline execution.

2. To track the progress of the pipeline run, enter the following command::

   $ tkn pipelinerun logs <pipelinerun_id> -f

   The <pipelinerun_id> in the above command is the ID for the PipelineRun that was returned in the output of the previous command.

3. Start the Pipeline for the front-end application:

   $ tkn pipeline start build-and-deploy \
       -w name=shared-workspace,volumeClaimTemplateFile=https://raw.githubusercontent.com/openshift/pipelines-tutorial/release-tech-preview-3/01_pipeline/03_persistent_volume_claim.yaml \
       -p deployment-name=vote-ui \
       -p git-url=http://github.com/openshift-pipelines/vote-ui.git \
       -p IMAGE=image-registry.openshift-image-registry.svc:5000/pipelines-tutorial/vote-ui \

4. To track the progress of the pipeline run, enter the following command:

   $ tkn pipelinerun logs <pipelinerun_id> -f

   The <pipelinerun_id> in the above command is the ID for the PipelineRun that was returned in the output of the previous command.

5. After a few minutes, use tkn pipelinerun list command to verify that the Pipeline ran successfully by listing all the PipelineRuns:

   $ tkn pipelinerun list

   The output lists the PipelineRuns:

    NAME                         STARTED      DURATION     STATUS
    build-and-deploy-run-xy7rw   1 hour ago   2 minutes    Succeeded
    build-and-deploy-run-z2rz8   1 hour ago   19 minutes   Succeeded

6. Get the application route:

   $ oc get route vote-ui --template='http://{{.spec.host}}'

   Note the output of the previous command. You can access the application using this route.

7. To rerun the last pipeline run, using the pipeline resources and service account of the previous pipeline, run:

   $ tkn pipeline start build-and-deploy --last

Procedure

1. Copy the content of the following sample TriggerBinding YAML file and save it:

   apiVersion: triggers.tekton.dev/v1alpha1
   kind: TriggerBinding
   metadata:
     name: vote-app
   spec:
     params:
     - name: git-repo-url
       value: $(body.repository.url)
     - name: git-repo-name
       value: $(body.repository.name)
     - name: git-revision
       value: $(body.head_commit.id)

2. Create the TriggerBinding resource:

   $ oc create -f <triggerbinding-yaml-file-name.yaml>

   Alternatively, you can create the TriggerBinding resource directly from the pipelines-tutorial Git repository:

   $ oc create -f https://raw.githubusercontent.com/openshift/pipelines-tutorial/release-tech-preview-3/03_triggers/01_binding.yaml

3. Copy the content of the following sample TriggerTemplate YAML file and save it:

   apiVersion: triggers.tekton.dev/v1alpha1
   kind: TriggerTemplate
   metadata:
     name: vote-app
   spec:
     params:
     - name: git-repo-url
       description: The git repository url
     - name: git-revision
       description: The git revision
       default: release-tech-preview-3
     - name: git-repo-name
       description: The name of the deployment to be created / patched
   
     resourcetemplates:
     - apiVersion: tekton.dev/v1beta1
       kind: PipelineRun
       metadata:
         name: build-deploy-$(tt.params.git-repo-name)-$(uid)
       spec:
         serviceAccountName: pipeline
         pipelineRef:
           name: build-and-deploy
         params:
         - name: deployment-name
           value: $(tt.params.git-repo-name)
         - name: git-url
           value: $(tt.params.git-repo-url)
         - name: git-revision
           value: $(tt.params.git-revision)
         - name: IMAGE
           value: image-registry.openshift-image-registry.svc:5000/pipelines-tutorial/$(tt.params.git-repo-name)
         workspaces:
         - name: shared-workspace
           volumeClaimTemplate:
             spec:
               accessModes:
                 - ReadWriteOnce
               resources:
                 requests:
                   storage: 500Mi

   The template specifies a volume claim template to create a persistent volume claim for defining the storage volume for the workspace. Therefore, you do not need to create a persistent volume claim to provide data storage.

4. Create the TriggerTemplate resource:

   $ oc create -f <triggertemplate-yaml-file-name.yaml>

   Alternatively, you can create the TriggerTemplate resource directly from the pipelines-tutorial Git repository:

   $ oc create -f https://raw.githubusercontent.com/openshift/pipelines-tutorial/release-tech-preview-3/03_triggers/02_template.yaml

5. Copy the contents of the following sample Trigger YAML file and save it:

   apiVersion: triggers.tekton.dev/v1alpha1
   kind: Trigger
   metadata:
     name: vote-trigger
   spec:
     serviceAccountName: pipeline
     bindings:
       - ref: vote-app
     template:
        name: vote-app

6. Create the Trigger resource:

   $ oc create -f <trigger-yaml-file-name.yaml>

   Alternatively, you can create the Trigger resource directly from the pipelines-tutorial Git repository:

   $ oc create -f https://github.com/openshift/pipelines-tutorial/blob/release-tech-preview-3/03_triggers/03_trigger.yaml

7. Copy the contents of the following sample EventListener YAML file and save it:

   apiVersion: triggers.tekton.dev/v1alpha1
   kind: EventListener
   metadata:
     name: vote-app
   spec:
     serviceAccountName: pipeline
     triggers:
       - triggerRef: vote-trigger

   Alternatively, if you have not defined a trigger custom resource, add the binding and template spec to the EventListener YAML file, instead of referring to the name of the trigger:

   apiVersion: triggers.tekton.dev/v1alpha1
   kind: EventListener
   metadata:
     name: vote-app
   spec:
     serviceAccountName: pipeline
     triggers:
     - bindings:
       - ref: vote-app
       template:
         name: vote-app

8. Create the EventListener resource:

   $ oc create -f <eventlistener-yaml-file-name.yaml>

   Alternatively, you can create the EvenListener resource directly from the pipelines-tutorial Git repository:

   $ oc create -f https://raw.githubusercontent.com/openshift/pipelines-tutorial/release-tech-preview-3/03_triggers/04_event_listener.yaml

9. Expose the EventListener service as an OpenShift Container Platform route to make it publicly accessible:

   $ oc expose svc el-vote-app

Procedure

1. Get the Webhook URL:

   $ echo "URL: $(oc  get route el-vote-app --template='http://{{.spec.host}}')"

   Note the URL obtained in the output.

2. Configure Webhooks manually on the front-end repository:

   1. Open the front-end Git repository vote-ui in your browser.
   2. Click Settings → Webhooks → Add Webhook

   3. On the Webhooks/Add Webhook page:

      1. Enter the Webhook URL from step 1 in Payload URL field
      2. Select application/json for the Content type
      3. Specify the secret in the Secret field
      4. Ensure that the Just the push event is selected
      5. Select Active
      6. Click Add Webhook
3. Repeat step 2 for the back-end repository vote-api.

Procedure

1. From the terminal, clone your forked Git repository vote-ui:

   $ git clone git@github.com:<your GitHub ID>/vote-ui.git -b release-tech-preview-3

2. Push an empty commit:

   $ git commit -m "empty-commit" --allow-empty && git push origin release-tech-preview-3

3. Check if the pipeline run was triggered:

   $ tkn pipelinerun list

   Notice that a new pipeline run was initiated.

Procedure

1. In the Add view of the Developer perspective, click the Pipeline tile to see the Pipeline Builder page.
2. Enter a unique name for the Pipeline.

3. Select a Task from the Select task list to add a Task to the Pipeline. This example uses the s2i-nodejs Task.

   1. To add sequential Tasks to the Pipeline, click the plus icon to the right or left of the Task, and from the Select task list, select the Task you want to add to the Pipeline. For this example, use the plus icon to the right of the s2i-nodejs Task to add an openshift-client Task.

   2. To add a parallel Task to the existing Task, click the plus icon displayed below the Task, and from the Select Task list, select the parallel Task you want to add to the Pipeline.

      Figure 5.1. Pipeline Builder

      

4. Click Add Resources to specify the name and type of resources that the Pipeline Run will use. These resources are then used by the Tasks in the Pipeline as inputs and outputs. For this example:

   1. Add an input resource. In the Name field, enter Source, and from the Resource Type drop-down list, select Git.
   2. Add an output resource. In the Name field, enter Img, and from the Resource Type drop-down list, select Image.
5. The Parameters for a Task are prepopulated based on the specifications of the Task. If required, use the Add Parameters link to add additional parameters.

6. A Missing Resources warning is displayed on a Task if the resources for the Task are not specified. Click the s2i-nodejs Task to see the side panel with details for the Task.

   Figure 5.2. Tasks details in Pipelines Builder

   

7. In the Task side panel, specify the resources and parameters for it:

   1. In the Input Resources → Source section, the Select Resources drop-down list displays the resources that you added to the Pipeline. For this example, select Source.
   2. In the Output Resources → Image section, click the Select Resources list, and select Img.
   3. If required, in the Parameters section, add more parameters to the default ones, by using the $(params.<param-name>) syntax.
8. Similarly, add an input resource for the openshift-client Task.
9. Click Create to create the Pipeline. You are redirected to the Pipeline Details page that displays the details of the created Pipeline.
10. Click the Actions drop-down menu, and then click Start to start the Pipeline.

Procedure

1. In the Pipelines view of the Developer perspective, select a project from the Project drop-down list to see the Pipelines in that project.

   Figure 5.3. Pipelines view in the Developer perspective

   
2. Click the required Pipeline to see the Pipeline Details page. This page provides a visual representation of all the serial and parallel Tasks in the Pipeline. The Tasks are also listed at the lower right of the page. You can click the listed Tasks to view Task details.

3. Optionally, in the Pipeline Details page:

   • Click the YAML tab to edit the YAML file for the Pipeline.

   • Click the Pipeline Runs tab to see the completed, running, or failed runs for the pipeline.

     Note

     The Details section of the Pipeline Run Details page displays a Log Snippet of the failed pipeline run. Log Snippet provides a general error message and a snippet of the log. A link to the Logs section provides quick access to the details about the failed run. The Log Snippet is also displayed in the Details section of the Task Run Details page.

     You can use the Options menu to stop a running pipeline, to rerun a pipeline using the same parameters and resources as that of the previous pipeline execution, or to delete a pipeline run.

   • Click the Parameters tab to see the parameters defined in the pipeline. You can also add or edit additional parameters as required.
   • Click the Resources tab to see the resources defined in the pipeline. You can also add or edit additional resources as required.

1. In the Pipelines view of the Developer perspective, click the Options menu adjoining a Pipeline, and select Start.

2. The Start Pipeline dialog box displays the Git Resources and the Image Resources based on the Pipeline definition.

   Note

   For Pipelines created using the From Git option, the Start Pipeline dialog box also displays an APP_NAME field in the Parameters section, and all the fields in the dialog box are prepopulated by the Pipeline templates.

   1. If you have resources in your namespace, the Git Resources and the Image Resources fields are prepopulated with those resources. If required, use the drop-downs to select or create the required resources and customize the Pipeline Run instance.

3. Optional: Modify the Advanced Options to add credentials to authenticate the specified private Git server or Docker registry.

   1. Under Advanced Options, click Show Credentials Options and select Add Secret.

   2. In the Create Source Secret section, specify the following:

      1. A unique Secret Name for the secret.
      2. In the Designated provider to be authenticated section, specify the provider to be authenticated in the Access to field, and the base Server URL.

      3. Select the Authentication Type and provide the credentials:

         • For the Authentication Type Image Registry Crendentials, specify the Registry Server Address that you want to authenticate, and provide your credentials in the Username, Password, and Email fields.

           Select Add Credentials if you want to specify an additional Registry Server Address.

         • For the Authentication Type Basic Authentication, specify the values for the UserName and Password or Token fields.
         • For the Authentication Type SSH Keys, specify the value for the SSH Private Key field.
      4. Select the check mark to add the secret.

   You can add multiple secrets based upon the number of resources in your Pipeline.

4. Click Start to start the PipelineRun.

5. The Pipeline Run Details page displays the Pipeline being executed. After the Pipeline starts, the Tasks and Steps within each Task are executed. You can:

   • Hover over the Tasks to see the time taken for the execution of each Step.
   • Click on a Task to see logs for each of the Steps in the Task.

   • Click the Logs tab to see the logs according to the execution sequence of the Tasks and use the Download button to download the logs to a text file.

     Figure 5.4. Pipeline run

     

6. For Pipelines created using the From Git option, you can use the Topology view to interact with Pipelines after you start them:

   Note

   To see Pipelines created using the Pipeline Builder in the Topology view, customize the Pipeline labels to link the Pipeline with the application workload.

   1. On the left navigation panel, click Topology, and click on the application to see the Pipeline Runs listed in the side panel.

   2. In the Pipeline Runs section, click Start Last Run to start a new Pipeline Run with the same parameters and resources as the previous ones. This option is disabled if a Pipeline Run has not been initiated.

      Figure 5.5. Pipelines on the Topology view

      

   3. In the Topology page, hover to the left of the application to see the status of the pipeline run for the application.

      Note

      The side panel of the application node in the Topology page displays a Log Snippet when a pipeline run fails on a specific task run. You can view the Log Snippet in the Pipeline Runs section, under the Resources tab. Log Snippet provides a general error message and a snippet of the log. A link to the Logs section provides quick access to the details about the failed run.

Procedure

1. In the Pipelines view of the Developer perspective, select the Pipeline you want to edit to see the details of the Pipeline. In the Pipeline Details page, click Actions and select Edit Pipeline.

2. In the Pipeline Builder page:

   • You can add additional Tasks, parameters, or resources to the Pipeline.
   • You can click the Task you want to modify to see the Task details in the side panel and modify the required Task details, such as the display name, parameters and resources.
   • Alternatively, to delete the Task, click the Task, and in the side panel, click Actions and select Remove Task.
3. Click Save to save the modified Pipeline.

Procedure

1. In the Pipelines view of the Developer perspective, click the Options menu adjoining a Pipeline, and select Delete Pipeline.
2. In the Delete Pipeline confirmation prompt, click Delete to confirm the deletion.