Onboard Jenkins to DevOps Change Velocity — Workspace

  • Release version: Washingtondc
  • Updated August 1, 2024
  • 4 minutes to read

    • Connect to your Jenkins instance using the DevOps Change Workspace playbook to discover pipelines.

    Before you begin

    Complete the tasks specified in the Getting started with DevOps Change Velocity topic.

    Install and enable the ServiceNow DevOps plugin for Jenkins. If you've already installed it, update to the latest version. For instructions, see Configure Jenkins plugin.

    Role required: sn_devops.admin or sn_devops.tool_owner

    Procedure

    1. Navigate to Workspaces > DevOps Change Workspace and use one of the following options to open the playbook to onboard Jenkins.
      You can connect a tool from an application if you also know which specific pipelines should be associated and tracked under that application to streamline the setup. This will allow you to easily associate and import data from Jenkins as well.
      OptionSteps
      Homepage
      1. Select Connect a tool.
      2. From the Connect to a tool modal, select the tool from the appropriate category. For example, if you want to connect to Jenkins as an orchestration tool, you'd select Jenkins under the Orchestration category.
      Applications module
      1. Select Applications (Applications icon.) from the primary navigation.
      2. Select an existing application, or create one. To create an application, see Create an application - Workspace.
      3. From the  Recommended actions  pane, select the  Connect a tool  card.
      4. From the Connect to a tool modal, select the tool from the appropriate category. For example, if you want to connect to Jenkins as an orchestration tool, you'd select Jenkins under the Orchestration category.
      Tools module
      1. Select Tools (Tools icon.) from the primary navigation.
      2. From the Capability list, select the appropriate category. For example, if you want to connect to Jenkins as an orchestration tool, select the Orchestration category.
      3. Select Connect a tool.
      4. On the  Connect to a tool  modal, select Jenkins.
      Important:
      If you want to discover and track tool objects like pipelines while connecting to the tool, you must connect your tool from the Application module.
    2. In the Tool name field, enter a name for the tool.

      Connect to the Jenkins tool screen

    3. On the Jenkins instance details playbook activity:
      1. Enter the URL of your Jenkins instance.
      2. Enter the login credentials (password or access token or API token) of the Jenkins instance.
        To generate API token, see Connect to Jenkins using API token authentication.
      3. If your Jenkins instance is attached to a MID Server, select the MID Server option and enter its details.
        A MID server is required if your tool instance is hosted on-prem. For more information about MID server, see MID Server selection
    4. Select Connect.

      Connect to the Jenkins tool - Enter instance details screen

    5. Permission checks are run on the credentials that you entered.
      Permissions required and permissions that are available are displayed. If you want to enter credentials with better permissions, select Re-enter credentials. For detailed information on all the required permissions, see Jenkins permissions in Permissions required for DevOps tools.

      You can choose to continue with the tool connection even if you don't have all the required permissions.

      Connect to Jenkins tool - Permission checks screen

    6. Select Next.
    7. Specify the access for the tool.
      1. If you want to control access to the tool, add the groups that must be given access to the tool in the Maintained by field.
        The tasks these users in the groups can perform depends on the role assigned to them.
        • DevOps Tool Owner role: Can view and edit the tool.
        • DevOps App Owner role: Can view the tool and can associate, discover, import historical data, and modify pipeline steps (if applicable) of the tool's objects (such as plans, repositories, and pipelines).
        • DevOps Administrator role: Can edit all tools.
        • Other DevOps roles: Can view the tool.
        Note:
        If you don't select a group and skip this step, all users with the DevOps Tool Owner role will be able to edit the tool.
      2. If you choose to control access to the tool, the All App Owners can view and associate tool objects to applications option becomes available for selection.

        This option enables all users having the DevOps App Owner role to access the tool. If selected, they’ll be able to view, associate, discover, import historical data, and modify pipeline steps (if applicable) of the tool's objects.

      3. Select Assign.

      Specify tool access

    8. Install the ServiceNow DevOps plugin for Jenkins.

      For more information on the extension, see Configure Jenkins plugin.

      Install Jenkins plugin.

    9. Select Configure to automatically set up ServiceNow DevOps Configuration in your Jenkins instance.
      Important:

      • You must first install and enable the ServiceNow DevOps plugin for Jenkins. If you've already installed it, update to the latest version. For instructions, see Configure Jenkins plugin.

      • To configure webhooks automatically, Jenkins admin access is required.
      • If you choose to automatically configure this tool, then the existing set up for ServiceNow DevOps Configuration in Jenkins will be over-written.
      • You can add a total of ten ServiceNow configurations.

      Configure webhooks automatically.

      Figure 1. Automatically sets up ServiceNow DevOps Configuration in Jenkins
      Automatically sets up ServiceNow DevOps configuration in Jenkins

      To configure webhooks manually in Jenkins, see Configure webhooks manually for Jenkins.

      You can also choose to enable nightly polling to retrieve data for any tracked pipelines by selecting the Enable Polling property option in the Administration module. See DevOps Change Velocity properties.

      Important:
      • If you're connecting from the Home page or Tools module, the connection is complete and you're taken to the Summary page.
      • If you're connecting from the Applications module, then pipelines available in your instance are discovered. You can track and import historical data from them.
    10. Select the pipelines that you want to track from Select pipelines playbook activity.
      For each selected pipeline, all steps are imported for the last successful execution.

      Select pipelines to track.

    11. Optional: In the Assign services to pipeline steps activity, specify Step type and Service for each pipeline step.

      Assign services to pipelines in Jenkins.

      Completing this step as part of tool onboarding enables the DevOps Insights dashboards to show more meaningful data immediately.

    12. If you want to import pipeline data, select the date range and select Submit.
    13. From the Summary page, select View tool recordto review the details of the connected Jenkins tool.

      Summary page.

      Note:
      If your tool credential has changed, you must update the credentials in your ServiceNow instance. For more information, see Update third-party tool credentials in DevOps Change Velocity.

    Result

    You’ve successfully onboarded your Jenkins tool to DevOps Change Velocity.