Skip to content

Commit 4eb4fa8

Browse files
author
TuannasCodeCatastrophe
committed
draft needs codeblocks and icon
1 parent 28ef155 commit 4eb4fa8

File tree

4 files changed

+277
-0
lines changed

4 files changed

+277
-0
lines changed

‎app/_how-tos/connect-azure-devops-to-the-konnect-catalog-with-the-konnect-api.md‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
---
2+
title: Connect Azure DevOps repositories to Catalog with the Konnect API
3+
content_type: how_to
4+
description: Learn how to connect Azure DevOps repositories to your {{site.konnect_catalog}} services in {{site.konnect_short_name}} using the Konnect API.
5+
products:
6+
- catalog
7+
works_on:
8+
- konnect
9+
tools:
10+
- konnect-api
11+
tags:
12+
- integrations
13+
- azure-devops
14+
search_aliases:
15+
- azure repos
16+
- devops
17+
- service catalog
18+
related_resources:
19+
- text: "{{site.konnect_catalog}}"
20+
url: /catalog/
21+
- text: Integrations
22+
url: /catalog/integrations/
23+
- text: Azure DevOps reference
24+
url: /catalog/integrations/azure-devops/
25+
- text: "Connect Azure DevOps repositories to Catalog with the Konnect UI"
26+
url: /how-to/connect-azure-devops-with-konnect-ui/
27+
automated_tests: false
28+
tldr:
29+
q: How do I connect Azure DevOps to {{site.konnect_short_name}} using the API?
30+
a: Use the Konnect Integrations API to create and authorize an Azure DevOps integration instance with your organization name and PAT, then map an ingested repository to a {{site.konnect_catalog}} service.
31+
prereqs:
32+
inline:
33+
- title: "{{site.konnect_short_name}} roles"
34+
include_content: prereqs/service-catalog-integration-role
35+
icon_url: /assets/icons/kogo-white.svg
36+
- title: Create and configure an Azure account
37+
content: |
38+
You need to configure the following in Azure DevOps:
39+
- An [Azure DevOps account](https://azure.microsoft.com/en-gb/pricing/purchase-options/azure-account?icid=devops).
40+
- An [Azure DevOps personal access token (PAT)](https://learn.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops&tabs=Windows) with `Code: Read` permission.
41+
{:.info}
42+
> Your PAT expires after one year. Make sure that you renew it after it expires.
43+
---
44+
45+
## Configure the Azure DevOps integration
46+
47+
Before you can discover Azure DevOps repositories in Catalog, you must configure the integration:
48+
49+
[insert codeblock]
50+
51+
Export the ID of your Azure DevOps integration:
52+
53+
[insert codeblock]
54+
55+
Next, authorize the integration with your Azure DevOps PAT:
56+
57+
[insert codeblock]
58+
59+
Once authorized, resources from your Azure DevOps account will be discoverable in the UI.
60+
61+
## Create a Service in Catalog
62+
63+
Create a service that you’ll map to your Azure DevOps resources:
64+
65+
[insert codeblock]
66+
67+
Export the service ID:
68+
69+
[insert codeblock]
70+
71+
## List Azure Dev Ops resources
72+
73+
Before you can map your Azure DevOps resources to a service in {{site.konnect_catalog}}, you first need to find the resources that are pulled in from Azure DevOps:
74+
75+
[insert codeblock]
76+
77+
{:.info}
78+
> If you don't immediately see resources, you might need to manually sync 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**.
79+
80+
Export the resource ID you want to map to the service:
81+
82+
[insert codeblock]
83+
84+
## Map resources to a service
85+
86+
Now, map the Azure DevOps resource to the service:
87+
88+
[insert codeblock]
89+
90+
## Validate the mapping
91+
92+
To confirm that the Azure DevOps resource is now mapped to the intended service, list the service’s mapped resources:
93+
94+
[insert codeblock]

‎app/_how-tos/connect-azure-devops-to-the-konnect-catalog-with-the-konnect-ui.md‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
---
2+
title: Connect Azure DevOps repositories to Catalog with the {{site.konnect_short_name}} UI
3+
content_type: how_to
4+
description: Learn how to connect Azure DevOps repositories to your {{site.konnect_catalog}} services in {{site.konnect_short_name}} using the UI.
5+
products:
6+
- catalog
7+
works_on:
8+
- konnect
9+
tags:
10+
- integrations
11+
- azure-devops
12+
search_aliases:
13+
- devops
14+
- azure repos
15+
- service catalog
16+
related_resources:
17+
- text: "{{site.konnect_catalog}}"
18+
url: /catalog/
19+
- text: Integrations
20+
url: /catalog/integrations/
21+
- text: Azure DevOps reference
22+
url: /catalog/integrations/azure-devops/
23+
- text: "Connect Azure DevOps repositories to Catalog with the Konnect API"
24+
url: /how-to/connect-azure-devops-with-konnect-api/
25+
automated_tests: false
26+
tldr:
27+
q: How do I connect Azure DevOps repositories to {{site.konnect_short_name}}?
28+
a: Install the Azure DevOps integration in {{site.konnect_short_name}}, authorize it with a Personal Access Token (PAT) that has Code → Read access, then map an Azure DevOps repository to your {{site.konnect_catalog}} service.
29+
prereqs:
30+
inline:
31+
- title: "{{site.konnect_short_name}} roles"
32+
include_content: prereqs/service-catalog-integration-role
33+
icon_url: /assets/icons/kogo-white.svg
34+
- title: Create and configure an Azure account
35+
content: |
36+
You need to configure the following in Azure DevOps:
37+
- An [Azure DevOps account](https://azure.microsoft.com/en-gb/pricing/purchase-options/azure-account?icid=devops).
38+
- An [Azure DevOps personal access token (PAT)](https://learn.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops&tabs=Windows) with `Code: Read` permission.
39+
{:.info}
40+
> Your PAT expires after one year. Make sure that you renew it after it expires.
41+
---
42+
43+
## Configure the Azure DevOps integration
44+
45+
Before you can discover Azure DevOps repositories in Catalog, you must configure the integration:
46+
47+
1. In the {{site.konnect_short_name}} sidebar, click **Catalog**.
48+
1. In the Catalog sidebar, click **Integrations**.
49+
1. Click **Azure DevOps**.
50+
1. Click **Add Azure DevOps instance**.
51+
1. In the **Azure DevOps organization name** field, enter your organization name exactly as it is in Azure DevOps.
52+
1. In the **Azure DevOps personal access token (PAT)** field, enter your Azure DevOps token.
53+
1. (Optional) In the **Description** field, enter a description for this instance.
54+
1. Click **Save**.
55+
56+
## Create a catalog service and map the Azure DevOps resources
57+
58+
1. In the {{site.konnect_short_name}} sidebar, click **Catalog**.
59+
1. In the Catalog sidebar, click **Services**.
60+
1. Click **New service**.
61+
1. In the **Display Name** field, enter `user-service`.
62+
1. Click **Create**.
63+
1. Click **Map Resources**.
64+
1. Select `user-service`.
65+
66+
## Validate the mapping
67+
To confirm that the Azure DevOps resource is now mapped to the intended service, navigate to the new service:
68+
1. In the {{site.konnect_short_name}} sidebar, click **Catalog**.
69+
1. In the Catalog sidebar, click **Services**.
70+
1. Click the `user-service` service.
71+
1. Click the **Resources** tab.
72+
73+
You'll see the `user-service` resource listed.

‎app/_landing_pages/catalog/integrations.yaml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,20 @@ rows:
150150
url: "/how-to/monitor-dynatrace-slos-with-konnect-api/"
151151
- text: Tutorial ({{site.konnect_short_name}} UI)
152152
url: "/how-to/monitor-dynatrace-slos-with-konnect-ui/"
153+
154+
- blocks:
155+
- type: card
156+
config:
157+
title: Azure DevOps
158+
description: Connect Azure DevOps repositories directly to your {{site.konnect_catalog}} services.
159+
icon: /assets/icons/third-party/azure-devops.png
160+
ctas:
161+
- text: Reference
162+
url: "/catalog/integrations/azure-devops/"
163+
- text: Tutorial ({{site.konnect_short_name}} API)
164+
url: "/how-to/connect-azure-devops-to-the-konnect-catalog-with-the-konnect-api/"
165+
- text: Tutorial ({{site.konnect_short_name}} UI)
166+
url: "/how-to/connect-azure-devops-to-the-konnect-catalog-with-the-konnect-ui/"
153167

154168
- header:
155169
type: h2

‎app/catalog/integrations/azure-devops.md‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
---
2+
title: "Azure DevOps"
3+
content_type: reference
4+
layout: reference
5+
icon: /assets/icons/third-party/azuredevops.png
6+
7+
products:
8+
- catalog
9+
- gateway
10+
11+
tags:
12+
- integrations
13+
- azuredevops
14+
search_aliases:
15+
- service catalog
16+
breadcrumbs:
17+
- /catalog/
18+
- /catalog/integrations/
19+
20+
works_on:
21+
- konnect
22+
description:
23+
24+
related_resources:
25+
- text: "{{site.konnect_catalog}}"
26+
url: /catalog/
27+
- text: "Connect Azure DevOps repositories to Catalog with the Konnect API"
28+
url: /how-to/connect-azure-devops-to-the-konnect-catalog-with-the-konnect-api/
29+
- text: "Connect Azure DevOps repositories to Catalog with the Konnect UI"
30+
url: /how-to/connect-azure-devops-to-the-konnect-catalog-with-the-konnect-ui/
31+
---
32+
33+
The Azure DevOps integration lets Konnect Catalog securely read and ingest repository metadata from Azure DevOps using a PAT with `Code: Read` access. Teams can reference and manage their source-code assets inside {{site.konnect_catalog}} and prepare for future governance and scorecard workflows.
34+
35+
For a complete tutorial, choose one of the following:
36+
- [Connect Azure DevOps repositories to Catalog with the Konnect API](/how-to/connect-azure-devops-to-the-konnect-catalog-with-the-konnect-api/)
37+
- [Connect Azure DevOps repositories to Catalog with the Konnect UI](/how-to/connect-azure-devops-to-the-konnect-catalog-with-the-konnect-ui/)
38+
39+
### Prerequisites
40+
You need to configure the following:
41+
- An [Azure DevOps account](https://azure.microsoft.com/en-gb/pricing/purchase-options/azure-account?icid=devops)
42+
- An [Azure DevOps personal access token (PAT)]([Azure DevOps personal access token (PAT)](https://learn.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops&tabs=Windows) with `Code: Read` permission.
43+
44+
### Configure the integration
45+
{% navtabs "azure-devops-integration" %}
46+
{% navtab "UI" %}
47+
48+
1. In the Konnect sidebar, click **Catalog**.
49+
1. In the Catalog sidebar, click **Integrations**.
50+
1. Click **Azure DevOps**.
51+
1. Click **Add Azure DevOps instance**.
52+
1. In the **Azure DevOps organization name** field, enter your organization name exactly as it is in Azure DevOps.
53+
1. In the **Azure DevOps personal access token (PAT)** field, enter your Azure DevOps token.
54+
1. (Optional) In the **Description** field, enter a description for this instance.
55+
1. Click **Save**.
56+
57+
{% endnavtab %}
58+
{% navtab "API" %}
59+
60+
[insert]
61+
62+
{% endnavtab %}
63+
{% navtab "Terraform" %}
64+
65+
[insert]
66+
67+
{% endnavtab %}
68+
{% endnavtabs %}
69+
70+
For additional Azure DevOps resources, use the following table:
71+
72+
{% table %}
73+
columns:
74+
- title: Entity
75+
key: entity
76+
- title: Description
77+
key: description
78+
rows:
79+
- entity: "OAuth 2.0 Scopes"
80+
description: "Define and control the specific resources an OAuth application can access in Azure DevOps by requesting granular scopes."
81+
- entity: "Personal Access Tokens (PATs)"
82+
description: "Authenticate with Azure DevOps by generating a time-limited token that grants scoped access, follow least-privilege practices by selecting only required permissions, and store the token securely to prevent misuse."
83+
{% endtable %}
84+
85+
86+
## Discovery information
87+
88+
<!-- vale off-->
89+
90+
{% include_cached catalog/service-catalog-discovery.html
91+
discovery_support=page.discovery_support
92+
discovery_default=page.discovery_default
93+
bindable_entities=page.bindable_entities
94+
mechanism=page.mechanism %}
95+
96+
<!-- vale on-->

0 commit comments

Comments
 (0)