Rundeck Sync

Learn how to configure a Rundeck Sync for Infisical.

Prerequisites:

• Set up and add secrets to Infisical Cloud
• Create a Rundeck Connection

Infisical UI

1. Navigate to Project > Integrations and select the Secret Syncs tab. Click the Add Sync button, then choose Rundeck as the destination.

   

2. Configure the Source to specify where secrets should be retrieved from, then click Continue.

   
   • Environment: The project environment to retrieve secrets from.
   • Secret Path: The folder path to retrieve secrets from.

If you need to sync secrets from multiple folder locations, check out secret imports.

3. Configure the Destination to specify where secrets should be deployed, then click Continue.

   
   • Rundeck Connection: The Rundeck Connection to authenticate with.
   • Project: The Rundeck project to sync secrets to.
   • Path: The Key Storage path within the project. Must start with / (e.g. /production).
   Secrets are stored in Rundeck Key Storage under keys/project/<project><path>. For example, a secret named API_KEY synced to project web-app with path /production is stored at keys/project/web-app/production/API_KEY.

4. Configure the Initial Sync Behavior to determine how Infisical should resolve the first sync, then click Continue.

   
   • Overwrite Destination Secrets: On the initial sync, Infisical writes its secrets to Rundeck. No secrets are imported from Rundeck, and depending on your configuration this can remove secrets from Rundeck.
   Rundeck Syncs do not support importing secrets from the destination — only overwrite is available.

5. Configure the Sync Options to control how secrets are written, then click Continue.

   
   • Disable Secret Deletion: If enabled, Infisical will not remove secrets from Rundeck during a sync. Enable this if you intend to manage some secrets manually outside of Infisical.
   • Auto-Sync on Changes: If enabled, secrets are automatically synced to Rundeck whenever they change in the source. Turn off to sync manually only.
   • Customize Key Names: Add a prefix or suffix so Infisical can identify which keys in Rundeck it manages — anything else is left untouched.

6. Configure the Details of your Rundeck Sync, then click Continue.

   
   • Name: The name of your sync. Must be slug-friendly.
   • Description: An optional description for your sync.

7. Review your Rundeck Sync configuration, then click Create Sync.

   

8. Your Rundeck Sync is created and will begin syncing your secrets to the destination.

   

API

To create a Rundeck Sync, make an API request to the Create Rundeck Sync API endpoint.

Sample request

Request

curl    --request POST \
--url https://app.infisical.com/api/v1/secret-syncs/rundeck \
--header 'Content-Type: application/json' \
--data '{
    "name": "my-rundeck-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": {
        "project": "web-app",
        "path": "/production"
    }
}'

Sample response

Response

{
    "secretSync": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "my-rundeck-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": "rundeck",
            "name": "my-rundeck-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": "rundeck",
        "destinationConfig": {
            "project": "web-app",
            "path": "/production"
        }
    }
}