Deploy Superset¶

With PostgreSQL and Redis running, you can now deploy Superset itself and connect it to both services.

Deploy the charm¶

A Superset deployment is made up of three functions, each deployed as its own application from the same charm and selected with the charm-function configuration option:

the web server and UI (app-gunicorn, the default),
the worker that runs asynchronous queries and scheduled reports (worker),
the beat scheduler that triggers periodic tasks (beat).

This tutorial deploys the web server only. To add workers and a scheduler later, see Scale and tune performance.

Superset requires a secret key, which it uses to sign session cookies and encrypt sensitive values in its metadata database. Generate one and pass it at deploy time, together with an admin password:

juju deploy superset-k8s --channel 6/stable \
  --config superset-secret-key="$(openssl rand -base64 42)" \
  --config admin-password=<ADMIN_PASSWORD>

Caution

Keep the secret key stable for the lifetime of a deployment: changing it later invalidates everything encrypted with it, including stored database connection credentials. Set admin-password explicitly as well, otherwise the initial admin account is created with the default password admin.

The charm channel selects the Superset major version, for example 6/stable for Superset 6. See Versions and channels for the full list.

Until it is integrated with its backing services, the charm reports blocked with Needs a PostgreSQL relation.

Integrate with PostgreSQL and Redis¶

juju integrate superset-k8s postgresql-k8s
juju integrate superset-k8s redis-k8s

Superset initializes its database schema and creates the admin account on first start, which takes a few minutes. Watch the deployment until the unit reports active with the message Status check: UP:

juju status --relations --watch 2s

App             Version  Status  Scale  Charm           Channel    Rev  Address         Exposed  Message
postgresql-k8s  14.15    active      1  postgresql-k8s  14/stable  495  10.152.183.243  no
redis-k8s       7.2.5    active      1  redis-k8s       latest/edge 36  10.152.183.182  no
superset-k8s    v6.1.0   active      1  superset-k8s    6/stable    52  10.152.183.135  no       Status check: UP

Unit               Workload  Agent  Address      Ports  Message
postgresql-k8s/0*  active    idle   10.1.255.10         Primary
redis-k8s/0*       active    idle   10.1.255.21
superset-k8s/0*    active    idle   10.1.255.5          Status check: UP

Integration provider     Requirer                    Interface          Type     Message
postgresql-k8s:database  superset-k8s:postgresql_db  postgresql_client  regular
redis-k8s:redis          superset-k8s:redis          redis              regular
superset-k8s:peer        superset-k8s:peer           superset           peer

Log in to the UI¶

Find the unit’s IP address in the Address column of the superset-k8s/0 unit, then open Superset in your browser:

http://<UNIT_ADDRESS>:8088

With the Multipass setup, that address is only routable from inside the VM. Either browse from multipass shell superset-tutorial, or forward the port out of the VM:

# Run inside the VM. `multipass list` gives the VM address to then browse from the host.
microk8s kubectl port-forward -n superset-k8s pod/superset-k8s-0 9002:9002 --address 0.0.0.0

Note

Accessing the unit IP directly is fine for a local tutorial. For anything beyond that, expose Superset through an ingress with TLS - see Expose Superset with ingress.

Superset is up and running. Continue to create a dashboard.