API Catalog -> Service Catalog Migration #26763
Conversation
| {{< site-region region="gov,ap1" >}} | ||
| <div class="alert alert-warning">API Catalog is not supported for your selected <a href="/getting_started/site">Datadog site</a> ({{< region-param key="dd_site_name" >}}).</div> | ||
| {{< /site-region >}} | ||
|
|
||
| <div class="alert alert-warning"><h5 class="card-title text-black mt-0 mb-1">The API Catalog features are migrating to Service Catalog</h5> |
There was a problem hiding this comment.
No need for this message anymore in the new docs :)
There was a problem hiding this comment.
this file wont be relevant anymore
| API Catalog is based on APM tracing, so the first step is to make sure your services are instrumented. Click **Learn More** in the app, then select **Troubleshoot** to verify this. | ||
| {{< img src="tracing/api_catalog/api-catalog-discovery-learn-more.png" alt="Learn More button in the app" style="width:30%;text-align: left;" >}} | ||
|
|
||
| If your service is instrumented and you still can't see the endpoints, there are two options: |
There was a problem hiding this comment.
this paragraph will not be relevant anymore
|
|
||
| Use the Datadog GitHub integration to import API definitions and keep them updated. After connecting, the API automatically updates whenever the file content changes in the repository. | ||
|
|
||
| To import an OpenAPI or Swagger file using the GitHub integration: |
There was a problem hiding this comment.
this should be changed according to the new approach
There was a problem hiding this comment.
Do you do this from the Setup & Config tab now, or is this done through the entity yaml?
| @@ -89,6 +90,85 @@ Click a service in Service Catalog to open the side panel with the following det | |||
|
|
|||
| Click **View Related** and select a page from the dropdown menu to navigate into related pages in Datadog, such as the [APM Service Page][6] and service map for this service, or related telemetry data pages, such as for distributed tracing, infrastructure, network performance, Log Management, RUM, and Continuous Profiler. | |||
|
|
|||
| ## Add metadata to endpoints | |||
There was a problem hiding this comment.
this is now part of entity yaml, we should change the documentation accordingly
There was a problem hiding this comment.
Does this work the same as outlined here? https://www.datadoghq.com/blog/service-catalog-schema-v3/
There was a problem hiding this comment.
Yes, but APIs do not appear there, we should rewrite this section I guess to include API explanations. (also we should get rid of the 'API Catalog' mentions here)
| An endpoint is an HTTP resource exposed by a service at a specific URL path. | ||
|
|
||
| In case of a resource that represents an endpoint, a new **Definition** section will be added to the resource page | ||
|
|
| @@ -1,5 +1,5 @@ | |||
| --- | |||
| title: Datadog API Catalog | |||
| title: Endpoint Observability | |||
There was a problem hiding this comment.
we have links that will not work here anymore right?
There was a problem hiding this comment.
This page has now been deleted per your suggestion, but I've added aliases so that all links should redirect appropriately.
* removing deprecation message * proposed changes * Fix typo. --------- Co-authored-by: Brett Blue <[email protected]>
What does this PR do? What is the motivation?
Integrate API Catalog docs into Service Catalog to reflect the new state of the product.
Preview
To do
Consolidate/remove content for API Catalog that's already covered by Service Catalog:
Merge instructions
Merge readiness:
Merge queue is enabled in this repo. To have it automatically merged after it receives the required reviews, create the PR (from a branch that follows the
<yourname>/descriptionnaming convention) and then add the following PR comment:Additional notes