You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@superset.apache.org by ru...@apache.org on 2026/08/28 04:02:54 UTC
(superset) branch fix/from-pr-41073-needs-docs-feat-helm-add-gateway-api-htt created (now eb69e5ac49b)
This is an automated email from the ASF dual-hosted git repository.
rusackas pushed a change to branch fix/from-pr-41073-needs-docs-feat-helm-add-gateway-api-htt
in repository https://gitbox.apache.org/repos/asf/superset.git
at eb69e5ac49b docs(helm): document Gateway API HTTPRoute support
This branch includes the following new commits:
new eb69e5ac49b docs(helm): document Gateway API HTTPRoute support
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
(superset) 01/01: docs(helm): document Gateway API HTTPRoute support
Posted by ru...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
rusackas pushed a commit to branch fix/from-pr-41073-needs-docs-feat-helm-add-gateway-api-htt
in repository https://gitbox.apache.org/repos/asf/superset.git
commit eb69e5ac49b11d070f1a4f36b67865a26007fc9a
Author: rusackas <ev...@rusackas.com>
AuthorDate: Thu Aug 27 21:02:33 2026 -0700
docs(helm): document Gateway API HTTPRoute support
The httproute.enabled Helm value and its parentRefs/hostnames/rules
options (including automatic websocket and MCP route appending) landed
in #41073 but weren't covered in the Kubernetes/Helm installation
docs. Document it alongside the existing Ingress guidance.
Co-Authored-By: Claude <no...@anthropic.com>
---
docs/admin_docs/installation/kubernetes.mdx | 37 +++++++++++++++++++++++++++++
1 file changed, 37 insertions(+)
diff --git a/docs/admin_docs/installation/kubernetes.mdx b/docs/admin_docs/installation/kubernetes.mdx
index a374338e4c9..a9318b9f755 100644
--- a/docs/admin_docs/installation/kubernetes.mdx
+++ b/docs/admin_docs/installation/kubernetes.mdx
@@ -87,6 +87,7 @@ The chart will publish appropriate services to expose the Superset UI internally
- Configure the Service as a `LoadBalancer` or `NodePort`
- Set up an `Ingress` for it - the chart includes a definition, but will need to be tuned to your needs (hostname, tls, annotations etc...)
+- Set up a Gateway API `HTTPRoute` for it - see [Exposing Superset via Gateway API (HTTPRoute)](#exposing-superset-via-gateway-api-httproute) below
- Run `kubectl port-forward superset-xxxx-yyyy :8088` to directly tunnel one pod's port into your localhost
Depending how you configured external access, the URL will vary. Once you've identified the appropriate URL you can log in with:
@@ -319,6 +320,42 @@ configOverrides:
AUTH_USER_REGISTRATION_ROLE = "Admin"
```
+### Exposing Superset via Gateway API (HTTPRoute)
+
+As an alternative to `Ingress`, the chart can create a [Gateway API](https://gateway-api.sigs.k8s.io/)
+`HTTPRoute` that attaches to a Gateway already running in your cluster. This requires the Gateway
+API CRDs (`gateway.networking.k8s.io/v1`) to be installed, along with a Gateway resource for the
+route to attach to.
+
+```yaml
+httproute:
+ enabled: true
+ parentRefs:
+ - name: my-gateway
+ namespace: gateway-system
+ hostnames:
+ - superset.example.com
+ rules:
+ - matches:
+ - path:
+ type: PathPrefix
+ value: /
+```
+
+- `httproute.parentRefs` lists the Gateway(s) the route attaches to.
+- `httproute.hostnames` matches against the HTTP `Host` header; it's templated, so values like
+ `{{ .Release.Name }}` can be used.
+- `httproute.rules` are routing rules backed by the Superset service; each rule accepts standard
+ `matches`, `filters`, and `timeouts` fields, and an optional `weight` (defaults to `1`) to leave
+ room for traffic splitting across multiple rules.
+- If `supersetWebsockets.enabled` is set, an extra rule routing `supersetWebsockets.ingress.path`
+ (default `/ws`) to the `-ws` service is appended automatically, mirroring the `Ingress` behavior
+ so global async queries keep working behind a Gateway.
+- If `supersetMcp.enabled` and `supersetMcp.httproute.enabled` are both set, an extra rule routing
+ `supersetMcp.httproute.path` to the `-mcp` service is appended as well.
+- Set `httproute.apiVersion` to `gateway.networking.k8s.io/v1beta1` if your cluster's Gateway API
+ installation hasn't promoted `HTTPRoute` to `v1` yet.
+
### Enable Alerts and Reports
For this, as per the [Alerts and Reports doc](/admin-docs/configuration/alerts-reports), you will need to: