mirror of
https://github.com/awatertrevi/infisical.git
synced 2026-09-22 13:39:35 +00:00
doc: add docs for gcp secret manager secret sync
This commit is contained in:
Sheen Capadngan
Binary file not shown.
|
After Width: | Height: | Size: 1.0 MiB |
Binary file not shown.
|
After Width: | Height: | Size: 624 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 626 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 685 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 664 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 608 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 628 KiB |
135
docs/integrations/secret-syncs/gcp-secret-manager.mdx
Normal file
135
docs/integrations/secret-syncs/gcp-secret-manager.mdx
Normal file
@@ -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
|
||||
|
||||
<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 **GCP Secret Manager** 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**.
|
||||
|
||||
|
||||
- **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**.
|
||||
|
||||
|
||||
- **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**.
|
||||
|
||||
|
||||
- **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**.
|
||||
|
||||
|
||||
8. If enabled, your GCP Secret Manager Sync will begin syncing your secrets to the destination endpoint.
|
||||
|
||||
|
||||
</Tab>
|
||||
<Tab title="API">
|
||||
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"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
</Tab>
|
||||
|
||||
</Tabs>
|
||||
@@ -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"
|
||||
]
|
||||
}
|
||||
]
|
||||
|
||||
Reference in New Issue
Block a user