awatertrevi/infisical
1
0
Fork 0
mirror of https://github.com/awatertrevi/infisical.git synced 2026-09-22 13:39:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: adds chef platform docs

Browse Source
This commit is contained in:
Piyush Gupta
2025-10-30 23:16:46 +05:30
parent 0661efee3e
commit f72971e3b8
40 changed files with 432 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

142
docs/integrations/app-connections/chef.mdx Normal file
View File

@@ -0,0 +1,142 @@
---
title: "Chef Connection"
description: "Learn how to configure a Chef Connection for Infisical."
---
Infisical supports the use of User Private Key to connect with Chef Server.
Please access your **starter kit** to get all the required information to create a Chef Connection.
<Accordion title="If you don't have a starter kit">
<Warning>
If you download a new starter kit, your previous private key/user key will
no longer be valid. Please make sure to update all the places that use the
previous private key.
</Warning>
<Steps>
<Step title="Navigate to your Chef Server Dashboard, and click on the 'Organizations' tab">
![Chef Server User Keys](/images/app-connections/chef/chef-dashboard.png)
</Step>
<Step title="Click on the organization you want to connect to, and then click on the 'Starter Kit' button">
![Starter Kit](/images/app-connections/chef/starter-kit.png)
</Step>
<Step title="Click on the 'Download Starter Kit' button to download the starter kit">
![Download Starter
Kit](/images/app-connections/chef/download-starter-kit.png)
</Step>
<Step title='Download the starter kit zip file and extract the contents'>
![Extract Starter
Kit](/images/app-connections/chef/extract-starter-kit.png)
</Step>
</Steps>
</Accordion>
<Steps>
<Step title="Open your starter kit's folder">
Open your starter kit's folder(or `chef-repo`) and navigate to the `.chef`
folder.
<Note>
Please make sure you have hidden files visible in your file explorer.
</Note>
![.chef folder](/images/app-connections/chef/chef-folder.png)
</Step>
<Step title='Copy the private key'>
In the `.chef` folder, you will find a `[your-username].pem` file. ![Private
Key File](/images/app-connections/chef/private-key-file.png)
**Private Key:** Copy the content of the private key file.
</Step>
<Step title='Open the config.rb file'>
Open the `config.rb` file and copy the content of the file.
![Config.rb File Content](/images/app-connections/chef/chef-connection-details.png)
**User Name(1):** The user name of the chef user.
**Server URL(2):** The server url of the chef server.
**Organization Name(3):** The organization name of the chef server.
</Step>
</Steps>
## Create a Chef Connection in Infisical via UI
<Tabs>
<Tab title="Infisical UI">
<Steps>
<Step title="Navigate to App Connections">
In your Infisical dashboard, navigate to the **App Connections** page in the desired project.
![App Connections Tab](/images/app-connections/general/add-connection.png)
</Step>
<Step title="Select Chef Connection">
Click **+ Add Connection** and choose **Chef** Connection from the list of integrations.
![Select Chef Connection](/images/app-connections/chef/app-connection-option.png)
</Step>
<Step title="Fill out the Chef Connection form">
Complete the form by providing:
- A descriptive name for the connection
- An optional description
- Server URL(optional): The URL of the Chef server to connect to(defaults to https://api.chef.io)
- Organization name
- User name
- Private key: Your Chef user's private key (.pem file)
![Chef Connection Modal](/images/app-connections/chef/app-connection-form.png)
</Step>
<Step title="Connection created">
After submitting the form, your **Chef Connection** will be successfully created and ready to use with your Infisical project.
![Chef Connection Created](/images/app-connections/chef/app-connection-generated.png)
</Step>
</Steps>
</Tab>
<Tab title="API">
To create a Chef Connection via API, send a request to the [Create Chef Connection](/api-reference/endpoints/app-connections/chef/create) endpoint.
### Sample request
```bash Request
curl --request POST \
--url https://app.infisical.com/api/v1/app-connections/chef \
--header 'Content-Type: application/json' \
--data '{
"name": "my-chef-connection",
"method": "user-key",
"projectId": "7ffbb072-2575-495a-b5b0-127f88caef78",
"credentials": {
"orgName": "my-org",
"userName": "my-user",
"privateKey": "your-private-key"
}
}'
```
### Sample response
```bash Response
{
"appConnection": {
"id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
"name": "my-chef-connection",
"description": null,
"projectId": "7ffbb072-2575-495a-b5b0-127f88caef78",
"version": 1,
"orgId": "abcdef12-3456-7890-abcd-ef1234567890",
"createdAt": "2025-10-13T10:15:00.000Z",
"updatedAt": "2025-10-13T10:15:00.000Z",
"isPlatformManagedCredentials": false,
"credentialsHash": "d41d8cd98f00b204e9800998ecf8427e",
"app": "chef",
"method": "user-key",
"credentials": {
"orgName": "my-org",
"userName": "my-user",
}
}
}
```
</Tab>
</Tabs>

154
docs/integrations/secret-syncs/chef.mdx Normal file
View File

@@ -0,0 +1,154 @@
---
title: "Chef Sync"
description: "Learn how to configure a Chef Sync for Infisical."
---
**Prerequisites:**
- Create a [Chef Connection](/integrations/app-connections/chef)
<Tabs>
<Tab title="Infisical UI">
<Steps>
<Step title="Add Sync">
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)
</Step>
<Step title="Select 'Chef'">
![Select Chef](/images/secret-syncs/chef/select-option.png)
</Step>
<Step title="Configure source">
Configure the **Source** from where secrets should be retrieved, then click **Next**.
![Configure Source](/images/secret-syncs/chef/sync-source.png)
- **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>
</Step>
<Step title="Configure destination">
Configure the **Destination** to where secrets should be deployed, then click **Next**.
![Configure Destination](/images/secret-syncs/chef/sync-destination.png)
- **Chef Connection**: The Chef Connection to authenticate with.
- **Data Bag**: The Data Bag Name to sync secrets to.
- **Data Bag Item**: The Data Bag Item Name to sync secrets to.
</Step>
<Step title="Configure Sync Options">
Configure the **Sync Options** to specify how secrets should be synced, then click **Next**.
![Configure Options](/images/secret-syncs/chef/sync-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.
- **Import Secrets (Prioritize Infisical)**: Imports secrets from the destination endpoint before syncing, prioritizing values from Infisical over Laravel Forge when keys conflict.
- **Import Secrets (Prioritize Laravel Forge)**: Imports secrets from the destination endpoint before syncing, prioritizing values from Laravel Forge over Infisical when keys conflict.
- **Key Schema**: Template that determines how secret names are transformed when syncing, using `{{secretKey}}` as a placeholder for the original secret name and `{{environment}}` for the environment.
<Note>
We highly recommend using a Key Schema to ensure that Infisical only manages the specific keys you intend, keeping everything else untouched.
</Note>
- **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.
</Step>
<Step title="Configure details">
Configure the **Details** of your Chef Sync, then click **Next**.
![Configure Details](/images/secret-syncs/chef/sync-details.png)
- **Name**: The name of your sync. Must be slug-friendly.
- **Description**: An optional description for your sync.
</Step>
<Step title="Review configuration">
Review your Chef Sync configuration, then click **Create Sync**.
![Review Configuration](/images/secret-syncs/chef/sync-review.png)
</Step>
<Step title="Sync created">
If enabled, your Chef Sync will begin syncing your secrets to the destination endpoint.
![Sync Created](/images/secret-syncs/chef/sync-created.png)
</Step>
</Steps>
</Tab>
<Tab title="API">
To create a **Chef Sync**, make an API request to the [Create Chef Sync](/api-reference/endpoints/secret-syncs/chef/create) API endpoint.
### Sample request
```bash Request
curl --request POST \
--url https://app.infisical.com/api/v1/secret-syncs/chef \
--header 'Content-Type: application/json' \
--data '{
"name": "my-chef-sync",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "sync to chef site",
"connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"environment": "dev",
"secretPath": "/",
"isEnabled": true,
"isAutoSyncEnabled": true,
"syncOptions": {
"initialSyncBehavior": "overwrite-destination",
"disableSecretDeletion": false
},
"destinationConfig": {
"dataBagName": "my-data-bag",
"dataBagItemName": "my-data-bag-item"
}
}'
```
### Sample response
```bash Response
{
"secretSync": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "my-chef-sync",
"description": "sync to chef site",
"folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2025-07-19T12:00:00Z",
"updatedAt": "2025-07-19T12:00:00Z",
"syncStatus": "succeeded",
"lastSyncJobId": "job-1234",
"lastSyncMessage": null,
"lastSyncedAt": "2025-07-19T12:00:00Z",
"syncOptions": {
"initialSyncBehavior": "overwrite-destination",
"disableSecretDeletion": false
},
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"connection": {
"app": "chef",
"name": "my-chef-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": "/"
},
"destination": "chef",
"destinationConfig": {
"dataBagName": "my-data-bag",
"dataBagItemName": "my-data-bag-item"
}
}
}
```
</Tab>
</Tabs>