integration resource is used to represent credentials that have been encrypted using Shippable Integrations.
You can create a
integration resource by adding it to
resources: - name: <string> type: integration integration: <string>
name-- should be an easy to remember text string
type-- is set to
integration-- name of the subscription integration. All Shippable Integrations can be used here
Used in Jobs
This resource is used as an IN for the following jobs
Default Environment Variables
integration is used as an
OUT for a job that can execute user defined scripts, a set of environment variables are configured by the platform that may be useful to set the context before user defined scripts execute as part of the job. These variables are available when this resource is used.
<NAME> is the the friendly name of the resource.
||The name of the resource.|
||The ID of the resource.|
||The type of the resource. In this case
||Values from the integration that was used. More info on the specific integration page.|
||The directory containing files for the resource.|
||The operation of the resource; either
||The ID of the version of the resource being used.|
||The number of the version of the resource being used.|
Some special cases depending on the
If the integration is of type Key-Value pair, the key-values are exported as-is without adding
RESOURCENAME_INTEGRATION_in the key name. They act like params resources, but are stored encrypted for security reasons.
If the integration of type ssh-key or pem-key is used, the environment variable will mess up the key structure due to carriage returns. Hence the platform will extract the private key into a file and puts the location in the environment variable below.
Environment variable Description
points directly to the private key file.
Shippable Utility Functions
To make it easy to use these environment variables, the platform provides a command line utility that can be used to work with these values.
How to use these utility functions is documented here.