Skip to content

Commit

Permalink
Merge pull request #2260 from EnterpriseDB/release/2022-01-27
Browse files Browse the repository at this point in the history
Release: 2022-01-27
  • Loading branch information
drothery-edb authored Jan 27, 2022
2 parents 03fa5db + 3aae6fc commit c20b91e
Show file tree
Hide file tree
Showing 5 changed files with 105 additions and 1 deletion.
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: Managing Superset access
---

You control access to Superset data sources by using Superset roles and permissions.

Superset has three roles mapped to BigAnimal roles:

- Gamma
- Alpha
- Admin

Learn more about Superset roles, users, and permissions management in [Superset Security](https://superset.apache.org/docs/security).

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
| --------------- | ------------- | ------------------------------------------ |
| 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 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).
Original file line number Diff line number Diff line change
Expand Up @@ -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 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.
Original file line number Diff line number Diff line change
Expand Up @@ -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**.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
title: "Analyzing your data with Apache Superset"
---
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.

!!!note
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 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. 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 information for your cluster:

1. Sign in to the [BigAnimal](https://portal.biganimal.com/) portal.

3. Go to the [Clusters](https://portal.biganimal.com/clusters) page.
4. Select the name of your cluster.
5. Select the **Connect** tab.



To connect to a BigAnimal cluster:

1. Sign in to the [BigAnimal](https://portal.biganimal.com/) portal.

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`
!!!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 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.

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).


Upon successful connection, you can add datasets, charts, and 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).

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.

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, select **Analyze > SQL Editor**.






4 changes: 3 additions & 1 deletion product_docs/docs/biganimal/release/using_cluster/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,6 @@
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. BigAnimal also handles backup and restore.

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.

0 comments on commit c20b91e

Please sign in to comment.