Install via Helm

Prerequisites

• Helm >= 3.6.0
• Kubernetes >= 1.19.0

Quick Start

You can also check https://github.com/apache/incubator-devlake-helm-chart to make contribution

Install

To install the chart with release name devlake:

helm repo add devlake https://apache.github.io/incubator-devlake-helm-chart
helm repo update
helm install devlake devlake/devlake --version=0.17.0

And visit your devlake from the node port (32001 by default).

http://YOUR-NODE-IP:32001

Tips:

If you are using minikube inside your mac, please use the following command to forward the port:

kubectl port-forward service/devlake-ui  30090:4000

and open another terminal:

kubectl port-forward service/devlake-grafana  30091:3000

Then you can visit: config-ui by url http://YOUR-NODE-IP:30090 grafana by url http://YOUR-NODE-IP:30091

Update

helm repo update
helm upgrade --install devlake devlake/devlake --version=0.17.0

Uninstall

To uninstall/delete the devlake release:

helm uninstall devlake

Some example deployments

Deploy with NodePort

Conditions:

• IP Address of Kubernetes node: 192.168.0.6
• Want to visit devlake with port 30000.

helm install devlake devlake/devlake --set service.uiPort=30000

After deployed, visit devlake: http://192.168.0.6:30000

Deploy with Ingress

Conditions:

• I have already configured default ingress for the Kubernetes cluster
• I want to use http://devlake.example.com for visiting devlake

helm install devlake devlake/devlake --set "ingress.enabled=true,ingress.hostname=devlake.example.com"

After deployed, visit devlake: http://devlake.example.com, and grafana at http://devlake.example.com/grafana

Deploy with Ingress (Https)

Conditions:

• I have already configured ingress(class: nginx) for the Kubernetes cluster, and the https using 8443 port.
• I want to use https://devlake-0.example.com:8443 for visiting devlake.
• The https certificates are generated by letsencrypt.org, and the certificate and key files: cert.pem and key.pem

First, create the secret:

kubectl create secret tls ssl-certificate --cert cert.pem --key secret.pem

Then, deploy the devlake:

helm install devlake devlake/devlake \
    --set "ingress.enabled=true,ingress.enableHttps=true,ingress.hostname=devlake-0.example.com" \
    --set "ingress.className=nginx,ingress.httpsPort=8443" \
    --set "ingress.tlsSecretName=ssl-certificate"

After deployed, visit devlake: https://devlake-0.example.com:8443, and grafana at https://devlake-0.example.com:8443/grafana

Parameters

Some useful parameters for the chart, you could also check them in values.yaml

Parameter	Description	Default
replicaCount	Replica Count for devlake, currently not used	1
imageTag	The version tag for all images	see Values.yaml
mysql.useExternal	If use external mysql server, set true	false
mysql.externalServer	External mysql server address	127.0.0.1
mysql.externalPort	External mysql server port	3306
mysql.username	username for mysql	merico
mysql.password	password for mysql	merico
mysql.database	database for mysql	lake
mysql.rootPassword	root password for mysql	admin
mysql.storage.class	storage class for mysql's volume	""
mysql.storage.size	volume size for mysql's data	5Gi
mysql.image.repository	repository for mysql's image	mysql
mysql.image.tag	image tag for mysql's image	8
mysql.image.pullPolicy	pullPolicy for mysql's image	IfNotPresent
mysql.extraLabels	extra labels for mysql's statefulset	{}
mysql.securityContext	pod security context values	{}
mysql.containerSecurityContext	container security context values	{}
grafana.image.repository	repository for grafana's image	apache/devlake-dashboard
grafana.image.pullPolicy	pullPolicy for grafana's image	Always
grafana.useExternal	If use external grafana server	false
grafana.externalUrl	external grafana server if use external	""
grafana.extraLabels	extra labels for grafana's statefulset	{}
grafana.securityContext	pod security context values	{}
grafana.containerSecurityContext	container security context values	{}
grafana.oauthEnabled	enable oauth for grafana	false
grafana.oauthConfig	a list of env vars used for oauth	{}
lake.storage.class	storage class for lake's volume	""
lake.storage.size	volume size for lake's data	100Mi
lake.image.repository	repository for lake's image	apache/devlake
lake.image.pullPolicy	pullPolicy for lake's image	Always
lake.loggingDir	log dir for the lake server	/app/logs
lake.loggingLevel	log level for the lake server	info
lake.dotenv	initial configurations for injecting to lake's .env	see Values.yaml
lake.extraLabels	extra labels for lake's statefulset	{}
lake.securityContext	pod security context values	{}
lake.containerSecurityContext	container security context values	{}
ui.image.repository	repository for ui's image	apache/devlake-config-ui
ui.image.pullPolicy	pullPolicy for ui's image	Always
ui.basicAuth.enabled	If the basic auth in ui is enabled	false
ui.basicAuth.user	The user name for the basic auth	"admin"
ui.basicAuth.password	The password for the basic auth	"admin"
ui.basicAuth.useSecret	If use secret instead of configmap for basic auth	false
ui.basicAuth.autoCreateSecret	If let the helm chart create the secret	true
ui.basicAuth.secretName	The basic auth secret name	devlake-auth
ui.extraLabels	extra labels for ui's statefulset	{}
ui.securityContext	pod security context values	{}
ui.containerSecurityContext	container security context values	{}
service.type	Service type for exposed service	NodePort
service.uiPort	Node port for config ui	32001
service.ingress.enabled	If enable ingress	false
service.ingress.enableHttps	If enable https	false
service.ingress.className	Name for ingressClass. leave empty for using default	""
service.ingress.hostname	The hostname/domainname for ingress	localhost
service.ingress.prefix	The prefix for endpoints, currently not used	/
service.ingress.tlsSecretName	The secret name for tls's certificate for https	""
service.ingress.httpPort	The http port for ingress	80
service.ingress.httpsPort	The https port for ingress	443
option.localtime	The hostpath for mount as /etc/localtime	/etc/localtime
option.database	The database type, valids: mysql	mysql
option.useConnectionDetailsSecret	If use secret instead of configmap for db connection	false
option.connectionSecretName	The database connection details secret name	devlake-db-connection
option.autoCreateSecret	If let the helm chart create the secret	true
awsCognitoAuth.enabled	use AWS cognito for authentication	false
awsCognitoAuth.awsAuthRegion	aws Cognito auth region	""
awsCognitoAuth.awsAuthUserPoolID	aws Cognito user pool ID	""
awsCognitoAuth.awsAuthUserPoolWebClientID	aws Cognito web client ID for the user pool	""

FAQ

1. Can I use a managed Cloud database service instead of running database in docker?

Yes, it just set useExternal value to true while you deploy devlake with helm chart. Below we'll use MySQL on AWS RDS as an example.

a. (Optional) Create a MySQL instance on AWS RDS following this doc, skip this step if you'd like to use an existing instance b. Proviede below values while install from helm:

- `mysql.useExternal`: this should be `true`
- `mysql.externalServer`: use your RDS instance's IP address or domain name.
- `mysql.externalPort`: use your RDS instance's database port.
- `mysql.username`: use your `username` for access RDS instance's DB
- `mysql.password`: use your `password` for access RDS instance's DB
- `mysql.database`: use your RDS instance's DB name, you may need to create a database first with `CREATE DATABASE <DB name>;`

Here is the example:

helm repo add devlake https://apache.github.io/incubator-devlake-helm-chart
helm repo update
helm install devlake devlake/devlake \
  --set mysql.useExternal=true \
  --set mysql.externalServer=db.example.com \
  --set mysql.externalPort=3306 \
  --set mysql.username=admin \
  --set mysql.password=password_4_admin \
  --set mysql.database=devlake

2. Can I use a secret to store the database connection details?

Yes, to do so, you need to have a secret in your Kubernetes Cluster that contains the following values:

• MYSQL_USER: The user to connect to your DB.
• MYSQL_PASSWORD: The password to connect to your DB.
• MYSQL_DATABASE: The database to connect to your DB.
• MYSQL_ROOT_PASSWORD: The root password to connect to your DB.
• DB_URL: mysql://username:password@dbserver:port/database?charset=utf8mb4&parseTime=True

The secret name needs to be the same as the value option.connectionSecretName

3. Can I use an external Grafana instead of running built-in Grafana?

Yes, the devlake helm chart supports using an external Grafana. You can set the following values while installing from helm:

• grafana.useExternal: this should be true
• grafana.externalUrl: use your Grafana's URL, e.g. https://grafana.example.com

Here is the example:

helm repo add devlake https://apache.github.io/incubator-devlake-helm-chart
helm repo update
helm install devlake devlake/devlake \
  --set grafana.useExternal=true \
  --set grafana.externalUrl=https://grafana.example.com

Troubleshooting

If you run into any problem, please check the Troubleshooting or create an issue