Skip to content

Superset

You can deploy an instance of Superset with your Hydrolix cluster. Superset is an open-source data exploration and visualization platform that allows users to query, visualize, and analyze data ingested into Hydrolix.

Deploy Superset⚓︎

To deploy Superset into your cluster, add the following to your hydrolixcluster.yaml

1
2
data_visualization_tools:
- superset

Hydrolix should deploy two additional pods:

1
2
superset-xxxxxxxxxx-xxxxx
superset-init-db-xx-x-x-xxxxx

Superset is exposed at the superset.{my-host}.hydrolix.live subdomain. Accessing this URL requires a DNS wildcard record (*.{my-host}.hydrolix.live) and a wildcard certificate for Traefik.

Superset network configuration⚓︎

Create a DNS record⚓︎

Set the following environment variable:

1
export HDX_KUBERNETES_NAMESPACE={your-k8s-namespace}

Run the following command to retrieve the Traefik record:

1
kubectl get service/traefik --namespace=$HDX_KUBERNETES_NAMESPACE

You should see output similar to the following:

1
2
NAME          TYPE           CLUSTER-IP       EXTERNAL-IP                                                                     PORT(S)                                AGE                                                                          8089/TCP                               68m
traefik       LoadBalancer   10.64.14.42    34.66.136.134   80:31708/TCP,9000:32344/TCP            2m50s

Use the DNS provider of your choice. Set up an A record for your hostname that points to the EXTERNAL-IP from the response.

Key Value
Record name *.{my-host}.hydrolix.live
Record type A
Value 34.66.136.134

Issue a wildcard certificate for Traefik⚓︎

Manual⚓︎

You can manually import a valid wildcard certificate using the instructions to use or renew your own certificate.

Automatic⚓︎

Must use Route53

Automatic wildcard certificate handling is only available for DNS records managed with AWS Route53.

  1. Create an IAM policy using the following minimum permissions policy. Replace the values for {hosted-zone-id} and _acme-challenge.{my-host}.hydrolix.live with the Route53 hosted zone ID and the Hydrolix cluster hostname.

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
    {
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": "route53:GetChange",
            "Resource": "arn:aws:route53:::change/*"
        },
        {
            "Effect": "Allow",
            "Action": "route53:ListHostedZonesByName",
            "Resource": "*"
        },
        {
            "Effect": "Allow",
            "Action": [
                "route53:ListResourceRecordSets"
            ],
            "Resource": [
                "arn:aws:route53:::hostedzone/{hosted-zone-id}"
            ]
        },
        {
            "Effect": "Allow",
            "Action": [
                "route53:ChangeResourceRecordSets"
            ],
            "Resource": [
                "arn:aws:route53:::hostedzone/{hosted-zone-id}"
            ],
            "Condition": {
                "ForAllValues:StringEquals": {
                    "route53:ChangeResourceRecordSetsNormalizedRecordNames": [
                        "_acme-challenge.{my-host}.hydrolix.live"
                    ],
                    "route53:ChangeResourceRecordSetsRecordTypes": [
                        "TXT"
                    ]
                }
            }
        }
    ]
}

  2. Attach the policy to a user by adding IAM identity permissions. This can be done directly or by attaching to an identity (user group, role) that includes the user.

  3. Use the AWS Guide to create a new IAM access key and secret.

  4. In hydrolixcluster.yaml configuration, set issue_wildcard_cert: true.

  5. In Kubernetes, set the following values in the curated secret using the access key ID and secret access key generated for the AWS user. Set the region and hosted zone ID corresponding to the Route53 A record.

    1
2
3
4
    ROUTE53_AWS_ACCESS_KEY_ID = {Access key ID}
ROUTE53_AWS_SECRET_ACCESS_KEY = {Secret access key}
ROUTE53_AWS_HOSTED_ZONE_ID = {Route53 zone ID}
ROUTE53_AWS_REGION = {Route53 region}

Use Superset⚓︎

The Superset instance is now accessible. To visit it in your web browser, go to https://superset.{my-host}.hydrolix.live.

Login using your standard Hydrolix credentials. You should be redirected automatically to https://superset.{my-host}.hydrolix.live/superset/welcome/.

Superset welcome pane showing project overview interface

deactivate Superset⚓︎

Remove Superset from your cluster by deleting the deployment setting from your Hydrolix configuration. Delete these two lines:

1
2
data_visualization_tools:
- superset

When the change is applied, your Hydrolix installation will remove the two additional Superset pods. If you like, remove the DNS settings described in Create a DNS record.

Note that even though the Superset service is disabled, the internal configuration for Superset will persist in the Hydrolix database. If you later decide to re-enable Superset, the previous configuration will take effect.