Onboard SonarQube to DevOps Change Velocity — Workspace

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

    • Connect to your Sonar instance using the DevOps Change Workspace playbook.

    Before you begin

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

    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 SonarQube.
      OptionSteps
      Homepage
      1. Select the Connect tool widget
      2. On the  Connect to a tool  modal, select SonarQube from the Software quality category.
      Applications module
      1. Select Applications (Applications icon.).
      2. Select an existing application, or create one. To create an application, see Create an application - Classic.
      3. From the  Recommended actions  pane, select the  Connect a tool  card.
      4. On the  Connect to a tool  modal, select SonarQube from the Software quality category.
      Tools module
      1. Select Tools (Tools icon.).
      2. From the Capability list, select Software quality.
      3. Select Connect a tool.
      4. On the  Connect to a tool  modal, select SonarQube.
    2. Enter a name to identify your tool and click Next.
    3. On the Enter Sonar instance details playbook activity section, enter the following details:
      1. In the URL of the SonarQube instance field, enter the SonarQube or SonarCloud instance URL.

        For example, https://sonarcloud.io.

      2. In the SonarQube username field, enter the user name for your Sonar account.
      3. In the Password or access token field, enter the token generated in Sonar.
      4. If your Sonar instance is attached to a MID Server, select the Use 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. Click Connect and review the details of the successfully connected Sonar instance.

      Connect to SonarQube instance in DevOps Change workspace.

    5. 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

    6. From the Summary page, select View tool record to review the details of the connected instance.

      Connection summary

    Result

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