Skip to content

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.2.0-alpha-1791549041 (Hopsworks 5.2.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 145
airflow 151
arrowflight 46
certs-operator 29
consul consul 1.8.16 24
docker-registry 90
grafana grafana 7.0.17 7
hive 78
hopsfs 221
hopsfs-csi 29
hopsworks 934
hw-kueue kueue 0.12.2 94
hw-kyverno 58
judge 23
kafka strimzi-kafka-operator 1.2.0 102
kserve 266
minio 42
olk prometheus-elasticsearch-exporter 5.8.0 164
onlinefs 93
prometheus prometheus 25.20.2, prometheus-adapter 4.11.0 9
ray kuberay-operator 1.4.0 2
rondb rondb 26.2.21 464
spark spark-operator 2.5.1 160
superset mysql 12.3.5, superset 0.15.0 25
trino trino 1.41.0 38
vpa 18

Other values#

Defaults as YAML
hopsworkslib: {}
hopsworkslib #
Type object, default {}. override hopsworkslib values