Skip to main content

Setup Azure DevOps Discovery

Overview

This step will guide you through the process of setting up Azure DevOps Discovery to automatically find all your catalog-info.yaml files for you.

Step Checklist

This is the second (2) step in this guide, once completed you can move onto the next step.

  1. Setup the Azure integration in App Settings
  2. Setup Azure DevOps Discovery
  3. Install the Azure DevOps Annotator Processor
  4. Install the Azure DevOps plugin
  5. Install the Azure DevOps scaffolder actions
  6. Install the Azure DevOps Wiki collator

Walkthrough

Here's how to enable Azure DevOps Discovery:

  1. Navigate to Catalog Settings
  2. Then click the Ingest button on the Azure DevOps card
  3. Now in the new screen that appears click on the 2nd "+ Add Item" button
  4. Then provide a Key name, your Azure DevOps Organization name works well for this
  5. For host enter dev.azure.com
  6. Then for organization enter your Azure DevOps Organization name
  7. For project you can list a single project but the more common approach is to use * as that will include all your Projects in the provided Organization
  8. You can provide the optional repository and path fields but the default are best for getting started
  9. Next we will provide a frequency, for initial setup we recommend using a short 10 minute frequency, long term a longer 12 hours or 1 day frequency is best
  10. Then for timeout use 15 or 30 minutes
  11. You can skip the optional initialDelay and scope fields, their default are sound
  12. You can now click the Save button in the bottom right to save the configuration you've just set up
  13. In the top right you'll see a pulsing message "Applying new configuration..." as the settings get saved
  14. The message will then change to "New configuration applied successfully." with a Reload button, click it to reload the configuration
  15. Portal is now configured to discovery your catalog-info.yaml files for you!

From here you can now move on to Step 3 where you'll Install the Azure DevOps Annotator Processor to automatically add helpful annotations to your entities.