跳到主内容

在 Kubernetes 上安装



在 Kubernetes 上运行 Superset 受官方 Helm 仓库中提供的 Superset Helm 图表支持。

先决条件​

  • 一个 Kubernetes 集群
  • 已安装 Helm
注意

对于更简单的单主机环境，我们建议使用 minikube，它在许多平台上都易于设置，并且与此处引用的 Helm 图表配合得非常好。

运行​

  1. 添加 Superset helm 仓库
helm repo add superset https://apache.github.io/superset
"superset" has been added to your repositories
  1. 查看仓库中的图表
helm search repo superset
NAME                    CHART VERSION   APP VERSION     DESCRIPTION
superset/superset       0.1.1           1.0             Apache Superset is a modern, enterprise-ready b...
  1. 配置您的设置覆盖

就像任何典型的 Helm 图表一样，您需要编写一个 values.yaml 文件，该文件将定义/覆盖默认的 values.yaml 中公开的任何值，或其依赖的任何子图表中的值。

下面有关于您可能需要的一些重要覆盖的更多信息。

  1. 安装并运行
helm upgrade --install --values my-values.yaml superset superset/superset

您应该会看到各种 Pod 弹出，例如

kubectl get pods
NAME                                    READY   STATUS      RESTARTS   AGE
superset-celerybeat-7cdcc9575f-k6xmc    1/1     Running     0          119s
superset-f5c9c667-dw9lp                 1/1     Running     0          4m7s
superset-f5c9c667-fk8bk                 1/1     Running     0          4m11s
superset-init-db-zlm9z                  0/1     Completed   0          111s
superset-postgresql-0                   1/1     Running     0          6d20h
superset-redis-master-0                 1/1     Running     0          6d20h
superset-worker-75b48bbcc-jmmjr         1/1     Running     0          4m8s
superset-worker-75b48bbcc-qrq49         1/1     Running     0          4m12s

具体列表将取决于您的一些特定配置覆盖，但您通常会看到

  • N 个 superset-xxxx-yyyy 和 superset-worker-xxxx-yyyy Pod (取决于您的 supersetNode.replicaCount 和 supersetWorker.replicaCount 值)
  • 1 个 superset-postgresql-0 Pod，取决于您的 postgres 设置
  • 1 个 superset-redis-master-0 Pod，取决于您的 redis 设置
  • 如果您在值覆盖中设置了 supersetCeleryBeat.enabled = true，则有 1 个 superset-celerybeat-xxxx-yyyy Pod
  1. 访问它

该图表将发布适当的服务，以便在您的 k8s 集群内部公开 Superset UI。要从外部访问它，您需要

  • 将服务配置为 LoadBalancer 或 NodePort
  • 为其设置 Ingress - 图表中包含定义，但需要根据您的需求进行调整（主机名、tls、注解等...）
  • 运行 kubectl port-forward superset-xxxx-yyyy :8088 以直接将一个 Pod 的端口隧道到您的本地主机

根据您配置外部访问的方式，URL 会有所不同。一旦您确定了合适的 URL，您就可以使用以下凭据登录

  • 用户：admin
  • 密码：admin

重要设置​

安全设置​

默认的安全设置和密码已包含在内，但您必须更新它们才能运行 prod 实例，特别是

postgresql:
  postgresqlPassword: superset

确保为您的 SECRET_KEY 设置一个唯一的、强且复杂的字母数字字符串，并使用工具帮助您生成足够随机的序列。

  • 要生成一个好的密钥，您可以运行 openssl rand -base64 42
configOverrides:
  secret: |
    SECRET_KEY = 'YOUR_OWN_RANDOM_GENERATED_SECRET_KEY'

如果您想更改之前的密钥，那么您应该轮换密钥。Kubernetes 部署的默认密钥是 thisISaSECRET_1234

configOverrides:
  my_override: |
    PREVIOUS_SECRET_KEY = 'YOUR_PREVIOUS_SECRET_KEY'
    SECRET_KEY = 'YOUR_OWN_RANDOM_GENERATED_SECRET_KEY'
init:
  command:
    - /bin/sh
    - -c
    - |
      . {{ .Values.configMountPath }}/superset_bootstrap.sh
      superset re-encrypt-secrets
      . {{ .Values.configMountPath }}/superset_init.sh
注意

Superset 使用 Scarf Gateway 收集遥测数据。了解不同 Superset 版本的安装数量有助于项目做出有关修补和长期支持的决策。Scarf 会清除个人身份信息 (PII)，并且仅提供聚合统计数据。

要在基于 Helm 的安装中选择退出此数据收集，请编辑 helm/superset/values.yaml 文件中的 repository: 行，将 apachesuperset.docker.scarf.sh/apache/superset 替换为 apache/superset，以直接从 Docker Hub 拉取镜像。

依赖项​

在引导脚本中安装额外的包并进行任何其他引导配置。对于生产集群，建议在 CI 中完成此步骤并构建自己的镜像。

注意

Superset 需要为每个要连接的数据存储安装一个 Python DB-API 数据库驱动程序和 SQLAlchemy 方言。

有关更多信息，请参阅安装数据库驱动程序。建议您参考 pyproject.toml 中列出的版本，而不是像下面这样将它们硬编码到您的引导脚本中。

以下示例安装了 BigQuery 和 Elasticsearch 的驱动程序，允许您在 Superset 设置中连接到这些数据源

bootstrapScript: |
  #!/bin/bash
  uv pip install .[postgres] \
    .[bigquery] \
    .[elasticsearch] &&\
  if [ ! -f ~/bootstrap ]; then echo "Running Superset with uid {{ .Values.runAsUser }}" > ~/bootstrap; fi

superset_config.py​

默认的 superset_config.py 相当简单，您很可能需要对其进行扩展。这可以通过在 configOverrides 中指定一个或多个键/值条目来完成，例如

configOverrides:
  my_override: |
    # This will make sure the redirect_uri is properly computed, even with SSL offloading
    ENABLE_PROXY_FIX = True
    FEATURE_FLAGS = {
        "DYNAMIC_PLUGINS": True
    }

这些将被评估为 Helm 模板，因此能够引用其他 values.yaml 变量，例如 {{ .Values.ingress.hosts[0] }} 将解析为您的 ingress 外部域。

整个 superset_config.py 将作为 secret 安装，因此直接传递敏感参数是安全的……但是使用 secret 环境变量可能会更具可读性。

可以通过运行 helm upgrade --install --values my-values.yaml --set-file configOverrides.oauth=set_oauth.py 来提供完整的 python 文件

环境变量​

如果这些变量是敏感的，可以通过 extraEnv 或 extraSecretEnv 作为键/值对传递。然后可以在 superset_config.py 中使用例如 os.environ.get("VAR") 引用它们。

extraEnv:
  SMTP_HOST: smtp.gmail.com
  SMTP_USER: user@gmail.com
  SMTP_PORT: "587"
  SMTP_MAIL_FROM: user@gmail.com

extraSecretEnv:
  SMTP_PASSWORD: xxxx

configOverrides:
  smtp: |
    import ast
    SMTP_HOST = os.getenv("SMTP_HOST","localhost")
    SMTP_STARTTLS = ast.literal_eval(os.getenv("SMTP_STARTTLS", "True"))
    SMTP_SSL = ast.literal_eval(os.getenv("SMTP_SSL", "False"))
    SMTP_USER = os.getenv("SMTP_USER","superset")
    SMTP_PORT = os.getenv("SMTP_PORT",25)
    SMTP_PASSWORD = os.getenv("SMTP_PASSWORD","superset")

系统包​

如果需要新的系统包，可以通过覆盖容器的 command 在应用程序启动前安装它们，例如

supersetWorker:
  command:
    - /bin/sh
    - -c
    - |
      apt update
      apt install -y somepackage
      apt autoremove -yqq --purge
      apt clean

      # Run celery worker
      . {{ .Values.configMountPath }}/superset_bootstrap.sh; celery --app=superset.tasks.celery_app:app worker

数据源​

数据源定义可以通过在 extraConfigs 中提供键/值 yaml 定义来自动声明

extraConfigs:
  import_datasources.yaml: |
    databases:
    - allow_file_upload: true
      allow_ctas: true
      allow_cvas: true
      database_name: example-db
      extra: "{\r\n    \"metadata_params\": {},\r\n    \"engine_params\": {},\r\n    \"\
        metadata_cache_timeout\": {},\r\n    \"schemas_allowed_for_file_upload\": []\r\n\
        }"
      sqlalchemy_uri: example://example-db.local
      tables: []

这些也将作为 secret 挂载，并且可以包含敏感参数。

配置示例​

设置 OAuth​

注意

OAuth 设置需要安装 authlib Python 库。这可以通过更新 bootstrapScript 使用 pip 完成。有关更多信息，请参阅依赖项部分。

extraEnv:
  AUTH_DOMAIN: example.com

extraSecretEnv:
  GOOGLE_KEY: xxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com
  GOOGLE_SECRET: xxxxxxxxxxxxxxxxxxxxxxxx

configOverrides:
  enable_oauth: |
    # This will make sure the redirect_uri is properly computed, even with SSL offloading
    ENABLE_PROXY_FIX = True

    from flask_appbuilder.security.manager import AUTH_OAUTH
    AUTH_TYPE = AUTH_OAUTH
    OAUTH_PROVIDERS = [
        {
            "name": "google",
            "icon": "fa-google",
            "token_key": "access_token",
            "remote_app": {
                "client_id": os.getenv("GOOGLE_KEY"),
                "client_secret": os.getenv("GOOGLE_SECRET"),
                "api_base_url": "https://www.googleapis.com/oauth2/v2/",
                "client_kwargs": {"scope": "email profile"},
                "request_token_url": None,
                "access_token_url": "https://#/o/oauth2/token",
                "authorize_url": "https://#/o/oauth2/auth",
                "authorize_params": {"hd": os.getenv("AUTH_DOMAIN", "")}
            },
        }
    ]

    # Map Authlib roles to superset roles
    AUTH_ROLE_ADMIN = 'Admin'
    AUTH_ROLE_PUBLIC = 'Public'

    # Will allow user self registration, allowing to create Flask users from Authorized User
    AUTH_USER_REGISTRATION = True

    # The default user self registration role
    AUTH_USER_REGISTRATION_ROLE = "Admin"

启用警报和报告​

为此，根据警报和报告文档，您需要

在 Celery worker 中安装支持的 webdriver​

这可以通过使用预安装了 webdriver 的自定义镜像来完成，或者在启动时通过覆盖 command 来安装。这是一个 chromedriver 的工作示例

supersetWorker:
  command:
    - /bin/sh
    - -c
    - |
      # Install chrome webdriver
      # See https://github.com/apache/superset/blob/4fa3b6c7185629b87c27fc2c0e5435d458f7b73d/docs/src/pages/docs/installation/email_reports.mdx
      apt-get update
      apt-get install -y wget
      wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
      apt-get install -y --no-install-recommends ./google-chrome-stable_current_amd64.deb
      wget https://chromedriver.storage.googleapis.com/88.0.4324.96/chromedriver_linux64.zip
      apt-get install -y zip
      unzip chromedriver_linux64.zip
      chmod +x chromedriver
      mv chromedriver /usr/bin
      apt-get autoremove -yqq --purge
      apt-get clean
      rm -f google-chrome-stable_current_amd64.deb chromedriver_linux64.zip

      # Run
      . {{ .Values.configMountPath }}/superset_bootstrap.sh; celery --app=superset.tasks.celery_app:app worker

运行 Celery beat​

此 Pod 将触发在警报和报告 UI 部分配置的计划任务

supersetCeleryBeat:
  enabled: true

配置适当的 Celery 任务和 SMTP/Slack 设置​

extraEnv:
  SMTP_HOST: smtp.gmail.com
  SMTP_USER: user@gmail.com
  SMTP_PORT: "587"
  SMTP_MAIL_FROM: user@gmail.com

extraSecretEnv:
  SLACK_API_TOKEN: xoxb-xxxx-yyyy
  SMTP_PASSWORD: xxxx-yyyy

configOverrides:
  feature_flags: |
    import ast

    FEATURE_FLAGS = {
        "ALERT_REPORTS": True
    }

    SMTP_HOST = os.getenv("SMTP_HOST","localhost")
    SMTP_STARTTLS = ast.literal_eval(os.getenv("SMTP_STARTTLS", "True"))
    SMTP_SSL = ast.literal_eval(os.getenv("SMTP_SSL", "False"))
    SMTP_USER = os.getenv("SMTP_USER","superset")
    SMTP_PORT = os.getenv("SMTP_PORT",25)
    SMTP_PASSWORD = os.getenv("SMTP_PASSWORD","superset")
    SMTP_MAIL_FROM = os.getenv("SMTP_MAIL_FROM","superset@superset.com")

    SLACK_API_TOKEN = os.getenv("SLACK_API_TOKEN",None)
  celery_conf: |
    from celery.schedules import crontab

    class CeleryConfig:
      broker_url = f"redis://{env('REDIS_HOST')}:{env('REDIS_PORT')}/0"
      imports = (
          "superset.sql_lab",
          "superset.tasks.cache",
          "superset.tasks.scheduler",
      )
      result_backend = f"redis://{env('REDIS_HOST')}:{env('REDIS_PORT')}/0"
      task_annotations = {
          "sql_lab.get_sql_results": {
              "rate_limit": "100/s",
          },
      }
      beat_schedule = {
          "reports.scheduler": {
              "task": "reports.scheduler",
              "schedule": crontab(minute="*", hour="*"),
          },
          "reports.prune_log": {
              "task": "reports.prune_log",
              'schedule': crontab(minute=0, hour=0),
          },
          'cache-warmup-hourly': {
              "task": "cache-warmup",
              "schedule": crontab(minute="*/30", hour="*"),
              "kwargs": {
                  "strategy_name": "top_n_dashboards",
                  "top_n": 10,
                  "since": "7 days ago",
              },
          }
      }

    CELERY_CONFIG = CeleryConfig
  reports: |
    EMAIL_PAGE_RENDER_WAIT = 60
    WEBDRIVER_BASEURL = "http://{{ template "superset.fullname" . }}:{{ .Values.service.port }}/"
    WEBDRIVER_BASEURL_USER_FRIENDLY = "https://www.example.com/"
    WEBDRIVER_TYPE= "chrome"
    WEBDRIVER_OPTION_ARGS = [
        "--force-device-scale-factor=2.0",
        "--high-dpi-support=2.0",
        "--headless",
        "--disable-gpu",
        "--disable-dev-shm-usage",
        # This is required because our process runs as root (in order to install pip packages)
        "--no-sandbox",
        "--disable-setuid-sandbox",
        "--disable-extensions",
    ]

加载示例数据和仪表板​

如果您正在试用 Superset 并希望探索一些数据和仪表板，您可以通过创建一个 my_values.yaml 文件并按照上述“运行”部分中“配置您的设置覆盖”步骤中的说明进行部署来加载一些示例。要加载示例，请将以下内容添加到 my_values.yaml 文件中

init:
  loadExamples: true