Key-Value Pair Integration

Available under the Integration Family: Generic

Key-Value Pair Integration is used to inject configurations into Shippable DevOps Assembly Lines activities.

You can create this from the integrations page by following instructions here: Adding an account integration.

This is the information you would require to create this integration:

  • Name -- friendly name for the integration
  • Key Values -- A collection of Key-Values

Resources that use this Integration

Resources are the building blocks of assembly lines and some types of resources refer to integrations by their names. The following resource types can be created with a Key-Value Pair integration.

Default Environment Variables

When you create a resource with this integration, and use it as an IN or 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 a resource with this integration type is used.

<NAME> is the the friendly name of the resource.

Environment variable Description
<NAME>_INTEGRATION_NAME Name supplied in the integration
KEY Name of the First Key defined and will have value set
KEY Name of the Nth Key defined and will have value set

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.

Further Reading