document pod overrides (#545)

fhennig · adwk67 · web-flow · commit d43521576e9c · 2024-09-23T06:19:07.000Z
* document-pod-overrides

* use tabs in the installation section

* Change a bunch of wording

* Change a bunch of wording

* Change a bunch of wording

* Update docs/modules/superset/pages/getting_started/first_steps.adoc

Co-authored-by: Andrew Kenworthy &lt;1712947+adwk67@users.noreply.github.com&gt;

* Update docs/modules/superset/pages/getting_started/first_steps.adoc

Co-authored-by: Andrew Kenworthy &lt;1712947+adwk67@users.noreply.github.com&gt;

* Update docs/modules/superset/pages/getting_started/first_steps.adoc

Co-authored-by: Andrew Kenworthy &lt;1712947+adwk67@users.noreply.github.com&gt;

* Update docs/modules/superset/pages/getting_started/installation.adoc

Co-authored-by: Andrew Kenworthy &lt;1712947+adwk67@users.noreply.github.com&gt;

---------

Co-authored-by: Andrew Kenworthy &lt;1712947+adwk67@users.noreply.github.com&gt;
diff --git a/docs/modules/superset/pages/getting_started/first_steps.adoc b/docs/modules/superset/pages/getting_started/first_steps.adoc
@@ -6,36 +6,37 @@ Once you have followed the steps in  xref:getting_started/installation.adoc[] fo
 
 Superset metadata (slices, connections, tables, dashboards etc.) is stored in an SQL database.
 
-For testing purposes, you can spin up a PostgreSQL database with the following commands:
+For testing, you can set up a PostgreSQL database with these commands:
 
 [source,bash]
 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 instructions for one of the xref:required-external-components[supported databases] to get a production-ready database.
+WARNING: This setup is not suitable for use in production.
+Refer to the xref:required-external-components[supported databases] for production-ready database setup instructions.
 
 == 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`:
+You need to create a secret with the required credentials (database connection credentials and an admin account for Superset).
+Create a file called `superset-credentials.yaml`:
 
 [source,yaml]
 include::example$getting_started/superset-credentials.yaml[]
 
-And apply it:
+Apply the Secret:
 
 [source,bash]
 include::example$getting_started/getting_started.sh[tag=apply-superset-credentials]
 
-The `connections.secretKey` will be used for securely signing the session cookies and can be used
-for any other security related needs by extensions. It should be a long random string of bytes.
+The `connections.secretKey` will be used for securely signing the session cookies and can be used by the extensions for any other security-related needs.
+It should be a long, random string.
 
-`connections.sqlalchemyDatabaseUri` must contain the connection string to the SQL database storing
-the Superset metadata.
+`connections.sqlalchemyDatabaseUri` must contain the connection string to the SQL database storing the Superset metadata.
 
 The `adminUser` fields are used to create an admin user.
-Please note that the admin user will be disabled if you use a non-default authentication mechanism like LDAP.
+If using non-default authentication (e.g., LDAP), the admin user is disabled.
 
 == Creation of a Superset node
 
@@ -67,40 +68,43 @@ include::example$getting_started/getting_started.sh[tag=wait-superset]
 
 == Connecting to the web interface
 
-When the Superset node is created and the database is initialized, Superset can be opened in the
-browser.
+Once the Superset node is created and the database is initialized, you can open Superset in your browser.
 
-The Superset port which defaults to `8088` can be forwarded to the local host:
+To forward the Superset port (`8088`) to localhost, run:
 
 [source,bash]
 include::example$getting_started/getting_started.sh[tag=port-forwarding]
 
-Then it can be opened in the browser with `http://localhost:8088`.
-
-Enter the admin credentials from the Kubernetes secret:
+Then, open `http://localhost:8088` in your browser and log in with the admin credentials from the Kubernetes secret.
 
 image::getting_started/superset-login.png[Login screen of Superset]
 
-Great! Now the Superset is already ready to use, but if you also want some sample data and dashboards to explore the functionalities Superset has to offer, continue with the next step.
+Superset is now ready for use.
+If you want to load sample data and dashboards and explore Superset's functionality, proceed to the next step.
 
 == Loading examples and accessing example dashboards
 
-To have some data to play with and some dashboards to explore, Superset comes with some example data that you can load. To do so, create a file `superset-load-examples-job.yaml` with this content:
+To have some data to play with and some dashboards to explore, Superset comes with some example data that you can load.
+To do so, create a file `superset-load-examples-job.yaml` with this content:
 
 [source,bash]
 include::example$getting_started/superset-load-examples-job.yaml[]
 
-This is a Kubernetes Job. The same connection information and credentials are loaded that are also used by the Superset instance. The Job will load the example data. Execute it and await its termination like so:
+This Kubernetes Job uses the same connection information and credentials as the Superset instance to load the example data.
+Run the Job and wait for it to finish with the following command:
 
 [source,bash]
 include::example$getting_started/getting_started.sh[tag=load-examples]
 
-The Job will take a few minutes to terminate. Afterwards, check back again on the web interface. New dashboards should be available:
+The Job will take a few minutes to terminate.
+Afterwards, check back again on the web interface.
+New dashboards should be available:
 
 image::getting_started/superset-dashboard.png[Superset dashboard showing birth names]
 
-Great! Now you can explore this sample data, run queries on it or create your own dashboards.
+Great!
+Now you can explore this sample data, run queries on it or create your own dashboards.
 
 == What's next
 
-Look at the xref:usage-guide/index.adoc[] to find out more about configuring your Superset instance or have a look at the Superset documentation to https://superset.apache.org/docs/creating-charts-dashboards/creating-your-first-dashboard[create your first dashboard].
+Check the xref:usage-guide/index.adoc[] to find out more about configuring your Superset instance or have a look at the Superset documentation to https://superset.apache.org/docs/creating-charts-dashboards/creating-your-first-dashboard[create your first dashboard].
diff --git a/docs/modules/superset/pages/getting_started/index.adoc b/docs/modules/superset/pages/getting_started/index.adoc
@@ -1,10 +1,11 @@
 = Getting started
 
-This guide will get you started with Superset using the Stackable Operator. It will guide you through the installation of the Operator and its dependencies, setting up your first Superset instance, connecting to it and looking at some sample data.
+This guide helps you get started with Superset using the Stackable Operator.
+It covers the installation of the Operator and its dependencies, setting up your first Superset instance, connecting to it, and exploring sample data.
 
 == Prerequisites
 
-You will need:
+You’ll need the following:
 
 * a Kubernetes cluster
 * kubectl
@@ -17,7 +18,7 @@ Resource sizing depends on cluster type(s), usage and scope, but as a starting p
 
 == What's next
 
-The Guide is divided into two steps:
+The guide is divided into two steps:
 
 * xref:getting_started/installation.adoc[Installing the Operators].
 * xref:getting_started/first_steps.adoc[Setting up the Superset instance and connecting to it].
diff --git a/docs/modules/superset/pages/getting_started/installation.adoc b/docs/modules/superset/pages/getting_started/installation.adoc
@@ -1,17 +1,18 @@
 = Installation
 
-On this page you will install the Stackable Superset Operator as well as the commons, secret and listener Operator which are
-required by all Stackable Operators.
+On this page you will install the Stackable Superset Operator as well as the commons, secret and listener operators which are required by all Stackable Operators.
 
 == Stackable Operators
 
-There are 2 ways to run Stackable Operators
-
-. Using xref:management:stackablectl:index.adoc[]
-. Using Helm
-
-=== stackablectl
+There are multiple ways to install the Stackable Operator for Apache Zookeeper.
+`stackablectl` is the preferred way but Helm is also supported.
+OpenShift users may prefer installing the operator from the RedHat Certified Operator catalog using the OpenShift web console.
 
+[tabs]
+====
+stackablectl (recommended)::
++
+--
 `stackablectl` is the command line tool to interact with Stackable operators and our recommended way to install
 Operators. Follow the xref:management:stackablectl:installation.adoc[installation steps] for your platform.
 
@@ -27,12 +28,15 @@ The tool will show
 [source]
 include::example$getting_started/install_output.txt[]
 
-TIP: Consult the xref:management:stackablectl:quickstart.adoc[] to learn more about how to use `stackablectl`. For
-example, you can use the `--cluster kind` flag to create a Kubernetes cluster with link:https://kind.sigs.k8s.io/[kind].
-
-=== Helm
+TIP: Consult the xref:management:stackablectl:quickstart.adoc[] to learn more about how to use `stackablectl`.
+For example, you can use the `--cluster kind` flag to create a Kubernetes cluster with link:https://kind.sigs.k8s.io/[kind].
+--
 
-You can also use Helm to install the Operators. Add the Stackable Helm repository:
+Helm::
++
+--
+You can also use Helm to install the Operators.
+Add the Stackable Helm repository:
 [source,bash]
 ----
 include::example$getting_started/getting_started.sh[tag=helm-add-repo]
@@ -44,8 +48,10 @@ Then install the Stackable Operators:
 include::example$getting_started/getting_started.sh[tag=helm-install-operators]
 ----
 
-Helm will deploy the Operators in a Kubernetes Deployment and apply the CRDs for the Superset service (as well as the
-CRDs for the required operators). You are now ready to deploy Superset in Kubernetes.
+Helm will deploy the operators in a Kubernetes Deployment and apply the CRDs for the Superset service (as well as the CRDs for the required operators).
+You are now ready to deploy Superset in Kubernetes.
+--
+====
 
 == What's next
 
diff --git a/docs/modules/superset/pages/index.adoc b/docs/modules/superset/pages/index.adoc
@@ -13,8 +13,8 @@
 * {feature-tracker}[Feature Tracker {external-link-icon}^]
 * {crd}[CRD documentation {external-link-icon}^]
 
-The Stackable operator for {superset}[Apache Superset] is an operator that can deploy and manage Apache Superset clusters on Kubernetes.
-Superset is a data exploration and visualization tool that connects to data sources via SQL.
+The Stackable operator for {superset}[Apache Superset] deploys and manages Superset clusters on Kubernetes.
+Superset is a data exploration and visualization tool that connects to SQL-based data sources.
 Store your data in Apache Druid or Trino, and manage your Druid and Trino instances with the Stackable operators for xref:druid:index.adoc[Apache Druid] or xref:trino:index.adoc[Trino].
 This operator helps you manage your Superset instances on Kubernetes efficiently.
 
diff --git a/docs/modules/superset/pages/usage-guide/configuration-environment-overrides.adoc b/docs/modules/superset/pages/usage-guide/configuration-environment-overrides.adoc
@@ -112,5 +112,9 @@ nodes:
       config: {}
 ----
 
-
 // cliOverrides don't make sense for this operator, so the feature is omitted for now
+
+== Pod overrides
+
+The Superset operator also supports Pod overrides, allowing you to override any property that you can set on a Kubernetes Pod.
+Read the xref:concepts:overrides.adoc#pod-overrides[Pod overrides documentation] to learn more about this feature.
