Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Connect Azure DevOps repositories to Catalog with the {{site.konnect_short_name}} API
title: Connect Azure DevOps repositories to {{site.konnect_catalog}} Classic with the {{site.konnect_short_name}} API
permalink: /how-to/connect-azure-devops-to-the-konnect-catalog-with-the-konnect-api/
content_type: how_to
description: Learn how to connect Azure DevOps repositories to your {{site.konnect_catalog}} services in {{site.konnect_short_name}} using the Konnect API.
description: Learn how to connect Azure DevOps repositories to your {{site.konnect_catalog}} Classic services in {{site.konnect_short_name}} using the Konnect API.
products:
- catalog
works_on:
Expand All @@ -17,8 +17,8 @@ search_aliases:
- devops
- service catalog
related_resources:
- text: "{{site.konnect_catalog}}"
url: /catalog/
- text: "{{site.konnect_catalog}} Classic"
url: /catalog-classic/
- text: Integrations
url: /catalog/integrations/
- text: Azure DevOps reference
Expand Down Expand Up @@ -49,6 +49,8 @@ prereqs:
```
---

{% include_cached catalog/catalog-classic-banner.md %}

## Configure the Azure DevOps integration

Before you can discover Azure DevOps repositories in {{site.konnect_catalog}}, export your Azure DevOps organization name exactly as it appears in Azure DevOps:
Expand Down Expand Up @@ -97,7 +99,7 @@ body:

Once authorized, resources from your Azure DevOps account are discoverable in the UI.

## Create a Service in Catalog
## Create a Service in {{site.konnect_catalog}} Classic

Create a service to map to your Azure DevOps resources:

Expand All @@ -120,7 +122,7 @@ capture:

## List Azure DevOps resources

Before you map Azure DevOps resources to a service in Catalog, locate the resources that {{site.konnect_short_name}} ingests from Azure DevOps:
Before you map Azure DevOps resources to a service in {{site.konnect_catalog}} Classic, locate the resources that {{site.konnect_short_name}} ingests from Azure DevOps:

<!--vale off-->
{% konnect_api_request %}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Connect Azure DevOps repositories to Catalog with the {{site.konnect_short_name}} UI
title: Connect Azure DevOps repositories to {{site.konnect_catalog}} Classic with the {{site.konnect_short_name}} UI
permalink: /how-to/connect-azure-devops-to-the-konnect-catalog-with-the-konnect-ui/
content_type: how_to
description: Learn how to connect Azure DevOps repositories to your {{site.konnect_catalog}} services in {{site.konnect_short_name}} using the UI.
description: Learn how to connect Azure DevOps repositories to your {{site.konnect_catalog}} Classic services in {{site.konnect_short_name}} using the UI.
products:
- catalog
works_on:
Expand All @@ -14,8 +14,8 @@ search_aliases:
- azure repos
- service catalog
related_resources:
- text: "{{site.konnect_catalog}}"
url: /catalog/
- text: "{{site.konnect_catalog}} Classic"
url: /catalog-classic/
- text: Integrations
url: /catalog/integrations/
- text: Azure DevOps reference
Expand All @@ -26,7 +26,7 @@ related_resources:
automated_tests: false
tldr:
q: How do I connect an Azure DevOps repository to a service in {{site.konnect_short_name}}?
a: Configure the Azure DevOps integration with your organization name and PAT, create a {{site.konnect_catalog}} service, then map the discovered Azure DevOps repository resource to that {{site.konnect_catalog}} service.
a: Configure the Azure DevOps integration with your organization name and PAT, create a {{site.konnect_catalog}} Classic service, then map the discovered Azure DevOps repository resource to that {{site.konnect_catalog}} Classic service.
prereqs:
skip_product: true
inline:
Expand All @@ -43,9 +43,11 @@ prereqs:
> Your PAT can be created with an expiration period of your choice, up to a maximum of one year. Make sure to renew the PAT before it expires to avoid interruptions.
---

{% include_cached catalog/catalog-classic-banner.md %}

## Configure the Azure DevOps integration

Before you can discover Azure DevOps repositories in {{site.konnect_catalog}}, you must configure the integration:
Before you can discover Azure DevOps repositories in {{site.konnect_catalog}} Classic, you must configure the integration:

1. In the {{site.konnect_short_name}} sidebar, click **Catalog**.
1. In the {{site.konnect_catalog}} sidebar, click **Integrations**.
Expand All @@ -60,9 +62,9 @@ Before you can discover Azure DevOps repositories in {{site.konnect_catalog}}, y

If you don't immediately see resources, try manually syncing your Azure DevOps integration. From the {{site.konnect_short_name}} UI, navigate to the Azure DevOps integration that you just installed. Then, from the **Actions** dropdown menu, select **Sync Now**.

## Create a {{site.konnect_catalog}} service and map the Azure DevOps resources
## Create a {{site.konnect_catalog}} Classic service and map the Azure DevOps resources

After you configure the Azure DevOps integration, create a service in {{site.konnect_catalog}} and map an Azure DevOps repository resource to it.
After you configure the Azure DevOps integration, create a service in {{site.konnect_catalog}} Classic and map an Azure DevOps repository resource to it.

{:.info}
> In this tutorial, we’ll refer to your Azure DevOps repository as `azure-devops-repository`.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Discover and govern APIs with Catalog
title: Discover and govern APIs with {{site.konnect_catalog}} Classic
permalink: /how-to/discover-and-govern-apis-with-service-catalog/
content_type: how_to
description: Learn how to discover APIs in AWS API Gateway, SwaggerHub, and GitHub with {{site.konnect_catalog}} and govern them with scorecards.
description: Learn how to discover APIs in AWS API Gateway, SwaggerHub, and GitHub with {{site.konnect_catalog}} Classic and govern them with scorecards.
products:
- catalog
works_on:
Expand All @@ -15,8 +15,8 @@ entities:
search_aliases:
- service catalog
related_resources:
- text: "{{site.konnect_catalog}}"
url: /catalog/
- text: "{{site.konnect_catalog}} Classic"
url: /catalog-classic/
- text: Integrations
url: /catalog/integrations/
- text: AWS API Gateway reference
Expand All @@ -27,12 +27,12 @@ automated_tests: false
tldr:
q: How do I discover and govern third-party APIs in {{site.konnect_short_name}}?
a: |
{{site.konnect_catalog}} allows you to find and centrally view all APIs from these integrations and map them to a {{site.konnect_catalog}} service. First, authorize the integrations in {{site.konnect_catalog}} for AWS API Gateway, GitHub, and SwaggerHub. Then, create a {{site.konnect_catalog}} service and map resources from the integrations to the service. Finally, add a service documentation scorecard to your service to govern API documentation standards.
{{site.konnect_catalog}} Classic allows you to find and centrally view all APIs from these integrations and map them to a {{site.konnect_catalog}} Classic service. First, authorize the integrations in {{site.konnect_catalog}} Classic for AWS API Gateway, GitHub, and SwaggerHub. Then, create a {{site.konnect_catalog}} Classic service and map resources from the integrations to the service. Finally, add a service documentation scorecard to your service to govern API documentation standards.
prereqs:
inline:
- title: "{{site.konnect_short_name}} roles"
content: |
To configure {{site.konnect_catalog}} integrations, services, and scorecards, you need the following [roles in {{site.konnect_short_name}}](/konnect-platform/teams-and-roles/#service-catalog):
To configure {{site.konnect_catalog}} Classic integrations, services, and scorecards, you need the following [roles in {{site.konnect_short_name}}](/konnect-platform/teams-and-roles/#service-catalog):
* Integration Admin
* Scorecard Admin
* Service Admin
Expand All @@ -47,7 +47,7 @@ prereqs:
icon_url: /assets/icons/third-party/swaggerhub.svg
- title: GitHub
content: |
To integrate GitHub with {{site.konnect_catalog}}, you need the following:
To integrate GitHub with {{site.konnect_catalog}} Classic, you need the following:
* Sufficient permissions in GitHub to authorize third-party applications and install the {{site.konnect_short_name}} GitHub App
* A GitHub organization
* A repository that you want to pull in to {{site.konnect_short_name}}. You can grant access to either all repositories or selected repositories during the authorization process. You can name your GitHub repository whatever you'd like. In this tutorial, we'll refer to your GitHub repository as `github-repo`.
Expand All @@ -58,11 +58,13 @@ tools:
- deck
---

{% include_cached catalog/catalog-classic-banner.md %}

## Configure the AWS API Gateway, GitHub, and SwaggerHub integrations

In this tutorial, we'll be discovering APIs and API specs from AWS API Gateway, GitHub, and SwaggerHub in {{site.konnect_catalog}}. {{site.konnect_catalog}} allows you to find and centrally view all APIs from these integrations and map them to a {{site.konnect_catalog}} service.
In this tutorial, we'll be discovering APIs and API specs from AWS API Gateway, GitHub, and SwaggerHub in {{site.konnect_catalog}} Classic. {{site.konnect_catalog}} Classic allows you to find and centrally view all APIs from these integrations and map them to a {{site.konnect_catalog}} Classic service.

Before you can discover APIs in {{site.konnect_catalog}}, you must configure the third-party integrations.
Before you can discover APIs in {{site.konnect_catalog}} Classic, you must configure the third-party integrations.

### Configure the AWS API Gateway integration

Expand Down Expand Up @@ -91,9 +93,9 @@ The {{site.konnect_short_name}} application can be managed from GitHub as a [Git
1. In the **Instance name** field, enter `swaggerhub-test`.
1. Click **Save**.

## Create a {{site.konnect_catalog}} service and map the API resources
## Create a {{site.konnect_catalog}} Classic service and map the API resources

Now that your integrations are configured, you can create a {{site.konnect_catalog}} service to map the ingested APIs.
Now that your integrations are configured, you can create a {{site.konnect_catalog}} Classic service to map the ingested APIs.

{:.info}
> In this tutorial, we'll refer to your ingested resources like the following:
Expand All @@ -113,11 +115,11 @@ Now that your integrations are configured, you can create a {{site.konnect_catal
1. Select `github-repo`.
1. Click **Map 3 Resources**.

Your integration APIs are now discoverable from one {{site.konnect_catalog}} service.
Your integration APIs are now discoverable from one {{site.konnect_catalog}} Classic service.

## Govern the APIs with scorecards

Now that you've discovered and mapped the APIs to a {{site.konnect_catalog}} service, you can govern the service documentation of these ingested APIs with a [scorecard](/catalog/scorecards/). The built-in service documentation scorecard will alert you when your APIs don't adhere to [API documentation best practices](/catalog/scorecards/#service-documentation-linting).
Now that you've discovered and mapped the APIs to a {{site.konnect_catalog}} Classic service, you can govern the service documentation of these ingested APIs with a [scorecard](/catalog/scorecards/). The built-in service documentation scorecard will alert you when your APIs don't adhere to [API documentation best practices](/catalog/scorecards/#service-documentation-linting).

1. In the {{site.konnect_short_name}} sidebar, click [**Catalog**](https://cloud.konghq.com/service-catalog/).
1. In the Catalog sidebar, click **Scorecards**.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Discover AWS Gateway APIs in Catalog with the Konnect API
title: Discover AWS Gateway APIs in {{site.konnect_catalog}} Classic with the Konnect API
permalink: /how-to/discover-aws-gateway-apis-using-konnect-api/
content_type: how_to
description: Learn how to connect an AWS Gateway API to your {{site.konnect_catalog}} service in {{site.konnect_short_name}} using the API.
description: Learn how to connect an AWS Gateway API to your {{site.konnect_catalog}} Classic service in {{site.konnect_short_name}} using the API.
products:
- catalog
works_on:
Expand All @@ -15,20 +15,20 @@ tags:
search_aliases:
- service catalog
related_resources:
- text: "{{site.konnect_catalog}}"
url: /catalog/
- text: "{{site.konnect_catalog}} Classic"
url: /catalog-classic/
- text: Integrations
url: /catalog/integrations/
- text: AWS API Gateway reference
url: /catalog/integrations/aws-api-gateway/
- text: "Discover AWS Gateway APIs in {{site.konnect_catalog}} with the {{site.konnect_short_name}} UI"
- text: "Discover AWS Gateway APIs in {{site.konnect_catalog}} Classic with the Konnect UI"
url: /how-to/discover-aws-gateway-apis-using-konnect-ui/
- text: Discover and govern APIs with {{site.konnect_catalog}}
url: /how-to/discover-and-govern-apis-with-service-catalog/
automated_tests: false
tldr:
q: How do I discover AWS API Gateway API in {{site.konnect_short_name}}?
a: Install the AWS API Gateway integration in {{site.konnect_short_name}} and authorize access with your {{site.konnect_catalog}} role ARN, then link an API to your {{site.konnect_catalog}} service.
a: Install the AWS API Gateway integration in {{site.konnect_short_name}} and authorize access with your {{site.konnect_catalog}} Classic role ARN, then link an API to your {{site.konnect_catalog}} Classic service.
prereqs:
inline:
- title: "{{site.konnect_short_name}} roles"
Expand All @@ -39,13 +39,15 @@ prereqs:
icon_url: /assets/icons/aws.svg
---

{% include_cached catalog/catalog-classic-banner.md %}

## Configure the AWS API Gateway integration

Before you can discover APIs in {{site.konnect_catalog}}, you must configure the AWS API Gateway integration.
Before you can discover APIs in {{site.konnect_catalog}} Classic, you must configure the AWS API Gateway integration.

{% include /catalog/aws-api-gateway-integration.md %}

## Create a service in {{site.konnect_catalog}}
## Create a service in {{site.konnect_catalog}} Classic

Create a service that you'll map to your AWS API Gateway resources:

Expand All @@ -69,7 +71,7 @@ export AWS_SERVICE_ID='YOUR-SERVICE-ID'

## List AWS API Gateway resources

Before you can map your AWS API Gateway resources to a service in {{site.konnect_catalog}}, you first need to find the resources that are pulled in from AWS API Gateway:
Before you can map your AWS API Gateway resources to a service in {{site.konnect_catalog}} Classic, you first need to find the resources that are pulled in from AWS API Gateway:

<!--vale off-->
{% konnect_api_request %}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Discover AWS Gateway APIs in Catalog with the Konnect UI
title: Discover AWS Gateway APIs in {{site.konnect_catalog}} Classic with the Konnect UI
permalink: /how-to/discover-aws-gateway-apis-using-konnect-ui/
content_type: how_to
description: Learn how to connect an AWS Gateway API to your {{site.konnect_catalog}} service in {{site.konnect_short_name}} using the UI.
description: Learn how to connect an AWS Gateway API to your {{site.konnect_catalog}} Classic service in {{site.konnect_short_name}} using the UI.
products:
- catalog
works_on:
Expand All @@ -15,20 +15,20 @@ tags:
search_aliases:
- service catalog
related_resources:
- text: "{{site.konnect_catalog}}"
url: /catalog/
- text: "{{site.konnect_catalog}} Classic"
url: /catalog-classic/
- text: Integrations
url: /catalog/integrations/
- text: AWS API Gateway reference
url: /catalog/integrations/aws-api-gateway/
- text: "Discover AWS Gateway APIs in {{site.konnect_catalog}} with the {{site.konnect_short_name}} API"
- text: "Discover AWS Gateway APIs in {{site.konnect_catalog}} Classic with the Konnect API"
url: /how-to/discover-aws-gateway-apis-using-konnect-api/
- text: Discover and govern APIs with {{site.konnect_catalog}}
url: /how-to/discover-and-govern-apis-with-service-catalog/
automated_tests: false
tldr:
q: How do I discover AWS API Gateway API in {{site.konnect_short_name}}?
a: Install the AWS API Gateway integration in {{site.konnect_short_name}} and authorize access with your {{site.konnect_catalog}} role ARN, then link an API to your {{site.konnect_catalog}} service.
a: Install the AWS API Gateway integration in {{site.konnect_short_name}} and authorize access with your {{site.konnect_catalog}} Classic role ARN, then link an API to your {{site.konnect_catalog}} Classic service.
prereqs:
inline:
- title: "{{site.konnect_short_name}} roles"
Expand All @@ -39,15 +39,17 @@ prereqs:
icon_url: /assets/icons/aws.svg
---

{% include_cached catalog/catalog-classic-banner.md %}

## Configure the AWS API Gateway integration

Before you can discover APIs in {{site.konnect_catalog}}, you must configure the AWS API Gateway integration.
Before you can discover APIs in {{site.konnect_catalog}} Classic, you must configure the AWS API Gateway integration.

{% include /catalog/aws-api-gateway-integration.md %}

## Create a {{site.konnect_catalog}} service and map the API resources
## Create a {{site.konnect_catalog}} Classic service and map the API resources

Now that your integration is configured, you can create a {{site.konnect_catalog}} service to map the ingested APIs.
Now that your integration is configured, you can create a {{site.konnect_catalog}} Classic service to map the ingested APIs.

{:.info}
> In this tutorial, we'll refer to your ingested AWS API Gateway API as `aws-api`.
Expand All @@ -62,7 +64,7 @@ Now that your integration is configured, you can create a {{site.konnect_catalog
1. Select `aws-api`.
1. Click **Map 1 Resource**.

Your integration APIs are now discoverable from one {{site.konnect_catalog}} service.
Your integration APIs are now discoverable from one {{site.konnect_catalog}} Classic service.

{:.info}
> You might need to manually sync your AWS API Gateway integration for resources to appear. In the {{site.konnect_short_name}} UI, by navigate to the AWS API Gateway integration you just installed and select **Sync Now** from the **Actions** dropdown menu.
Expand Down
Loading
Loading