Skip to content

Commit 4e06bad

Browse files
authored
SEI-14315 Update SEI Azure DevOps Integration Documentation (#11659)
* SEI-14315 * SME Review
1 parent b1b5539 commit 4e06bad

File tree

1 file changed

+30
-23
lines changed

1 file changed

+30
-23
lines changed

docs/software-engineering-insights/shared/integrations/azure-devops.mdx

Lines changed: 30 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Azure DevOps Services is a cloud offering. To integrate with the on-premises off
1616

1717
### Requirements
1818

19-
The following permissions and settings are required to use the **SEI AzureDevOps Services integration**:
19+
The following permissions and settings are required to use the **SEI Azure DevOps Services integration**:
2020

2121
<Tabs>
2222
<TabItem value = "OAuth" label = "OAuth" default>
@@ -32,22 +32,26 @@ The following permissions and settings are required to use the **SEI AzureDevOps
3232
</TabItem>
3333
<TabItem value = "PAT" label = "Personal Access Token">
3434

35-
Before you configure the **SEI AzureDevOps integration**, you must generate a **Personal Access Token**.
35+
Before you configure the **SEI Azure DevOps integration**, you must generate a **Personal Access Token**.
3636

37-
1. Sign in to your **Azure DevOps organization** with **Microsoft account** using the following url: `https://dev.azure.com/{yourorganisation}`.
37+
The SEI Azure DevOps integration only ingests projects accessible to the provided token. If access changes later, ingestion for those projects will stop until access is restored.
38+
39+
1. Sign in to your **Azure DevOps organization** with your **Microsoft account** using the following URL: `https://dev.azure.com/{yourorganisation}`.
3840
2. Navigate to your **User Settings**:
39-
1. Click on your profile picture in the top right corner.
40-
2. Select **Security** from the dropdown menu.
41-
3. Under **Personal Access Tokens**, click on the **+ New Token** button.
41+
42+
- Click on your profile picture in the top right corner.
43+
- Select **Security** from the dropdown menu.
44+
- Under **Personal Access Tokens**, click on the **+ New Token** button.
45+
4246
3. In the **Organization** dropdown, select **All accessible organizations**.
4347

44-
:::info
45-
Due to a limitation in Azure DevOps, the PAT token must be configured with the All accessible organizations scope to ensure Harness can retrieve the user data
46-
:::
48+
:::info
49+
Due to a limitation in Azure DevOps, the PAT token must be configured with the All accessible organizations scope to ensure Harness can retrieve the user data.
50+
:::
4751

4852
4. Configure the **Scopes** by choosing the required level of access for the token as given below.
4953

50-
<img src={adoPatPermissions} alt="Permissions for an Azure DevOps for the PAT token" width="1000" />
54+
<img src={adoPatPermissions} alt="Permissions for an Azure DevOps for the PAT token" width="1000" />
5155

5256
</TabItem>
5357
</Tabs>
@@ -94,30 +98,32 @@ To ensure your integration can work correctly, refer to the list of [Harness Pla
9498
* The **Description** and **Tags** are optional.
9599
* Add the **Personal Access Token** you previously generated in Azure DevOps.
96100

97-
<img src={adoPat} alt="Add the Azure DevOps PAT" width="1000" />
101+
<img src={adoPat} alt="Add the Azure DevOps PAT" width="1000" />
98102

99103
* Select the specific Azure DevOps services you want to integrate:
100104
* Azure Boards
101105
* Azure Pipelines
102106
* Azure Repos
103107

104-
<img src={adoServices} alt="Add Azure DevOps Services Services" width="1000" />
108+
<img src={adoServices} alt="Add Azure DevOps Services Services" width="1000" />
105109

106110
* Click on **Validate Connection** to validate the connection, and once successful, you'll have the integration set up under the **Your Integrations** tab.
107111

108-
:::info
109-
Different integrations will be automatically created for all the Azure DevOps services.
112+
:::info
113+
Different integrations will be automatically created for all the Azure DevOps services.
110114

111-
For example:
115+
For example:
112116

113-
* Azure integration - Boards for Azure Boards
114-
* Azure integration - Pipelines for Azure DevOps Pipelines
115-
* Azure integration - Repos for Azure DevOps Repos
116-
:::
117+
* Azure integration - Boards for Azure Boards
118+
* Azure integration - Pipelines for Azure DevOps Pipelines
119+
* Azure integration - Repos for Azure DevOps Repos
120+
:::
117121

118122
</TabItem>
119123
</Tabs>
120124

125+
After adding the integration, it may take up to 24 hours for data to fully sync to SEI. During this time, any widgets you set up in Insights may not display data until the sync is complete.
126+
121127
### Limitations
122128

123129
1. The Azure DevOps integration currently ingests and retains data for the last 90 days.
@@ -129,10 +135,11 @@ For example:
129135
* CICD Pipeline Jobs Duration Report
130136
* CICD Pipeline Jobs Duration Trend Report
131137
4. The integration does not accurately reflect the pipeline stage status across the widgets.
132-
133-
:::note
134-
After adding the integration, it may take up to 24 hours for data to fully sync to SEI. During this time, any widgets you set up in Insights may not display data until the sync is complete.
135-
:::
138+
5. If the access token used for the integration loses access to some projects (i.e. when projects are removed or permissions change), SEI will stop ingesting data from those projects. Data ingestion continues for the remaining accessible projects.
139+
140+
If project access is restored later, ingestion resumes **incrementally** for the newly accessible projects. Historical data will not be backfilled automatically, since SEI has no reference point for when to start ingestion.
141+
142+
To capture historical data for newly added projects, contact [Harness Support](/docs/software-engineering-insights/sei-support) to schedule a manual ingestion re-run for the selected projects.
136143

137144
### See also
138145

0 commit comments

Comments
 (0)