Redash
Redash is an open source tool built for teams to query, visualize and collaborate.
Introduction
This chart bootstraps a Redash deployment on a Kubernetes cluster using the Helm package manager.
This is a contributed project developed by volunteers and not officially supported by Redash.
Current chart version is 2.0.0-beta.6
Source code can be found here
Prerequisites
- At least 3 GB of RAM available on your cluster
- Kubernetes 1.15+ - chart is tested with latest 3 stable versions
- Helm 2 or 3
- PV provisioner support in the underlying infrastructure
Installing the Chart
To install the chart with the release name my-release, add the chart repository:
$ helm repo add redash https://getredash.github.io/contrib-helm-chart/Create a values file with required secrets (store this securely!):
$ cat > my-values.yaml <<- EOM
redash:
cookieSecret: $(openssl rand -base64 32)
secretKey: $(openssl rand -base64 32)
postgresql:
postgresqlPassword: $(openssl rand -base64 32)
EOMInstall the chart:
$ helm upgrade --install -f my-values.yaml my-release redash/redashThe command deploys Redash on the Kubernetes cluster in the default configuration. The configuration section and and default values.yaml lists the parameters that can be configured during installation.
Tip: List all releases using
helm list
Uninstalling the Chart
To uninstall/delete the my-release deployment:
$ helm delete my-releaseThe command removes all the Kubernetes components associated with the chart and deletes the release.
Chart Requirements
| Repository | Name | Version |
|---|---|---|
| https://kubernetes-charts.storage.googleapis.com | postgresql | ^8.3.4 |
| https://kubernetes-charts.storage.googleapis.com | redis | ^10.5.3 |
Configuration
The following table lists the configurable parameters of the Redash chart and their default values.
Chart Values
| Key | Type | Default | Description |
|---|---|---|---|
| adhocWorker.affinity | object | {} |
Affinity for ad-hoc worker pod assignment ref |
| adhocWorker.env | object | {"QUEUES":"queries,celery","WORKERS_COUNT":2} |
Redash ad-hoc worker specific envrionment variables. |
| adhocWorker.nodeSelector | object | {} |
Node labels for ad-hoc worker pod assignment ref |
| adhocWorker.podSecurityContext | object | {} |
Security contexts for ad-hoc worker pod assignment ref |
| adhocWorker.replicaCount | int | 1 |
Number of ad-hoc worker pods to run |
| adhocWorker.resources | string | nil |
Ad-hoc worker resource requests and limits ref |
| adhocWorker.securityContext | object | {} |
|
| adhocWorker.tolerations | list | [] |
Tolerations for ad-hoc worker pod assignment ref |
| env | object | {"PYTHONUNBUFFERED":0} |
Redash global envrionment variables - applied to both server and worker containers. |
| fullnameOverride | string | "" |
|
| image.pullPolicy | string | "IfNotPresent" |
|
| image.repository | string | "redash/redash" |
Redash image name used for server and worker pods |
| image.tag | string | "8.0.2.b37747" |
Redash image tag |
| imagePullSecrets | list | [] |
Name(s) of secrets to use if pulling images from a private registry |
| ingress.annotations | object | {} |
Ingress annotations configuration |
| ingress.enabled | bool | false |
Enable ingress controller resource |
| ingress.hosts | list | [{"host":"chart-example.local","paths":[]}] |
Ingress resource hostnames and path mappings |
| ingress.tls | list | [] |
Ingress TLS configuration |
| nameOverride | string | "" |
|
| postgresql.enabled | bool | true |
Whether to deploy a PostgreSQL server to satisfy the applications database requirements. To use an external PostgreSQL set this to false and configure the externalPostgreSQL parameter. |
| postgresql.image.tag | string | "9.6.17-debian-10-r3" |
Bitnami supported version close to the one specified in Redash setup docker-compose.yml |
| postgresql.persistence.accessMode | string | "ReadWriteOnce" |
Use PostgreSQL volume as ReadOnly or ReadWrite |
| postgresql.persistence.enabled | bool | true |
Use a PVC to persist PostgreSQL data (when postgresql chart enabled) |
| postgresql.persistence.size | string | "10Gi" |
PVC Storage Request size for PostgreSQL volume |
| postgresql.persistence.storageClass | string | "" |
|
| postgresql.postgresqlDatabase | string | "redash" |
PostgreSQL database name (when postgresql chart enabled) |
| postgresql.postgresqlPassword | string | nil |
REQUIRED: PostgreSQL password for redash user (when postgresql chart enabled) |
| postgresql.postgresqlUsername | string | "redash" |
PostgreSQL username for redash user (when postgresql chart enabled) |
| postgresql.service.port | int | 5432 |
|
| postgresql.service.type | string | "ClusterIP" |
|
| redash.additionalDestinations | string | nil |
REDASH_ADDITIONAL_DESTINATIONS value. Defaults to ``. |
| redash.additionalQueryRunners | string | nil |
REDASH_ADDITIONAL_QUERY_RUNNERS value. Defaults to ``. |
| redash.adhocQueryTimeLimit | string | nil |
REDASH_ADHOC_QUERY_TIME_LIMIT value. Defaults to None. |
| redash.alertsDefaultMailSubjectTemplate | string | nil |
REDASH_ALERTS_DEFAULT_MAIL_SUBJECT_TEMPLATE value. Defaults to ({state}) {alert_name}. |
| redash.allowScriptsInUserInput | string | nil |
REDASH_ALLOW_SCRIPTS_IN_USER_INPUT value. Defaults to false. Disable sanitization of text input, allowing full html. |
| redash.authType | string | nil |
REDASH_AUTH_TYPE value. Defaults to api_key. |
| redash.bigqueryHttpTimeout | string | nil |
REDASH_BIGQUERY_HTTP_TIMEOUT value. Defaults to 600. |
| redash.celeryBackend | string | nil |
REDASH_CELERY_BACKEND value. Defaults to CELERY_BROKER. |
| redash.celeryBroker | string | nil |
REDASH_CELERY_BROKER value. Defaults to REDIS_URL. |
| redash.celeryTaskResultExpires | string | nil |
REDASH_CELERY_TASK_RESULT_EXPIRES value. Defaults to 3600 \* 4. How many seconds to keep celery task results in cache (in seconds). |
| redash.cookieSecret | string | nil |
REQUIRED REDASH_COOKIE_SECRET value. Defaults to ``. Stored as a Secret value. |
| redash.corsAccessControlAllowCredentials | string | nil |
REDASH_CORS_ACCESS_CONTROL_ALLOW_CREDENTIALS value. Defaults to false. |
| redash.corsAccessControlAllowHeaders | string | nil |
REDASH_CORS_ACCESS_CONTROL_ALLOW_HEADERS value. Defaults to Content-Type. |
| redash.corsAccessControlAllowOrigin | string | nil |
REDASH_CORS_ACCESS_CONTROL_ALLOW_ORIGIN value. Defaults to ``. |
| redash.corsAccessControlRequestMethod | string | nil |
REDASH_CORS_ACCESS_CONTROL_REQUEST_METHOD value. Defaults to GET, POST, PUT. |
| redash.dashboardRefreshIntervals | string | nil |
REDASH_DASHBOARD_REFRESH_INTERVALS value. Defaults to 60,300,600,1800,3600,43200,86400. |
| redash.dateFormat | string | nil |
REDASH_DATE_FORMAT value. Defaults to DD/MM/YY. |
| redash.disabledQueryRunners | string | nil |
REDASH_DISABLED_QUERY_RUNNERS value. Defaults to ``. |
| redash.enabledDestinations | string | nil |
REDASH_ENABLED_DESTINATIONS value. Defaults to ”,”.join(default_destinations). |
| redash.enabledQueryRunners | string | nil |
REDASH_ENABLED_QUERY_RUNNERS value. Defaults to ”,”.join(default_query_runners). |
| redash.enforceHttps | string | nil |
REDASH_ENFORCE_HTTPS value. Defaults to false. |
| redash.eventReportingWebhooks | string | nil |
REDASH_EVENT_REPORTING_WEBHOOKS value. Defaults to ``. |
| redash.featureAllowCustomJsVisualizations | string | nil |
REDASH_FEATURE_ALLOW_CUSTOM_JS_VISUALIZATIONS value. Defaults to false. |
| redash.featureAutoPublishNamedQueries | string | nil |
REDASH_FEATURE_AUTO_PUBLISH_NAMED_QUERIES value. Defaults to true. |
| redash.featureDisableRefreshQueries | string | nil |
REDASH_FEATURE_DISABLE_REFRESH_QUERIES value. Defaults to false. Disable scheduled query execution. |
| redash.featureDumbRecents | string | nil |
REDASH_FEATURE_DUMB_RECENTS value. Defaults to false. |
| redash.featureShowPermissionsControl | string | nil |
REDASH_FEATURE_SHOW_PERMISSIONS_CONTROL value. Defaults to false. |
| redash.featureShowQueryResultsCount | string | nil |
REDASH_FEATURE_SHOW_QUERY_RESULTS_COUNT value. Defaults to true. Disable/enable showing count of query results in status. |
| redash.googleClientId | string | nil |
REDASH_GOOGLE_CLIENT_ID value. Defaults to ``. |
| redash.googleClientSecret | string | nil |
REDASH_GOOGLE_CLIENT_SECRET value. Defaults to ``. Stored as a Secret value. |
| redash.host | string | nil |
REDASH_HOST value. Defaults to ``. |
| redash.invitationTokenMaxAge | string | nil |
REDASH_INVITATION_TOKEN_MAX_AGE value. Defaults to 60 _ 60 _ 24 \* 7. |
| redash.jobExpiryTime | string | nil |
REDASH_JOB_EXPIRY_TIME value. Defaults to 3600 \* 12. |
| redash.jwtAuthAlgorithms | string | nil |
REDASH_JWT_AUTH_ALGORITHMS value. Defaults to HS256,RS256,ES256. |
| redash.jwtAuthAudience | string | nil |
REDASH_JWT_AUTH_AUDIENCE value. Defaults to ``. |
| redash.jwtAuthCookieName | string | nil |
REDASH_JWT_AUTH_COOKIE_NAME value. Defaults to ``. |
| redash.jwtAuthHeaderName | string | nil |
REDASH_JWT_AUTH_HEADER_NAME value. Defaults to ``. |
| redash.jwtAuthIssuer | string | nil |
REDASH_JWT_AUTH_ISSUER value. Defaults to ``. |
| redash.jwtAuthPublicCertsUrl | string | nil |
REDASH_JWT_AUTH_PUBLIC_CERTS_URL value. Defaults to ``. |
| redash.jwtLoginEnabled | string | nil |
REDASH_JWT_LOGIN_ENABLED value. Defaults to false. |
| redash.ldapBindDn | string | nil |
REDASH_LDAP_BIND_DN value. Defaults to None. |
| redash.ldapBindDnPassword | string | nil |
REDASH_LDAP_BIND_DN_PASSWORD value. Defaults to ``. Stored as a Secret value. |
| redash.ldapCustomUsernamePrompt | string | nil |
REDASH_LDAP_CUSTOM_USERNAME_PROMPT value. Defaults to LDAP/AD/SSO username:. |
| redash.ldapDisplayNameKey | string | nil |
REDASH_LDAP_DISPLAY_NAME_KEY value. Defaults to displayName. |
| redash.ldapEmailKey | string | nil |
REDASH_LDAP_EMAIL_KEY value. Defaults to mail. |
| redash.ldapLoginEnabled | string | nil |
REDASH_LDAP_LOGIN_ENABLED value. Defaults to false. |
| redash.ldapSearchDn | string | nil |
REDASH_LDAP_SEARCH_DN value. Defaults to REDASH_SEARCH_DN. |
| redash.ldapSearchTemplate | string | nil |
REDASH_LDAP_SEARCH_TEMPLATE value. Defaults to (cn=%(username)s). |
| redash.ldapUrl | string | nil |
REDASH_LDAP_URL value. Defaults to None. |
| redash.limiterStorage | string | nil |
REDASH_LIMITER_STORAGE value. Defaults to REDIS_URL. |
| redash.logLevel | string | nil |
REDASH_LOG_LEVEL value. Defaults to INFO. |
| redash.mailAsciiAttachments | string | nil |
REDASH_MAIL_ASCII_ATTACHMENTS value. Defaults to false. |
| redash.mailDefaultSender | string | nil |
REDASH_MAIL_DEFAULT_SENDER value. Defaults to None. |
| redash.mailMaxEmails | string | nil |
REDASH_MAIL_MAX_EMAILS value. Defaults to None. |
| redash.mailPassword | string | nil |
REDASH_MAIL_PASSWORD value. Defaults to None. Stored as a Secret value. |
| redash.mailPort | string | nil |
REDASH_MAIL_PORT value. Defaults to 25. |
| redash.mailServer | string | nil |
REDASH_MAIL_SERVER value. Defaults to localhost. |
| redash.mailUseSsl | string | nil |
REDASH_MAIL_USE_SSL value. Defaults to false. |
| redash.mailUseTls | string | nil |
REDASH_MAIL_USE_TLS value. Defaults to false. |
| redash.mailUsername | string | nil |
REDASH_MAIL_USERNAME value. Defaults to None. |
| redash.multiOrg | string | nil |
REDASH_MULTI_ORG value. Defaults to false. |
| redash.passwordLoginEnabled | string | nil |
REDASH_PASSWORD_LOGIN_ENABLED value. Defaults to true. |
| redash.proxiesCount | string | nil |
REDASH_PROXIES_COUNT value. Defaults to 1. |
| redash.queryRefreshIntervals | string | nil |
REDASH_QUERY_REFRESH_INTERVALS value. Defaults to 60, 300, 600, 900, 1800, 3600, 7200, 10800, 14400, 18000, 21600, 25200, 28800, 32400, 36000, 39600, 43200, 86400, 604800, 1209600, 2592000. |
| redash.queryResultsCleanupCount | string | nil |
REDASH_QUERY_RESULTS_CLEANUP_COUNT value. Defaults to 100. |
| redash.queryResultsCleanupEnabled | string | nil |
REDASH_QUERY_RESULTS_CLEANUP_ENABLED value. Defaults to true. |
| redash.queryResultsCleanupMaxAge | string | nil |
REDASH_QUERY_RESULTS_CLEANUP_MAX_AGE value. Defaults to 7. |
| redash.remoteUserHeader | string | nil |
REDASH_REMOTE_USER_HEADER value. Defaults to X-Forwarded-Remote-User. |
| redash.remoteUserLoginEnabled | string | nil |
REDASH_REMOTE_USER_LOGIN_ENABLED value. Defaults to false. |
| redash.samlEntityId | string | nil |
REDASH_SAML_ENTITY_ID value. Defaults to ``. |
| redash.samlMetadataUrl | string | nil |
REDASH_SAML_METADATA_URL value. Defaults to ``. |
| redash.samlNameidFormat | string | nil |
REDASH_SAML_NAMEID_FORMAT value. Defaults to ``. |
| redash.schemaRunTableSizeCalculations | string | nil |
REDASH_SCHEMA_RUN_TABLE_SIZE_CALCULATIONS value. Defaults to false. |
| redash.schemasRefreshQueue | string | nil |
REDASH_SCHEMAS_REFRESH_QUEUE value. Defaults to celery. The celery queue for refreshing the data source schemas. |
| redash.schemasRefreshSchedule | string | nil |
REDASH_SCHEMAS_REFRESH_SCHEDULE value. Defaults to 30. How often to refresh the data sources schemas (in minutes). |
| redash.secretKey | string | nil |
REQUIRED REDASH_SECRET_KEY value. Defaults to ``. Secret key used for data encryption. Stored as a Secret value. |
| redash.sentryDsn | string | nil |
REDASH_SENTRY_DSN value. Defaults to ``. |
| redash.staticAssetsPath | string | nil |
REDASH_STATIC_ASSETS_PATH value. Defaults to ”../client/dist/”. |
| redash.statsdHost | string | nil |
REDASH_STATSD_HOST value. Defaults to 127.0.0.1. |
| redash.statsdPort | string | nil |
REDASH_STATSD_PORT value. Defaults to 8125. |
| redash.statsdPrefix | string | nil |
REDASH_STATSD_PREFIX value. Defaults to redash. |
| redash.statsdUseTags | string | nil |
REDASH_STATSD_USE_TAGS value. Defaults to false. Whether to use tags in statsd metrics (influxdb’s format). |
| redash.throttleLoginPattern | string | nil |
REDASH_THROTTLE_LOGIN_PATTERN value. Defaults to 50/hour. |
| redash.versionCheck | string | nil |
REDASH_VERSION_CHECK value. Defaults to true. |
| redash.webWorkers | string | nil |
REDASH_WEB_WORKERS value. Defaults to 4. How many processes will gunicorn spawn to handle web requests. |
| redis.cluster.enabled | bool | false |
|
| redis.databaseNumber | int | 0 |
Enable Redis clustering (when redis chart enabled) |
| redis.enabled | bool | true |
Whether to deploy a Redis server to satisfy the applications database requirements. To use an external Redis set this to false and configure the externalRedis parameter. |
| redis.master.port | int | 6379 |
Redis master port to use (when redis chart enabled) |
| scheduledWorker.affinity | object | {} |
Affinity for scheduled worker pod assignment ref |
| scheduledWorker.env | object | {"QUEUES":"scheduled_queries","WORKERS_COUNT":2} |
Redash scheduled worker specific envrionment variables. |
| scheduledWorker.nodeSelector | object | {} |
Node labels for scheduled worker pod assignment ref |
| scheduledWorker.podSecurityContext | object | {} |
Security contexts for scheduled worker pod assignment ref |
| scheduledWorker.replicaCount | int | 1 |
Number of scheduled worker pods to run |
| scheduledWorker.resources | string | nil |
Scheduled worker resource requests and limits ref |
| scheduledWorker.securityContext | object | {} |
|
| scheduledWorker.tolerations | list | [] |
Tolerations for scheduled worker pod assignment ref |
| server.affinity | object | {} |
Affinity for server pod assignment ref |
| server.env | object | {} |
Redash server specific envrionment variables |
| server.httpPort | int | 5000 |
Server container port (only useful if you are using a customized image) |
| server.nodeSelector | object | {} |
Node labels for server pod assignment ref |
| server.podSecurityContext | object | {} |
Security contexts for server pod assignment ref |
| server.replicaCount | int | 1 |
Number of server pods to run |
| server.resources | string | nil |
Server resource requests and limits ref |
| server.securityContext | object | {} |
|
| server.tolerations | list | [] |
Tolerations for server pod assignment ref |
| service.port | int | 80 |
Service external port |
| service.type | string | "ClusterIP" |
Kubernetes Service type |
| serviceAccount.annotations | object | {} |
Annotations to add to the service account |
| serviceAccount.create | bool | true |
Specifies whether a service account should be created |
| serviceAccount.name | string | nil |
The name of the service account to use. If not set and create is true, a name is generated using the fullname template |
Upgrading
- See the changelog for major changes in each release
- The project will use the semver specification for chart version numbers (chart versions will not match Redash versions, since we may need to update the chart more than once for the same Redash release)
- Always back up your database before upgrading!
- Schema migrations will be run automatically after each upgrade
To upgrade a release named my-release:
helm repo update
helm upgrade --reuse-values my-release redash/redashBelow are notes on manual configuration changes or steps needed for major chart version updates.
From 1.x to 2.x
- There are 3 required secrets (see above) that must now be specified in your release
- The server.env is now depreciated (except for non-standard variables such as PYTHON_*) to allow for better management of Redash configuration and secret values - any existing configuration should be migrated to the new values
From pre-release to 1.x
- The values.yaml structure has several changes
- The Redash, PostgreSQL and Redis versions have all been updated
- Due to these changes you will likely need to dump the database and reload it into a fresh install
- The chart now has it's own repo: https://getredash.github.io/contrib-helm-chart/
License
This chart uses the Apache 2 license.
Contributing
Contributions are welcome.