Configure SSH Tunnel Connectivity

Contents:

Expand all Collapse all

Our documentation site is moving!

For up-to-date documentation of Dataprep, please visit us at https://help.alteryx.com/Dataprep/.

Contents:

This section describes how to enable SSH tunneling between the Dataprep by Trifacta application and your cloud-based database infrastructure. When this feature is enabled and properly configured, users connect to your databases through a more secure manner.

Security concerns:

Credentials are stored in a secure database table.
Calls through the SSH tunnel happen with each API request to the platform. When the call has been satisfied, the connection is closed.
- For asynchronous calls to the database, the connection is not left open during the asynchronous execution of the request.

Limitations

NOTE: This feature can be enabled by request. For more information, please contact Google Support.

This feature is not available for some connections.
SSH key-pair must be generated in the legacy OpenSSH format. The new OpenSSH format is not supported. Instructions for generating the legacy format are provided below.

Prerequisites

You must have credentials to access the SSH tunneling for each connection type.
You must whitelist the Dataprep by Trifacta Service on your database server. For more information, see Whitelist Platform Service.

Configure

When SSH tunneling is available for your connection type, the following options can be configured to enable it.

NOTE: SSH tunneling is enabled on a per-connection basis. If enabled for a connection type, the SSH options appear under the Advanced options in the connection window.

These properties are available when you create the connection. After you have specified the connection including SSH tunneling options, you should test the connection.

For more information, see Create Connection Window.

Basic Properties

Property	Description
SSH tunneling host	If you are using SSH tunneling, please specify the SSH host for tunneling into your infrastructure.
Advanced Credential Type	Depending on the type, you must specify the properties for the credentials to use to connection. See sections below.

SSH Tunneling Basic

Property

Description

SSH Tunneling User Name

(optional) Username with which to authenticate to the SSH tunnel.

In some environments, a username may be optional.

SSH Tunneling Password

Password for the username

SSH Tunneling with Key

NOTE: Use of an SSH key that requires a passphrase is not supported.

Property

Description

SSH Tunneling User Name

(optional) Username with which to authenticate to the SSH tunnel.

In some environments, a username may be optional.

SSH Tunneling SSH Key

Key used to access the SSH tunnel.

NOTE: This key must be generated in legacy OpenSSH format. See below.

Generate SSH key

Please use the following command to generate an SSH key from the node where the database server node:

ssh-keygen -t rsa -m PEM

Use

When you have configured SSH tunneling properly, all users of the connection use the SSH configuration to access the targeted database.

When a connection is shared with credentials, the SSH authentication credentials are also shared. For more information, see Share a Connection.

Send Feedback

Page tree