Onboard ADO repositories to Polaris applications

Black Duck Polaris Platform

This procedure describes how to onboard one or more Azure DevOps repositories to new or existing Polaris applications. During this process, you'll have the option of importing all repositories in your Azure DevOps instance or choosing specific repos to import.

Before you begin, review Integrate Azure DevOps with Polaris. If you're using Azure DevOps Server, that topic explains how to make sure Polaris has network access to your ADO Server instance. Create a personal access token as described in Azure Tokens for SCM Bulk Integration and/or Monitoring before proceeding.

Important:

Bulk SCM integration with Azure DevOps Cloud requires a Polaris Premium subscription.

Note: SCA Fix Pull Requests are supported for repositories hosted in Azure DevOps Cloud and Azure DevOps Server. For Azure DevOps Server integrations, Polaris creates the pull request over the Secure Tunnel that connects it to your repository. See SCA Fix Pull Requests.

Onboard Azure DevOps repositories to Polaris applications

  1. On the Portfolio page, select + Create > New Application(s) with SCM.
  2. Connect to your SCM:
    1. Select the type of server hosting your repositories:
      • Cloud-hosted — for Azure DevOps Cloud
      • Self-hosted — for Azure DevOps Server
    2. Select Azure Repos.
    3. (Azure DevOps Server only) Enter the SCM URL of your Azure DevOps Server instance, including the collection path (for example, https://{server}/{collection}).
    4. (Azure DevOps Server only) If you're using the Secure Tunnel, check URL is in a private network and select a secure tunnel from the pull-down menu (see Prerequisites).
    5. Enter your Azure DevOps access token under Repository Access Token.
      Note: The access token provided here will be used to complete the onboarding process and will be subject to rate limits enforced by Azure DevOps.
    6. Click Test Connection.

      You should receive a Connection Successful message and the Quick Start options should be visible. If your connection test is unsuccessful, check the following:

      • That your network connection is stable.
      • That the Repository Access Token is accurate.
      • That the Repository Access Token is still valid and has not expired.
      • That you selected the correct provider for your SCM.
      • That you have authorized the access token for use outside SSO (if applicable).
      • (Azure DevOps Server only) That the teleport agent (for example, Bridge) in the private network is running and pointing at the secure tunnel. See Add and manage secure tunnels in the Polaris UI.
  3. If your connection is successful, use the Select Method dropdown menu to select one of the following:
    • Automatically create Polaris Applications from Azure DevOps organizations. If you select this option, the default name for each new project will be the Azure project's name followed by the parent Azure organization. You can change this naming convention by altering the string in the Application Name Template field if you prefer.
      Important: This first option will onboard every single repo in your ADO instance. Depending on the number of repos you have, this could take a significant amount of time and result in many unwanted projects. We recommend you choose the second option in most circumstances, especially when first testing this feature.
    • Manually map Azure Repos to Polaris Applications. If you select this option, the name of each new Polaris project is based on the originating Azure DevOps project name and repository name.

    If you selected the first option, skip ahead to step 7.

    Note: Azure DevOps Server does not support group-level service hook auto-registration. Service hooks must be configured at the Collection or Project level in Azure DevOps Server.


  4. Under the Projects heading, use the pull-down menu to browse and select one or more of the repos in your ADO instance.
    Important: You'll be mapping the selected repos to a single Polaris application. If you want to add some repos to a different application, deselect them for now.
  5. Using the radio buttons under the Application heading, choose whether you want to use a New or Existing Polaris application for the selected repos.
    • New - enter a unique, suitable name for the new application in the text field provided.
    • Existing - use the dropdown menu to select the intended application.
    Note: Each selected repo will be mapped to a new Polaris project within the chosen application.
  6. If you want to assign other repos to a different application, select Add More and repeat steps 4-6 until you have all of the mappings you need.
  7. If you want to assign specific roles to users for these applications, use the Assign Application Role table to specify each role and the users you want to have it. Select Add More to add as many role assignments as you need.
    Important: Verify that each user has access to the relevant repositories in your Azure DevOps instance.
  8. (Optional) Configure synchronization settings under Integrations.

    These settings allow you to sync your SCM provider with Polaris and include non-default branches in your onboarding and ongoing synchronization. After onboarding is complete, you can manage these settings at the application level. See Synchronizing Polaris with your SCM Provider.

    1. Select Keep repositories and branches synchronized with SCM to have Polaris actively monitor SCM updates, deletions, renames, and branch modifications and implement the necessary changes to the corresponding Polaris projects and branches.
      Note: If selected without the additional branches option below, this applies only to default branches.
    2. Select Continue to import new repositories for above organizations to automatically create a new project in Polaris when a new repository is added to your SCM.
      Note: This option is only available if you selected the automatic mapping method.
    3. Select Import additional branches matching substrings to import and synchronize non-default branches whose names include specific text.

      After selecting this option, enter a comma-separated list of the text substrings you want to match against (for example, -release, -demo, and so on).

      If you want Polaris to continue monitoring for branch creation events after the initial integration, select Continue to import new branches matching substrings. Polaris will monitor for new branches matching the specified substrings across all selected repositories.

  9. Click Import Repositories.

    On your Portfolio page, a progress bar will track the percentage of completion.

    If the onboarding fails, an email notification will be sent to the user who initiated the onboarding. Organization Admins can monitor activity in audit logs (My Organization > Audit Logs).

    Click Cancel to cancel the import. Any repository in the process of being imported at the time of cancellation will complete in the background after the cancel is accepted, and all further onboarding will be stopped immediately. For example, if you import ten repositories and cancel at 50%, five repositories would be imported and five repositories would not.

Next steps