To create a Jenkinsfile-based pipeline from a remote code repository, you can configure a webhook in the remote repository so that the pipeline is automatically triggered when the remote repository changes.

This document demonstrates how to trigger a pipeline using a webhook in a GitHub repository.

Prerequisites

  • The DevOps extension must be installed and enabled on the KubeSphere platform.

  • You have created a workspace, a DevOps project, and a user (for example, project-regular), and have invited this user to the DevOps project and granted the operator role. Refer to Invite a User to a DevOps Project.

  • You have created a Jenkinsfile-based pipeline from a remote code repository. For more information, refer to Create a Pipeline Using Jenkinsfile.

Configure Webhook

Obtain the Webhook URL

  1. Log in to the KubeSphere console as the project-regular user and enter your workspace.

  2. Click  DevOps > Pipeline in the left navigation pane.

  3. Select a DevOps project from the drop-down list in the upper left corner of the page.

  4. On the Pipeline page, click a pipeline (for example, jenkins-in-scm) to view its details page.

  5. Click Operation, and select Edit Settings from the drop-down menu.

  6. In the dialog box that appears, scroll to Webhook to obtain the Webhook push URL.

Set Up the Webhook in the GitHub Repository

  1. Log in to your GitHub account and go to the devops-maven-sample repository.

  2. Click Settings > Webhooks, and then click Add webhook.

  3. In Payload URL, enter the Webhook push URL from the pipeline, and then click Add webhook. This tutorial selects the default Just the push event. Configure it according to your actual needs. For more information, refer to GitHub Documentation.

  4. The configured webhook will be displayed on the Webhooks page.

Trigger the Pipeline Using Webhook

Submit a Pull Request to the Repository

  1. On the Code page of the devops-maven-sample repository, click master and then select the v4.1.0-sonarqube branch.

  2. Go to /deploy/dev-ol and click the file devops-sample.yaml.

  3. Click pen-light to edit the file. For example, change the value of spec.replicas to 3.

  4. Click Commit changes.

Check the Webhook Delivery

  1. On the Settings > Webhooks page of the devops-maven-sample repository, click the created webhook.

  2. Click Recent Deliveries, and then click a specific delivery record to view its details.

Check the Pipeline Status

  1. On the Run Records tab of the pipeline details page, check whether a new run has been triggered by the pull request submitted to the v4.1.0-sonarqube branch of the remote repository.

  2. Go to the Workloads > Pods page of the kubesphere-sample-dev project and check the status of the 3 pods. If the 3 pods are in the running state, it indicates that the pipeline is running normally.