Catalog services

A Catalog service is a collection of one or more resources from integrations.

A Catalog service represents the following:

• A unit of software that is typically owned by a single team
• Exposes one or more APIs
• May be dependent on other Catalog services (as either upstream or downstream)

Catalog services allow you to gain visibility into all resources in your organization, including what teams or people own them.

To create a Catalog service, do one of the following:

echo '
resource "konnect_catalog_service" "my_catalogservice" {
  name         = "billing"
  display_name = "Billing Service"
  description  = "Billing Service for the app"
  custom_fields = jsonencode({
    "cost_center" : "eng",
    "owner" : "Amal",
    "product_manager" : "Ariel",
    "dashboard" : {
      "name" : "Example Dashboard",
      "link" : "https://app.example.com/dashboard/123",
    },
    "git_repo" : {
      "name" : "example-repo",
      "link" : "https://github.com/example/repo",
    },
    "jira_project" : null,
    "slack_channel" : {
      "name" : "test-channel",
      "link" : "https://example.slack.com/archives/C098WKDB020"
    },
  })

  labels = {
    key = "value"
  }
}
' >> main.tf

APIs can be associated with Catalog services, which allows API consumers and service owners to see which APIs and services are associated with each other. If you’ve already assigned API specs to a service from integrations, migrate them to APIs.

Note: After an API spec is migrated to an API, the API spec is unlinked from the integration and will instead be stored as a snapshot by Kong. Since APIs take a snapshot of the API spec when it’s linked, they do not update automatically. For example, if you update your ingested spec in AWS, it doesn’t automatically pull changes in to the API, you must re-upload the spec manually.

To link APIs with a Catalog service, you need the following Konnect roles at a minimum for the services and APIs:

• API viewer
• Service viewer
• Service admin

To link APIs to a service, do the following:

curl -X POST "https://us.api.konghq.com/v1/catalog-services/$CATALOG_SERVICE_ID/api-mappings" \
     --no-progress-meter --fail-with-body  \
     -H "Authorization: Bearer $KONNECT_TOKEN" \
     --json '{
       "api_id": "'$API_ID'"
     }'