stable/metabase/README.md
As of Nov 13, 2020, charts in this repo will no longer be updated. For more information, see the Helm Charts Deprecation and Archive Notice, and Update.
Metabase is the easy, open source way for everyone in your company to ask questions and learn from data.
This chart is deprecated and no longer supported.
$ helm install stable/metabase
This chart bootstraps a Metabase deployment on a Kubernetes cluster using the Helm package manager.
To install the chart with the release name my-release:
$ helm install --name my-release stable/metabase
The command deploys Metabase on the Kubernetes cluster in the default configuration. The configuration section lists the parameters that can be configured during installation.
Tip: List all releases using
helm list
To uninstall/delete the my-release deployment:
$ helm delete my-release
The command removes all the Kubernetes components associated with the chart and deletes the release.
The following table lists the configurable parameters of the Metabase chart and their default values.
| Parameter | Description | Default |
|---|---|---|
| replicaCount | desired number of controller pods | 1 |
| podAnnotations | controller pods annotations | {} |
| podLabels | extra pods labels | {} |
| image.repository | controller container image repository | metabase/metabase |
| image.tag | controller container image tag | v0.36.3 |
| image.pullPolicy | controller container image pull policy | IfNotPresent |
| fullnameOverride | String to fully override metabase.fullname template | null |
| listen.host | Listening on a specific network host | 0.0.0.0 |
| listen.port | Listening on a specific network port | 3000 |
| ssl.enabled | Enable SSL to run over HTTPS | false |
| ssl.port | SSL port | null |
| ssl.keyStore | The key store in JKS format | null |
| ssl.keyStorePassword | The password for key Store | null |
| database.type | Backend database type | h2 |
| database.encryptionKey | Secret key for encrypt sensitive information into database | null |
| database.connectionURI | Database connection URI (alternative to the below settings) | null |
| database.host | Database host | null |
| database.port | Database port | null |
| database.dbname | Database name | null |
| database.username | Database username | null |
| database.password | Database password | null |
| database.existingSecret | Exising secret for database credentials | null |
| database.existingSecretUsernameKey | Username key for exising secret | null |
| database.existingSecretPasswordKey | Password key for exising secret | null |
| database.existingSecretConnectionURIKey | ConnectionURI key for exising secret | null |
| password.complexity | Complexity requirement for Metabase account's password | normal |
| password.length | Minimum length required for Metabase account's password | 6 |
| timeZone | Service time zone | UTC |
| emojiLogging | Get a funny emoji in service log | true |
| javaOpts | JVM options | null |
| pluginsDirectory | A directory with Metabase plugins | null |
| livenessProbe.initialDelaySeconds | Delay before liveness probe is initiated | 120 |
| livenessProbe.timeoutSeconds | When the probe times out | 30 |
| livenessProbe.failureThreshold | Minimum consecutive failures for the probe | 6 |
| readinessProbe.initialDelaySeconds | Delay before readiness probe is initiated | 30 |
| readinessProbe.timeoutSeconds | When the probe times out | 3 |
| readinessProbe.periodSeconds | How often to perform the probe | 5 |
| service.type | ClusterIP, NodePort, or LoadBalancer | ClusterIP |
| service.loadBalancerSourceRanges | Array of Source Ranges | null |
| service.externalPort | Service external port | 80 |
| service.internalPort | Service internal port, should be the same as listen.port | 3000 |
| service.nodePort | Service node port | null |
| service.annotations | Service annotations | {} |
| ingress.enabled | Enable ingress controller resource | false |
| ingress.hosts | Ingress resource hostnames | null |
| ingress.path | Ingress path | / |
| ingress.labels | Ingress labels configuration | null |
| ingress.annotations | Ingress annotations configuration | {} |
| ingress.tls | Ingress TLS configuration | null |
| log4jProperties | Custom log4j.properties file | null |
| resources | Server resource requests and limits | {} |
| nodeSelector | Node labels for pod assignment | {} |
| tolerations | Toleration labels for pod assignment | [] |
| affinity | Affinity settings for pod assignment | {} |
| jetty.maxThreads | Jetty max number of threads | null |
| jetty.minThreads | Jetty min number of threads | null |
| jetty.maxQueued | Jetty max queue size | null |
| jetty.maxIdleTime | Jetty max idle time | null |
| siteUrl | Base URL, useful for serving behind a reverse proxy | null |
| session.maxSessionAge | Session expiration defined in minutes | 20160 |
| session.sessionCookies | When browser is closed, user login session will expire | null |
The above parameters map to the env variables defined in metabase. For more information please refer to the metabase documentations.
Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,
$ helm install --name my-release \
--set timeZone=US/Pacific,password.complexity=strong,password.length=10 \
stable/metabase
The above command sets the time zone to US/Pacific, strong user password complexity and minimum length at 10
Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,
$ helm install --name my-release -f values.yaml stable/metabase
Tip: You can use the default values.yaml