From 9096e27794c6426784935c4a8f95c1f20eeb140a Mon Sep 17 00:00:00 2001 From: "Hugh A. Miles II" Date: Tue, 21 Feb 2023 22:23:32 -0500 Subject: [PATCH] chore: Add docs for ssh tunneling (#23131) Co-authored-by: Beto Dealmeida (cherry picked from commit a0ca0c04ff97c4d18c9567035e8b702bdca7f181) --- RESOURCES/FEATURE_FLAGS.md | 1 + .../docs/installation/setup-ssh-tunneling.mdx | 21 +++++++++++++++++++ 2 files changed, 22 insertions(+) create mode 100644 docs/docs/installation/setup-ssh-tunneling.mdx diff --git a/RESOURCES/FEATURE_FLAGS.md b/RESOURCES/FEATURE_FLAGS.md index aa4d6c635565d..76138f3ea5d9f 100644 --- a/RESOURCES/FEATURE_FLAGS.md +++ b/RESOURCES/FEATURE_FLAGS.md @@ -61,6 +61,7 @@ These features are **finished** but currently being tested. They are usable, but - GENERIC_CHART_AXES - GLOBAL_ASYNC_QUERIES [(docs)](https://github.com/apache/superset/blob/master/CONTRIBUTING.md#async-chart-queries) - RLS_IN_SQLLAB +- SSH_TUNNELING [(docs)](https://superset.apache.org/docs/installation/setup-ssh-tunneling) - USE_ANALAGOUS_COLORS - UX_BETA - VERSIONED_EXPORT diff --git a/docs/docs/installation/setup-ssh-tunneling.mdx b/docs/docs/installation/setup-ssh-tunneling.mdx new file mode 100644 index 0000000000000..a9ff34559d308 --- /dev/null +++ b/docs/docs/installation/setup-ssh-tunneling.mdx @@ -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.