diff --git a/app/_assets/stylesheets/badges.less b/app/_assets/stylesheets/badges.less index 02705b506088..0236a41f3c2e 100644 --- a/app/_assets/stylesheets/badges.less +++ b/app/_assets/stylesheets/badges.less @@ -28,6 +28,13 @@ text-fill-color: transparent; } } + &.events::after { + content: "Supports Events"; + color: white; + background: linear-gradient(90deg, #5052FD 0%, #033796 100%); + padding: 5px 12px 4px; + text-align: center; + } &.techpartner::after { content: "TECH PARTNER"; diff --git a/app/_data/tables/konnect/integrations.yml b/app/_data/tables/konnect/integrations.yml index 961badc6ec8d..1fba946caf6c 100644 --- a/app/_data/tables/konnect/integrations.yml +++ b/app/_data/tables/konnect/integrations.yml @@ -6,6 +6,7 @@ integrations: - name: GitHub icon: github.svg slug: github + events: true description: Associate a service to one or more GitHub repositories - name: Traceable.io icon: traceable.svg @@ -22,4 +23,5 @@ integrations: # Put icon in /assets/images/icons/third-party/. # slug: The filename of the integration page itself, used for links. Don't include the file extension (e.g. .md) # E.g. if the page is at /konnect/service-catalog/integrations/pagerduty, the slug is pagerduty + # events: True if the integration supports eventing. # description: Short description (100 char max) of the integration diff --git a/app/_includes/service-catalog-integrations.html b/app/_includes/service-catalog-integrations.html index 7897f8d386b9..5c00fa62e8ab 100644 --- a/app/_includes/service-catalog-integrations.html +++ b/app/_includes/service-catalog-integrations.html @@ -7,6 +7,9 @@ {{ i.name }}
{{i.description}}
+ {% if i.events == true %} + + {% endif %} {% endfor %} diff --git a/app/konnect/service-catalog/index.md b/app/konnect/service-catalog/index.md index 129379419020..d94f44925fdf 100644 --- a/app/konnect/service-catalog/index.md +++ b/app/konnect/service-catalog/index.md @@ -54,27 +54,26 @@ graph LR > *Figure 1: This diagram shows how you can use both external integrations, like GitHub and PagerDuty, as well as internal integrations like Gateway Manager to pull resources into Service Catalog. You can then map those resources (like GitHub repositories, PagerDuty services, and Gateway services) to Service Catalog services.* -## Service Catalog use cases +## {{site.service_catalog_name}} use cases | You want to... | Then use... | | -------------- | ----------- | -| Keep track of your organization's resource ownership by mapping teams to Service Catalog services. | Add the Service Catalog service's owner when you [create a new Service Catalog service in {{site.konnect_short_name}}](https://cloud.konghq.com/service-catalog/create-service) | -| Gain visibility into all your services, including unrecognized or undiscovered APIs in your organization. | [Service Catalog integrations](https://cloud.konghq.com/service-catalog/integrations) | -| Consolidate key Service Catalog service health metrics, documentation, and API specs into a single list, allowing you to interact with other tools from one place. | [Service Catalog dashboard](https://cloud.konghq.com/service-catalog/) | -| View integration-related events (like pull requests, merges, or configuration changes) associated with your Service Catalog services. | Use the **Events** tab. | +| Keep track of your organization's resource ownership by mapping teams to {{site.service_catalog_name}} services. | Add the {{site.service_catalog_name}}service's owner when you [create a new {{site.service_catalog_name}} service in {{site.konnect_short_name}}](https://cloud.konghq.com/service-catalog/create-service) | +| Gain visibility into all your services, including unrecognized or undiscovered APIs in your organization. | [{{site.service_catalog_name}} integrations](https://cloud.konghq.com/service-catalog/integrations) | +| Consolidate key {{site.service_catalog_name}} service health metrics, documentation, and API specs into a single list, allowing you to interact with other tools from one place. | [{{site.service_catalog_name}} dashboard](https://cloud.konghq.com/service-catalog/) | -## Service Catalog terminology +## {{site.service_catalog_name}} terminology | Term | Definition | | ---- | ---------- | | Integration | These are applications, either {{site.konnect_short_name}}-internal or external, that act as sources from which you can ingest resources. For example, GitHub. | -| Resource | An umbrella term that denotes entities ingested by Service Catalog from enabled integrations. A resource can range from an infrastructural component (like Gateway services, mesh services, databases, and caches) to an external application or tool (like code repositories, CI/CD infrastructure, and on-call systems) to a piece of documentation (like API specs). Resources can be mapped to one or more Service Catalog services. | -| Service Catalog service | A unit of software that is typically owned by a single team, exposes one or more APIs, and may be dependent on other Service Catalog services (as either upstream or downstream). A Service Catalog service can be thought of as a collection of one or more resources. | -| Service Catalog | A comprehensive catalog of all resources and Service Catalog services running in your organization. | -| Events | An event is a captured unit of information logged by the Service Catalog. It includes a wide range of activities such as user-driven actions, configuration changes, and alerts. | +| Resource | An umbrella term that denotes entities ingested by {{site.service_catalog_name}} from enabled integrations. A resource can range from an infrastructural component (like Gateway services, mesh services, databases, and caches) to an external application or tool (like code repositories, CI/CD infrastructure, and on-call systems) to a piece of documentation (like API specs). Resources can be mapped to one or more {{site.service_catalog_name}} services. | +| {{site.service_catalog_name}} service | A unit of software that is typically owned by a single team, exposes one or more APIs, and may be dependent on other {{site.service_catalog_name}} services (as either upstream or downstream). A {{site.service_catalog_name}} service can be thought of as a collection of one or more resources. | +| {{site.service_catalog_name}} | A comprehensive catalog of all resources and {{site.service_catalog_name}} services running in your organization. | +| Events | An [event](/konnect/service-catalog/integrations/#events) is a captured unit of information logged by the {{site.service_catalog_name}}. It includes a wide range of activities such as user-driven actions, configuration changes, and alerts. | ## FAQs @@ -131,4 +130,3 @@ Yes, you can configure access controls and manage permissions to Service Catalog ## More information * [Service Catalog integrations](/konnect/service-catalog/integrations) - diff --git a/app/konnect/service-catalog/integrations/github.md b/app/konnect/service-catalog/integrations/github.md index c3bc0f6681a0..64db7e48b298 100644 --- a/app/konnect/service-catalog/integrations/github.md +++ b/app/konnect/service-catalog/integrations/github.md @@ -11,7 +11,7 @@ mechanism: "pull/ingestion model" _Type: External_ -The GitHub integration allows you to associate your Service Catalog service to one or more GitHub repositories. +The GitHub integration allows you to associate your {{site.service_catalog_name}} service to one or more GitHub repositories. For each linked Repository, the UI can show a **Repository Summary** with simple data pulled from the GitHub API, such as the number of open issues, open pull requests, most recently closed pull requests, languages, and more. @@ -32,15 +32,15 @@ Entity | Description -------|------------- Repository | A GitHub repository relating to the service -## Supported events +## Events -Supported events include the following actions: +The Eventing feature supports viewing the following event types for linked repositories from the {{site.konnect_product_name}} UI. | Event Type | |----------------------------| -| Pull request opened | -| Pull request merged | -| Pull request closed | +| Open pull request | +| Merge pull request | +| Close pull request | ## Discovery information diff --git a/app/konnect/service-catalog/integrations/index.md b/app/konnect/service-catalog/integrations/index.md index 876695c40de5..d75e202e4982 100644 --- a/app/konnect/service-catalog/integrations/index.md +++ b/app/konnect/service-catalog/integrations/index.md @@ -6,13 +6,18 @@ beta: true --- Integrations are applications - either {{site.konnect_short_name}}-internal applications or external -third-party applications - that you can enable or disable within Service Catalog. +third-party applications - that you can enable or disable within {{site.service_catalog_name}}. When enabled, an integration gives you and your teams the ability to: * Discover new resources * Create new services based on existing resources +* View key events associated with the integration directly in the event tab in {{site.konnect_saas}}. ## Integrations {% include_cached service-catalog-integrations.html %} + +## Events + +Eventing allows you to view key events associated with your {{site.service_catalog_name}} integrations directly from the Events tab in the {{site.konnect_saas}} UI. From here you can search or filter through events by keywords in the event title and filter by time frame. \ No newline at end of file