-
Notifications
You must be signed in to change notification settings - Fork 13.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: Add docs for ssh tunneling (#23131)
Co-authored-by: Beto Dealmeida <roberto@dealmeida.net> (cherry picked from commit a0ca0c0)
- Loading branch information
Showing
2 changed files
with
22 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
title: Setup SSH Tunneling | ||
hide_title: true | ||
sidebar_position: 13 | ||
version: 1 | ||
--- | ||
|
||
## SSH Tunneling | ||
|
||
1. Turn on feature flag | ||
- Change [`SSH_TUNNELING`](https://github.com/apache/superset/blob/eb8386e3f0647df6d1bbde8b42073850796cc16f/superset/config.py#L489) to `True` | ||
- If you want to add more security when establishing the tunnel we allow users to overwrite the `SSHTunnelManager` class (here)[https://github.com/apache/superset/blob/eb8386e3f0647df6d1bbde8b42073850796cc16f/superset/config.py#L507] | ||
- You can also set the [`SSH_TUNNEL_LOCAL_BIND_ADDRESS`](https://github.com/apache/superset/blob/eb8386e3f0647df6d1bbde8b42073850796cc16f/superset/config.py#L508) this the host address where the tunnel will be accessible on your VPC | ||
|
||
2. Create database w/ ssh tunnel enabled | ||
- With the feature flag enabled you should now see ssh tunnel toggle. | ||
- Click the toggle to enables ssh tunneling and add your credentials accordingly. | ||
- Superset allows for 2 different type authenticaion (Basic + Private Key). These credentials should come from your service provider. | ||
|
||
3. Verify data is flowing | ||
- Once SSH tunneling has been enabled, go to SQL Lab and write a query to verify data is properly flowing. |