mirror of
https://github.com/awatertrevi/infisical.git
synced 2026-09-22 13:39:35 +00:00
feat(secret-sync): Add Azure Devops docs
This commit is contained in:
carlosmonastyrski
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Available"
|
||||
openapi: "GET /api/v1/app-connections/azure-devops/available"
|
||||
---
|
||||
@@ -0,0 +1,10 @@
|
||||
---
|
||||
title: "Create"
|
||||
openapi: "POST /api/v1/app-connections/azure-devops"
|
||||
---
|
||||
|
||||
<Note>
|
||||
Azure DevOps Connections must be created through the Infisical UI if you are using OAuth.
|
||||
Check out the configuration docs for [Azure DevOps Connections](/integrations/app-connections/azure-devops) for a step-by-step
|
||||
guide.
|
||||
</Note>
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Delete"
|
||||
openapi: "DELETE /api/v1/app-connections/azure-devops/{connectionId}"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Get by ID"
|
||||
openapi: "GET /api/v1/app-connections/azure-devops/{connectionId}"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Get by Name"
|
||||
openapi: "GET /api/v1/app-connections/azure-devops/connection-name/{connectionName}"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "List"
|
||||
openapi: "GET /api/v1/app-connections/azure-devops"
|
||||
---
|
||||
@@ -0,0 +1,10 @@
|
||||
---
|
||||
title: "Update"
|
||||
openapi: "PATCH /api/v1/app-connections/azure-devops/{connectionId}"
|
||||
---
|
||||
|
||||
<Note>
|
||||
Azure DevOps Connections must be updated through the Infisical UI if you are using OAuth.
|
||||
Check out the configuration docs for [Azure DevOps Connections](/integrations/app-connections/azure-devops) for a step-by-step
|
||||
guide.
|
||||
</Note>
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Create"
|
||||
openapi: "POST /api/v1/secret-syncs/azure-devops"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Delete"
|
||||
openapi: "DELETE /api/v1/secret-syncs/azure-devops/{syncId}"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Get by ID"
|
||||
openapi: "GET /api/v1/secret-syncs/azure-devops/{syncId}"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Get by Name"
|
||||
openapi: "GET /api/v1/secret-syncs/azure-devops/sync-name/{syncName}"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Import Secrets"
|
||||
openapi: "POST /api/v1/secret-syncs/azure-devops/{syncId}/import-secrets"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "List"
|
||||
openapi: "GET /api/v1/secret-syncs/azure-devops"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Remove Secrets"
|
||||
openapi: "POST /api/v1/secret-syncs/azure-devops/{syncId}/remove-secrets"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Sync Secrets"
|
||||
openapi: "POST /api/v1/secret-syncs/azure-devops/{syncId}/sync-secrets"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Update"
|
||||
openapi: "PATCH /api/v1/secret-syncs/azure-devops/{syncId}"
|
||||
---
|
||||
BIN
docs/images/app-connections/azure/devops/devops-connection.png
Normal file
BIN
docs/images/app-connections/azure/devops/devops-connection.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.8 MiB |
Binary file not shown.
|
After Width: | Height: | Size: 2.1 MiB |
Binary file not shown.
|
After Width: | Height: | Size: 2.1 MiB |
BIN
docs/images/app-connections/azure/devops/select-connection.png
Normal file
BIN
docs/images/app-connections/azure/devops/select-connection.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 2.3 MiB |
BIN
docs/images/integrations/azure-devops/app-api-permissions.png
Normal file
BIN
docs/images/integrations/azure-devops/app-api-permissions.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.8 MiB |
BIN
docs/images/secret-syncs/azure-devops/devops-destination.png
Normal file
BIN
docs/images/secret-syncs/azure-devops/devops-destination.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 202 KiB |
BIN
docs/images/secret-syncs/azure-devops/devops-details.png
Normal file
BIN
docs/images/secret-syncs/azure-devops/devops-details.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 202 KiB |
BIN
docs/images/secret-syncs/azure-devops/devops-options.png
Normal file
BIN
docs/images/secret-syncs/azure-devops/devops-options.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 220 KiB |
BIN
docs/images/secret-syncs/azure-devops/devops-review.png
Normal file
BIN
docs/images/secret-syncs/azure-devops/devops-review.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 214 KiB |
BIN
docs/images/secret-syncs/azure-devops/devops-source.png
Normal file
BIN
docs/images/secret-syncs/azure-devops/devops-source.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 195 KiB |
BIN
docs/images/secret-syncs/azure-devops/devops-synced.png
Normal file
BIN
docs/images/secret-syncs/azure-devops/devops-synced.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 294 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 235 KiB |
137
docs/integrations/app-connections/azure-devops.mdx
Normal file
137
docs/integrations/app-connections/azure-devops.mdx
Normal file
@@ -0,0 +1,137 @@
|
||||
---
|
||||
title: "Azure DevOps Connection"
|
||||
description: "Learn how to configure an Azure DevOps Connection for Infisical."
|
||||
---
|
||||
|
||||
Infisical currently supports two methods for connecting to Azure DevOps, which are OAuth and Azure DevOps API Token.
|
||||
|
||||
<Accordion title="Self-Hosted Instance">
|
||||
Using the Azure DevOps OAuth connection on a self-hosted instance of Infisical requires configuring an application in Azure
|
||||
and registering your instance with it.
|
||||
|
||||
**Prerequisites:**
|
||||
|
||||
- Set up Azure.
|
||||
|
||||
<Steps>
|
||||
<Step title="Create an application in Azure">
|
||||
Navigate to Azure Active Directory > App registrations to create a new application.
|
||||
|
||||
<Info>
|
||||
Azure Active Directory is now Microsoft Entra ID.
|
||||
</Info>
|
||||
|
||||
|
||||
|
||||
Create the application. As part of the form, set the **Redirect URI** to `https://your-domain.com/organization/app-connections/azure/oauth/callback`.
|
||||
<Tip>
|
||||
The domain you defined in the Redirect URI should be equivalent to the `SITE_URL` configured in your Infisical instance.
|
||||
</Tip>
|
||||
|
||||
|
||||
</Step>
|
||||
<Step title="Assign API permissions to the application">
|
||||
|
||||
For the Azure Connection to work with DevOps Pipelines, you need to assign the following permission to the application.
|
||||
|
||||
#### Azure DevOps permissions
|
||||
|
||||
Set the API permissions of the Azure application to include the following permissions:
|
||||
- Azure DevOps
|
||||
- `user_impersonation`
|
||||
- `vso.project_write`
|
||||
- `vso.variablegroups_manage`
|
||||
- `vso.variablegroups_write`
|
||||
|
||||
|
||||
|
||||
|
||||
</Step>
|
||||
<Step title="Add your application credentials to Infisical">
|
||||
Obtain the **Application (Client) ID** and **Directory (Tenant) ID** (this will be used later in the Infisical connection) in Overview and generate a **Client Secret** in Certificate & secrets for your Azure application.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Back in your Infisical instance, add two new environment variables for the credentials of your Azure application.
|
||||
|
||||
- `INF_APP_CONNECTION_AZURE_CLIENT_ID`: The **Application (Client) ID** of your Azure application.
|
||||
- `INF_APP_CONNECTION_AZURE_CLIENT_SECRET`: The **Client Secret** of your Azure application.
|
||||
|
||||
Once added, restart your Infisical instance and use the Azure Client Secrets connection.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Azure DevOps personal access token (PAT)">
|
||||
#### Create a new Azure DevOps personal access token (PAT)
|
||||
You'll need to create a new personal access token (PAT) in order to authenticate Infisical with Azure DevOps.
|
||||
<Steps>
|
||||
<Step title="Navigate to Azure DevOps">
|
||||
|
||||
</Step>
|
||||
<Step title="Create a new token">
|
||||
Make sure the newly created token has Read/Write access to the Release scope.
|
||||
|
||||
|
||||
<Note>
|
||||
Please make sure that the token has access to the following scopes: Variable Groups _(read, create, & manage)_, Release _(read/write)_, Project and Team _(read)_, Service Connections _(read & query)_
|
||||
</Note>
|
||||
</Step>
|
||||
<Step title="Copy the new access token">
|
||||
Copy the newly created token as this will be used to authenticate Infisical with Azure DevOps.
|
||||
|
||||
</Step>
|
||||
</Steps>
|
||||
</Accordion>
|
||||
|
||||
## Setup Azure Connection in Infisical
|
||||
|
||||
<Steps>
|
||||
<Step title="Navigate to App Connections">
|
||||
Navigate to the **App Connections** tab on the **Organization Settings** page. 
|
||||
</Step>
|
||||
<Step title="Add Connection">
|
||||
Select the **Azure Connection** option from the connection options modal. 
|
||||
</Step>
|
||||
|
||||
<Step title="Create Connection">
|
||||
<Tabs>
|
||||
<Tab title="Infisical UI">
|
||||
<Steps>
|
||||
<Step title="Fill in Connection Details">
|
||||
Fill in the **Tenant ID** field with the Directory (Tenant) ID you obtained in the previous step. And the organization name of the Azure DevOps organization you want to connect to.
|
||||
|
||||
|
||||
<Tip>
|
||||
You can find the **Organization Name** on https://dev.azure.com/
|
||||
</Tip>
|
||||
</Step>
|
||||
<Step title="Grant Access">
|
||||
You will then be redirected to Azure to grant Infisical access to your Azure account. Once granted,
|
||||
you will be redirected back to Infisical's App Connections page. 
|
||||
</Step>
|
||||
</Steps>
|
||||
</Tab>
|
||||
<Tab title="API">
|
||||
<Steps>
|
||||
<Step title="Fill in Connection Details">
|
||||
Fill in the **API Key** field with the API key you obtained in the previous step. And the organization name of the Azure DevOps organization you want to connect to.
|
||||
|
||||
|
||||
<Tip>
|
||||
You can find the **Organization Name** on https://dev.azure.com/
|
||||
</Tip>
|
||||
</Step>
|
||||
</Steps>
|
||||
</Tab>
|
||||
</Tabs>
|
||||
</Step>
|
||||
<Step title="Connection Created">
|
||||
Your **Azure Client Secrets Connection** is now available for use. 
|
||||
</Step>
|
||||
</Steps>
|
||||
143
docs/integrations/secret-syncs/azure-devops.mdx
Normal file
143
docs/integrations/secret-syncs/azure-devops.mdx
Normal file
@@ -0,0 +1,143 @@
|
||||
---
|
||||
title: "Azure DevOps Sync"
|
||||
description: "Learn how to configure a Azure DevOps Sync for Infisical."
|
||||
---
|
||||
|
||||
**Prerequisites:**
|
||||
|
||||
- Set up and add secrets to [Infisical Cloud](https://app.infisical.com)
|
||||
- Create an [Azure DevOps Connection](/integrations/app-connections/azure-devops)
|
||||
|
||||
<Tabs>
|
||||
<Tab title="Infisical UI">
|
||||
1. Navigate to **Project** > **Integrations** and select the **Secret Syncs** tab. Click on the **Add Sync** button.
|
||||
|
||||
|
||||
2. Select the **Azure DevOps** option.
|
||||
|
||||
|
||||
3. Configure the **Source** from where secrets should be retrieved, then click **Next**.
|
||||
|
||||
|
||||
- **Environment**: The project environment to retrieve secrets from.
|
||||
- **Secret Path**: The folder path to retrieve secrets from.
|
||||
|
||||
<Tip>
|
||||
If you need to sync secrets from multiple folder locations, check out [secret imports](/documentation/platform/secret-reference#secret-imports).
|
||||
</Tip>
|
||||
|
||||
4. Configure the **Destination** to where secrets should be deployed, then click **Next**.
|
||||
|
||||
|
||||
- **Azure DevOps Connection**: The Azure DevOps Connection to authenticate with.
|
||||
- **Project**: The Azure DevOps project to deploy secrets to.
|
||||
<p class="height:1px" />
|
||||
|
||||
5. Configure the **Sync Options** to specify how secrets should be synced, then click **Next**.
|
||||
|
||||
|
||||
- **Initial Sync Behavior**: Determines how Infisical should resolve the initial sync.
|
||||
- **Overwrite Destination Secrets**: Removes any secrets at the destination endpoint not present in Infisical.
|
||||
<Note>
|
||||
Azure Devops does not support importing secrets.
|
||||
</Note>
|
||||
- **Key Schema**: Template that determines how secret names are transformed when syncing, using `{{secretKey}}` as a placeholder for the original secret name.
|
||||
- **Auto-Sync Enabled**: If enabled, secrets will automatically be synced from the source location when changes occur. Disable to enforce manual syncing only.
|
||||
- **Disable Secret Deletion**: If enabled, Infisical will not remove secrets from the sync destination. Enable this option if you intend to manage some secrets manually outside of Infisical.
|
||||
|
||||
6. Configure the **Details** of your Azure DevOps Sync, then click **Next**.
|
||||
|
||||
|
||||
- **Name**: The name of your sync. Must be slug-friendly.
|
||||
- **Description**: An optional description for your sync.
|
||||
|
||||
7. Review your Azure DevOps Sync configuration, then click **Create Sync**.
|
||||
|
||||
|
||||
8. If enabled, your Azure DevOps Sync will begin syncing your secrets to the destination endpoint.
|
||||
|
||||
|
||||
</Tab>
|
||||
<Tab title="API">
|
||||
To create a **Azure DevOps Sync**, make an API request to the [Create Azure DevOps Sync](/api-reference/endpoints/secret-syncs/azure-devops/create) API endpoint.
|
||||
|
||||
### Sample request
|
||||
|
||||
```bash Request
|
||||
curl --request POST \
|
||||
--url https://app.infisical.com/api/v1/secret-syncs/azure-devops \
|
||||
--header 'Content-Type: application/json' \
|
||||
--data '{
|
||||
"name": "my-devops-sync",
|
||||
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
||||
"description": "an example sync",
|
||||
"connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
||||
"environment": "dev",
|
||||
"secretPath": "/my-secrets",
|
||||
"isEnabled": true,
|
||||
"syncOptions": {
|
||||
"initialSyncBehavior": "overwrite-destination",
|
||||
"disableSecretDeletion": true
|
||||
},
|
||||
"destinationConfig": {
|
||||
"devopsProjectId": "12345678-90ab-cdef-1234-567890abcdef",
|
||||
"devopsProjectName": "example-project"
|
||||
}
|
||||
}'
|
||||
```
|
||||
|
||||
### Sample response
|
||||
|
||||
```json Response
|
||||
{
|
||||
"secretSync": {
|
||||
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
||||
"name": "my-key-vault-sync",
|
||||
"description": "an example sync",
|
||||
"isEnabled": true,
|
||||
"version": 1,
|
||||
"folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
||||
"connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
||||
"createdAt": "2023-11-07T05:31:56Z",
|
||||
"updatedAt": "2023-11-07T05:31:56Z",
|
||||
"syncStatus": "succeeded",
|
||||
"lastSyncJobId": "123",
|
||||
"lastSyncMessage": null,
|
||||
"lastSyncedAt": "2023-11-07T05:31:56Z",
|
||||
"importStatus": null,
|
||||
"lastImportJobId": null,
|
||||
"lastImportMessage": null,
|
||||
"lastImportedAt": null,
|
||||
"removeStatus": null,
|
||||
"lastRemoveJobId": null,
|
||||
"lastRemoveMessage": null,
|
||||
"lastRemovedAt": null,
|
||||
"syncOptions": {
|
||||
"initialSyncBehavior": "overwrite-destination",
|
||||
"keySchema": "PIPELINE_${key}",
|
||||
"disableSecretDeletion": true
|
||||
},
|
||||
"connection": {
|
||||
"app": "azure-devops",
|
||||
"name": "Production DevOps Organization",
|
||||
"id": "8b92f5cc-3g77-5e80-6666-6ff57069385d"
|
||||
},
|
||||
"environment": {
|
||||
"slug": "production",
|
||||
"name": "Production Environment",
|
||||
"id": "4f16j9gg-7k11-9i23-2222-2jj91403729h"
|
||||
},
|
||||
"folder": {
|
||||
"id": "5a71e8dd-2f66-4d70-7777-7cc46958274c",
|
||||
"path": "/devops/pipeline-secrets"
|
||||
},
|
||||
"destination": "azure-devops",
|
||||
"destinationConfig": {
|
||||
"devopsProjectId": "12345678-90ab-cdef-1234-567890abcdef",
|
||||
"devopsProjectName": "example-project"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
</Tab>
|
||||
</Tabs>
|
||||
@@ -492,6 +492,7 @@
|
||||
"integrations/app-connections/aws",
|
||||
"integrations/app-connections/azure-app-configuration",
|
||||
"integrations/app-connections/azure-client-secrets",
|
||||
"integrations/app-connections/azure-devops",
|
||||
"integrations/app-connections/azure-key-vault",
|
||||
"integrations/app-connections/camunda",
|
||||
"integrations/app-connections/databricks",
|
||||
@@ -524,6 +525,7 @@
|
||||
"integrations/secret-syncs/aws-parameter-store",
|
||||
"integrations/secret-syncs/aws-secrets-manager",
|
||||
"integrations/secret-syncs/azure-app-configuration",
|
||||
"integrations/secret-syncs/azure-devops",
|
||||
"integrations/secret-syncs/azure-key-vault",
|
||||
"integrations/secret-syncs/camunda",
|
||||
"integrations/secret-syncs/databricks",
|
||||
@@ -1176,6 +1178,18 @@
|
||||
"api-reference/endpoints/app-connections/azure-client-secret/delete"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Azure DevOps",
|
||||
"pages": [
|
||||
"api-reference/endpoints/app-connections/azure-devops/list",
|
||||
"api-reference/endpoints/app-connections/azure-devops/available",
|
||||
"api-reference/endpoints/app-connections/azure-devops/get-by-id",
|
||||
"api-reference/endpoints/app-connections/azure-devops/get-by-name",
|
||||
"api-reference/endpoints/app-connections/azure-devops/create",
|
||||
"api-reference/endpoints/app-connections/azure-devops/update",
|
||||
"api-reference/endpoints/app-connections/azure-devops/delete"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Azure Key Vault",
|
||||
"pages": [
|
||||
@@ -1443,6 +1457,20 @@
|
||||
"api-reference/endpoints/secret-syncs/azure-app-configuration/remove-secrets"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Azure DevOps",
|
||||
"pages": [
|
||||
"api-reference/endpoints/secret-syncs/azure-devops/list",
|
||||
"api-reference/endpoints/secret-syncs/azure-devops/get-by-id",
|
||||
"api-reference/endpoints/secret-syncs/azure-devops/get-by-name",
|
||||
"api-reference/endpoints/secret-syncs/azure-devops/create",
|
||||
"api-reference/endpoints/secret-syncs/azure-devops/update",
|
||||
"api-reference/endpoints/secret-syncs/azure-devops/delete",
|
||||
"api-reference/endpoints/secret-syncs/azure-devops/sync-secrets",
|
||||
"api-reference/endpoints/secret-syncs/azure-devops/import-secrets",
|
||||
"api-reference/endpoints/secret-syncs/azure-devops/remove-secrets"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Azure Key Vault",
|
||||
"pages": [
|
||||
|
||||
Reference in New Issue
Block a user