Helm chart values reference#
This section lists every value you can configure when deploying Hopsworks with the Hopsworks Helm chart, with one page per top-level key. It is generated from the README.md files of the chart and its subcharts, and for RonDB from the values.schema.json of the RonDB chart that Hopsworks pins. On a released version of the docs it matches the Hopsworks Helm chart for that release; on the development docs it reflects the latest chart published to the development channel.
You set these values in the values.<cloud>.yaml file that you pass to helm install. For a guided, end-to-end setup, follow one of the cloud installation guides, such as the AWS getting started guide. Only a small subset of these values is needed for a typical install: "Common values" below lists the ones the cloud installation guides set, and the pages are the exhaustive reference.
"All values" lists the pages. Each page states when its subchart is deployed: when the condition names several values, Helm uses the first one that is set. "Upstream charts" are the charts a subchart installs from other Helm repositories, and each link opens a chart's documentation for the version Hopsworks pins. A page lists only the values Hopsworks sets for its upstream charts, except the RonDB page, which lists all of the RonDB chart's values. A default is the value Hopsworks deploys: the root chart's settings for a subchart are applied over the subchart's own defaults. Every value has its own link (the # next to its key), and each section has its defaults as a values file under "Defaults as YAML".
Generated from the Hopsworks Helm chart 5.3.0-alpha-1795214116 (Hopsworks 5.3.0).
Common values#
| Value | What it sets |
|---|---|
global._hopsworks.cloudProvider | The cloud the cluster runs on; HopsFS, Consul and Hopsworks configure themselves from it. |
global._hopsworks.storageClassName | The storage class of every persistent volume. |
global._hopsworks.imageRegistry | The registry the Hopsworks images are pulled from. |
global._hopsworks.imagePullSecrets | The pull secrets for that registry. |
global._hopsworks.managedDockerRegistery | Use the cloud provider's container registry for the images Hopsworks builds for users. |
global._hopsworks.managedObjectStorage | Use a cloud bucket for HopsFS data and for the RonDB and OpenSearch backups. |
global._hopsworks.minio.enabled | Deploy MinIO in the cluster; turn it off when a cloud bucket is used. |
global._hopsworks.externalLoadBalancers.enabled | Expose services through LoadBalancer Services. |
hopsworks.ingress.host | The host name of the Hopsworks UI and API. |
hopsworks.ingress.ingressClassName | The ingress controller that serves it. |
hopsworks.velero.backup.enabled | Back up Kubernetes resources with Velero, which needs its own install. |
rondb.rondb.clusterSize | The size of the RonDB cluster: data replicas, node groups, MySQL and REST API servers. |
All values#
| Values | Upstream charts | Keys |
|---|---|---|
global | 168 | |
airflow | 162 | |
arrowflight | 46 | |
certs-operator | 29 | |
consul | consul 1.8.16 | 24 |
docker-registry | 90 | |
grafana | grafana 7.0.17 | 7 |
hive | 79 | |
hopsfs | 226 | |
hopsfs-csi | 29 | |
hopsworks | 1057 | |
hw-envoy-ai-gateway | 43 | |
hw-envoy-gateway | 40 | |
hw-keda | keda 2.21.0 | 24 |
hw-kueue | 63 | |
hw-kyverno | 60 | |
judge | 23 | |
kafka | strimzi-kafka-operator 1.3.1 | 104 |
kserve | 293 | |
minio | 42 | |
olk | prometheus-elasticsearch-exporter 5.8.0 | 165 |
onlinefs | 99 | |
prometheus | prometheus 25.20.2, prometheus-adapter 4.11.0 | 9 |
ray | kuberay-operator 1.4.0 | 2 |
rondb | rondb 26.2.24 | 498 |
spark | spark-operator 2.5.1 | 160 |
superset | mysql 12.3.5, superset 0.15.0 | 36 |
trino | trino 1.41.0 | 38 |
vpa | 18 |
Other values#
Defaults as YAML
hopsworkslib: {}
semantic-gateway:
arrowMemoryLimitBytes: null
biTables:
enabled: true
buildCacheEntries: 100
cache:
dataVersionSeconds: 30
entryMaxBytes: 8388608
maxBytes: 268435456
ttlSeconds: 300
cors:
allowedOrigins: []
dependencies:
hopsworks:
consulServiceName: glassfish
consulServiceTag: hopsworks
podLabels:
- app: hopsworks-instance
- app: hopsworks-admin
port: 8182
trino:
consulServiceName: trino
consulServiceTag: coordinator
podLabels:
app.kubernetes.io/component: coordinator
app.kubernetes.io/name: hopsworks-trino
port: 8443
externalLoadBalancer:
annotations: {}
class: null
enabled: null
hostname: null
managed: null
nodePort: null
nodeSelector: {}
flight:
maxHeaderBytes: 65536
maxMessageBytes: 4194304
queuedCalls: 256
threads: 64
flightPort: 18446
graphql:
maxFields: 500
handleTtlSeconds: 3600
hopsworkslib: {}
hpa:
enabled: false
maxReplicas: 4
targetCPUUtilizationPercentage: 80
httpRequestTimeoutSeconds: 120
httpResponseTimeoutSeconds: null
image:
pullPolicy: null
registry: null
repository: hopsworks/semantic-gateway
tag: null
jvmOptions: -XX:MaxRAMPercentage=50
maxJsonBytes: 67108864
maxJsonRows: 100000
maxRows: 1000000
networkPolicy:
enabled: true
nodeSelector: {}
podDisruptionBudget:
enabled: true
minAvailable: 1
queryConcurrency: 16
queryTimeoutSeconds: 300
replicas: 2
resources:
limits:
cpu: '2'
memory: 4Gi
requests:
cpu: 500m
memory: 4Gi
security:
runAsGroup: 1000
runAsUser: 1000
sessionCacheSeconds: 60
shutdownGraceSeconds: 45
signingKey:
existingSecret: null
tolerations: []
topologySpreadConstraint: {}
hopsworkslib#- Type
object, default{}. override hopsworkslib values semantic-gateway#- Type
object, default{}. override semantic-gateway values semantic-gateway.arrowMemoryLimitBytes#- Type
string, defaultnil. bytes of Arrow buffers the queries of a replica hold at once (ARROW_MEMORY_LIMIT_BYTES); a query that needs more fails. Null leaves the gateway's default, half the JVM heap (1 GiB with the default memory limit). The buffers sit outside the heap, so heap + this + the JVM's own memory must fit the memory limit (resources.limits) semantic-gateway.biTables.enabled#- Type
bool, defaulttrue. show each semantic project over Flight SQL as tables (a metrics table and one per saved query) and translate BI tools' SQL over them into metric queries (BI_TABLES_ENABLED). Experimental semantic-gateway.buildCacheEntries#- Type
int, default100. compiled builds each replica keeps in memory (BUILD_CACHE_ENTRIES) semantic-gateway.cache.dataVersionSeconds#- Type
int, default30. seconds a replica reuses the backend's answer on the feature group data versions and access a build reads (DATA_VERSION_CACHE_SECONDS). Bounds how long a cached result outlives a new commit or a revoked share semantic-gateway.cache.entryMaxBytes#- Type
int, default8388608. largest result, in bytes, the cache keeps (CACHE_ENTRY_MAX_BYTES). A larger result still streams to the client, uncached semantic-gateway.cache.maxBytes#- Type
int, default268435456. bytes of query results each replica keeps in its result cache (CACHE_MAX_BYTES), on the heap (resources.limits) semantic-gateway.cache.ttlSeconds#- Type
int, default300. seconds a cached result is served before the query runs on Trino again (CACHE_TTL_SECONDS) semantic-gateway.cors.allowedOrigins#- Type
list, default[]. Browser origins whose pages may call the GraphQL API (CORS_ALLOWED_ORIGINS), such as a spreadsheet add-in's, for example https://addin.example.com; "*" allows any. Requests authenticate with the Authorization header, never cookies. None by default semantic-gateway.dependencies.hopsworks#-
Type
object. Payara, reached for sessions and build artifacts (HOPSWORKS_URL). The NetworkPolicy admits its pods to the internal port and lets the gateway reach them semantic-gateway.dependencies.hopsworks.podLabels#- Type
list, default[{"app":"hopsworks-instance"},{"app":"hopsworks-admin"}]. label sets of the Payara pods, one podSelector each semantic-gateway.dependencies.trino#-
Type
object. the Trino coordinator, reached over JDBC with TLS (TRINO_URL). The NetworkPolicy lets the gateway reach its pods semantic-gateway.dependencies.trino.podLabels#-
Type
object. labels of the Trino coordinator pods semantic-gateway.externalLoadBalancer.annotations#- Type
object, default{}. annotations of the external Service, merged over global._hopsworks.externalLoadBalancers.annotations semantic-gateway.externalLoadBalancer.class#- Type
string, defaultnil. load balancer class name. If not set, global._hopsworks.externalLoadBalancers.class is used semantic-gateway.externalLoadBalancer.enabled#- Type
string, defaultnil. Expose the Arrow Flight SQL port outside the cluster on the Service semantic-gateway-external. If not set, global._hopsworks.externalLoadBalancers.enabled is used semantic-gateway.externalLoadBalancer.hostname#- Type
string, defaultnil. DNS name, or IP address, clients reach the load balancer at. Added to the gateway's certificate, which clients check the name against; set hopsworks.variables.loadbalancer_external_domain_semantic_gateway to the same name so the connection details Hopsworks hands out use it. Set it at install: the certificate's names cannot change later unless the HopsworksCert semantic-gateway is deleted before the upgrade. semantic-gateway.externalLoadBalancer.managed#- Type
string, defaultnil. Cloud provider provisions the load balancer (a LoadBalancer Service). False makes it a NodePort Service for a load balancer outside Kubernetes, which on AWS a TargetGroupBinding attaches to global.unmanagedLoadBalancers.semanticGateway.targetGroupId. If not set, global._hopsworks.externalLoadBalancers.managed is used semantic-gateway.externalLoadBalancer.nodePort#- Type
string, defaultnil. Explicit nodePort for the external Service when the load balancer is unmanaged (managed: false), so a load balancer outside Kubernetes can target a fixed port. Null lets Kubernetes allocate one from the cluster's node-port range; a set value must lie in that range (30000-32767 by default), which the API server enforces at install. semantic-gateway.externalLoadBalancer.nodeSelector#- Type
object, default{}. selector for nodes the AWS TargetGroupBinding routes traffic to semantic-gateway.flight.maxHeaderBytes#- Type
int, default65536. largest header list, in bytes, a Flight SQL call may send (FLIGHT_MAX_HEADER_BYTES) semantic-gateway.flight.maxMessageBytes#- Type
int, default4194304. largest request message, in bytes, a Flight SQL call may send (FLIGHT_MAX_MESSAGE_BYTES) semantic-gateway.flight.queuedCalls#- Type
int, default256. Flight SQL calls waiting for a free thread (FLIGHT_QUEUED_CALLS). A call past the threads and this queue is refused at once semantic-gateway.flight.threads#- Type
int, default64. Flight SQL calls a replica runs at once (FLIGHT_THREADS) semantic-gateway.flightPort#- Type
int, default18446. Port of the Arrow Flight SQL server (FLIGHT_PORT), which dbt's JDBC dialect, ADBC and dbt-sl-sdk clients query, and of externalLoadBalancer, which serves it outside the cluster. hopsworks.variables.semantic_gateway_flight_port tells those clients the port, so change both together. Inside the cluster the ClusterIP Service serves it at 18446 whatever this is. semantic-gateway.graphql.maxFields#- Type
int, default500. most fields a GraphQL operation may select, each alias counted (GRAPHQL_MAX_FIELDS). A larger operation is refused before it runs semantic-gateway.handleTtlSeconds#- Type
int, default3600. seconds a signed handle (a Flight ticket, a prepared statement) stays valid after the gateway issues it (HANDLE_TTL_SECONDS) semantic-gateway.hopsworkslib#- Type
object, default{}. override hopsworkslib values semantic-gateway.hpa.enabled#- Type
bool, defaultfalse. Autoscale the Deployment on CPU with an HPA. While enabled, replicas is not rendered and the HPA owns spec.replicas. semantic-gateway.hpa.maxReplicas#- Type
int, default4. most replicas the HPA scales to semantic-gateway.hpa.targetCPUUtilizationPercentage#- Type
int, default80. average CPU utilization, in percent of the request, the HPA keeps the replicas at semantic-gateway.httpRequestTimeoutSeconds#- Type
int, default120. Seconds a client has to send an HTTP request, from its first byte through the TLS handshake to the end of the body (HTTP_REQUEST_TIMEOUT_SECONDS) semantic-gateway.httpResponseTimeoutSeconds#- Type
string, defaultnil. Seconds an HTTP answer may take, from the request read to its last byte written, the query and a slow reader included (HTTP_RESPONSE_TIMEOUT_SECONDS). Null leaves the gateway's default, 2 x (queryTimeoutSeconds + 30) + 240, which is 900 with the default queryTimeoutSeconds and follows it. The gateway refuses to start with less than queryTimeoutSeconds + 30 semantic-gateway.image.pullPolicy#- Type
string, defaultnil. image pull policy. If not set, global._hopsworks.imagePullPolicy, then IfNotPresent semantic-gateway.image.registry#- Type
string, defaultnil. image registry. If not set, global._hopsworks.imageRegistry is used semantic-gateway.image.repository#- Type
string, default"hopsworks/semantic-gateway". image repository. The image is built from hopsworks-ee semantic-gateway.image.tag#- Type
string, defaultnil. image tag. If not set, the chart's appVersion, the Hopsworks version the gateway is built with semantic-gateway.jvmOptions#- Type
string, default"-XX:MaxRAMPercentage=50". JVM options of the gateway, passed as JAVA_TOOL_OPTIONS. -XX:MaxRAMPercentage=50 makes the heap half the memory limit, leaving the other half for the Arrow buffers and the JVM's own memory (resources.limits). The image adds -XX:+ExitOnOutOfMemoryError, so the pod restarts on an OutOfMemoryError whatever this holds semantic-gateway.maxJsonBytes#- Type
int, default67108864. most bytes, counted as JSON text, a JSON or CSV query result holds (MAX_JSON_BYTES). A larger result is refused with 413. Each query slot may hold one on the heap, so queryConcurrency x maxJsonBytes must fit the heap with the cache (resources.limits) semantic-gateway.maxJsonRows#- Type
int, default100000. most rows a JSON query result holds (MAX_JSON_ROWS), which the gateway keeps in memory whole. A larger result is cut off and flagged as truncated semantic-gateway.maxRows#- Type
int, default1000000. most rows an Arrow query result streams (MAX_ROWS). A larger result is cut off, and the X-Semantic-Max-Rows header lets the client tell semantic-gateway.networkPolicy.enabled#- Type
bool, defaulttrue. restrict the gateway's traffic: the internal port to the Payara pods, the metrics port to the release namespace, egress to DNS, Payara and Trino semantic-gateway.nodeSelector#- Type
object, default{}. node selector. If empty, global._hopsworks.nodeSelector is used semantic-gateway.podDisruptionBudget.enabled#- Type
bool, defaulttrue. keep minAvailable replicas through voluntary disruptions. Rendered only with more than one replica semantic-gateway.podDisruptionBudget.minAvailable#- Type
int, default1. replicas kept available. Must be less than replicas semantic-gateway.queryConcurrency#- Type
int, default16. queries each replica runs at once (QUERY_CONCURRENCY). A query that finds no free slot within 30 s is refused with 503. Each slot may hold a JSON answer of maxJsonBytes on the heap (resources.limits) semantic-gateway.queryTimeoutSeconds#- Type
int, default300. seconds a query may run on Trino before the gateway cancels it (QUERY_TIMEOUT_SECONDS), counted after the up to 30 s it may wait for a slot. The read and send timeouts of the Ingresses in front of the gateway (hopsworks.semanticLayer) must exceed this plus 30, or nginx answers 504 for a query that then succeeds: raise them with it semantic-gateway.replicas#- Type
int, default2. Number of replicas. Not rendered while the HPA is enabled: the HPA then owns spec.replicas and this value is its minReplicas. semantic-gateway.resources.limits#- Type
object, default{"cpu":"2","memory":"4Gi"}. resource limits of the gateway container. With the defaults, the 4Gi memory limit is a 2 GiB heap (jvmOptions), 1 GiB of Arrow buffers outside the heap (arrowMemoryLimitBytes) and 1 GiB for the JVM's own memory (metaspace, thread stacks, gRPC buffers). The heap holds the result cache (cache.maxBytes, 256 MiB), the query history queue (64 MiB) and a JSON answer in each query slot (queryConcurrency x maxJsonBytes, 16 x 64 MiB): 1344 MiB, leaving the rest of the heap for compiled builds and the queries' working memory. The gateway refuses to start when cache.maxBytes + 64 MiB + queryConcurrency x maxJsonBytes exceeds the heap, so raising queryConcurrency, maxJsonBytes or cache.maxBytes past that needs a larger memory limit, in requests and limits together semantic-gateway.resources.requests#- Type
object, default{"cpu":"500m","memory":"4Gi"}. resource requests of the gateway container. Keep the memory request equal to the limit: the JVM sizes itself from the limit semantic-gateway.security.runAsGroup#- Type
int, default1000. group the gateway runs as semantic-gateway.security.runAsUser#- Type
int, default1000. user the gateway runs as semantic-gateway.sessionCacheSeconds#- Type
int, default60. seconds the gateway keeps a caller's session, fetched from the backend, before it asks again (SESSION_CACHE_SECONDS) semantic-gateway.shutdownGraceSeconds#- Type
int, default45. Seconds requests in flight get to finish when a pod stops (SHUTDOWN_GRACE_SECONDS); the gateway accepts no new ones meanwhile, and flushes its query history for up to 10 s more. The pod's terminationGracePeriodSeconds is this plus 30, which also covers the 5 s the pod keeps serving while it is removed from the Service endpoints semantic-gateway.signingKey.existingSecret#- Type
string, defaultnil. Secret holding the key the gateway signs handles (Flight tickets, prepared statements) with, undercurrent, and optionally a key it also accepts, underprevious. Null: the chart creates the Secret semantic-gateway-signing with a randomcurrentand keeps both keys across upgrades by reading it back, which needs global._hopsworks.mode auto; any other mode (ArgoCD) fails the render until this names a Secret you create. Rotate in two rollouts: first add the new key asprevious, then make itcurrentand the old keyprevious. After each edit of the Secret, roll the pods: a helm upgrade does it for the Secret the chart created, whose keys the pods carry a checksum of; for an existingSecret, restart the Deployment. Handles signed with the old key stay valid until they expire (handleTtlSeconds). semantic-gateway.tolerations#- Type
list, default[]. tolerations. If empty, global._hopsworks.tolerations is used semantic-gateway.topologySpreadConstraint#- Type
object, default{}. The default topology spread constraint. If not defined the global topology spread constraint would be used instead.