mirror of
https://github.com/awatertrevi/infisical.git
synced 2026-10-09 19:28:33 +00:00
doc: add camunda secret sync
This commit is contained in:
Sheen
Binary file not shown.
|
After Width: | Height: | Size: 1.0 MiB |
Binary file not shown.
|
After Width: | Height: | Size: 626 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 616 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 667 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 656 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 615 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 640 KiB |
@@ -9,11 +9,11 @@ Infisical supports connecting to Camunda APIs using [client credentials](https:/
|
||||
|
||||
<Steps>
|
||||
<Step title="Navigate to Organization Management">
|
||||
In your Camunda Console, navigate to the **Organization** tab in the top navigation menu.
|
||||
In your Camunda Cloud Console, navigate to the **Organization** tab in the top navigation menu.
|
||||
|
||||
</Step>
|
||||
<Step title="Access Administration API">
|
||||
From the navigation tabs, click on **Administration API** to manage your API credentials and click the **Create client credentials** button.
|
||||
From the Organization Management tabs, click on **Administration API** to manage your API credentials and click the **Create client credentials** button.
|
||||
|
||||
</Step>
|
||||
<Step title="Name Your Client">
|
||||
@@ -22,8 +22,8 @@ Infisical supports connecting to Camunda APIs using [client credentials](https:/
|
||||
<Step title="Set Credential Permissions">
|
||||
In the "Create new client credentials" modal, select the following permissions required for secret syncs:
|
||||
|
||||
- **Connector secrets**: Enable all operations (Get, Create, Update, Delete)
|
||||
- **Cluster**: Enable read access (Get)
|
||||
- **Connector secrets**: Enable all operations (Get, Create, Update, Delete)
|
||||
|
||||
These specific permissions are required for Infisical to properly sync and manage your Camunda secrets.
|
||||
|
||||
@@ -43,6 +43,7 @@ Infisical supports connecting to Camunda APIs using [client credentials](https:/
|
||||
You can download these credentials or copy them to use in the next section.
|
||||
|
||||
</Step>
|
||||
|
||||
</Steps>
|
||||
|
||||
## Setup Camunda Connection in Infisical
|
||||
@@ -59,18 +60,18 @@ Infisical supports connecting to Camunda APIs using [client credentials](https:/
|
||||
Connection](/images/app-connections/camunda/camunda-app-connection-select.png)
|
||||
</Step>
|
||||
<Step title="Input Credentials">
|
||||
Select the **Client Credentials** method and enter the Camunda client credentials you created:
|
||||
Select the **Client Credentials** method and enter the Camunda client
|
||||
credentials you created:
|
||||
|
||||
- **Client ID**: Your `CAMUNDA_CONSOLE_CLIENT_ID` value
|
||||
- **Client Secret**: Your `CAMUNDA_CONSOLE_CLIENT_SECRET` value
|
||||
|
||||
Infisical will automatically configure the connection using these credentials to access the Camunda API.
|
||||
Infisical will automatically configure the connection using these credentials to access the Camunda API. Click **Connect to Camunda** to establish the connection. 
|
||||
|
||||
Click **Connect to Camunda** to establish the connection.
|
||||
|
||||
</Step>
|
||||
<Step title="Connection Created">
|
||||
Your **Camunda Connection** is now available for use in your Infisical projects.
|
||||
|
||||
Your **Camunda Connection** is now available for use in your Infisical
|
||||
projects. 
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
@@ -0,0 +1,139 @@
|
||||
---
|
||||
title: "Camunda Sync"
|
||||
description: "Learn how to configure a Camunda Sync for Infisical."
|
||||
---
|
||||
|
||||
**Prerequisites:**
|
||||
|
||||
- Set up and add secrets to [Infisical Cloud](https://app.infisical.com)
|
||||
- Create a [Camunda Connection](/integrations/app-connections/camunda)
|
||||
|
||||
<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 **Camunda** 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**.
|
||||
|
||||
|
||||
- **Camunda Connection**: The Camunda Connection to authenticate with.
|
||||
- **Cluster**: The Camunda cluster to sync connector secrets to.
|
||||
|
||||
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.
|
||||
- **Import Secrets (Prioritize Infisical)**: Imports secrets from the destination endpoint before syncing, prioritizing values from Infisical over Camunda when keys conflict.
|
||||
- **Import Secrets (Prioritize Camunda)**: Imports secrets from the destination endpoint before syncing, prioritizing values from Camunda over Infisical when keys conflict.
|
||||
- **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 Camunda Sync, then click **Next**.
|
||||
|
||||
|
||||
- **Name**: The name of your sync. Must be slug-friendly.
|
||||
- **Description**: An optional description for your sync.
|
||||
|
||||
7. Review your Camunda Sync configuration, then click **Create Sync**.
|
||||
|
||||
|
||||
8. If enabled, your Camunda Sync will begin syncing your secrets to the destination endpoint.
|
||||
|
||||
|
||||
</Tab>
|
||||
<Tab title="API">
|
||||
To create an **Camunda Sync**, make an API request to the [Create Camunda Sync](/api-reference/endpoints/secret-syncs/camunda/create) API endpoint.
|
||||
|
||||
### Sample request
|
||||
|
||||
```bash Request
|
||||
curl --request POST \
|
||||
--url https://app.infisical.com/api/v1/secret-syncs/camunda \
|
||||
--header 'Content-Type: application/json' \
|
||||
--data '{
|
||||
"name": "my-camunda-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"
|
||||
},
|
||||
"destinationConfig": {
|
||||
"scope": "cluster",
|
||||
"clusterUUID": "cc4c8dae-dce9-4f4c-9882-132b2bd65fa5"
|
||||
}
|
||||
}'
|
||||
```
|
||||
|
||||
### Sample response
|
||||
|
||||
```bash Response
|
||||
{
|
||||
"secretSync": {
|
||||
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
||||
"name": "my-camunda-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"
|
||||
},
|
||||
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
||||
"connection": {
|
||||
"app": "camunda",
|
||||
"name": "my-camunda-connection",
|
||||
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
|
||||
},
|
||||
"environment": {
|
||||
"slug": "dev",
|
||||
"name": "Development",
|
||||
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
|
||||
},
|
||||
"folder": {
|
||||
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
||||
"path": "/my-secrets"
|
||||
},
|
||||
"destination": "camunda",
|
||||
"destinationConfig": {
|
||||
"scope": "cluster",
|
||||
"clusterUUID": "cc4c8dae-dce9-4f4c-9882-132b2bd65fa5"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
</Tab>
|
||||
|
||||
</Tabs>
|
||||
+3
-2
@@ -417,13 +417,13 @@
|
||||
"integrations/app-connections/aws",
|
||||
"integrations/app-connections/azure-app-configuration",
|
||||
"integrations/app-connections/azure-key-vault",
|
||||
"integrations/app-connections/camunda",
|
||||
"integrations/app-connections/databricks",
|
||||
"integrations/app-connections/gcp",
|
||||
"integrations/app-connections/github",
|
||||
"integrations/app-connections/humanitec",
|
||||
"integrations/app-connections/mssql",
|
||||
"integrations/app-connections/postgres",
|
||||
"integrations/app-connections/camunda"
|
||||
"integrations/app-connections/postgres"
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -439,6 +439,7 @@
|
||||
"integrations/secret-syncs/aws-secrets-manager",
|
||||
"integrations/secret-syncs/azure-app-configuration",
|
||||
"integrations/secret-syncs/azure-key-vault",
|
||||
"integrations/secret-syncs/camunda",
|
||||
"integrations/secret-syncs/databricks",
|
||||
"integrations/secret-syncs/gcp-secret-manager",
|
||||
"integrations/secret-syncs/github",
|
||||
|
||||
Reference in New Issue
Block a user