Skip to content

Commit

Permalink
Feat: Eventing support in Service Catalog (#8075)
Browse files Browse the repository at this point in the history
* save

* eventing docs plus small fixes

* Update app/konnect/service-catalog/integrations/index.md

* fix table and variable

* Apply suggestions from code review

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

---------

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
  • Loading branch information
Guaris and lena-larionova authored Oct 31, 2024
1 parent b9f62dd commit 265546e
Show file tree
Hide file tree
Showing 6 changed files with 40 additions and 11 deletions.
7 changes: 7 additions & 0 deletions app/_assets/stylesheets/badges.less
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,13 @@
text-fill-color: transparent;
}
}
&.events::after {
content: "Supports Events";
color: #3972d5;
background: #f2f6fe;
padding: 5px 12px 4px;
text-align: center;
}

&.premiumpartner::after {
content: "PREMIUM PARTNER";
Expand Down
2 changes: 2 additions & 0 deletions app/_data/tables/konnect/integrations.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -22,4 +23,5 @@ integrations:
# Put icon in /assets/images/icons/third-party/<file>.
# 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
4 changes: 4 additions & 0 deletions app/_includes/service-catalog-integrations.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@
<span style="font-size: 22px;display:block;margin-bottom:8px;">{{ i.name }}</span>
</div>
<div class="install-description">{{i.description}}</div>
{% if i.events == true %}
<br>
<span class="badge events"></span>
{% endif %}
</div>
</a>
{% endfor %}
Expand Down
19 changes: 10 additions & 9 deletions app/konnect/service-catalog/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,25 +54,27 @@ 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/) |
| 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/) |

<!-- commenting this out until it's released:
| Govern how services are created and maintained across your company to adhere to security, compliance, and engineering best practices. | Scorecards |-->

## 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. |
| 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

Expand Down Expand Up @@ -128,4 +130,3 @@ Yes, you can configure access controls and manage permissions to Service Catalog

## More information
* [Service Catalog integrations](/konnect/service-catalog/integrations)

13 changes: 12 additions & 1 deletion app/konnect/service-catalog/integrations/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -32,6 +32,17 @@ Entity | Description
-------|-------------
Repository | A GitHub repository relating to the service

## Events

This integration supports events.

You can view the following event types for linked repositories from the {{site.konnect_product_name}} UI:

* Open pull request
* Merge pull request
* Close pull request


## Discovery information

<!-- vale off-->
Expand Down
6 changes: 5 additions & 1 deletion app/konnect/service-catalog/integrations/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,17 @@ 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.

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_short_name}}

## 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_short_name}} UI. From here you can search or filter through events by keywords in the event title and filter by time frame.

0 comments on commit 265546e

Please sign in to comment.