docs: added required external components (#393)

* added file * renamed heading in index
stackabletech · Aug 10, 2023 · 4a508f4 · 4a508f4
1 parent bf7f055
commit 4a508f4
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 2 deletions.
diff --git a/docs/modules/superset/pages/getting_started/first_steps.adoc b/docs/modules/superset/pages/getting_started/first_steps.adoc
@@ -14,6 +14,8 @@ include::example$getting_started/getting_started.sh[tag=add-bitnami-repo]
 [source,bash]
 include::example$getting_started/getting_started.sh[tag=install-bitnami-psql]
 
+WARNING: This setup is unsuitable for production use! Follow the specific production setup instuctions for one of the xref:required-external-components[supported databases] to get a production-ready database.
+
 == Secret with Superset credentials
 
 A secret with the necessary credentials must be created: this contains database connection credentials as well as an admin account for Superset itself. Create a file called `superset-credentials.yaml`:

diff --git a/docs/modules/superset/pages/index.adoc b/docs/modules/superset/pages/index.adoc
@@ -32,9 +32,9 @@ For every xref:concepts:roles-and-role-groups.adoc#_role_groups[role group] you
 
 ConfigMaps are created, one per RoleGroup and also one for the SupersetDB. Both ConfigMaps contains two files: `log_config.py` and `superset_config.py` which contain logging and general Superset configuration respectively.
 
-== Dependencies
+== Required external component: Metastore SQL database
 
-Superset requires an SQL database in which to store its metadata, dashboards and users. The Stackable platform does not have its own Operator for an SQL database but the xref:getting_started/index.adoc[] guides you through installing an example database with a Superset instance that you can use to get started.
+Superset requires an SQL database in which to store its metadata, dashboards and users. The xref:getting_started/index.adoc[] guides you through installing an example database with a Superset instance that you can use to get started, but is not suitable for production use. Follow the setup instructions for one of the xref:required-external-components.adoc[supported databases] for a production database.
 
 == Connecting to data sources
 

diff --git a/docs/modules/superset/pages/required-external-components.adoc b/docs/modules/superset/pages/required-external-components.adoc
@@ -0,0 +1,8 @@
+= Required external components
+
+Superset uses an SQL database to store metadata. The supported databases and versions are:
+
+* PostgreSQL 10, 11, 12, 13, 14, 15
+* MySQL 5
+
+Reference: https://superset.apache.org/docs/installation/configuring-superset/#using-a-production-metastore[Superset documentation]
diff --git a/docs/modules/superset/partials/nav.adoc b/docs/modules/superset/partials/nav.adoc
@@ -9,5 +9,6 @@
 ** xref:superset:usage-guide/monitoring.adoc[]
 ** xref:superset:usage-guide/logging.adoc[]
 ** xref:superset:usage-guide/configuration-environment-overrides.adoc[]
+* xref:superset:required-external-components.adoc[]
 * xref:superset:configuration.adoc[]
 * xref:superset:cluster_operations.adoc[]