< img height="1" width="1" style="display:none;" alt="" src="https://px.ads.linkedin.com/collect/?pid=3131724&fmt=gif" />
🚀 KubeSphere v4.1.2 with Enhancements and Bug Fixes is available now. Read the release notes for v4.1.2 → close
  • English
    • English
    • 简体中文
    1. 1.Create a KubeSphere Cloud account and log in to the platform.
    2. 2.In the upper-right corner, click Console, and then click Lite Cluster on the left.
    3. 3.Create a K8s cluster with KubeSphere installed.
    4. 4.Access KubeSphere with the default account and password (admin/P@88w0rd).
  •  Star
  1. Docs / 
  2. Documentation / 
  3. Extension User Guide / 
  4. DevOps / 
  5. How to Use DevOps / 
  6. Pipelines / 
  7. Trigger a Pipeline Using a Webhook

Documentation

Last updated:
    Edit

    Trigger a Pipeline Using a Webhook

    If you 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 changes are made to the remote repository.

    This tutorial demonstrates how to trigger a pipeline by using a webhook in GitHub.

    Prerequisites

    • DevOps must have been installed and enabled.

    • A workspace, a DevOps project, and a user (e.g., project-regular) have been created, and the user has been invited to the DevOps project with the operator role. Refer to Role and Member Management.

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

    Configure a Webhook

    Get a webhook URL

    1. Log in to the KubeSphere web console as the project-regular user.

    2. Click Workspace Management and enter your DevOps project.

    3. On the Pipelines page, click a pipeline (e.g., jenkins-in-scm) to view its details page.

    4. Click More and select Edit Settings in the drop-down list.

    5. In the pop-up dialog box, scroll down to Webhook to get the webhook push URL.

    Set a webhook in the GitHub repository

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

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

    3. Enter the webhook push URL of the pipeline for Payload URL and click Add webhook. This tutorial selects Just the push event for demonstration purposes. You can make other settings based on your needs. For more information, see GitHub Documentation.

    4. The configured webhook is displayed on the Webhooks page.

    Trigger the Pipeline Using the 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 Webhook Delivery

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

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

    Check Pipeline Status

    1. Log in to the KubeSphere web console as the project-regular user.

    2. Click Workspace Management and enter your DevOps project.

    3. On the Pipelines page, click a pipeline (e.g., jenkins-in-scm) to view its details page.

    4. On the Run Records tab, check if the pull request submitted to the remote repository v4.1.0-sonarqube branch has triggered a new run.

    Receive the latest news, articles and updates from KubeSphere


    Thanks for the feedback. If you have a specific question about how to use KubeSphere, ask it on Slack. Open an issue in the GitHub repo if you want to report a problem or suggest an improvement.

    Previous : Pipeline Settings
    What’s on this Page