A Generic integration is used to store key/value information that can be accessed in steps as environment variables. Because all integration properties are stored in a secure, encrypted vault, this is suitable for storing secrets such as username/password credentials.
Creating a Generic Integration
You can add this integration by following steps on the Managing Pipelines Integrations page.
Here is the information you need to create this integration:
Name -- choose a friendly name for the integration
Custom Environment Variables -- the Key and Value pair to store. Select Secure to secure the custom environment variable.
You can add as many key-value pairs as you need in the integration by clicking Add for each.
Usage
The Generic integration can be added directly to a step in the integrations
section.
Default Environment Variables
When you add this integration to a step, All key-value pairs are made available as environment variables.
Environment variable | Description |
---|---|
| The value stored for the custom environment variable. |
Example
You can define a Generic integration with the following entries:
Name:
myCredentials
Custom Environment Variables:
Key:
username
Value:
janedoe
Key:
password
Value:
nAm30fMyp3t
When myCredentials
is specified in a step's integrations
block, the key-value pairs stored there can then be accessed in the step as environment variables:
Note
Export generic integration key values as it is. Use as <key> instead of <int>_<integration-name>_<key>. Can be achieved using API only. Pass "exportKey": true
, while creating/updating api/v1/projectIntegrations.
pipelines: - name: generic_integration_example steps: - name: step_1 type: Bash configuration: integrations: - name: exportWithKey14856 - name: myCredentials execution: onExecute: - printenv $int_myCredentials_username - printenv $int_myCredentials_password - withkey=${exportWithKey} # - echo $withkey