SSH Key Integration

JFrog Pipelines Documentation

ft:sourceType
Paligo

SSH Key Integration is used to connect JFrog Pipelines to VMs that allow SSH based auth. This is typically used to SSH in and then run commands on the machine. Tools like Terraform and Ansible use this to execute scripts on a machine.

Creating an SSH Key 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

  • Public Key -- Public SSH Key

  • Private Key -- Private SSH Key

Note: The SSH Key must be generated without passphrase.

Usage

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

The SSH Key integration can also be added directly to a step in the integrations section. This automatically adds the public and private SSH keys to the SSH client configuration file (~/.ssh) to enable a secure connection through the ssh command.

Default Environment Variables

When you create a VmCluster resource with this integration, and create a step that uses it, a set of environment variables is automatically made available.

Environment variable

Description

res_<resource-name>_sshKey_publicKey

Public Key supplied in the integration

res_<resource-name>_sshKey_privateKey

Private Key supplied in the integration

When you add this integration directly to a step, a set of environment variables is automatically made available.

Environment variable

Description

int_<integration-name>_publicKey

Public Key supplied in the integration

int_<integration-name>_privateKey

Private Key supplied in the integration