SSH Keys Integration

SSH Key Integration is used to connect Shippable DevOps Assembly Lines platform to VMs that allow SSH based auth. This is typically used to SSH in and then run activities on the machine. Tools like Terraform and Ansible use this to execute scripts on a machine.

Creating an Integration

You can add this integration by following steps on the Adding an integration page.

Here is the information you need to create this integration:

  • Integration type -- SSH key
  • Name -- choose a friendly name for the integration
  • Public Key -- Public SSH Key
  • Private Key -- Private SSH Key

Note: The SSH Key must be generated without passphrase.

Usage in CI

Usage in Assembly Lines

The SSH key integration can be used in the following resources:

Default Environment Variables

When you create a resource with this integration, and use it as an IN or OUT for a runSh or runCI job, a set of environment variables is automatically made available that you can use in your scripts.

<NAME> is the the friendly name of the resource with all letters capitalized and all characters that are not letters, numbers or underscores removed. Any numbers at the beginning of the name are also removed to create a valid variable. For example, my-key-1 will be converted to MYKEY1, and my_key_1 will be converted to MY_KEY_1.

Environment variable Description
<NAME>_NAME Name supplied in the integration
<NAME>_PUBLICKEY Public Key supplied in the integration
<NAME>_PRIVATEKEY Private Key supplied in the integration
<NAME>_PUBLIC_KEY_PATH Path of a file containing the public key supplied in the integration
<NAME>_PRIVATE_KEY_PATH Path of a file containing the private key supplied in the integration

Shippable Utility Functions

The platform also provides a command line utility called shipctl that can be used to retrieve the values of these environment variables.

The specific function that can be used in the jobs yml is: shipctl get_integration_resource_field <resource name> <field name>.

Here is a table that provides the mapping from the environment variable to the field name.

Environment variable Field Name
<NAME>_PUBLICKEY publicKey
<NAME>_PRIVATEKEY privateKey

More information on other utility functions is documented here.

Further Reading