Step 1. Discover Core Information

No developer wants to document things manually, especially not in a continuous delivery world. As a result, automation is the first step toward the catalogs at the core of VSM. We support our customers here in two ways:

• With out-of-the-box integrations, you can get started extracting your data within minutes. It could be a plugin (e.g. for Jenkins), it could be a scheduled job hosted by us
• With powerful APIs that enable you to build your integrations and leverage our platform capabilities to monitor them & keep them up-to-date.

Create your service baseline

The center of automated VSM data is the service catalog. To get you started fast and efficiently, we look to automate a scalable baseline from your code repository. Utilizing out-of-the-box integrations to Github (SaaS or OnPrem), Azure Repos, and more, we discover a full list of all the repositories managed in your organization.

The first discovery scan brings a first list into your mapping inbox. From here, you filter which discovered repos are valuable and should thus appear in your service catalog and which should not be selecting the relevant services and clicking the import button. This ensures that only valuable data lives in your catalog and remains clutter-free. Ideally, this is already done by your teams - urge them to claim their services directly from the inbox. This will ensure data accuracy and accelerate ownership mapping.

Establish your API catalog

📘

Early Access

Please note, that the API Catalog is currently in Early Access. Please reach out if you want to get this activated for your workspace, or stay tuned for the general availability.

Next to the Service Catalog, VSM captures a comprehensive and related API catalog. Combining the two allows a more sophisticated understanding of your service architecture by capturing which services are connected and how.

Here too, we consider integration the ideal data source, populated via VSMs REST endpoints for API data or scraped from existing API documentation in an external system.

If none are immediately possible, there is always the manual option - either way, in the end, each team should take responsibility to accurately map one level upstream & one level downstream of their services to build a comprehensive catalog.