From 9ec933ea0b47f657c7e2476078d0b4ec67b89655 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Fri, 3 Sep 2021 19:21:38 -0400 Subject: [PATCH 01/21] docs(UPM-2046): docs for superset first pass --- .../06_analyze_with_superset.mdx | 86 +++++++++++++++++++ 1 file changed, 86 insertions(+) create mode 100644 product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx diff --git a/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx b/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx new file mode 100644 index 00000000000..e3ab8aa8b4f --- /dev/null +++ b/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx @@ -0,0 +1,86 @@ +--- +title: "Analyze with Apache Superset" +--- +You could use Apache Superset to analyze, explore, and visualize data stored in your PostgreSQL clusters. +If you are logged in to EDB Cloud and have permissions to access superset, you can open Apache Superset using one of **Analyze** links. + +!!! Note + Apache Superset shares Single Sign On with EDB Cloud. If you log out of Superset you will be logged out of EDB Cloud + + +## Connecting Superset to your Cluster + +To connect superset to your cluster you need to provide a connection string for your cluster. +As described [here](https://superset.apache.org/docs/databases/postgres#postgres) the connection string must have the following format: + + + `postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require` + +To find the host and port of your cluster: + + + +1. Sign in to the [EDB Cloud](https://portal.edbcloud.com/) portal. +2. Go to the [Clusters](https://portal.edbcloud.com/clusters) page. +3. Select the name of your cluster. +4. Select the **Connect** tab and find **Host** and **Port** . + +Connecting Superset to a EDB Cloud cluster is similar to connecting[ Superset to a new database](https://superset.apache.org/docs/creating-charts-dashboards/first-dashboard#connecting-to-a-new-database). +To create a connection to an EDB Cloud cluster: + +1. Sign in to the [EDB Cloud](https://portal.edbcloud.com/) portal. +2. Navigate to **Analyze->Connections**. +3. Select **+ Database **button on top right. This will open a dialog box. +4. Enter **DATABASE NAME**. Enter the connection string for your cluster as **SQLALCHEMY URI**, in the format described above. +5. Check the connection using the **TEST CONNECTION** button and add it if you see success pop-up + + + +Upon successful connection, you are good to add datasets, charts and dashboards. + + +!!! Note + Superset will only work with postgres clusters which are local to it or accessible on a public network. Add clusters from the region where the superset is deployed in the data plane. + + +## Using Superset Dashboards + +You can use Superset Dashboard to analyze data stored in your cluster. [This page](https://superset.apache.org/docs/creating-charts-dashboards/first-dashboard) contains instructions for creating a simple Superset dashboard. + +To view all available Superset Dashboards, navigate to** Analyze>Dashboards** + + +## Using Superset Charts + +You can use Superset Charts to visualize data stored in your cluster. [Superset documentation ](https://superset.apache.org/docs/creating-charts-dashboards/exploring-data)contains instructions and examples of creating Superset Chart. + +To view all available Superset Charts, navigate to **Analyze>Charts**. + + +## Using Superset SQL Lab + +You can use Superset SQL Lab to write queries to access/modify data stored in your cluster. To access SQL Lab, navigate to **Analyze>SQL Editor**. + + +## Superset Permissions + +Access to Superset data sources is controlled by Superset roles. Learn more about Superset Roles, Users and Permissions management in [Superset Security](https://superset.apache.org/docs/security). + +EDB Cloud account using the following special permission: + + + +* superset:admin +* superset:alpha + +The mapping of EDB Cloud permissions to Superset roles is as follows: + + + +* User has an `Admin` role in Superset if the user has an EDB Cloud role with `superset:admin` permission. +* User has an `Alpha` role in Superset if the user has an EDB Cloud role with `superset:alpha` permission. +* User has an `Gamma` role in Superset if no EDB Cloud role assigned to the user has any of the two superset permissions. + + + +You can control Access to Seperset by using EDB Cloud Roles and special EDB Cloud Superset permissions by assigning superset permissions to the user roles. See [Changing Role Permissions](../administering_cluster/01_portal_access/#changing-role-permissions). From a1551a26c2d4072f94a939ff9ce6faea27982a29 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Tue, 7 Sep 2021 10:17:25 -0400 Subject: [PATCH 02/21] docs(UPM-2046): docs for superset : integrating Simon's suggetions --- .../06_analyze_with_superset.mdx | 20 ++++++++----------- 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx b/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx index e3ab8aa8b4f..eb03a6e17cc 100644 --- a/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx @@ -39,10 +39,6 @@ To create a connection to an EDB Cloud cluster: Upon successful connection, you are good to add datasets, charts and dashboards. -!!! Note - Superset will only work with postgres clusters which are local to it or accessible on a public network. Add clusters from the region where the superset is deployed in the data plane. - - ## Using Superset Dashboards You can use Superset Dashboard to analyze data stored in your cluster. [This page](https://superset.apache.org/docs/creating-charts-dashboards/first-dashboard) contains instructions for creating a simple Superset dashboard. @@ -70,17 +66,17 @@ EDB Cloud account using the following special permission: -* superset:admin -* superset:alpha - -The mapping of EDB Cloud permissions to Superset roles is as follows: - +* _superset:admin_ +* _superset:alpha_ +These EDB Cloud permissions translate to Superset roles as follows: -* User has an `Admin` role in Superset if the user has an EDB Cloud role with `superset:admin` permission. -* User has an `Alpha` role in Superset if the user has an EDB Cloud role with `superset:alpha` permission. -* User has an `Gamma` role in Superset if no EDB Cloud role assigned to the user has any of the two superset permissions. +| User Superset Role | EDB Cloud User Role | Superset Privileges | +| --------------------| ---------------------------------------- | ----------------------------------------------------------------- | +| Gamma | Has no any superset related permissions | View data they granted access to, can create dashboards | +| Alpha | Include _superset:alpha_ permission | Gamma privileges +add or alter data sources | +| Admin | Include _superset:admin_ permission | Alpha privileges + grant or revoke access to data to other users | You can control Access to Seperset by using EDB Cloud Roles and special EDB Cloud Superset permissions by assigning superset permissions to the user roles. See [Changing Role Permissions](../administering_cluster/01_portal_access/#changing-role-permissions). From f76d650989536d3d90d4bf66aa6ebc573299aef0 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Tue, 7 Sep 2021 10:20:19 -0400 Subject: [PATCH 03/21] docs(UPM-2046): docs for superset : integrating Vishal's suggestions --- .../release/using_cluster/06_analyze_with_superset.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx b/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx index eb03a6e17cc..fd453734dfa 100644 --- a/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx @@ -5,7 +5,7 @@ You could use Apache Superset to analyze, explore, and visualize data stored in If you are logged in to EDB Cloud and have permissions to access superset, you can open Apache Superset using one of **Analyze** links. !!! Note - Apache Superset shares Single Sign On with EDB Cloud. If you log out of Superset you will be logged out of EDB Cloud + Apache Superset shares Single Sign On with EDB Cloud. If you log out of Superset you will be logged out of EDB Cloud and vice-versa. ## Connecting Superset to your Cluster @@ -79,4 +79,4 @@ These EDB Cloud permissions translate to Superset roles as follows: | Admin | Include _superset:admin_ permission | Alpha privileges + grant or revoke access to data to other users | -You can control Access to Seperset by using EDB Cloud Roles and special EDB Cloud Superset permissions by assigning superset permissions to the user roles. See [Changing Role Permissions](../administering_cluster/01_portal_access/#changing-role-permissions). +You can control Access to Superset by using EDB Cloud Roles and special EDB Cloud Superset permissions by assigning superset permissions to the user roles. See [Changing Role Permissions](../administering_cluster/01_portal_access/#changing-role-permissions). From a425c7cc02b5142d8c594ca2fc5e953798a4126d Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Tue, 7 Sep 2021 16:34:38 -0400 Subject: [PATCH 04/21] Update 06_analyze_with_superset.mdx --- .../06_analyze_with_superset.mdx | 63 ++++++++++--------- 1 file changed, 32 insertions(+), 31 deletions(-) diff --git a/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx b/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx index fd453734dfa..0498f855a4c 100644 --- a/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx @@ -1,73 +1,74 @@ --- -title: "Analyze with Apache Superset" +title: "Analyzing Your Data with Apache Superset" --- -You could use Apache Superset to analyze, explore, and visualize data stored in your PostgreSQL clusters. -If you are logged in to EDB Cloud and have permissions to access superset, you can open Apache Superset using one of **Analyze** links. +You can use Apache Superset to analyze, explore, and visualize data stored in your PostgreSQL clusters. +If you are logged in to EDB Cloud and have permissions to access Superset, you can open Apache Superset using one of **Analyze** links. !!! Note - Apache Superset shares Single Sign On with EDB Cloud. If you log out of Superset you will be logged out of EDB Cloud and vice-versa. + Apache Superset shares Single Sign On with EDB Cloud. If you log out of Superset you will be logged out of EDB Cloud and vice-versa. ## Connecting Superset to your Cluster -To connect superset to your cluster you need to provide a connection string for your cluster. -As described [here](https://superset.apache.org/docs/databases/postgres#postgres) the connection string must have the following format: - `postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require` -To find the host and port of your cluster: +You will need your host and port to connect to Superset. To find the host and port of your cluster: +1. Sign in to the [EDB Cloud](https://portal.edbcloud.com/) portal. +3. Go to the [Clusters](https://portal.edbcloud.com/clusters) page. +4. Select the name of your cluster. +5. Select the **Connect** tab and find **Host** and **Port**. -1. Sign in to the [EDB Cloud](https://portal.edbcloud.com/) portal. -2. Go to the [Clusters](https://portal.edbcloud.com/clusters) page. -3. Select the name of your cluster. -4. Select the **Connect** tab and find **Host** and **Port** . -Connecting Superset to a EDB Cloud cluster is similar to connecting[ Superset to a new database](https://superset.apache.org/docs/creating-charts-dashboards/first-dashboard#connecting-to-a-new-database). To create a connection to an EDB Cloud cluster: 1. Sign in to the [EDB Cloud](https://portal.edbcloud.com/) portal. -2. Navigate to **Analyze->Connections**. -3. Select **+ Database **button on top right. This will open a dialog box. -4. Enter **DATABASE NAME**. Enter the connection string for your cluster as **SQLALCHEMY URI**, in the format described above. -5. Check the connection using the **TEST CONNECTION** button and add it if you see success pop-up +2. Navigate to **Analyze > Connections**. +3. Select the **+ Database** button on top right. This will open a dialog box. +4. Enter a value for **DATABASE NAME**. +5. Enter the connection string for your cluster as **SQLALCHEMY URI**, in the following format: + + `postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require` + +7. Check the connection using the **TEST CONNECTION** button and add it if the connection was successful. +For more information on connecting to Superset, see: +- [Superset documentation on connecting to Postgres](https://superset.apache.org/docs/databases/postgres#postgres). +- [Connecting Superset to a new database](https://superset.apache.org/docs/creating-charts-dashboards/first-dashboard#connecting-to-a-new-database) since connecting Superset to a EDB Cloud cluster is similar to connecting to a new database. -Upon successful connection, you are good to add datasets, charts and dashboards. +Upon successful connection, you are good to add datasets, charts, and dashboards. -## Using Superset Dashboards +## Using Superset Dashboards -You can use Superset Dashboard to analyze data stored in your cluster. [This page](https://superset.apache.org/docs/creating-charts-dashboards/first-dashboard) contains instructions for creating a simple Superset dashboard. +You can use Superset dashboards to analyze data stored in your cluster. For a tutorial on creating a simple dashboard, see [Creating Your First Dashboard](https://superset.apache.org/docs/creating-charts-dashboards/first-dashboard). -To view all available Superset Dashboards, navigate to** Analyze>Dashboards** +To view all available Superset dashboards, navigate to **Analyze > Dashboards**. ## Using Superset Charts -You can use Superset Charts to visualize data stored in your cluster. [Superset documentation ](https://superset.apache.org/docs/creating-charts-dashboards/exploring-data)contains instructions and examples of creating Superset Chart. +You can use Superset charts to visualize data stored in your cluster. See the [Superset documentation](https://superset.apache.org/docs/creating-charts-dashboards/exploring-data) for instructions and examples of creating Superset charts. -To view all available Superset Charts, navigate to **Analyze>Charts**. +To view all available Superset charts, navigate to **Analyze > Charts**. ## Using Superset SQL Lab -You can use Superset SQL Lab to write queries to access/modify data stored in your cluster. To access SQL Lab, navigate to **Analyze>SQL Editor**. +You can use Superset SQL Lab to write queries to access and modify data stored in your cluster. To access SQL Lab, navigate to **Analyze > SQL Editor**. ## Superset Permissions -Access to Superset data sources is controlled by Superset roles. Learn more about Superset Roles, Users and Permissions management in [Superset Security](https://superset.apache.org/docs/security). - -EDB Cloud account using the following special permission: - +Access to Superset data sources is controlled by Superset roles. Learn more about superset roles, users and permissions management in [Superset Security](https://superset.apache.org/docs/security). +EDB Cloud users can be granted the following special permissions: -* _superset:admin_ -* _superset:alpha_ +* superset:admin +* superset:alpha These EDB Cloud permissions translate to Superset roles as follows: @@ -79,4 +80,4 @@ These EDB Cloud permissions translate to Superset roles as follows: | Admin | Include _superset:admin_ permission | Alpha privileges + grant or revoke access to data to other users | -You can control Access to Superset by using EDB Cloud Roles and special EDB Cloud Superset permissions by assigning superset permissions to the user roles. See [Changing Role Permissions](../administering_cluster/01_portal_access/#changing-role-permissions). +You can control access to Superset by assigning superset permissions to EDB Cloud user roles. See [Changing Role Permissions](../administering_cluster/01_portal_access/#changing-role-permissions). From 12f456c9a4f3faa3b3edac268987eb383f7ebe26 Mon Sep 17 00:00:00 2001 From: skrivov-edb Date: Wed, 8 Sep 2021 20:30:00 -0400 Subject: [PATCH 05/21] docs(UPM-2046): docs for superset : gamma --- .../06_analyze_with_superset.mdx | 21 ++++++++++--------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx b/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx index 0498f855a4c..7f7d5b427cb 100644 --- a/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx @@ -28,15 +28,15 @@ To create a connection to an EDB Cloud cluster: 2. Navigate to **Analyze > Connections**. 3. Select the **+ Database** button on top right. This will open a dialog box. -4. Enter a value for **DATABASE NAME**. +4. Enter a value for **DATABASE NAME**. 5. Enter the connection string for your cluster as **SQLALCHEMY URI**, in the following format: - + `postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require` - + 7. Check the connection using the **TEST CONNECTION** button and add it if the connection was successful. -For more information on connecting to Superset, see: -- [Superset documentation on connecting to Postgres](https://superset.apache.org/docs/databases/postgres#postgres). +For more information on connecting to Superset, see: +- [Superset documentation on connecting to Postgres](https://superset.apache.org/docs/databases/postgres#postgres). - [Connecting Superset to a new database](https://superset.apache.org/docs/creating-charts-dashboards/first-dashboard#connecting-to-a-new-database) since connecting Superset to a EDB Cloud cluster is similar to connecting to a new database. Upon successful connection, you are good to add datasets, charts, and dashboards. @@ -69,15 +69,16 @@ EDB Cloud users can be granted the following special permissions: * superset:admin * superset:alpha +* superset:gamma These EDB Cloud permissions translate to Superset roles as follows: -| User Superset Role | EDB Cloud User Role | Superset Privileges | -| --------------------| ---------------------------------------- | ----------------------------------------------------------------- | -| Gamma | Has no any superset related permissions | View data they granted access to, can create dashboards | -| Alpha | Include _superset:alpha_ permission | Gamma privileges +add or alter data sources | -| Admin | Include _superset:admin_ permission | Alpha privileges + grant or revoke access to data to other users | +| User Superset Role | EDB Cloud User Role | Superset Privileges | +| --------------------| ----------------------------------------------------------- | ----------------------------------------------------------------- | +| Gamma | Has _superset:gamma_ or no any superset related permissions | View data they granted access to, can create dashboards | +| Alpha | Include _superset:alpha_ permission | Gamma privileges +add or alter data sources | +| Admin | Include _superset:admin_ permission | Alpha privileges + grant or revoke access to data to other users | You can control access to Superset by assigning superset permissions to EDB Cloud user roles. See [Changing Role Permissions](../administering_cluster/01_portal_access/#changing-role-permissions). From 6ade096d2fa6569b62880de3a1559edeb8828e17 Mon Sep 17 00:00:00 2001 From: drothery-edb <83650384+drothery-edb@users.noreply.github.com> Date: Thu, 9 Sep 2021 10:26:31 -0400 Subject: [PATCH 06/21] Dee-comments-superset-gamma Dee's comments on Superset Permissions section --- .../using_cluster/06_analyze_with_superset.mdx | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx b/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx index 7f7d5b427cb..3f0fe1ce44a 100644 --- a/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx @@ -51,7 +51,7 @@ To view all available Superset dashboards, navigate to **Analyze > Dashboards**. ## Using Superset Charts -You can use Superset charts to visualize data stored in your cluster. See the [Superset documentation](https://superset.apache.org/docs/creating-charts-dashboards/exploring-data) for instructions and examples of creating Superset charts. +You can use Superset charts to visualize data stored in your cluster, see the [Superset documentation](https://superset.apache.org/docs/creating-charts-dashboards/exploring-data) for instructions and examples of creating Superset charts. To view all available Superset charts, navigate to **Analyze > Charts**. @@ -63,7 +63,7 @@ You can use Superset SQL Lab to write queries to access and modify data stored i ## Superset Permissions -Access to Superset data sources is controlled by Superset roles. Learn more about superset roles, users and permissions management in [Superset Security](https://superset.apache.org/docs/security). +You control access to Superset data sources by Superset roles and permissions. Learn more about Superset roles, users, and permissions management in [Superset Security](https://superset.apache.org/docs/security). To assign Superset permissions to EDB Cloud user role, see [Changing Role Permissions](../administering_cluster/01_portal_access/#changing-role-permissions). EDB Cloud users can be granted the following special permissions: @@ -74,11 +74,11 @@ EDB Cloud users can be granted the following special permissions: These EDB Cloud permissions translate to Superset roles as follows: -| User Superset Role | EDB Cloud User Role | Superset Privileges | +| User Superset Role | Permissions Included in EDB Cloud User Role | Superset Privileges | | --------------------| ----------------------------------------------------------- | ----------------------------------------------------------------- | -| Gamma | Has _superset:gamma_ or no any superset related permissions | View data they granted access to, can create dashboards | -| Alpha | Include _superset:alpha_ permission | Gamma privileges +add or alter data sources | -| Admin | Include _superset:admin_ permission | Alpha privileges + grant or revoke access to data to other users | +| Gamma | Either superset:gamma or no Superset-related permissions | View data that user has been granted access to, create dashboards | +| Alpha | superset:alpha | Gamma privileges, add or alter data sources | +| Admin | superset:admin_ permission | Alpha privileges, grant or revoke access to data to other users | + -You can control access to Superset by assigning superset permissions to EDB Cloud user roles. See [Changing Role Permissions](../administering_cluster/01_portal_access/#changing-role-permissions). From 9e3ea8bf87b54939c92e6eb3188e3cb554875c9b Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Thu, 16 Sep 2021 10:27:30 -0400 Subject: [PATCH 07/21] updated content after getting a demo moved permissions section to a new topic under Administering --- .../01a_superset_access.mdx | 20 +++++++++++ .../06_analyze_with_superset.mdx | 34 ++++++------------- .../biganimal/release/using_cluster/index.mdx | 2 +- .../beta/administering_cluster/index.mdx | 5 +++ .../edbcloud/beta/using_cluster/index.mdx | 7 ++++ 5 files changed, 43 insertions(+), 25 deletions(-) create mode 100644 product_docs/docs/biganimal/release/administering_cluster/01a_superset_access.mdx create mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/index.mdx create mode 100644 product_docs/docs/edbcloud/beta/using_cluster/index.mdx diff --git a/product_docs/docs/biganimal/release/administering_cluster/01a_superset_access.mdx b/product_docs/docs/biganimal/release/administering_cluster/01a_superset_access.mdx new file mode 100644 index 00000000000..3a172bcf96e --- /dev/null +++ b/product_docs/docs/biganimal/release/administering_cluster/01a_superset_access.mdx @@ -0,0 +1,20 @@ +--- +title: Managing Superset Access +--- + +You control access to Superset data sources by Superset roles and permissions. Learn more about Superset roles, users, and permissions management in [Superset Security](https://superset.apache.org/docs/security). To assign Superset permissions to the EDB Cloud user role, see [Changing Role Permissions](01_portal_access/#changing-role-permissions). + +EDB Cloud users can be granted the following special permissions: + +* superset:admin +* superset:alpha +* superset:gamma (granted by default) + +These EDB Cloud permissions translate to Superset roles as follows: + + +| User Superset Role | Permissions Included in EDB Cloud User Role | Superset Privileges | +| --------------------| ----------------------------------------------------------- | ----------------------------------------------------------------- | +| Gamma | No additional permissions needed | View data that user has been granted access to, create dashboards | +| Alpha | superset:alpha | Gamma privileges, add or alter data sources | +| Admin | superset:admin_ permission | Alpha privileges, grant or revoke access to data to other users | \ No newline at end of file diff --git a/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx b/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx index 3f0fe1ce44a..dc844496f40 100644 --- a/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx @@ -2,7 +2,9 @@ title: "Analyzing Your Data with Apache Superset" --- You can use Apache Superset to analyze, explore, and visualize data stored in your PostgreSQL clusters. -If you are logged in to EDB Cloud and have permissions to access Superset, you can open Apache Superset using one of **Analyze** links. +You can open Superset from the [EDB Cloud](https://portal.edbcloud.com/) portal using the **Analyze** links. + +Default permissions include the ability to view data and create dashboards. To add or alter data sources, you need additional permissions. For more information on permissions to access Superset, see [Managing Superset Access](../administering_cluster/01a_superset_access). !!! Note Apache Superset shares Single Sign On with EDB Cloud. If you log out of Superset you will be logged out of EDB Cloud and vice-versa. @@ -13,7 +15,7 @@ If you are logged in to EDB Cloud and have permissions to access Superset, you c -You will need your host and port to connect to Superset. To find the host and port of your cluster: +You need your host and port to connect to Superset. To find the host and port of your cluster: 1. Sign in to the [EDB Cloud](https://portal.edbcloud.com/) portal. @@ -27,19 +29,20 @@ To create a connection to an EDB Cloud cluster: 1. Sign in to the [EDB Cloud](https://portal.edbcloud.com/) portal. 2. Navigate to **Analyze > Connections**. -3. Select the **+ Database** button on top right. This will open a dialog box. +3. Select **+ Database** to open the **Add database** dialog box. 4. Enter a value for **DATABASE NAME**. -5. Enter the connection string for your cluster as **SQLALCHEMY URI**, in the following format: +5. Enter the connection string for your cluster in the **SQLALCHEMY URI** field, using the following format: `postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require` -7. Check the connection using the **TEST CONNECTION** button and add it if the connection was successful. +7. Check the connection by selecting **TEST CONNECTION**. Select **ADD** if the connection was successful. For more information on connecting to Superset, see: -- [Superset documentation on connecting to Postgres](https://superset.apache.org/docs/databases/postgres#postgres). - [Connecting Superset to a new database](https://superset.apache.org/docs/creating-charts-dashboards/first-dashboard#connecting-to-a-new-database) since connecting Superset to a EDB Cloud cluster is similar to connecting to a new database. +- [Superset documentation on connecting to Postgres](https://superset.apache.org/docs/databases/postgres#postgres). -Upon successful connection, you are good to add datasets, charts, and dashboards. + +Upon successful connection, you can add datasets, charts, and dashboards. ## Using Superset Dashboards @@ -61,24 +64,7 @@ To view all available Superset charts, navigate to **Analyze > Charts**. You can use Superset SQL Lab to write queries to access and modify data stored in your cluster. To access SQL Lab, navigate to **Analyze > SQL Editor**. -## Superset Permissions - -You control access to Superset data sources by Superset roles and permissions. Learn more about Superset roles, users, and permissions management in [Superset Security](https://superset.apache.org/docs/security). To assign Superset permissions to EDB Cloud user role, see [Changing Role Permissions](../administering_cluster/01_portal_access/#changing-role-permissions). - -EDB Cloud users can be granted the following special permissions: - -* superset:admin -* superset:alpha -* superset:gamma - -These EDB Cloud permissions translate to Superset roles as follows: - -| User Superset Role | Permissions Included in EDB Cloud User Role | Superset Privileges | -| --------------------| ----------------------------------------------------------- | ----------------------------------------------------------------- | -| Gamma | Either superset:gamma or no Superset-related permissions | View data that user has been granted access to, create dashboards | -| Alpha | superset:alpha | Gamma privileges, add or alter data sources | -| Admin | superset:admin_ permission | Alpha privileges, grant or revoke access to data to other users | diff --git a/product_docs/docs/biganimal/release/using_cluster/index.mdx b/product_docs/docs/biganimal/release/using_cluster/index.mdx index ce71430b69a..3d52b2aaff1 100644 --- a/product_docs/docs/biganimal/release/using_cluster/index.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/index.mdx @@ -2,4 +2,4 @@ title: "Using your cluster" --- -Account owners and contributors can connect, edit, scale, and monitor clusters through the BigAnimal portal. You can also restore clusters from BigAnimal automatic backups. +Account owners and contributors can connect, edit, scale, and monitor clusters through the BigAnimal portal. This section also provides information on how BigAnimal handles backup and restore and how to use Apache Superset to analyze the data in your clusters. diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/index.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/index.mdx new file mode 100644 index 00000000000..a1003fcbac7 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/administering_cluster/index.mdx @@ -0,0 +1,5 @@ +--- +title: "Administering Your Account" +--- + +In this section, account owners can find information on administrative activities for the EDB Cloud account including portal and database user access management as well as account activity reviews. diff --git a/product_docs/docs/edbcloud/beta/using_cluster/index.mdx b/product_docs/docs/edbcloud/beta/using_cluster/index.mdx new file mode 100644 index 00000000000..82cb6ab4224 --- /dev/null +++ b/product_docs/docs/edbcloud/beta/using_cluster/index.mdx @@ -0,0 +1,7 @@ +--- +title: "Using Your Cluster" +--- + +In this section, account owners and contributors can learn how to connect, edit, scale, and monitor clusters through the EDB Cloud portal. This section also provides information on how EDB Cloud handles backup and restore and how to use Apache Superset to analyze the data in your clusters. + + From d692b3c7fd4f5138910af0cb47d8237ac7897243 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Mon, 20 Sep 2021 16:21:33 -0400 Subject: [PATCH 08/21] addressing Ben's comments First cut at addressing Ben's comments --- .../01a_superset_access.mdx | 25 +++++++++++-------- .../06_analyze_with_superset.mdx | 6 ++--- 2 files changed, 17 insertions(+), 14 deletions(-) diff --git a/product_docs/docs/biganimal/release/administering_cluster/01a_superset_access.mdx b/product_docs/docs/biganimal/release/administering_cluster/01a_superset_access.mdx index 3a172bcf96e..fac801efc5d 100644 --- a/product_docs/docs/biganimal/release/administering_cluster/01a_superset_access.mdx +++ b/product_docs/docs/biganimal/release/administering_cluster/01a_superset_access.mdx @@ -2,19 +2,22 @@ title: Managing Superset Access --- -You control access to Superset data sources by Superset roles and permissions. Learn more about Superset roles, users, and permissions management in [Superset Security](https://superset.apache.org/docs/security). To assign Superset permissions to the EDB Cloud user role, see [Changing Role Permissions](01_portal_access/#changing-role-permissions). +You control access to Superset data sources by Superset roles and permissions. -EDB Cloud users can be granted the following special permissions: +Superset has three roles: -* superset:admin -* superset:alpha -* superset:gamma (granted by default) +- Gamma +- Alpha +- Admin -These EDB Cloud permissions translate to Superset roles as follows: +Learn more about Superset roles, users, and permissions management in [Superset Security](https://superset.apache.org/docs/security). +The Superset roles map to EDB Cloud permissions. You can add the Superset EDB Cloud permissions to EDB Cloud user roles, as needed. -| User Superset Role | Permissions Included in EDB Cloud User Role | Superset Privileges | -| --------------------| ----------------------------------------------------------- | ----------------------------------------------------------------- | -| Gamma | No additional permissions needed | View data that user has been granted access to, create dashboards | -| Alpha | superset:alpha | Gamma privileges, add or alter data sources | -| Admin | superset:admin_ permission | Alpha privileges, grant or revoke access to data to other users | \ No newline at end of file +| Superset Role | Description | EDB Cloud Superset Permissions +| --------------- | ------------- | ------------------------------------------ | +| Gamma | View data that user has been granted access to, create dashboards | No additional permissions needed +| Alpha | All Superset Gamma privileges, plus the ability to add or alter data sources | superset:alpha | +| Admin | All Superset Alpha privileges, plus the ability to grant or revoke access to data to other users | superset:admin_ permission + +To assign Superset permissions to the EDB Cloud user role, see [Changing Role Permissions](01_portal_access/#changing-role-permissions). \ No newline at end of file diff --git a/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx b/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx index dc844496f40..dcf83319e4b 100644 --- a/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx @@ -15,13 +15,13 @@ Default permissions include the ability to view data and create dashboards. To a -You need your host and port to connect to Superset. To find the host and port of your cluster: +In addition to your password, you need your user, host, port, and database name to connect to Superset. To find this additional information for your cluster: 1. Sign in to the [EDB Cloud](https://portal.edbcloud.com/) portal. 3. Go to the [Clusters](https://portal.edbcloud.com/clusters) page. 4. Select the name of your cluster. -5. Select the **Connect** tab and find **Host** and **Port**. +5. Select the **Connect** tab. To create a connection to an EDB Cloud cluster: @@ -33,7 +33,7 @@ To create a connection to an EDB Cloud cluster: 4. Enter a value for **DATABASE NAME**. 5. Enter the connection string for your cluster in the **SQLALCHEMY URI** field, using the following format: - `postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require` + `postgresql://{username}:{password}@{host}:{port}/{dbname}?sslmode=verify-full` 7. Check the connection by selecting **TEST CONNECTION**. Select **ADD** if the connection was successful. From 314d315c91b10e8cf3f9a10936e5f5bdaa6d26a0 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Wed, 22 Sep 2021 09:48:08 -0400 Subject: [PATCH 09/21] incorporated more comments incorporated more comments --- .../release/administering_cluster/01a_superset_access.mdx | 4 ++-- .../release/using_cluster/06_analyze_with_superset.mdx | 3 +++ 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/biganimal/release/administering_cluster/01a_superset_access.mdx b/product_docs/docs/biganimal/release/administering_cluster/01a_superset_access.mdx index fac801efc5d..ac648a07b5f 100644 --- a/product_docs/docs/biganimal/release/administering_cluster/01a_superset_access.mdx +++ b/product_docs/docs/biganimal/release/administering_cluster/01a_superset_access.mdx @@ -14,10 +14,10 @@ Learn more about Superset roles, users, and permissions management in [Superset The Superset roles map to EDB Cloud permissions. You can add the Superset EDB Cloud permissions to EDB Cloud user roles, as needed. -| Superset Role | Description | EDB Cloud Superset Permissions +| Superset Role | Description | EDB Cloud Permissions Mapped to Superset Role | --------------- | ------------- | ------------------------------------------ | | Gamma | View data that user has been granted access to, create dashboards | No additional permissions needed | Alpha | All Superset Gamma privileges, plus the ability to add or alter data sources | superset:alpha | -| Admin | All Superset Alpha privileges, plus the ability to grant or revoke access to data to other users | superset:admin_ permission +| Admin | All Superset Alpha privileges, plus the ability to grant or revoke access to data to other users | superset:admin To assign Superset permissions to the EDB Cloud user role, see [Changing Role Permissions](01_portal_access/#changing-role-permissions). \ No newline at end of file diff --git a/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx b/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx index dcf83319e4b..fb68ef9aa30 100644 --- a/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx @@ -23,6 +23,9 @@ In addition to your password, you need your user, host, port, and database name 4. Select the name of your cluster. 5. Select the **Connect** tab. +!!!note +Superset encyrpts your password. +!!! To create a connection to an EDB Cloud cluster: From 038e3d3cc2e1254fe02e5c872a5501f0a84a5bce Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Thu, 23 Sep 2021 14:25:14 -0400 Subject: [PATCH 10/21] Incorporating Ben's comments from 9/23 Incorporating Ben's comments from 9/23 --- .../using_cluster/06_analyze_with_superset.mdx | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx b/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx index fb68ef9aa30..ce93470b4e7 100644 --- a/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx @@ -23,9 +23,7 @@ In addition to your password, you need your user, host, port, and database name 4. Select the name of your cluster. 5. Select the **Connect** tab. -!!!note -Superset encyrpts your password. -!!! + To create a connection to an EDB Cloud cluster: @@ -37,11 +35,14 @@ To create a connection to an EDB Cloud cluster: 5. Enter the connection string for your cluster in the **SQLALCHEMY URI** field, using the following format: `postgresql://{username}:{password}@{host}:{port}/{dbname}?sslmode=verify-full` - + !!!note + Your password is always encrypted before storage and never leaves your cloud environment. It's used only by the Superset software running in your EDB Cloud infrastructure. As a defense-in-depth mechanism, EDB Cloud recommends using a Postgres user dedicated to Superset with a minimal set of read-only privileges to just the database you're connecting. Never use your `edb_admin` user with Superset. + !!! + 7. Check the connection by selecting **TEST CONNECTION**. Select **ADD** if the connection was successful. -For more information on connecting to Superset, see: -- [Connecting Superset to a new database](https://superset.apache.org/docs/creating-charts-dashboards/first-dashboard#connecting-to-a-new-database) since connecting Superset to a EDB Cloud cluster is similar to connecting to a new database. +For more information on connecting to Superset, see the upstream Superset documentation: +- [Connecting Superset to a new database](https://superset.apache.org/docs/creating-charts-dashboards/first-dashboard#connecting-to-a-new-database) - connecting Superset to a EDB Cloud cluster is similar to connecting to any new database. - [Superset documentation on connecting to Postgres](https://superset.apache.org/docs/databases/postgres#postgres). From 17d160a87ebf399aa54e0fb42efbcaf1800c6dfd Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Fri, 24 Sep 2021 13:52:57 -0400 Subject: [PATCH 11/21] removed "ready-only" from guidance removed "ready-only" from guidance re passwords and security --- .../release/using_cluster/06_analyze_with_superset.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx b/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx index ce93470b4e7..45b0c43dea4 100644 --- a/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx @@ -36,7 +36,7 @@ To create a connection to an EDB Cloud cluster: `postgresql://{username}:{password}@{host}:{port}/{dbname}?sslmode=verify-full` !!!note - Your password is always encrypted before storage and never leaves your cloud environment. It's used only by the Superset software running in your EDB Cloud infrastructure. As a defense-in-depth mechanism, EDB Cloud recommends using a Postgres user dedicated to Superset with a minimal set of read-only privileges to just the database you're connecting. Never use your `edb_admin` user with Superset. + Your password is always encrypted before storage and never leaves your cloud environment. It's used only by the Superset software running in your EDB Cloud infrastructure. As a defense-in-depth mechanism, EDB Cloud recommends using a Postgres user dedicated to Superset with a minimal set of privileges to just the database you're connecting. Never use your `edb_admin` user with Superset. !!! 7. Check the connection by selecting **TEST CONNECTION**. Select **ADD** if the connection was successful. From eb8c04b2ea6218e42d7c31035d9dd4a937eb0944 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Tue, 18 Jan 2022 14:39:20 -0500 Subject: [PATCH 12/21] cleanup after rebase --- .../release/administering_cluster/01a_superset_access.mdx | 6 +++--- .../docs/edbcloud/beta/administering_cluster/index.mdx | 5 ----- product_docs/docs/edbcloud/beta/using_cluster/index.mdx | 7 ------- 3 files changed, 3 insertions(+), 15 deletions(-) delete mode 100644 product_docs/docs/edbcloud/beta/administering_cluster/index.mdx delete mode 100644 product_docs/docs/edbcloud/beta/using_cluster/index.mdx diff --git a/product_docs/docs/biganimal/release/administering_cluster/01a_superset_access.mdx b/product_docs/docs/biganimal/release/administering_cluster/01a_superset_access.mdx index ac648a07b5f..1e91ecf2d41 100644 --- a/product_docs/docs/biganimal/release/administering_cluster/01a_superset_access.mdx +++ b/product_docs/docs/biganimal/release/administering_cluster/01a_superset_access.mdx @@ -12,12 +12,12 @@ Superset has three roles: Learn more about Superset roles, users, and permissions management in [Superset Security](https://superset.apache.org/docs/security). -The Superset roles map to EDB Cloud permissions. You can add the Superset EDB Cloud permissions to EDB Cloud user roles, as needed. +The Superset roles map to BigAnimal permissions. You can add the Superset BigAnimal permissions to BigAnimal user roles, as needed. -| Superset Role | Description | EDB Cloud Permissions Mapped to Superset Role +| Superset Role | Description | BigAnimal Permissions Mapped to Superset Role | --------------- | ------------- | ------------------------------------------ | | Gamma | View data that user has been granted access to, create dashboards | No additional permissions needed | Alpha | All Superset Gamma privileges, plus the ability to add or alter data sources | superset:alpha | | Admin | All Superset Alpha privileges, plus the ability to grant or revoke access to data to other users | superset:admin -To assign Superset permissions to the EDB Cloud user role, see [Changing Role Permissions](01_portal_access/#changing-role-permissions). \ No newline at end of file +To assign Superset permissions to the BigAnimal user role, see [Changing Role Permissions](01_portal_access/#changing-role-permissions). \ No newline at end of file diff --git a/product_docs/docs/edbcloud/beta/administering_cluster/index.mdx b/product_docs/docs/edbcloud/beta/administering_cluster/index.mdx deleted file mode 100644 index a1003fcbac7..00000000000 --- a/product_docs/docs/edbcloud/beta/administering_cluster/index.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Administering Your Account" ---- - -In this section, account owners can find information on administrative activities for the EDB Cloud account including portal and database user access management as well as account activity reviews. diff --git a/product_docs/docs/edbcloud/beta/using_cluster/index.mdx b/product_docs/docs/edbcloud/beta/using_cluster/index.mdx deleted file mode 100644 index 82cb6ab4224..00000000000 --- a/product_docs/docs/edbcloud/beta/using_cluster/index.mdx +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: "Using Your Cluster" ---- - -In this section, account owners and contributors can learn how to connect, edit, scale, and monitor clusters through the EDB Cloud portal. This section also provides information on how EDB Cloud handles backup and restore and how to use Apache Superset to analyze the data in your clusters. - - From 0da93f8624f79c26394ef5d0022814caf43b60bb Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Tue, 18 Jan 2022 14:45:06 -0500 Subject: [PATCH 13/21] more EDB Cloud cleanup --- .../using_cluster/06_analyze_with_superset.mdx | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx b/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx index 45b0c43dea4..b9a071e5547 100644 --- a/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx @@ -2,12 +2,12 @@ title: "Analyzing Your Data with Apache Superset" --- You can use Apache Superset to analyze, explore, and visualize data stored in your PostgreSQL clusters. -You can open Superset from the [EDB Cloud](https://portal.edbcloud.com/) portal using the **Analyze** links. +You can open Superset from the [BigAnimal](https://portal.biganimal.com/) portal using the **Analyze** links. Default permissions include the ability to view data and create dashboards. To add or alter data sources, you need additional permissions. For more information on permissions to access Superset, see [Managing Superset Access](../administering_cluster/01a_superset_access). !!! Note - Apache Superset shares Single Sign On with EDB Cloud. If you log out of Superset you will be logged out of EDB Cloud and vice-versa. + Apache Superset shares Single Sign On with BigAnimal. If you log out of Superset you will be logged out of BigAnimal and vice-versa. ## Connecting Superset to your Cluster @@ -17,17 +17,17 @@ Default permissions include the ability to view data and create dashboards. To a In addition to your password, you need your user, host, port, and database name to connect to Superset. To find this additional information for your cluster: -1. Sign in to the [EDB Cloud](https://portal.edbcloud.com/) portal. +1. Sign in to the [BigAnimal](https://portal.biganimal.com/) portal. -3. Go to the [Clusters](https://portal.edbcloud.com/clusters) page. +3. Go to the [Clusters](https://portal.biganimal.com/clusters) page. 4. Select the name of your cluster. 5. Select the **Connect** tab. -To create a connection to an EDB Cloud cluster: +To create a connection to a BigAnimal cluster: -1. Sign in to the [EDB Cloud](https://portal.edbcloud.com/) portal. +1. Sign in to the [BigAnimal](https://portal.edbcloud.com/) portal. 2. Navigate to **Analyze > Connections**. 3. Select **+ Database** to open the **Add database** dialog box. @@ -36,13 +36,13 @@ To create a connection to an EDB Cloud cluster: `postgresql://{username}:{password}@{host}:{port}/{dbname}?sslmode=verify-full` !!!note - Your password is always encrypted before storage and never leaves your cloud environment. It's used only by the Superset software running in your EDB Cloud infrastructure. As a defense-in-depth mechanism, EDB Cloud recommends using a Postgres user dedicated to Superset with a minimal set of privileges to just the database you're connecting. Never use your `edb_admin` user with Superset. + Your password is always encrypted before storage and never leaves your cloud environment. It's used only by the Superset software running in your BigAnimal infrastructure. As a defense-in-depth mechanism, EDB we recommend using a Postgres user dedicated to Superset with a minimal set of privileges to just the database you're connecting. Never use your `edb_admin` user with Superset. !!! 7. Check the connection by selecting **TEST CONNECTION**. Select **ADD** if the connection was successful. For more information on connecting to Superset, see the upstream Superset documentation: -- [Connecting Superset to a new database](https://superset.apache.org/docs/creating-charts-dashboards/first-dashboard#connecting-to-a-new-database) - connecting Superset to a EDB Cloud cluster is similar to connecting to any new database. +- [Connecting Superset to a new database](https://superset.apache.org/docs/creating-charts-dashboards/first-dashboard#connecting-to-a-new-database) - connecting Superset to a BigAnimal cluster is similar to connecting to any new database. - [Superset documentation on connecting to Postgres](https://superset.apache.org/docs/databases/postgres#postgres). From e14c4cdc7ba28125e66c13ae7a443fca897b0ae9 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Tue, 18 Jan 2022 14:46:28 -0500 Subject: [PATCH 14/21] fixing heading case --- .../release/using_cluster/06_analyze_with_superset.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx b/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx index b9a071e5547..070bc3aa8f9 100644 --- a/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx @@ -1,5 +1,5 @@ --- -title: "Analyzing Your Data with Apache Superset" +title: "Analyzing your data with Apache Superset" --- You can use Apache Superset to analyze, explore, and visualize data stored in your PostgreSQL clusters. You can open Superset from the [BigAnimal](https://portal.biganimal.com/) portal using the **Analyze** links. @@ -10,7 +10,7 @@ Default permissions include the ability to view data and create dashboards. To a Apache Superset shares Single Sign On with BigAnimal. If you log out of Superset you will be logged out of BigAnimal and vice-versa. -## Connecting Superset to your Cluster +## Connecting Superset to your cluster @@ -49,7 +49,7 @@ For more information on connecting to Superset, see the upstream Superset docume Upon successful connection, you can add datasets, charts, and dashboards. -## Using Superset Dashboards +## Using Superset dashboards You can use Superset dashboards to analyze data stored in your cluster. For a tutorial on creating a simple dashboard, see [Creating Your First Dashboard](https://superset.apache.org/docs/creating-charts-dashboards/first-dashboard). From fef22e6e6def7201e6dd1bd8facd098710c8e1ef Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Tue, 18 Jan 2022 14:47:22 -0500 Subject: [PATCH 15/21] yet more style guide updates --- .../release/administering_cluster/01a_superset_access.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/biganimal/release/administering_cluster/01a_superset_access.mdx b/product_docs/docs/biganimal/release/administering_cluster/01a_superset_access.mdx index 1e91ecf2d41..1a318e89e87 100644 --- a/product_docs/docs/biganimal/release/administering_cluster/01a_superset_access.mdx +++ b/product_docs/docs/biganimal/release/administering_cluster/01a_superset_access.mdx @@ -1,5 +1,5 @@ --- -title: Managing Superset Access +title: Managing Superset access --- You control access to Superset data sources by Superset roles and permissions. From 84e7c9174a21c3d180f76cb67c24f552b6acd1ef Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Fri, 21 Jan 2022 05:57:25 -0500 Subject: [PATCH 16/21] more cleanup and info about enabling the feature --- .../01a_superset_access.mdx | 2 +- .../release/administering_cluster/index.mdx | 2 ++ .../using_cluster/06_analyze_with_superset.mdx | 17 +++++++++-------- .../biganimal/release/using_cluster/index.mdx | 4 +++- 4 files changed, 15 insertions(+), 10 deletions(-) diff --git a/product_docs/docs/biganimal/release/administering_cluster/01a_superset_access.mdx b/product_docs/docs/biganimal/release/administering_cluster/01a_superset_access.mdx index 1a318e89e87..d3846e8d03f 100644 --- a/product_docs/docs/biganimal/release/administering_cluster/01a_superset_access.mdx +++ b/product_docs/docs/biganimal/release/administering_cluster/01a_superset_access.mdx @@ -14,7 +14,7 @@ Learn more about Superset roles, users, and permissions management in [Superset The Superset roles map to BigAnimal permissions. You can add the Superset BigAnimal permissions to BigAnimal user roles, as needed. -| Superset Role | Description | BigAnimal Permissions Mapped to Superset Role +| Superset role | Description | BigAnimal permissions mapped to Superset role | --------------- | ------------- | ------------------------------------------ | | Gamma | View data that user has been granted access to, create dashboards | No additional permissions needed | Alpha | All Superset Gamma privileges, plus the ability to add or alter data sources | superset:alpha | diff --git a/product_docs/docs/biganimal/release/administering_cluster/index.mdx b/product_docs/docs/biganimal/release/administering_cluster/index.mdx index e40afe7d6ba..9db3ff61754 100644 --- a/product_docs/docs/biganimal/release/administering_cluster/index.mdx +++ b/product_docs/docs/biganimal/release/administering_cluster/index.mdx @@ -3,3 +3,5 @@ title: "Administering your account" --- Administrative activities for the BigAnimal account include portal and database user access management as well as account activity reviews. + +If you have coordinated with [BigAnimal Support](../overview/support) to have the Apache Superset feature enabled, see [Managing Superset access](01a_superset_access) for information on setting up roles and permission for access to the Superset data sources. diff --git a/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx b/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx index 070bc3aa8f9..896228599d0 100644 --- a/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx @@ -1,10 +1,14 @@ --- title: "Analyzing your data with Apache Superset" --- -You can use Apache Superset to analyze, explore, and visualize data stored in your PostgreSQL clusters. +You can use Apache Superset to analyze, explore, and visualize data stored in your Postgres clusters. You can open Superset from the [BigAnimal](https://portal.biganimal.com/) portal using the **Analyze** links. -Default permissions include the ability to view data and create dashboards. To add or alter data sources, you need additional permissions. For more information on permissions to access Superset, see [Managing Superset Access](../administering_cluster/01a_superset_access). +!!!note + You need to contact [BigAnimal Support](../overview/support) to enable the Apache Superset feature. +!!! + +Default permissions include the ability to view data and create dashboards. To add or alter data sources, you need additional permissions. For more information on permissions to access Superset, see [Managing Superset access](../administering_cluster/01a_superset_access). !!! Note Apache Superset shares Single Sign On with BigAnimal. If you log out of Superset you will be logged out of BigAnimal and vice-versa. @@ -12,9 +16,6 @@ Default permissions include the ability to view data and create dashboards. To a ## Connecting Superset to your cluster - - - In addition to your password, you need your user, host, port, and database name to connect to Superset. To find this additional information for your cluster: 1. Sign in to the [BigAnimal](https://portal.biganimal.com/) portal. @@ -27,7 +28,7 @@ In addition to your password, you need your user, host, port, and database name To create a connection to a BigAnimal cluster: -1. Sign in to the [BigAnimal](https://portal.edbcloud.com/) portal. +1. Sign in to the [BigAnimal](https://portal.biganimal.com/) portal. 2. Navigate to **Analyze > Connections**. 3. Select **+ Database** to open the **Add database** dialog box. @@ -36,7 +37,7 @@ To create a connection to a BigAnimal cluster: `postgresql://{username}:{password}@{host}:{port}/{dbname}?sslmode=verify-full` !!!note - Your password is always encrypted before storage and never leaves your cloud environment. It's used only by the Superset software running in your BigAnimal infrastructure. As a defense-in-depth mechanism, EDB we recommend using a Postgres user dedicated to Superset with a minimal set of privileges to just the database you're connecting. Never use your `edb_admin` user with Superset. + Your password is always encrypted before storage and never leaves your cloud environment. It's used only by the Superset software running in your BigAnimal infrastructure. As a defense-in-depth mechanism, EDB we recommend using a Postgres user dedicated to Superset with a minimal set of privileges to just the database you're connecting. Never use your edb_admin user with Superset. !!! 7. Check the connection by selecting **TEST CONNECTION**. Select **ADD** if the connection was successful. @@ -56,7 +57,7 @@ You can use Superset dashboards to analyze data stored in your cluster. For a tu To view all available Superset dashboards, navigate to **Analyze > Dashboards**. -## Using Superset Charts +## Using Superset charts You can use Superset charts to visualize data stored in your cluster, see the [Superset documentation](https://superset.apache.org/docs/creating-charts-dashboards/exploring-data) for instructions and examples of creating Superset charts. diff --git a/product_docs/docs/biganimal/release/using_cluster/index.mdx b/product_docs/docs/biganimal/release/using_cluster/index.mdx index 3d52b2aaff1..10e66bbc134 100644 --- a/product_docs/docs/biganimal/release/using_cluster/index.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/index.mdx @@ -2,4 +2,6 @@ title: "Using your cluster" --- -Account owners and contributors can connect, edit, scale, and monitor clusters through the BigAnimal portal. This section also provides information on how BigAnimal handles backup and restore and how to use Apache Superset to analyze the data in your clusters. +Account owners and contributors can connect, edit, scale, and monitor clusters through the BigAnimal portal. This section also provides information on how BigAnimal handles backup and restore. + +If your organization has coordinated with [BigAnimal Support](../overview/support) to have the Apache Superset feature enabled, see [Analyzing your data with Apache Superset](06_analyze_with_superset) for information on using Apache Superset to analyze, explore, and visualize data stored in your Postgres clusters. From dd1c68a16bddcc869f8ae373b883611f1f19c4b5 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Tue, 25 Jan 2022 13:01:43 -0500 Subject: [PATCH 17/21] updated permissions --- .../release/administering_cluster/01a_superset_access.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/product_docs/docs/biganimal/release/administering_cluster/01a_superset_access.mdx b/product_docs/docs/biganimal/release/administering_cluster/01a_superset_access.mdx index d3846e8d03f..14369c68bf9 100644 --- a/product_docs/docs/biganimal/release/administering_cluster/01a_superset_access.mdx +++ b/product_docs/docs/biganimal/release/administering_cluster/01a_superset_access.mdx @@ -16,8 +16,8 @@ The Superset roles map to BigAnimal permissions. You can add the Superset BigAni | Superset role | Description | BigAnimal permissions mapped to Superset role | --------------- | ------------- | ------------------------------------------ | -| Gamma | View data that user has been granted access to, create dashboards | No additional permissions needed -| Alpha | All Superset Gamma privileges, plus the ability to add or alter data sources | superset:alpha | -| Admin | All Superset Alpha privileges, plus the ability to grant or revoke access to data to other users | superset:admin +| Gamma | View data that user has been granted access to, create dashboards | Reader | +| Alpha | All Superset Gamma privileges, plus the ability to add or alter data sources | Contributor | +| Admin | All Superset Alpha privileges, plus the ability to grant or revoke access to data to other users | Owner | To assign Superset permissions to the BigAnimal user role, see [Changing Role Permissions](01_portal_access/#changing-role-permissions). \ No newline at end of file From c92bf7b8f8a917472b8f60c9ac3a1ed0a0613ea5 Mon Sep 17 00:00:00 2001 From: Betsy Gitelman <93718720+ebgitelman@users.noreply.github.com> Date: Tue, 25 Jan 2022 14:03:06 -0500 Subject: [PATCH 18/21] Edits to Appache Superset content (editorial review) --- .../01a_superset_access.mdx | 6 ++-- .../release/administering_cluster/index.mdx | 2 +- .../06_analyze_with_superset.mdx | 34 +++++++++---------- .../biganimal/release/using_cluster/index.mdx | 4 +-- 4 files changed, 23 insertions(+), 23 deletions(-) diff --git a/product_docs/docs/biganimal/release/administering_cluster/01a_superset_access.mdx b/product_docs/docs/biganimal/release/administering_cluster/01a_superset_access.mdx index 14369c68bf9..c959c35f789 100644 --- a/product_docs/docs/biganimal/release/administering_cluster/01a_superset_access.mdx +++ b/product_docs/docs/biganimal/release/administering_cluster/01a_superset_access.mdx @@ -2,7 +2,7 @@ title: Managing Superset access --- -You control access to Superset data sources by Superset roles and permissions. +You control access to Superset data sources by using Superset roles and permissions. Superset has three roles: @@ -17,7 +17,7 @@ The Superset roles map to BigAnimal permissions. You can add the Superset BigAni | Superset role | Description | BigAnimal permissions mapped to Superset role | --------------- | ------------- | ------------------------------------------ | | Gamma | View data that user has been granted access to, create dashboards | Reader | -| Alpha | All Superset Gamma privileges, plus the ability to add or alter data sources | Contributor | +| Alpha | All Superset Gamma privileges, plus the ability to add or modify data sources | Contributor | | Admin | All Superset Alpha privileges, plus the ability to grant or revoke access to data to other users | Owner | -To assign Superset permissions to the BigAnimal user role, see [Changing Role Permissions](01_portal_access/#changing-role-permissions). \ No newline at end of file +To assign Superset permissions to the BigAnimal user role, see [Changing role permissions](01_portal_access/#changing-role-permissions). \ No newline at end of file diff --git a/product_docs/docs/biganimal/release/administering_cluster/index.mdx b/product_docs/docs/biganimal/release/administering_cluster/index.mdx index 9db3ff61754..a480aaf2b7c 100644 --- a/product_docs/docs/biganimal/release/administering_cluster/index.mdx +++ b/product_docs/docs/biganimal/release/administering_cluster/index.mdx @@ -4,4 +4,4 @@ title: "Administering your account" Administrative activities for the BigAnimal account include portal and database user access management as well as account activity reviews. -If you have coordinated with [BigAnimal Support](../overview/support) to have the Apache Superset feature enabled, see [Managing Superset access](01a_superset_access) for information on setting up roles and permission for access to the Superset data sources. +If you coordinated with [BigAnimal Support](../overview/support) to enable the Apache Superset feature, see [Managing Superset access](01a_superset_access) for information on setting up roles and permission for access to the Superset data sources. diff --git a/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx b/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx index 896228599d0..7b899122500 100644 --- a/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx @@ -5,18 +5,18 @@ You can use Apache Superset to analyze, explore, and visualize data stored in yo You can open Superset from the [BigAnimal](https://portal.biganimal.com/) portal using the **Analyze** links. !!!note - You need to contact [BigAnimal Support](../overview/support) to enable the Apache Superset feature. + Contact [BigAnimal Support](../overview/support) to enable the Apache Superset feature. !!! -Default permissions include the ability to view data and create dashboards. To add or alter data sources, you need additional permissions. For more information on permissions to access Superset, see [Managing Superset access](../administering_cluster/01a_superset_access). +Default permissions include the ability to view data and create dashboards. To add or modify data sources, you need additional permissions. For more information on permissions to access Superset, see [Managing Superset access](../administering_cluster/01a_superset_access). !!! Note - Apache Superset shares Single Sign On with BigAnimal. If you log out of Superset you will be logged out of BigAnimal and vice-versa. + Apache Superset shares single sign-on with BigAnimal. Logging out of Superset logs you out of BigAnimal and vice-versa. ## Connecting Superset to your cluster -In addition to your password, you need your user, host, port, and database name to connect to Superset. To find this additional information for your cluster: +In addition to your password, you need your user, host, port, and database name to connect to Superset. To find this information for your cluster: 1. Sign in to the [BigAnimal](https://portal.biganimal.com/) portal. @@ -26,24 +26,24 @@ In addition to your password, you need your user, host, port, and database name -To create a connection to a BigAnimal cluster: +To connect to a BigAnimal cluster: 1. Sign in to the [BigAnimal](https://portal.biganimal.com/) portal. -2. Navigate to **Analyze > Connections**. -3. Select **+ Database** to open the **Add database** dialog box. -4. Enter a value for **DATABASE NAME**. +2. Select **Analyze > Connections**. +3. Select **+ Database**. +4. In the Add Database dialog box, enter a value for **Database Name**. 5. Enter the connection string for your cluster in the **SQLALCHEMY URI** field, using the following format: - `postgresql://{username}:{password}@{host}:{port}/{dbname}?sslmode=verify-full` + `postgresql://{}:{}@{}:{}/{}?sslmode=verify-full` !!!note - Your password is always encrypted before storage and never leaves your cloud environment. It's used only by the Superset software running in your BigAnimal infrastructure. As a defense-in-depth mechanism, EDB we recommend using a Postgres user dedicated to Superset with a minimal set of privileges to just the database you're connecting. Never use your edb_admin user with Superset. + Your password is always encrypted before storage and never leaves your cloud environment. It's used only by the Superset software running in your BigAnimal infrastructure. As a defense-in-depth mechanism, we recommend using a Postgres user dedicated to Superset with a privileges to just the database you're connecting. Never use your edb_admin user with Superset. !!! -7. Check the connection by selecting **TEST CONNECTION**. Select **ADD** if the connection was successful. +6. Check the connection by selecting **Test Connection**. Select **Add** if the connection was successful. -For more information on connecting to Superset, see the upstream Superset documentation: -- [Connecting Superset to a new database](https://superset.apache.org/docs/creating-charts-dashboards/first-dashboard#connecting-to-a-new-database) - connecting Superset to a BigAnimal cluster is similar to connecting to any new database. +For more information on connecting to Superset, see the Superset documentation: +- [Connecting Superset to a new database](https://superset.apache.org/docs/creating-charts-dashboards/first-dashboard#connecting-to-a-new-database). Connecting Superset to a BigAnimal cluster is similar to connecting to any new database. - [Superset documentation on connecting to Postgres](https://superset.apache.org/docs/databases/postgres#postgres). @@ -54,19 +54,19 @@ Upon successful connection, you can add datasets, charts, and dashboards. You can use Superset dashboards to analyze data stored in your cluster. For a tutorial on creating a simple dashboard, see [Creating Your First Dashboard](https://superset.apache.org/docs/creating-charts-dashboards/first-dashboard). -To view all available Superset dashboards, navigate to **Analyze > Dashboards**. +To view all available Superset dashboards, select **Analyze > Dashboards**. ## Using Superset charts -You can use Superset charts to visualize data stored in your cluster, see the [Superset documentation](https://superset.apache.org/docs/creating-charts-dashboards/exploring-data) for instructions and examples of creating Superset charts. +You can use Superset charts to visualize data stored in your cluster. See the [Superset documentation](https://superset.apache.org/docs/creating-charts-dashboards/exploring-data) for instructions and examples of creating Superset charts. -To view all available Superset charts, navigate to **Analyze > Charts**. +To view all available Superset charts, select **Analyze > Charts**. ## Using Superset SQL Lab -You can use Superset SQL Lab to write queries to access and modify data stored in your cluster. To access SQL Lab, navigate to **Analyze > SQL Editor**. +You can use Superset SQL Lab to write queries to access and modify data stored in your cluster. To access SQL Lab, select **Analyze > SQL Editor**. diff --git a/product_docs/docs/biganimal/release/using_cluster/index.mdx b/product_docs/docs/biganimal/release/using_cluster/index.mdx index 10e66bbc134..cad09957c24 100644 --- a/product_docs/docs/biganimal/release/using_cluster/index.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/index.mdx @@ -2,6 +2,6 @@ title: "Using your cluster" --- -Account owners and contributors can connect, edit, scale, and monitor clusters through the BigAnimal portal. This section also provides information on how BigAnimal handles backup and restore. +Account owners and contributors can connect, edit, scale, and monitor clusters through the BigAnimal portal. BigAnimal also handles backup and restore. -If your organization has coordinated with [BigAnimal Support](../overview/support) to have the Apache Superset feature enabled, see [Analyzing your data with Apache Superset](06_analyze_with_superset) for information on using Apache Superset to analyze, explore, and visualize data stored in your Postgres clusters. +If your organization coordinated with [BigAnimal Support](../overview/support) to enable the Apache Superset feature, see [Analyzing your data with Apache Superset](06_analyze_with_superset) for information on using Apache Superset to analyze, explore, and visualize data stored in your Postgres clusters. From e5bbecd4051a6f113feb69995b123aa5493368dc Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Tue, 25 Jan 2022 14:39:19 -0500 Subject: [PATCH 19/21] minor revert --- .../release/using_cluster/06_analyze_with_superset.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx b/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx index 7b899122500..70c1ef8a826 100644 --- a/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/06_analyze_with_superset.mdx @@ -37,7 +37,7 @@ To connect to a BigAnimal cluster: `postgresql://{}:{}@{}:{}/{}?sslmode=verify-full` !!!note - Your password is always encrypted before storage and never leaves your cloud environment. It's used only by the Superset software running in your BigAnimal infrastructure. As a defense-in-depth mechanism, we recommend using a Postgres user dedicated to Superset with a privileges to just the database you're connecting. Never use your edb_admin user with Superset. + Your password is always encrypted before storage and never leaves your cloud environment. It's used only by the Superset software running in your BigAnimal infrastructure. As a defense-in-depth mechanism, we recommend using a Postgres user dedicated to Superset with a minimal set of privileges to just the database you're connecting. Never use your edb_admin user with Superset. !!! 6. Check the connection by selecting **Test Connection**. Select **Add** if the connection was successful. From 4ed61eb7aa736c95e9534db4a2ea35ccec918544 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Thu, 27 Jan 2022 07:20:40 -0500 Subject: [PATCH 20/21] Vishal's feedback --- .../release/administering_cluster/01a_superset_access.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/biganimal/release/administering_cluster/01a_superset_access.mdx b/product_docs/docs/biganimal/release/administering_cluster/01a_superset_access.mdx index c959c35f789..6d58c51537b 100644 --- a/product_docs/docs/biganimal/release/administering_cluster/01a_superset_access.mdx +++ b/product_docs/docs/biganimal/release/administering_cluster/01a_superset_access.mdx @@ -4,7 +4,7 @@ title: Managing Superset access You control access to Superset data sources by using Superset roles and permissions. -Superset has three roles: +Superset has three roles mapped to BigAnimal roles: - Gamma - Alpha @@ -18,6 +18,6 @@ The Superset roles map to BigAnimal permissions. You can add the Superset BigAni | --------------- | ------------- | ------------------------------------------ | | Gamma | View data that user has been granted access to, create dashboards | Reader | | Alpha | All Superset Gamma privileges, plus the ability to add or modify data sources | Contributor | -| Admin | All Superset Alpha privileges, plus the ability to grant or revoke access to data to other users | Owner | +| Admin | All Superset Alpha privileges, plus access to SQL Lab and the ability to grant or revoke access to data to other users | Owner | To assign Superset permissions to the BigAnimal user role, see [Changing role permissions](01_portal_access/#changing-role-permissions). \ No newline at end of file From f2a81742a344308d5c1f5dcac14387d4e445a504 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Thu, 27 Jan 2022 09:42:42 -0500 Subject: [PATCH 21/21] Additional info resulting from feedback --- .../biganimal/release/using_cluster/04_backup_and_restore.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/product_docs/docs/biganimal/release/using_cluster/04_backup_and_restore.mdx b/product_docs/docs/biganimal/release/using_cluster/04_backup_and_restore.mdx index 181b2024e3c..11bc1ddc74c 100644 --- a/product_docs/docs/biganimal/release/using_cluster/04_backup_and_restore.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/04_backup_and_restore.mdx @@ -18,6 +18,8 @@ You can restore backups into a new cluster in any region supported by BigAnimal. #### Perform a cluster restore +The restore operation is available for any cluster that has at least one available backup. For newly created clusters, the initial backup becomes available a few minutes after the new cluster is fully operational. + 1. Select the cluster you want to restore on the [Clusters](https://portal.biganimal.com/clusters) page in the [BigAnimal](https://portal.biganimal.com) portal. 2. From **Quick Actions**, select **Restore**.