diff --git a/docs/images/secret-syncs/gcp-secret-manager/gcp-secret-manager-created.png b/docs/images/secret-syncs/gcp-secret-manager/gcp-secret-manager-created.png new file mode 100644 index 000000000..502365ff7 Binary files /dev/null and b/docs/images/secret-syncs/gcp-secret-manager/gcp-secret-manager-created.png differ diff --git a/docs/images/secret-syncs/gcp-secret-manager/gcp-secret-manager-destination.png b/docs/images/secret-syncs/gcp-secret-manager/gcp-secret-manager-destination.png new file mode 100644 index 000000000..c50b6232a Binary files /dev/null and b/docs/images/secret-syncs/gcp-secret-manager/gcp-secret-manager-destination.png differ diff --git a/docs/images/secret-syncs/gcp-secret-manager/gcp-secret-manager-details.png b/docs/images/secret-syncs/gcp-secret-manager/gcp-secret-manager-details.png new file mode 100644 index 000000000..dbb47371f Binary files /dev/null and b/docs/images/secret-syncs/gcp-secret-manager/gcp-secret-manager-details.png differ diff --git a/docs/images/secret-syncs/gcp-secret-manager/gcp-secret-manager-options.png b/docs/images/secret-syncs/gcp-secret-manager/gcp-secret-manager-options.png new file mode 100644 index 000000000..addb343a7 Binary files /dev/null and b/docs/images/secret-syncs/gcp-secret-manager/gcp-secret-manager-options.png differ diff --git a/docs/images/secret-syncs/gcp-secret-manager/gcp-secret-manager-review.png b/docs/images/secret-syncs/gcp-secret-manager/gcp-secret-manager-review.png new file mode 100644 index 000000000..4d710b3af Binary files /dev/null and b/docs/images/secret-syncs/gcp-secret-manager/gcp-secret-manager-review.png differ diff --git a/docs/images/secret-syncs/gcp-secret-manager/gcp-secret-manager-source.png b/docs/images/secret-syncs/gcp-secret-manager/gcp-secret-manager-source.png new file mode 100644 index 000000000..9074d45ac Binary files /dev/null and b/docs/images/secret-syncs/gcp-secret-manager/gcp-secret-manager-source.png differ diff --git a/docs/images/secret-syncs/gcp-secret-manager/select-gcp-secret-manager-option.png b/docs/images/secret-syncs/gcp-secret-manager/select-gcp-secret-manager-option.png new file mode 100644 index 000000000..24e6ff95d Binary files /dev/null and b/docs/images/secret-syncs/gcp-secret-manager/select-gcp-secret-manager-option.png differ diff --git a/docs/integrations/secret-syncs/gcp-secret-manager.mdx b/docs/integrations/secret-syncs/gcp-secret-manager.mdx new file mode 100644 index 000000000..a4198d526 --- /dev/null +++ b/docs/integrations/secret-syncs/gcp-secret-manager.mdx @@ -0,0 +1,135 @@ +--- +title: "GCP Secret Manager Sync" +description: "Learn how to configure a GCP Secret Manager Sync for Infisical." +--- + +**Prerequisites:** + + - Set up and add secrets to [Infisical Cloud](https://app.infisical.com) + - Create a [GCP Connection](/integrations/app-connections/gcp) with the required **Secret Sync** permissions + + + + 1. Navigate to **Project** > **Integrations** and select the **Secret Syncs** tab. Click on the **Add Sync** button. + ![Secret Syncs Tab](/images/secret-syncs/general/secret-sync-tab.png) + + 2. Select the **GCP Secret Manager** option. + ![Select GCP Secret Manager](/images/secret-syncs/gcp-secret-manager/select-gcp-secret-manager-option.png) + + 3. Configure the **Source** from where secrets should be retrieved, then click **Next**. + ![Configure Source](/images/secret-syncs/gcp-secret-manager/gcp-secret-manager-source.png) + + - **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](/documentation/platform/secret-reference#secret-imports). + + + 4. Configure the **Destination** to where secrets should be deployed, then click **Next**. + ![Configure Destination](/images/secret-syncs/gcp-secret-manager/gcp-secret-manager-destination.png) + + - **GCP Connection**: The GCP Connection to authenticate with. + - **Project**: The GCP project to sync with. + + 5. Configure the **Sync Options** to specify how secrets should be synced, then click **Next**. + ![Configure Options](/images/secret-syncs/gcp-secret-manager/gcp-secret-manager-options.png) + + - **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. + - **Auto-Sync Enabled**: If enabled, secrets will automatically be synced from the source location when changes occur. Disable to enforce manual syncing only. + + 6. Configure the **Details** of your GCP Secret Manager Sync, then click **Next**. + ![Configure Details](/images/secret-syncs/gcp-secret-manager/gcp-secret-manager-details.png) + + - **Name**: The name of your sync. Must be slug-friendly. + - **Description**: An optional description for your sync. + + 7. Review your Secret Manager Sync configuration, then click **Create Sync**. + ![Confirm Configuration](/images/secret-syncs/gcp-secret-manager/gcp-secret-manager-review.png) + + 8. If enabled, your GCP Secret Manager Sync will begin syncing your secrets to the destination endpoint. + ![Sync Secrets](/images/secret-syncs/gcp-secret-manager/gcp-secret-manager-created.png) + + + + To create a **GCP Secret Manager Sync**, make an API request to the [Create GCP + Secret Manager Sync](/api-reference/endpoints/secret-syncs/gcp/create) API endpoint. + + ### Sample request + + ```bash Request + curl --request POST \ + --url https://app.infisical.com/api/v1/secret-syncs/gcp \ + --header 'Content-Type: application/json' \ + --data '{ + "destinationConfig": { + "projectId": "infisical-test-playground" + }, + "name": "my-gcp-sync", + "description": "this is an example secret sync", + "secretPath": "/", + "syncOptions": { + "initialSyncBehavior": "overwrite-destination" + }, + "isAutoSyncEnabled": true, + "connectionId": "eec83609-5eb4-4d8d-9f6e-ded016984f0d", + "environment": "dev", + "projectId": "09eda1f8-85a3-47a9-8a6f-e27f133b2a36" + }' + ``` + + ### Sample response + + ```bash Response + { + "secretSync": { + "id": "aee02c4a-4a5f-488c-82dd-0b3164772871", + "name": "my-gcp-sync", + "description": "this is an example secret sync", + "isAutoSyncEnabled": true, + "version": 1, + "projectId": "09eda1f8-85a3-47a9-8a6f-e27f133b2a36", + "folderId": "1447389e-16fb-49ba-96fd-361b5a2522af", + "connectionId": "eec83609-5eb4-4d8d-9f6e-ded016984f0d", + "createdAt": "2025-01-27T12:28:59.408Z", + "updatedAt": "2025-01-27T12:28:59.408Z", + "syncStatus": "pending", + "lastSyncJobId": null, + "lastSyncMessage": null, + "lastSyncedAt": null, + "importStatus": null, + "lastImportJobId": null, + "lastImportMessage": null, + "lastImportedAt": null, + "removeStatus": null, + "lastRemoveJobId": null, + "lastRemoveMessage": null, + "lastRemovedAt": null, + "syncOptions": { + "initialSyncBehavior": "overwrite-destination" + }, + "connection": { + "app": "gcp", + "name": "my-gcp-connection", + "id": "eec83609-5eb4-4d8d-9f6e-ded016984f0d" + }, + "environment": { + "slug": "dev", + "name": "Development", + "id": "124e0392-4070-4b1c-900e-ced30cd55bf3" + }, + "folder": { + "id": "1447389e-16fb-49ba-96fd-361b5a2522af", + "path": "/" + }, + "destination": "gcp", + "destinationConfig": { + "projectId": "infisical-test-playground" + } + } + } + ``` + + + diff --git a/docs/mint.json b/docs/mint.json index 9c728b319..c5b0ef1bc 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -365,7 +365,8 @@ "group": "Syncs", "pages": [ "integrations/secret-syncs/aws-parameter-store", - "integrations/secret-syncs/github" + "integrations/secret-syncs/github", + "integrations/secret-syncs/gcp-secret-manager" ] } ]